fix(api): document worktree run-engine status

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
DottaandPaperclip committed 2026-08-25 19:31:23 +00:00
1 parent 2c6eaaa52d
commit 4969067d62
5 files changed
+14 -7

No files matched your search

+2 -3
View File
@@ -243,9 +243,8 @@ export function instanceSettingsRoutes(db: Db) {
);
router.get("/instance/settings/experimental/worktree-run-engine", async (req, res) => {
// Boot-truth for the worktree run engine (PAP-14312). Readable by any
// authenticated org member or instance admin so the persistent banner and
// inherited-run surfaces render for everyone viewing a preview instance.
// Readable by any authenticated org member or instance admin so the persistent
// banner and inherited-run surfaces render for everyone viewing a preview instance.
assertBoardOrgAccess(req);
res.json(await svc.getWorktreeRunEngineStatus());
});
+8
View File
@@ -4137,6 +4137,14 @@ registry.registerPath({
responses: { 200: r.ok(), 401: r.unauthorized },
});
registry.registerPath({
method: "get",
path: "/api/instance/settings/experimental/worktree-run-engine",
tags: ["instance"],
summary: "Get worktree run-engine boot status",
responses: { 200: r.ok(), 401: r.unauthorized },
});
registry.registerPath({
method: "patch",
path: "/api/instance/settings/experimental",
+1 -1
View File
@@ -297,7 +297,7 @@ function isActiveRun(run: Pick<LedgerRun, "status" | "isLive">) {
}
/**
* PAP-14312: runs copied into a worktree seed are quarantined (cancelled +
* Runs copied into a worktree seed are quarantined (cancelled with
* `worktree_seed_quarantine`) so they never execute in the preview. Render them
* as "inherited — inactive" instead of a scary failed/cancelled run.
*/
@@ -136,7 +136,7 @@ function IdentityLine({
}
/**
* PAP-14312: persistent boot-truth for the worktree run engine. Renders nothing
* Persistent boot-truth for the worktree run engine. Renders nothing
* outside a worktree runtime. Otherwise it reports whether the scheduler is armed
* or suppressed (and why), which instance identity the toggle is bound to, and how
* many inherited runs were quarantined at seed time.
@@ -185,7 +185,7 @@ describe("InstanceExperimentalSettings — Conference Room Chat card (PAP-11233)
currentExperimentalSettings = { ...currentExperimentalSettings, ...patch };
return { ...currentExperimentalSettings };
});
// Boot-truth banner (PAP-14312) has its own coverage in
// The boot-truth banner has its own coverage in
// WorktreeRunEngineBanner.test.tsx; here it defaults to not-in-worktree so
// the page tests focus on the toggle and delegation.
mockInstanceSettingsApi.getWorktreeRunEngine.mockResolvedValue({
@@ -448,7 +448,7 @@ describe("InstanceExperimentalSettings — Conference Room Chat card (PAP-11233)
});
// The armed/suppressed/identity boot-truth states now live in the
// WorktreeRunEngineBanner (PAP-14312); the settings card only delegates to it.
// The settings card delegates boot-truth states to WorktreeRunEngineBanner.
// Full state coverage lives in WorktreeRunEngineBanner.test.tsx.
it("renders the run-engine boot-truth banner inside the worktree card", async () => {
setWorktreeRuntimeMeta(true);