@bevel-software/platform-core-backend 0.22.0 → 0.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/core/core-ports.d.ts +11 -1
- package/dist/core/core-ports.d.ts.map +1 -1
- package/dist/core/core-ports.js.map +1 -1
- package/dist/core/create-core-server.d.ts +3 -3
- package/dist/core/create-core-server.d.ts.map +1 -1
- package/dist/core/create-core-server.js +30 -11
- package/dist/core/create-core-server.js.map +1 -1
- package/dist/core/create-core-services.d.ts +9 -2
- package/dist/core/create-core-services.d.ts.map +1 -1
- package/dist/core/create-core-services.js +112 -23
- package/dist/core/create-core-services.js.map +1 -1
- package/dist/core/lifecycle.d.ts +34 -1
- package/dist/core/lifecycle.d.ts.map +1 -1
- package/dist/core/lifecycle.js +89 -13
- package/dist/core/lifecycle.js.map +1 -1
- package/dist/core-config.d.ts +0 -12
- package/dist/core-config.d.ts.map +1 -1
- package/dist/core-config.js +11 -13
- package/dist/core-config.js.map +1 -1
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/modules/access/access-control.interface.d.ts +42 -12
- package/dist/modules/access/access-control.interface.d.ts.map +1 -1
- package/dist/modules/access/access-control.service.d.ts +67 -10
- package/dist/modules/access/access-control.service.d.ts.map +1 -1
- package/dist/modules/access/access-control.service.js +214 -35
- package/dist/modules/access/access-control.service.js.map +1 -1
- package/dist/modules/access/access.routes.d.ts.map +1 -1
- package/dist/modules/access/access.routes.js +13 -15
- package/dist/modules/access/access.routes.js.map +1 -1
- package/dist/modules/auth/account-admission.d.ts +58 -7
- package/dist/modules/auth/account-admission.d.ts.map +1 -1
- package/dist/modules/auth/account-admission.js +44 -1
- package/dist/modules/auth/account-admission.js.map +1 -1
- package/dist/modules/auth/account.routes.d.ts +1 -1
- package/dist/modules/auth/account.routes.d.ts.map +1 -1
- package/dist/modules/auth/account.routes.js +61 -5
- package/dist/modules/auth/account.routes.js.map +1 -1
- package/dist/modules/auth/auth.middleware.d.ts +1 -1
- package/dist/modules/auth/auth.middleware.d.ts.map +1 -1
- package/dist/modules/auth/auth.middleware.js +18 -7
- package/dist/modules/auth/auth.middleware.js.map +1 -1
- package/dist/modules/auth/auth.routes.d.ts.map +1 -1
- package/dist/modules/auth/auth.routes.js +8 -0
- package/dist/modules/auth/auth.routes.js.map +1 -1
- package/dist/modules/auth/auth.service.d.ts +70 -2
- package/dist/modules/auth/auth.service.d.ts.map +1 -1
- package/dist/modules/auth/auth.service.js +176 -7
- package/dist/modules/auth/auth.service.js.map +1 -1
- package/dist/modules/auth/oidc-auth-provider.d.ts.map +1 -1
- package/dist/modules/auth/oidc-auth-provider.js +7 -2
- package/dist/modules/auth/oidc-auth-provider.js.map +1 -1
- package/dist/modules/database/core-schema.d.ts +41 -24
- package/dist/modules/database/core-schema.d.ts.map +1 -1
- package/dist/modules/database/core-schema.js +35 -27
- package/dist/modules/database/core-schema.js.map +1 -1
- package/dist/modules/kb-fs/branch-name.d.ts.map +1 -1
- package/dist/modules/kb-fs/branch-name.js +12 -2
- package/dist/modules/kb-fs/branch-name.js.map +1 -1
- package/dist/modules/kb-fs/repo-path.d.ts +11 -16
- package/dist/modules/kb-fs/repo-path.d.ts.map +1 -1
- package/dist/modules/kb-fs/repo-path.js +79 -0
- package/dist/modules/kb-fs/repo-path.js.map +1 -1
- package/dist/modules/kb-sync/kb-sync.routes.d.ts +2 -2
- package/dist/modules/kb-sync/kb-sync.routes.d.ts.map +1 -1
- package/dist/modules/kb-sync/kb-sync.routes.js +14 -3
- package/dist/modules/kb-sync/kb-sync.routes.js.map +1 -1
- package/dist/modules/kb-sync/sync-auth.d.ts +3 -1
- package/dist/modules/kb-sync/sync-auth.d.ts.map +1 -1
- package/dist/modules/kb-sync/sync-auth.js +1 -1
- package/dist/modules/kb-sync/sync-auth.js.map +1 -1
- package/dist/modules/mcp/mcp-auth.middleware.d.ts.map +1 -1
- package/dist/modules/mcp/mcp-auth.middleware.js +21 -6
- package/dist/modules/mcp/mcp-auth.middleware.js.map +1 -1
- package/dist/modules/mcp/oauth/bevel-oauth-provider.d.ts.map +1 -1
- package/dist/modules/mcp/oauth/bevel-oauth-provider.js +3 -2
- package/dist/modules/mcp/oauth/bevel-oauth-provider.js.map +1 -1
- package/dist/modules/settings/deployment-settings.service.d.ts.map +1 -1
- package/dist/modules/settings/deployment-settings.service.js +8 -3
- package/dist/modules/settings/deployment-settings.service.js.map +1 -1
- package/dist/modules/settings/setup.routes.d.ts +52 -1
- package/dist/modules/settings/setup.routes.d.ts.map +1 -1
- package/dist/modules/settings/setup.routes.js +207 -19
- package/dist/modules/settings/setup.routes.js.map +1 -1
- package/dist/modules/skills/skills.contract.d.ts +90 -18
- package/dist/modules/skills/skills.contract.d.ts.map +1 -1
- package/dist/modules/skills/skills.contract.js +4 -1
- package/dist/modules/skills/skills.contract.js.map +1 -1
- package/dist/modules/skills/skills.service.d.ts +98 -9
- package/dist/modules/skills/skills.service.d.ts.map +1 -1
- package/dist/modules/skills/skills.service.js +239 -37
- package/dist/modules/skills/skills.service.js.map +1 -1
- package/dist/modules/skills/skills.tools.d.ts +7 -0
- package/dist/modules/skills/skills.tools.d.ts.map +1 -1
- package/dist/modules/skills/skills.tools.js +71 -7
- package/dist/modules/skills/skills.tools.js.map +1 -1
- package/dist/modules/tool-auth/external-api-key.service.d.ts.map +1 -1
- package/dist/modules/tool-auth/external-api-key.service.js +4 -2
- package/dist/modules/tool-auth/external-api-key.service.js.map +1 -1
- package/dist/modules/tool-auth/internal-token.service.d.ts +3 -3
- package/dist/modules/tool-auth/tool-auth.middleware.d.ts +16 -7
- package/dist/modules/tool-auth/tool-auth.middleware.d.ts.map +1 -1
- package/dist/modules/tool-auth/tool-auth.middleware.js +34 -12
- package/dist/modules/tool-auth/tool-auth.middleware.js.map +1 -1
- package/dist/modules/tool-helpers/tool-handler.d.ts +2 -1
- package/dist/modules/tool-helpers/tool-handler.d.ts.map +1 -1
- package/dist/modules/tool-helpers/tool-handler.js +25 -4
- package/dist/modules/tool-helpers/tool-handler.js.map +1 -1
- package/dist/modules/tool-helpers/tool.contract.d.ts +3 -2
- package/dist/modules/tool-helpers/tool.contract.d.ts.map +1 -1
- package/dist/modules/tool-helpers/tool.contract.js.map +1 -1
- package/dist/modules/tool-helpers/validate-token.js +1 -1
- package/dist/modules/tool-helpers/validate-token.js.map +1 -1
- package/dist/modules/workflow/agent-tools/change-request-summary.d.ts +98 -0
- package/dist/modules/workflow/agent-tools/change-request-summary.d.ts.map +1 -0
- package/dist/modules/workflow/agent-tools/change-request-summary.js +81 -0
- package/dist/modules/workflow/agent-tools/change-request-summary.js.map +1 -0
- package/dist/modules/workflow/agent-tools/workflow.tools.d.ts.map +1 -1
- package/dist/modules/workflow/agent-tools/workflow.tools.js +75 -35
- package/dist/modules/workflow/agent-tools/workflow.tools.js.map +1 -1
- package/dist/modules/workflow/file-lock.service.d.ts +24 -0
- package/dist/modules/workflow/file-lock.service.d.ts.map +1 -1
- package/dist/modules/workflow/file-lock.service.js +30 -0
- package/dist/modules/workflow/file-lock.service.js.map +1 -1
- package/dist/modules/workflow/git/git.service.d.ts +69 -0
- package/dist/modules/workflow/git/git.service.d.ts.map +1 -1
- package/dist/modules/workflow/git/git.service.js +153 -2
- package/dist/modules/workflow/git/git.service.js.map +1 -1
- package/dist/modules/workflow/pending-commits.service.d.ts +38 -0
- package/dist/modules/workflow/pending-commits.service.d.ts.map +1 -1
- package/dist/modules/workflow/pending-commits.service.js +55 -0
- package/dist/modules/workflow/pending-commits.service.js.map +1 -1
- package/dist/modules/workflow/workflow-hooks.d.ts +54 -32
- package/dist/modules/workflow/workflow-hooks.d.ts.map +1 -1
- package/dist/modules/workflow/workflow-hooks.js +16 -1
- package/dist/modules/workflow/workflow-hooks.js.map +1 -1
- package/dist/modules/workflow/workflow.service.d.ts +60 -6
- package/dist/modules/workflow/workflow.service.d.ts.map +1 -1
- package/dist/modules/workflow/workflow.service.js +111 -4
- package/dist/modules/workflow/workflow.service.js.map +1 -1
- package/dist/modules/workspace/agent-access.gate.d.ts +94 -0
- package/dist/modules/workspace/agent-access.gate.d.ts.map +1 -0
- package/dist/modules/workspace/agent-access.gate.js +123 -0
- package/dist/modules/workspace/agent-access.gate.js.map +1 -0
- package/dist/modules/workspace/routine-write-policy.d.ts +5 -6
- package/dist/modules/workspace/routine-write-policy.d.ts.map +1 -1
- package/dist/modules/workspace/routine-write-policy.js +5 -6
- package/dist/modules/workspace/routine-write-policy.js.map +1 -1
- package/dist/modules/workspace/session-sink.d.ts +5 -5
- package/dist/modules/workspace/set-aside-clone.d.ts +46 -0
- package/dist/modules/workspace/set-aside-clone.d.ts.map +1 -0
- package/dist/modules/workspace/set-aside-clone.js +92 -0
- package/dist/modules/workspace/set-aside-clone.js.map +1 -0
- package/dist/modules/workspace/startup/kb-startup-runner.d.ts +59 -9
- package/dist/modules/workspace/startup/kb-startup-runner.d.ts.map +1 -1
- package/dist/modules/workspace/startup/kb-startup-runner.js +65 -24
- package/dist/modules/workspace/startup/kb-startup-runner.js.map +1 -1
- package/dist/modules/workspace/workspace.routes.d.ts.map +1 -1
- package/dist/modules/workspace/workspace.routes.js +92 -3
- package/dist/modules/workspace/workspace.routes.js.map +1 -1
- package/dist/modules/workspace/workspace.service.d.ts +115 -5
- package/dist/modules/workspace/workspace.service.d.ts.map +1 -1
- package/dist/modules/workspace/workspace.service.js +255 -25
- package/dist/modules/workspace/workspace.service.js.map +1 -1
- package/dist/modules/workspace/workspace.tools.d.ts +2 -2
- package/dist/modules/workspace/workspace.tools.d.ts.map +1 -1
- package/dist/modules/workspace/workspace.tools.js +309 -115
- package/dist/modules/workspace/workspace.tools.js.map +1 -1
- package/dist/modules/write-access/write-access.d.ts +60 -0
- package/dist/modules/write-access/write-access.d.ts.map +1 -0
- package/dist/modules/write-access/write-access.js +129 -0
- package/dist/modules/write-access/write-access.js.map +1 -0
- package/dist/shared/domain-errors.d.ts +25 -0
- package/dist/shared/domain-errors.d.ts.map +1 -1
- package/dist/shared/domain-errors.js +28 -0
- package/dist/shared/domain-errors.js.map +1 -1
- package/dist/shared/git.contract.d.ts +20 -0
- package/dist/shared/git.contract.d.ts.map +1 -1
- package/dist/shared/git.contract.js +26 -0
- package/dist/shared/git.contract.js.map +1 -1
- package/dist/tenancy/static-tenant-source.d.ts +0 -1
- package/dist/tenancy/static-tenant-source.d.ts.map +1 -1
- package/dist/tenancy/static-tenant-source.js +0 -2
- package/dist/tenancy/static-tenant-source.js.map +1 -1
- package/migrations/0014_change_request_closed_reason.sql +1 -0
- package/migrations/0015_account_deactivation.sql +3 -0
- package/migrations/meta/0014_snapshot.json +2265 -0
- package/migrations/meta/0015_snapshot.json +2271 -0
- package/migrations/meta/_journal.json +14 -0
- package/package.json +3 -3
- package/src/__tests__/kb-layout-config.test.ts +0 -2
- package/src/__tests__/retired-settings.test.ts +96 -0
- package/src/core/__tests__/gated-boot.test.ts +132 -0
- package/src/core/__tests__/lifecycle.test.ts +170 -1
- package/src/core/__tests__/set-aside-root-is-one-place.test.ts +63 -0
- package/src/core/core-ports.ts +11 -1
- package/src/core/create-core-server.ts +32 -14
- package/src/core/create-core-services.ts +129 -23
- package/src/core/lifecycle.ts +98 -13
- package/src/core-config.ts +13 -14
- package/src/index.ts +12 -1
- package/src/modules/access/__tests__/access-control.preview-relocation.test.ts +385 -0
- package/src/modules/access/__tests__/access-control.prospective.test.ts +94 -18
- package/src/modules/access/__tests__/access.routes.prospective.test.ts +6 -7
- package/src/modules/access/access-control.interface.ts +43 -12
- package/src/modules/access/access-control.service.ts +234 -36
- package/src/modules/access/access.routes.ts +13 -15
- package/src/modules/agent-instructions/__tests__/agent-instructions.route.test.ts +3 -1
- package/src/modules/auth/__tests__/account-deactivation.test.ts +252 -0
- package/src/modules/auth/__tests__/account.routes.test.ts +81 -3
- package/src/modules/auth/__tests__/auth.middleware.test.ts +45 -22
- package/src/modules/auth/__tests__/auth.service.test.ts +1 -1
- package/src/modules/auth/account-admission.ts +78 -9
- package/src/modules/auth/account.routes.ts +63 -7
- package/src/modules/auth/auth.middleware.ts +19 -8
- package/src/modules/auth/auth.routes.ts +8 -0
- package/src/modules/auth/auth.service.ts +179 -6
- package/src/modules/auth/oidc-auth-provider.ts +7 -2
- package/src/modules/database/core-schema.ts +35 -27
- package/src/modules/kb-fs/__tests__/branch-name.test.ts +10 -0
- package/src/modules/kb-fs/__tests__/repo-path.test.ts +123 -0
- package/src/modules/kb-fs/branch-name.ts +14 -1
- package/src/modules/kb-fs/repo-path.ts +85 -0
- package/src/modules/kb-sync/__tests__/kb-sync.routes.test.ts +26 -1
- package/src/modules/kb-sync/kb-sync.routes.ts +14 -4
- package/src/modules/kb-sync/sync-auth.ts +2 -2
- package/src/modules/mcp/__tests__/mcp-auth.middleware.test.ts +60 -3
- package/src/modules/mcp/__tests__/mcp.service.test.ts +68 -6
- package/src/modules/mcp/mcp-auth.middleware.ts +20 -6
- package/src/modules/mcp/oauth/bevel-oauth-provider.ts +3 -1
- package/src/modules/plugins/__tests__/plugins.tools.test.ts +2 -1
- package/src/modules/settings/__tests__/deployment-settings.service.test.ts +16 -0
- package/src/modules/settings/__tests__/setup.routes.git-mode.test.ts +91 -58
- package/src/modules/settings/__tests__/setup.routes.github-app.test.ts +25 -8
- package/src/modules/settings/__tests__/setup.routes.managed-phase.test.ts +14 -11
- package/src/modules/settings/__tests__/setup.routes.repository-change.test.ts +390 -0
- package/src/modules/settings/__tests__/setup.routes.test.ts +3 -0
- package/src/modules/settings/deployment-settings.service.ts +8 -3
- package/src/modules/settings/setup.routes.ts +263 -19
- package/src/modules/skills/__tests__/allowed-tools-warn.tools.test.ts +2 -1
- package/src/modules/skills/__tests__/branch-skills.tools.test.ts +218 -0
- package/src/modules/skills/__tests__/skills.service.test.ts +229 -5
- package/src/modules/skills/skills.contract.ts +91 -18
- package/src/modules/skills/skills.service.ts +278 -41
- package/src/modules/skills/skills.tools.ts +80 -8
- package/src/modules/tool-auth/__tests__/manual-auth.middleware.test.ts +14 -1
- package/src/modules/tool-auth/external-api-key.service.ts +4 -2
- package/src/modules/tool-auth/internal-token.service.ts +3 -3
- package/src/modules/tool-auth/tool-auth.middleware.ts +34 -11
- package/src/modules/tool-helpers/__tests__/agent-roles-write.test.ts +5 -3
- package/src/modules/tool-helpers/__tests__/phase4-tools.test.ts +3 -3
- package/src/modules/tool-helpers/__tests__/validate-token.test.ts +11 -1
- package/src/modules/tool-helpers/tool-handler.ts +24 -4
- package/src/modules/tool-helpers/tool.contract.ts +3 -2
- package/src/modules/tool-helpers/validate-token.ts +1 -1
- package/src/modules/workflow/__tests__/pending-commits.repository-replaced.test.ts +111 -0
- package/src/modules/workflow/__tests__/workflow.routes.history-read-gate.test.ts +25 -0
- package/src/modules/workflow/__tests__/workflow.service.repository-replaced.test.ts +249 -0
- package/src/modules/workflow/agent-tools/__tests__/workflow.tools.test.ts +264 -6
- package/src/modules/workflow/agent-tools/change-request-summary.ts +182 -0
- package/src/modules/workflow/agent-tools/workflow.tools.ts +86 -35
- package/src/modules/workflow/file-lock.service.ts +31 -0
- package/src/modules/workflow/git/__tests__/git.service.fileBytesAtCommit.test.ts +260 -0
- package/src/modules/workflow/git/git.service.ts +168 -0
- package/src/modules/workflow/pending-commits.service.ts +59 -1
- package/src/modules/workflow/workflow-hooks.ts +64 -26
- package/src/modules/workflow/workflow.service.ts +121 -4
- package/src/modules/workspace/__tests__/agent-access.gate.test.ts +208 -0
- package/src/modules/workspace/__tests__/escape-sequences.routes.test.ts +384 -0
- package/src/modules/workspace/__tests__/file-stat-access.test.ts +2 -1
- package/src/modules/workspace/__tests__/git-internals.security.test.ts +2 -1
- package/src/modules/workspace/__tests__/set-aside-clone.test.ts +52 -0
- package/src/modules/workspace/__tests__/workspace.routes.at-ref.test.ts +305 -0
- package/src/modules/workspace/__tests__/workspace.routes.download.test.ts +2 -0
- package/src/modules/workspace/__tests__/workspace.service.forget-clone-races.test.ts +147 -0
- package/src/modules/workspace/__tests__/workspace.service.replaced-repository.test.ts +326 -0
- package/src/modules/workspace/__tests__/workspace.service.test.ts +20 -9
- package/src/modules/workspace/__tests__/workspace.tools.agents-file.test.ts +2 -3
- package/src/modules/workspace/__tests__/workspace.tools.branch-errors.test.ts +2 -3
- package/src/modules/workspace/__tests__/workspace.tools.test.ts +685 -14
- package/src/modules/workspace/agent-access.gate.ts +164 -0
- package/src/modules/workspace/routine-write-policy.ts +5 -6
- package/src/modules/workspace/session-sink.ts +5 -5
- package/src/modules/workspace/set-aside-clone.ts +96 -0
- package/src/modules/workspace/startup/__tests__/kb-startup-runner.test.ts +86 -0
- package/src/modules/workspace/startup/kb-startup-runner.ts +115 -34
- package/src/modules/workspace/workspace.routes.ts +95 -3
- package/src/modules/workspace/workspace.service.ts +256 -24
- package/src/modules/workspace/workspace.tools.ts +338 -119
- package/src/modules/write-access/__tests__/write-access.test.ts +248 -0
- package/src/modules/write-access/write-access.ts +153 -0
- package/src/shared/domain-errors.ts +31 -0
- package/src/shared/git.contract.ts +27 -0
- package/src/tenancy/__tests__/static-tenant-source.test.ts +0 -1
- package/src/tenancy/static-tenant-source.ts +0 -3
- package/dist/modules/workflow/session-ontology.policy.d.ts +0 -52
- package/dist/modules/workflow/session-ontology.policy.d.ts.map +0 -1
- package/dist/modules/workflow/session-ontology.policy.js +0 -62
- package/dist/modules/workflow/session-ontology.policy.js.map +0 -1
- package/dist/modules/workflow/session-ontology.service.d.ts +0 -105
- package/dist/modules/workflow/session-ontology.service.d.ts.map +0 -1
- package/dist/modules/workflow/session-ontology.service.js +0 -147
- package/dist/modules/workflow/session-ontology.service.js.map +0 -1
- package/dist/modules/workspace/session-ontology.gate.d.ts +0 -114
- package/dist/modules/workspace/session-ontology.gate.d.ts.map +0 -1
- package/dist/modules/workspace/session-ontology.gate.js +0 -161
- package/dist/modules/workspace/session-ontology.gate.js.map +0 -1
- package/dist/shared/kb-layout.d.ts +0 -39
- package/dist/shared/kb-layout.d.ts.map +0 -1
- package/dist/shared/kb-layout.js +0 -103
- package/dist/shared/kb-layout.js.map +0 -1
- package/dist/shared/kb-layout.test.d.ts +0 -2
- package/dist/shared/kb-layout.test.d.ts.map +0 -1
- package/dist/shared/kb-layout.test.js +0 -75
- package/dist/shared/kb-layout.test.js.map +0 -1
- package/src/modules/workflow/__tests__/session-ontology.policy.test.ts +0 -62
- package/src/modules/workflow/__tests__/session-ontology.service.test.ts +0 -201
- package/src/modules/workflow/session-ontology.policy.ts +0 -70
- package/src/modules/workflow/session-ontology.service.ts +0 -183
- package/src/modules/workspace/__tests__/session-ontology.gate.test.ts +0 -239
- package/src/modules/workspace/session-ontology.gate.ts +0 -191
- package/src/shared/kb-layout.test.ts +0 -98
- package/src/shared/kb-layout.ts +0 -102
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Agent access gate — the per-call seam every gated agent tool runs through.
|
|
3
|
+
*
|
|
4
|
+
* It decides nothing of its own. It calls the hooks a DEPLOYMENT registered
|
|
5
|
+
* (`WorkflowHooks`): one before an agent read of a knowledge-base path, one
|
|
6
|
+
* before an agent write. A hook that throws refuses the operation and the
|
|
7
|
+
* caller sees that hook's own message and status. With no hook registered —
|
|
8
|
+
* every core-only deployment — nothing is refused and nothing is recorded, and
|
|
9
|
+
* a call that carries no `sessionId` is an ordinary call.
|
|
10
|
+
*
|
|
11
|
+
* The gate owns exactly two skips, and they are the ones core can decide on
|
|
12
|
+
* its own identity model: the caller is not an agent (a person in the app, a
|
|
13
|
+
* browser JWT), or the caller is the recovery/merge bot. Everything else —
|
|
14
|
+
* which paths matter, whether a session id is required, what the refusal says
|
|
15
|
+
* — belongs to the hook.
|
|
16
|
+
*
|
|
17
|
+
* Lives beside `assertCanRead` in the workspace tools; it does NOT touch
|
|
18
|
+
* `acquireLock` (that gate is protected-branch-only, and this one applies on
|
|
19
|
+
* all branches and to reads).
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
import type { JsonSchema } from '../tool-registry/tool.contract.js';
|
|
23
|
+
import type { ToolContext } from '../tool-helpers/tool.contract.js';
|
|
24
|
+
import type { WorkflowHooks } from '../workflow/workflow-hooks.js';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* What the `sessionId` input says on its own, before any deployment note. The
|
|
28
|
+
* id is the CONVERSATION's id: the in-process agent supplies its thread id
|
|
29
|
+
* automatically (via its per-run internal token), and an external agent mints
|
|
30
|
+
* one with `start_session` and passes it explicitly, because the MCP proxy is
|
|
31
|
+
* a pure passthrough and never injects args. The same id is the one `ask`
|
|
32
|
+
* takes, so a run's reads and its questions share one conversation.
|
|
33
|
+
*/
|
|
34
|
+
export const SESSION_ID_DESCRIPTION =
|
|
35
|
+
"This conversation's id, so the server can tell one run's calls apart. External agents (direct MCP calls and `call_tool_chain` alike): call the `start_session` tool ONCE at the very start of your work to obtain it, then pass that id here — the same id `ask` takes. The in-process agent runtime supplies this automatically (do not set it yourself).";
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* The `sessionId` input every gated tool declares. The description a MOUNTED
|
|
39
|
+
* tool ends up advertising is {@link ToolDescriptionNotes.sessionIdDescription},
|
|
40
|
+
* which appends whatever note the deployment registered; this constant is the
|
|
41
|
+
* unadorned default the notes are applied on top of.
|
|
42
|
+
*/
|
|
43
|
+
export const SESSION_ID_INPUT: JsonSchema = {
|
|
44
|
+
type: 'string',
|
|
45
|
+
description: SESSION_ID_DESCRIPTION,
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* The registration point for the wording a DEPLOYMENT wants agents to read
|
|
50
|
+
* about the gated tools — the counterpart of the hooks, which carry its rule.
|
|
51
|
+
* A deployment that refuses some calls can say so here; core registers
|
|
52
|
+
* nothing, so a core-only deployment advertises the plain descriptions.
|
|
53
|
+
*
|
|
54
|
+
* Registration may land AFTER the tools are mounted (an overlay registers from
|
|
55
|
+
* the tool-surface hook), so mounted tools subscribe with {@link onChange} and
|
|
56
|
+
* rewrite their own description and `sessionId` input when a note arrives.
|
|
57
|
+
*/
|
|
58
|
+
export class ToolDescriptionNotes {
|
|
59
|
+
private gatedTool = '';
|
|
60
|
+
private sessionId = '';
|
|
61
|
+
private readonly listeners = new Set<() => void>();
|
|
62
|
+
|
|
63
|
+
/** Append `note` to the description of every gated tool. */
|
|
64
|
+
registerGatedToolNote(note: string): void {
|
|
65
|
+
this.gatedTool = note;
|
|
66
|
+
this.announce();
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** Append `note` to the description of the `sessionId` input. */
|
|
70
|
+
registerSessionIdNote(note: string): void {
|
|
71
|
+
this.sessionId = note;
|
|
72
|
+
this.announce();
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
/** The registered gated-tool note, `''` when none is registered. */
|
|
76
|
+
gatedToolNote(): string {
|
|
77
|
+
return this.gatedTool;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/** The `sessionId` input's description, with any registered note appended. */
|
|
81
|
+
sessionIdDescription(): string {
|
|
82
|
+
return SESSION_ID_DESCRIPTION + this.sessionId;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** Re-run `listener` whenever a note is registered (mounted tools re-describe). */
|
|
86
|
+
onChange(listener: () => void): void {
|
|
87
|
+
this.listeners.add(listener);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
private announce(): void {
|
|
91
|
+
for (const listener of this.listeners) listener();
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
/** The per-deployment configuration the gate needs, built once in the composition root. */
|
|
96
|
+
export interface AgentAccessGate {
|
|
97
|
+
/** Lowercased email of the recovery/merge bot, which never reaches the hooks. */
|
|
98
|
+
recoveryBotEmail: string;
|
|
99
|
+
/**
|
|
100
|
+
* The workflow lifecycle-hook registry holding the BLOCKING `agentRead` and
|
|
101
|
+
* `preWrite` hooks. Core registers none; a deployment registers against
|
|
102
|
+
* `workflowService.hooks` — pass that same instance here.
|
|
103
|
+
*/
|
|
104
|
+
hooks: WorkflowHooks;
|
|
105
|
+
/** The notes a deployment adds to what agents read about these tools. */
|
|
106
|
+
notes: ToolDescriptionNotes;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/** Only agent callers are gated; `session` (browser JWT) and humans are not. */
|
|
110
|
+
function agentSourceOf(ctx: ToolContext): 'internal' | 'external' | null {
|
|
111
|
+
return ctx.source === 'internal' || ctx.source === 'external' ? ctx.source : null;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* The hook context for this call, or `null` when the call never reaches a hook:
|
|
116
|
+
* the caller is a person rather than an agent, or is the recovery/merge bot,
|
|
117
|
+
* which legitimately spans everything.
|
|
118
|
+
*/
|
|
119
|
+
function operationContext(
|
|
120
|
+
gate: AgentAccessGate,
|
|
121
|
+
ctx: ToolContext,
|
|
122
|
+
branch: string,
|
|
123
|
+
wsPath?: string,
|
|
124
|
+
): { sessionId?: string; wsPath?: string; branch: string; user: ToolContext['user']; source: 'internal' | 'external' } | null {
|
|
125
|
+
const source = agentSourceOf(ctx);
|
|
126
|
+
if (source === null) return null;
|
|
127
|
+
if (ctx.user.email.toLowerCase() === gate.recoveryBotEmail) return null;
|
|
128
|
+
return { sessionId: ctx.sessionId, wsPath, branch, user: ctx.user, source };
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Tell the registered read hooks about an agent read of `wsPath`. A hook that
|
|
133
|
+
* throws refuses the read with its own message and status; with none
|
|
134
|
+
* registered this is a no-op.
|
|
135
|
+
*/
|
|
136
|
+
export async function notifyAgentRead(
|
|
137
|
+
gate: AgentAccessGate,
|
|
138
|
+
ctx: ToolContext,
|
|
139
|
+
branch: string,
|
|
140
|
+
wsPath: string,
|
|
141
|
+
): Promise<void> {
|
|
142
|
+
const op = operationContext(gate, ctx, branch, wsPath);
|
|
143
|
+
if (op === null) return;
|
|
144
|
+
await gate.hooks.runAgentRead(op);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* Ask the registered write hooks whether an agent write may proceed. A hook
|
|
149
|
+
* that throws refuses it with its own message and status; with none registered
|
|
150
|
+
* this is a no-op.
|
|
151
|
+
*
|
|
152
|
+
* `wsPath` is omitted by the one write-capable tool with no resolvable target,
|
|
153
|
+
* `execute_command` — the hook then decides at the coarser session level.
|
|
154
|
+
*/
|
|
155
|
+
export async function assertAgentWriteAllowed(
|
|
156
|
+
gate: AgentAccessGate,
|
|
157
|
+
ctx: ToolContext,
|
|
158
|
+
branch: string,
|
|
159
|
+
wsPath?: string,
|
|
160
|
+
): Promise<void> {
|
|
161
|
+
const op = operationContext(gate, ctx, branch, wsPath);
|
|
162
|
+
if (op === null) return;
|
|
163
|
+
await gate.hooks.runPreWrite(op);
|
|
164
|
+
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Per-run write restriction for background/routine agents.
|
|
3
3
|
*
|
|
4
|
-
* The
|
|
5
|
-
*
|
|
6
|
-
* run may write, by extension. It exists for the `watchlist_check` routine, which is
|
|
4
|
+
* The agent-access gate ({@link ./agent-access.gate}) lets a deployment decide
|
|
5
|
+
* WHETHER a run may write a path at all; this narrower gate bounds WHAT KIND of
|
|
6
|
+
* file a run may write, by extension. It exists for the `watchlist_check` routine, which is
|
|
7
7
|
* allowed to refresh dashboard views (`.html`) but must never touch the
|
|
8
8
|
* knowledge-graph nodes (`.md`) or any other file — a hard, code-level guarantee
|
|
9
9
|
* rather than a prompt request (a prompt-only rule has already proven insufficient).
|
|
@@ -11,9 +11,8 @@
|
|
|
11
11
|
* Keyed by the agent run's `sessionId` (the background agent passes its run id as
|
|
12
12
|
* the session id, which the internal token then carries onto every loopback tool
|
|
13
13
|
* call as `ctx.sessionId`). A restriction lives only for the duration of one
|
|
14
|
-
* in-process run, so the store is a plain in-memory map — no durability needed
|
|
15
|
-
*
|
|
16
|
-
* proxy. The executor sets the restriction before streaming and clears it after.
|
|
14
|
+
* in-process run, so the store is a plain in-memory map — no durability needed.
|
|
15
|
+
* The executor sets the restriction before streaming and clears it after.
|
|
17
16
|
*/
|
|
18
17
|
|
|
19
18
|
import { ToolError } from '../tool-helpers/tool.contract.js';
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { randomUUID } from 'node:crypto';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Port behind `start_session` (workspace.tools.ts): mints the
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Port behind `start_session` (workspace.tools.ts): mints the id an external
|
|
5
|
+
* agent names its conversation with. The workspace module owns the port; WHAT
|
|
6
|
+
* backs the id is the composition root's choice:
|
|
7
7
|
*
|
|
8
|
-
* - Core default ({@link UuidSessionSink}): a bare random id —
|
|
9
|
-
*
|
|
8
|
+
* - Core default ({@link UuidSessionSink}): a bare random id — all the
|
|
9
|
+
* agent-access hooks need, with no app-side session record.
|
|
10
10
|
* - The enterprise app substitutes a sink that mints a REAL chat thread, so the
|
|
11
11
|
* same id also works end to end with `ask` (its sessionId IS a chat thread).
|
|
12
12
|
* See the `start_session` comment in workspace.tools.ts for why that
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { promises as fs } from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Moving a working copy of a repository that is no longer the configured one
|
|
6
|
+
* OUT OF THE WAY, rather than deleting it.
|
|
7
|
+
*
|
|
8
|
+
* Two places find such a clone: the KB startup phase, sweeping the whole
|
|
9
|
+
* workspaces root at boot and on the save that changes the address, and the
|
|
10
|
+
* workspace service, refusing to adopt one it finds on disk. Both must do the
|
|
11
|
+
* same thing with it, because what is in it is the same thing: commits that
|
|
12
|
+
* may exist nowhere else. A clone fetches and pushes through the address in
|
|
13
|
+
* its own `remote.origin.url`, and two repositories need not share a commit,
|
|
14
|
+
* so such a clone cannot be re-pointed — but that is a reason not to USE it,
|
|
15
|
+
* never a reason to destroy it.
|
|
16
|
+
*/
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Where working copies are set aside. NOT under the workspaces root: the
|
|
20
|
+
* workspace service's orphan sweep removes every folder there that is not a
|
|
21
|
+
* known branch's, and what is set aside has to outlive that sweep.
|
|
22
|
+
*
|
|
23
|
+
* PASS THE OVERRIDE, and pass BOTH CALLERS THE SAME ONE. The fallback is a
|
|
24
|
+
* sibling of the workspaces root, which is a lasting place only when that
|
|
25
|
+
* parent is itself a mounted volume — in the shipped compose file it is the
|
|
26
|
+
* container's own filesystem, so a copy left there is gone at the next
|
|
27
|
+
* recreate, having been kept on the promise that it would not be. The
|
|
28
|
+
* composition root therefore roots both the startup phase and the workspace
|
|
29
|
+
* service at one directory under the backups volume; the fallback is for a
|
|
30
|
+
* test, or a caller with no deployment layout to speak of.
|
|
31
|
+
*/
|
|
32
|
+
export function setAsideRootFor(workspacesRoot: string, override?: string): string {
|
|
33
|
+
return override ?? path.resolve(workspacesRoot, '..', 'replaced-working-copies');
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* One folder per occasion, so what was set aside together stays together and
|
|
38
|
+
* two replacements never land in each other's folder.
|
|
39
|
+
*/
|
|
40
|
+
export function setAsideStamp(at: Date = new Date()): string {
|
|
41
|
+
return at.toISOString().replace(/[:.]/g, '-');
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Move the clone at `repoDir` to `dest`. A rename when it can be one; a copy
|
|
46
|
+
* when it cannot (another volume, a handle held open on it), and only then is
|
|
47
|
+
* the original removed — so a copy that fails leaves the clone exactly where
|
|
48
|
+
* it was rather than half of it in each place.
|
|
49
|
+
*
|
|
50
|
+
* Throws with what to do about it. The caller decides how much that costs:
|
|
51
|
+
* the startup phase stops the boot (leaving the clone would fail a step later
|
|
52
|
+
* with git's words about a repository nobody configured), while a single
|
|
53
|
+
* branch open refuses that branch.
|
|
54
|
+
*/
|
|
55
|
+
export async function setAsideClone(repoDir: string, dest: string): Promise<void> {
|
|
56
|
+
// A destination that is already there is somebody's set-aside work, and
|
|
57
|
+
// never this call's to touch: the copy below cleans up after itself by
|
|
58
|
+
// removing the destination, which must then be one this call made.
|
|
59
|
+
const taken = (): Error =>
|
|
60
|
+
new Error(
|
|
61
|
+
`Could not set aside the working copy at ${repoDir}: ${dest} already holds one. Nothing was deleted or ` +
|
|
62
|
+
'moved. Try again; the folder is named for the moment it is made.',
|
|
63
|
+
);
|
|
64
|
+
if (await fs.access(dest).then(() => true, () => false)) throw taken();
|
|
65
|
+
await fs.mkdir(path.dirname(dest), { recursive: true });
|
|
66
|
+
try {
|
|
67
|
+
await fs.rename(repoDir, dest);
|
|
68
|
+
return;
|
|
69
|
+
} catch {
|
|
70
|
+
// Another volume, or a handle held open on it: copy instead.
|
|
71
|
+
}
|
|
72
|
+
// The destination is MADE here, by the one call that will fill it. Two
|
|
73
|
+
// calls that both found it absent above cannot both make it: the second
|
|
74
|
+
// is refused by the filesystem, before the cleanup below could ever be
|
|
75
|
+
// about a folder it did not create.
|
|
76
|
+
try {
|
|
77
|
+
await fs.mkdir(dest);
|
|
78
|
+
} catch (err) {
|
|
79
|
+
if ((err as NodeJS.ErrnoException).code === 'EEXIST') throw taken();
|
|
80
|
+
throw err;
|
|
81
|
+
}
|
|
82
|
+
try {
|
|
83
|
+
// Into the empty folder made above, which is why an existing destination
|
|
84
|
+
// is not an error here; nothing is overwritten (`force: false`).
|
|
85
|
+
await fs.cp(repoDir, dest, { recursive: true, errorOnExist: false, force: false, verbatimSymlinks: true });
|
|
86
|
+
} catch (err) {
|
|
87
|
+
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
|
|
88
|
+
throw new Error(
|
|
89
|
+
`Could not set aside the working copy at ${repoDir}, a clone of a repository that is no longer the ` +
|
|
90
|
+
`configured one, into ${dest}: ${err instanceof Error ? err.message : String(err)}. Nothing was deleted. ` +
|
|
91
|
+
'Make room there, or move that folder away by hand, and start again.',
|
|
92
|
+
{ cause: err },
|
|
93
|
+
);
|
|
94
|
+
}
|
|
95
|
+
await fs.rm(repoDir, { recursive: true, force: true });
|
|
96
|
+
}
|
|
@@ -302,6 +302,92 @@ describe('KbStartupRunner — the repository was replaced', () => {
|
|
|
302
302
|
expect((await git(repo, ['rev-parse', 'HEAD'])).trim()).toBe(head);
|
|
303
303
|
});
|
|
304
304
|
|
|
305
|
+
it('tells the workspace layer about every working copy it deletes', async () => {
|
|
306
|
+
// On a SAVE the process is already running, and the workspace service
|
|
307
|
+
// caches branch→directory. A clone that was set aside, left in that cache,
|
|
308
|
+
// is a path to nothing, and nothing would ever re-clone it.
|
|
309
|
+
await bootedOnTheOldRepository();
|
|
310
|
+
const replacement = await replacementUpstream();
|
|
311
|
+
const discarded: string[] = [];
|
|
312
|
+
|
|
313
|
+
await makeRunner([touchDefault], {
|
|
314
|
+
kbRepoUrl: () => replacement,
|
|
315
|
+
onCloneDiscarded: (id: string) => discarded.push(id),
|
|
316
|
+
}).runAll();
|
|
317
|
+
|
|
318
|
+
expect(discarded.sort()).toEqual(
|
|
319
|
+
[encodeURIComponent(DEFAULT_BRANCH), encodeURIComponent('someone/draft')].sort(),
|
|
320
|
+
);
|
|
321
|
+
});
|
|
322
|
+
|
|
323
|
+
/**
|
|
324
|
+
* Holding back the queue of a working copy is a precondition of setting it
|
|
325
|
+
* aside. A phase that carried on past a failure there would clone the
|
|
326
|
+
* replacement over an untouched queue, and the worker would commit those
|
|
327
|
+
* bytes into a repository they were never meant for.
|
|
328
|
+
*/
|
|
329
|
+
it('stops, with the working copy still in place, when its queue cannot be held back first', async () => {
|
|
330
|
+
await bootedOnTheOldRepository();
|
|
331
|
+
const replacement = await replacementUpstream();
|
|
332
|
+
const before = (await git(cloneDir(DEFAULT_BRANCH), ['config', '--get', 'remote.origin.url'])).trim();
|
|
333
|
+
const discarded: string[] = [];
|
|
334
|
+
|
|
335
|
+
await expect(
|
|
336
|
+
makeRunner([touchDefault], {
|
|
337
|
+
kbRepoUrl: () => replacement,
|
|
338
|
+
beforeCloneSetAside: async () => {
|
|
339
|
+
throw new Error('pending_commits is down');
|
|
340
|
+
},
|
|
341
|
+
onCloneDiscarded: (id: string) => discarded.push(id),
|
|
342
|
+
}).runAll(),
|
|
343
|
+
).rejects.toThrow(/pending_commits is down/);
|
|
344
|
+
|
|
345
|
+
// Nothing moved: the next run finds the same copy and asks again.
|
|
346
|
+
expect((await git(cloneDir(DEFAULT_BRANCH), ['config', '--get', 'remote.origin.url'])).trim()).toBe(before);
|
|
347
|
+
expect(discarded).toEqual([]);
|
|
348
|
+
});
|
|
349
|
+
|
|
350
|
+
it('holds back the queue of each working copy before it sets that copy aside', async () => {
|
|
351
|
+
await bootedOnTheOldRepository();
|
|
352
|
+
const replacement = await replacementUpstream();
|
|
353
|
+
const order: string[] = [];
|
|
354
|
+
|
|
355
|
+
await makeRunner([touchDefault], {
|
|
356
|
+
kbRepoUrl: () => replacement,
|
|
357
|
+
beforeCloneSetAside: async (id: string) => void order.push(`queue ${id}`),
|
|
358
|
+
onCloneDiscarded: (id: string) => void order.push(`aside ${id}`),
|
|
359
|
+
}).runAll();
|
|
360
|
+
|
|
361
|
+
const main = encodeURIComponent(DEFAULT_BRANCH);
|
|
362
|
+
expect(order.indexOf(`queue ${main}`)).toBeGreaterThanOrEqual(0);
|
|
363
|
+
expect(order.indexOf(`queue ${main}`)).toBeLessThan(order.indexOf(`aside ${main}`));
|
|
364
|
+
});
|
|
365
|
+
|
|
366
|
+
it('tells the git layer that each working copy it cloned is freshly fetched', async () => {
|
|
367
|
+
// A clone holds every ref, so it IS a successful fetch. Unsaid, the git
|
|
368
|
+
// layer keeps the per-workspace record that drove the replacement — a
|
|
369
|
+
// FAILED fetch of the repository that is gone — and a strict branch
|
|
370
|
+
// listing inside its TTL refuses the new clone's refs as unproven.
|
|
371
|
+
await bootedOnTheOldRepository();
|
|
372
|
+
const replacement = await replacementUpstream();
|
|
373
|
+
const announced: string[] = [];
|
|
374
|
+
|
|
375
|
+
await makeRunner([touchDefault], {
|
|
376
|
+
kbRepoUrl: () => replacement,
|
|
377
|
+
onCloneCreated: (id: string) => announced.push(id),
|
|
378
|
+
}).runAll();
|
|
379
|
+
|
|
380
|
+
// Every working copy the phase made in place of one it set aside.
|
|
381
|
+
expect(announced).toContain(encodeURIComponent(DEFAULT_BRANCH));
|
|
382
|
+
});
|
|
383
|
+
|
|
384
|
+
it('says nothing about a working copy it keeps', async () => {
|
|
385
|
+
await bootedOnTheOldRepository();
|
|
386
|
+
const discarded: string[] = [];
|
|
387
|
+
await makeRunner([touchDefault], { onCloneDiscarded: (id: string) => discarded.push(id) }).runAll();
|
|
388
|
+
expect(discarded).toEqual([]);
|
|
389
|
+
});
|
|
390
|
+
|
|
305
391
|
it('keeps every clone when the configured repository cannot be reached', async () => {
|
|
306
392
|
// A typo in the address must not cost the working copies: the sweep runs
|
|
307
393
|
// only once the configured remote has answered.
|
|
@@ -16,9 +16,11 @@ import {
|
|
|
16
16
|
failureOf,
|
|
17
17
|
gitFailure,
|
|
18
18
|
type GitFailure,
|
|
19
|
+
type GitFailureKind,
|
|
19
20
|
} from '../../../shared/git-failure.js';
|
|
20
21
|
import { redactSecret, urlQuerySecrets } from '../../../shared/redact-secret.js';
|
|
21
22
|
import { normalizeRepositoryAddress, sameRepository } from '../../kb-fs/remote-url.js';
|
|
23
|
+
import { setAsideClone, setAsideRootFor, setAsideStamp } from '../set-aside-clone.js';
|
|
22
24
|
|
|
23
25
|
/**
|
|
24
26
|
* The KB startup phase: run every registered {@link OnServerStart} step, in
|
|
@@ -29,7 +31,9 @@ import { normalizeRepositoryAddress, sameRepository } from '../../kb-fs/remote-u
|
|
|
29
31
|
*
|
|
30
32
|
* Fully fail-closed: any failure this phase cannot DECLARE (an unhandled
|
|
31
33
|
* step throw, an unreachable remote, a clone that will not come down, a
|
|
32
|
-
* refused write) throws out of `runAll
|
|
34
|
+
* refused write) throws out of `runAll`. The boot stops on it unless the
|
|
35
|
+
* host ANSWERED about the repository or the credentials, in which case it
|
|
36
|
+
* comes up gated instead — see `bootMaySurvive`. The container's
|
|
33
37
|
* restart policy is the retry — each attempt at boot time on quiet trees —
|
|
34
38
|
* so an environmental failure converges without a human the moment the
|
|
35
39
|
* environment returns. The one carve-out: a push rejected because a
|
|
@@ -53,13 +57,12 @@ export interface KbStartupRunnerOptions {
|
|
|
53
57
|
kbRepoUrl: () => string;
|
|
54
58
|
workspacesRoot: string;
|
|
55
59
|
/**
|
|
56
|
-
* Where a working copy of a repository that is no longer the configured
|
|
57
|
-
*
|
|
58
|
-
* `reconcileClonesWithConfiguredRepository`.
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
* persistent volume of its own. Default: a sibling of `workspacesRoot`.
|
|
60
|
+
* Where a working copy of a repository that is no longer the configured one
|
|
61
|
+
* is moved to, under a folder named for the moment it happened — see
|
|
62
|
+
* `reconcileClonesWithConfiguredRepository`. THE SAME VALUE THE WORKSPACE
|
|
63
|
+
* SERVICE IS GIVEN.
|
|
64
|
+
*
|
|
65
|
+
* Why, in one place: `setAsideRootFor` in `set-aside-clone.ts`.
|
|
63
66
|
*/
|
|
64
67
|
setAsideRoot?: string;
|
|
65
68
|
kbDirName: string;
|
|
@@ -78,6 +81,47 @@ export interface KbStartupRunnerOptions {
|
|
|
78
81
|
template `.gitignore` rule can never silently drop a required seed file
|
|
79
82
|
from the commit. */
|
|
80
83
|
buildSeedTree: (dir: string) => Promise<string[]>;
|
|
84
|
+
/**
|
|
85
|
+
* Called with the workspace id of each working copy the phase is ABOUT TO
|
|
86
|
+
* set aside for being a clone of another repository, and awaited first.
|
|
87
|
+
* Whatever is still queued to be committed into that copy was written
|
|
88
|
+
* against the repository that was left, so it must be held back before a
|
|
89
|
+
* fresh clone of another repository appears at the same path.
|
|
90
|
+
*
|
|
91
|
+
* A PRECONDITION, so a failure here STOPS THE PHASE with the copy still
|
|
92
|
+
* where it was. Carrying on would clone the replacement with the queue
|
|
93
|
+
* untouched, and the worker would then commit those bytes into a
|
|
94
|
+
* repository they were never meant for. Stopped before anything moved, the
|
|
95
|
+
* next run finds the same copy and asks again. Optional: a minimal graph
|
|
96
|
+
* has no queue.
|
|
97
|
+
*/
|
|
98
|
+
beforeCloneSetAside?: (workspaceId: string) => Promise<void>;
|
|
99
|
+
/**
|
|
100
|
+
* Called with the workspace id of each working copy the phase SET ASIDE for
|
|
101
|
+
* being a clone of another repository. The workspace service keeps a
|
|
102
|
+
* branch→directory cache and adopts whatever is on disk, so on a RUNNING
|
|
103
|
+
* server (the save that moves the deployment to another repository) the
|
|
104
|
+
* copy would otherwise stay in that cache as a path to nothing. Optional:
|
|
105
|
+
* at boot nothing has been cached yet.
|
|
106
|
+
*
|
|
107
|
+
* Never throws into the phase: a listener that fails must not stop a boot.
|
|
108
|
+
*/
|
|
109
|
+
onCloneDiscarded?: (workspaceId: string) => void | Promise<void>;
|
|
110
|
+
/**
|
|
111
|
+
* Called with the workspace id of each working copy the phase CLONED fresh.
|
|
112
|
+
* A clone has just downloaded every ref, which is a successful fetch by any
|
|
113
|
+
* measure — but the git layer keeps its own per-workspace record of the last
|
|
114
|
+
* fetch and whether it worked, and the one that drove the replacement is a
|
|
115
|
+
* FAILED fetch of the repository that is gone. Left standing, a strict
|
|
116
|
+
* branch listing inside that record's TTL refuses the new clone's refs as
|
|
117
|
+
* unproven, having never touched it.
|
|
118
|
+
*
|
|
119
|
+
* The ordinary path already says this (`WorkspaceService`'s cloned
|
|
120
|
+
* listener); the phase clones with git directly, so it has to say it itself.
|
|
121
|
+
*
|
|
122
|
+
* Never throws into the phase, for the same reason as above.
|
|
123
|
+
*/
|
|
124
|
+
onCloneCreated?: (workspaceId: string) => void;
|
|
81
125
|
}
|
|
82
126
|
|
|
83
127
|
/**
|
|
@@ -108,6 +152,42 @@ export class KbRemoteUnreachableError extends ClassifiedFailure {
|
|
|
108
152
|
}
|
|
109
153
|
}
|
|
110
154
|
|
|
155
|
+
/**
|
|
156
|
+
* The failure kinds a boot may survive GATED rather than stop on: the remote
|
|
157
|
+
* ANSWERED (or could not be reached at all), and what it said is about the
|
|
158
|
+
* repository or the credentials — not about what this deployment would write.
|
|
159
|
+
*
|
|
160
|
+
* All four are fixed by an operator somewhere other than this process: the
|
|
161
|
+
* host comes back, the repository is created or the token is granted access
|
|
162
|
+
* to it, a rotated token is entered on the setup screen. Refusing to boot
|
|
163
|
+
* over any of them takes away the very screen the fix is entered on — which
|
|
164
|
+
* is what happened on 2026-09-28, when a replaced repository answered
|
|
165
|
+
* `not found` inside a step and the container crash-looped.
|
|
166
|
+
*
|
|
167
|
+
* Every OTHER failure still stops the boot: it means a step or the template
|
|
168
|
+
* would write something wrong, and booting over that is worse than not
|
|
169
|
+
* booting at all.
|
|
170
|
+
*/
|
|
171
|
+
const GATED_BOOT_KINDS: ReadonlySet<GitFailureKind> = new Set([
|
|
172
|
+
'unreachable',
|
|
173
|
+
'not-found',
|
|
174
|
+
'credentials-rejected',
|
|
175
|
+
'write-refused',
|
|
176
|
+
]);
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Whether the boot may come up GATED on this failure instead of stopping.
|
|
180
|
+
*
|
|
181
|
+
* {@link KbRemoteUnreachableError} says so by its type — it is raised where
|
|
182
|
+
* the remote is first contacted, before any step. A failure raised INSIDE the
|
|
183
|
+
* phase says so by its classification: the same fetch that stops a boot when
|
|
184
|
+
* it is the first contact must not stop one when a step happened to make it.
|
|
185
|
+
*/
|
|
186
|
+
export function bootMaySurvive(err: unknown): boolean {
|
|
187
|
+
if (err instanceof KbRemoteUnreachableError) return true;
|
|
188
|
+
return err instanceof ClassifiedFailure && GATED_BOOT_KINDS.has(err.failure.kind);
|
|
189
|
+
}
|
|
190
|
+
|
|
111
191
|
export interface RetryOptions {
|
|
112
192
|
/** First wait before trying again. Default 30s. */
|
|
113
193
|
initialDelayMs?: number;
|
|
@@ -252,7 +332,7 @@ export class KbStartupRunner {
|
|
|
252
332
|
// Stopped by either: a failure that is no longer the remote at all
|
|
253
333
|
// (the knowledge base itself is wrong — asking again will not change
|
|
254
334
|
// it), or a remote answer that a retry cannot change (see above).
|
|
255
|
-
if (!(err
|
|
335
|
+
if (!bootMaySurvive(err) || !worthRetrying()) return stopOnStanding();
|
|
256
336
|
delay = Math.min(delay * 2, max);
|
|
257
337
|
log(`remote still unreachable; trying again in ${Math.round(delay / 1000)}s`);
|
|
258
338
|
}
|
|
@@ -561,9 +641,8 @@ export class KbStartupRunner {
|
|
|
561
641
|
return; // no workspaces yet
|
|
562
642
|
}
|
|
563
643
|
// One folder per run, so what was set aside together stays together.
|
|
564
|
-
const stamp =
|
|
565
|
-
const setAsideRoot =
|
|
566
|
-
this.opts.setAsideRoot ?? path.resolve(this.opts.workspacesRoot, '..', 'replaced-working-copies');
|
|
644
|
+
const stamp = setAsideStamp();
|
|
645
|
+
const setAsideRoot = setAsideRootFor(this.opts.workspacesRoot, this.opts.setAsideRoot);
|
|
567
646
|
for (const entry of entries) {
|
|
568
647
|
if (!entry.isDirectory()) continue;
|
|
569
648
|
const repoDir = path.join(this.opts.workspacesRoot, entry.name, this.opts.kbDirName);
|
|
@@ -587,12 +666,25 @@ export class KbStartupRunner {
|
|
|
587
666
|
continue;
|
|
588
667
|
}
|
|
589
668
|
const kept = path.join(setAsideRoot, stamp, entry.name);
|
|
590
|
-
|
|
669
|
+
// First, and allowed to stop the phase: see `beforeCloneSetAside`. The
|
|
670
|
+
// directory name IS the workspace id (`workspaceIdForBranch`).
|
|
671
|
+
await this.opts.beforeCloneSetAside?.(entry.name);
|
|
672
|
+
await setAsideClone(repoDir, kept);
|
|
591
673
|
startupLog.warn(
|
|
592
674
|
`working copy "${entry.name}" is a clone of another repository (${was}). Set aside at ${kept}; nothing was ` +
|
|
593
675
|
'deleted, and it will be cloned fresh from the configured one. Work that was never pushed is in that ' +
|
|
594
676
|
'folder: `git log` there shows it, and `git push <address> <branch>` from there sends it to a repository.',
|
|
595
677
|
);
|
|
678
|
+
// Setting it aside already removed it from the workspaces root, so the
|
|
679
|
+
// cached handle the workspace service holds for it now points at
|
|
680
|
+
// nothing.
|
|
681
|
+
try {
|
|
682
|
+
await this.opts.onCloneDiscarded?.(entry.name);
|
|
683
|
+
} catch (err) {
|
|
684
|
+
startupLog.warn(`could not finish setting the working copy "${entry.name}" aside:`, {
|
|
685
|
+
detail: this.redact(err instanceof Error ? err.message : String(err)),
|
|
686
|
+
});
|
|
687
|
+
}
|
|
596
688
|
}
|
|
597
689
|
}
|
|
598
690
|
|
|
@@ -638,27 +730,6 @@ export class KbStartupRunner {
|
|
|
638
730
|
* not (the backups root is a volume of its own in the shipped compose
|
|
639
731
|
* files), with the original removed only once the copy is complete.
|
|
640
732
|
*/
|
|
641
|
-
private async setAside(repoDir: string, dest: string): Promise<void> {
|
|
642
|
-
await fs.mkdir(path.dirname(dest), { recursive: true });
|
|
643
|
-
try {
|
|
644
|
-
await fs.rename(repoDir, dest);
|
|
645
|
-
return;
|
|
646
|
-
} catch {
|
|
647
|
-
// Another volume, or a handle held open on it: copy instead.
|
|
648
|
-
}
|
|
649
|
-
try {
|
|
650
|
-
await fs.cp(repoDir, dest, { recursive: true, errorOnExist: true, force: false, verbatimSymlinks: true });
|
|
651
|
-
} catch (err) {
|
|
652
|
-
await fs.rm(dest, { recursive: true, force: true }).catch(() => undefined);
|
|
653
|
-
throw new Error(
|
|
654
|
-
`Could not set aside the working copy at ${repoDir}, a clone of a repository that is no longer the ` +
|
|
655
|
-
`configured one, into ${dest}: ${err instanceof Error ? err.message : String(err)}. Nothing was deleted. ` +
|
|
656
|
-
'Make room there, or move that folder away by hand, and start again.',
|
|
657
|
-
{ cause: err },
|
|
658
|
-
);
|
|
659
|
-
}
|
|
660
|
-
await fs.rm(repoDir, { recursive: true, force: true });
|
|
661
|
-
}
|
|
662
733
|
|
|
663
734
|
/**
|
|
664
735
|
* The branch's working copy at the runtime layout
|
|
@@ -677,6 +748,16 @@ export class KbStartupRunner {
|
|
|
677
748
|
await fs.mkdir(workspaceDir, { recursive: true });
|
|
678
749
|
await fs.rm(repoDir, { recursive: true, force: true });
|
|
679
750
|
await git(this.opts.gitRunner, workspaceDir, ['clone', '-b', branch, this.opts.kbRepoUrl(), repoDir]);
|
|
751
|
+
// Said as soon as the clone is there, before its configuration: if a
|
|
752
|
+
// command below fails, the clone stays on disk, and the retry finds it
|
|
753
|
+
// and never comes back through here.
|
|
754
|
+
try {
|
|
755
|
+
this.opts.onCloneCreated?.(workspaceIdForBranch(branch));
|
|
756
|
+
} catch (err) {
|
|
757
|
+
startupLog.warn(`could not announce the fresh working copy for "${branch}":`, {
|
|
758
|
+
detail: this.redact(err instanceof Error ? err.message : String(err)),
|
|
759
|
+
});
|
|
760
|
+
}
|
|
680
761
|
await git(this.opts.gitRunner, repoDir, ['config', 'core.longpaths', 'true']);
|
|
681
762
|
await stampIdentity(this.opts.gitRunner, repoDir);
|
|
682
763
|
return repoDir;
|