Files
PaperClipAI/server/src/__tests__/heartbeat-project-env.test.ts
T
Nicky LeachandClaude Opus 5.5 11ac90e31f fix(build): typecheck server/src/__tests__ and fix every type error (#18739)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The server has about 1,100 test and helper files in
`server/src/__tests__`
> - `server/tsconfig.json` excludes that directory, Vitest does not
check types, and no script runs the tsconfig in that directory
> - So a test can call a function with the wrong arguments and still
pass, and no tool reports it
> - This gap hid 2,168 real type errors, and some of them hid tests that
did not test what they claim
> - This pull request fixes all of these errors and adds the directory
to the server layers from paperclipai/paperclip#18737
> - The benefit is that a type error in a server test now fails the
typecheck, with no baseline and no backlog

## Linked Issues or Issue Description

Refs paperclipai/paperclip#18737, which is merged and added the server
layers. Refs paperclipai/paperclip#18738, which is merged and checks the
test projects outside `pnpm -r`, so it is not a duplicate. Refs
paperclipai/paperclip#18137, which records that this directory has no
check.

**What happened?**

No tool checked the types of 1,074 of the 1,101 files in
`server/src/__tests__`. I searched `package.json`, the workflows, and
all tsconfig files. 27 files are in the program of another tsconfig, and
these 27 have 0 errors. 11 of the 27 are in
`helpers/maintenance/tsconfig.json`. No script ran that project when I
measured this. paperclipai/paperclip#18738 now runs it.

**Expected behavior**

The server typecheck checks these files, and a type error fails the
check.

**Steps to reproduce**

1. On the base commit, run `tsc -p server/src/__tests__/tsconfig.json
--noEmit`. It reports 6,536 errors and needs 12.3 GiB.
2. Add a type error to any file in `server/src/__tests__`.
3. Run `pnpm --filter @paperclipai/server typecheck`. It passes.

**Paperclip version or commit**

I measured the error breakdown below on commit `8dfd632452`, with
TypeScript 7.0.2. The branch now includes master up to
paperclipai/paperclip#18865.

**Deployment mode**

Not applicable. This issue applies to development and CI. No production
source file in the server changes.

### Error breakdown

Each row adds one change to the row above.

| Step | Total errors | Change | Cause |
| --- | --- | --- | --- |
| Config as committed | 6,536 | | |
| Add `src/types/*.d.ts` | 4,447 | -2,089 | Config. The Express request
types were missing. |
| Set `rootDir` to the repository root | 2,436 | -2,011 | Config. |
| Set `allowImportingTsExtensions` | 2,181 | -255 | Config. Vitest
accepts `.ts` imports. |
| Add `ES2024.Promise` to `lib` | 2,138 | -43 | Config. Node 24 has
`Promise.withResolvers`. |
| Set `allowJs` for `.mjs` imports | 2,148 | +10 | Config. It removes 8
`TS7016` errors and shows new real errors. |
| Set `declaration` to false | 2,142 | -6 | Config. Tests emit nothing.
|
| Count only files in `server/src` | 2,058 | -84 | Other packages: 53
Daytona, 29 Runner test, 2 UI. |

So 4,478 of the 6,536 errors (69%) came from config or scope, and 2,058
are real type errors in 314 files. The 29 Runner test errors are also
real, which gives 2,087 errors. Tests that master added after this
measurement had 81 more errors, so this pull request fixes 2,168 errors.

This table classifies the first 2,058 errors.

| Kind of real error | Errors |
| --- | --- |
| Wrong argument or assignment type | 1,023 |
| Stale or partial fixture objects | 525 |
| Property that the type does not have | 317 |
| Missing narrowing of null or unknown | 101 |
| Implicit any | 60 |
| Missing name or module | 16 |
| Other | 16 |

### What the type errors hid

Most errors were stale fixtures and loose mocks. These errors hid real
test problems, and this pull request fixes them:

- **A test that never ran.** `instrumentation.test.ts` required
`sdk-trace-base`, which is not installed. So 3 span tests were skipped.
They now run and pass.
- **Assertions that could not fail.**
- `issue-thread-interactions-service` used a company ID as an issue ID.
- `status-card-evaluation-work` compared `[]` with `[]` in a rollback
check.
- `slack-conversation-lifecycle` read `item.issueId`, which does not
exist.
  - `email-channels` used a permission key that does not exist.
- `heartbeat-project-env` imported `LOW_TRUST_REVIEW_PRESET`, which is
not exported. The value was undefined.
- **Postgres processes that did not stop.** 11 test files called `stop`
on the test database helper. That method does not exist, and the helper
method is `cleanup`.
- **Arguments that the service ignored.**
- `methodKey` is now `connectionMethodKey` in the Daytona, Unikraft,
1Password, and Railway tests.
- 108 calls passed `"owner-user"` to a parameter that expects an options
object.
- 9 chat wizard fixtures passed `managementContext` as `source`, so they
ran `existing_app` and not `manifest`.
  - 2 tests passed a `{ userId }` actor that the function ignores.
- Inserts into `environments` passed a `companyId` column that the table
does not have.
- **Problems in tests that master added during this work.**
- `sandbox-creation-operations` read `database.connectionString` when an
external test database was set. In that mode `database` is undefined, so
the fixture would stop with a TypeError. It now uses the external URL.
- `idle-completed-history` set a Dot operation to `dispatched`. That is
a Muse status, and the Dot type does not have it. The fixture now uses
`admitted`, which is a real in-flight Dot status.

### Possible product problems, not changed

These may be real problems in production code or types. I did not change
them, because this pull request does not change production behavior:

- `decisions-service` `service.create` does not validate the lenient
`cancel_issue_tree` input.
- `createConnection` ignores `input.connectionPurpose`.
- The `createConnection` route schema default stores `{}` for
`transportConfig`.
- `prepareManagedAiRuntime` accepted the invalid value `mode:
"connection"`.
- `createBinding` accepts invalid `projectionClass` strings outside
class 3.
- `ensureManagedProjectWorkspace` forwards an untyped `repoRef` by
spread.
- `routineVariableSchema.label` is optional, but `RoutineVariable.label`
is required.
- `ToolRunContext.projectId` may be too strict.
- `withdrawInteraction` reads `issue.status`, which its type omits.
- `issueService.list` and `reconcileNativeFinalizations` omit fields
that they return at runtime.
- `createGitHubExternalObjectProvider` handles `tokenProvider: null`,
but its type forbids this value.

## What Changed

- Fixed the 2,168 type errors. The diff changes 322 test and helper
files.
- Corrected `server/src/__tests__/tsconfig.json`. Editors and the
typecheck now read the same options and report the same errors.
- Added three `test-tree` layers to
`server/scripts/typecheck-layers.mjs`. They read the server layers as
declarations, and any error fails them. A hash of the path selects the
shard, so a new file does not move other files.
- Added `server/scripts/typecheck-stubs/daytona-sdk.d.ts`. Server tests
reach Daytona plugin source, and the root install does not have
`@daytonaio/sdk`.
- Changed two imports in `ui/src/lib/issue-execution-policy.ts` to use
`.js` extensions, because server tests import this file.
- Made `declarationsConfig` and `--declarations-only` skip the
`test-tree` layers, because these layers emit nothing. Other projects
read only the source layers. Added a test for this.
- Updated `doc/DEVELOPING.md`.

## Verification

Run these commands:

```sh
pnpm --filter @paperclipai/server typecheck
pnpm exec vitest run server/scripts/typecheck-layers.test.mjs
```

Results on macOS (arm64), Node 24, 16 cores. Each check ran after the
merge of paperclipai/paperclip#18738 unless the row says otherwise:

| Check | Commit | Result |
| --- | --- | --- |
| Server typecheck, `PAPERCLIP_TYPECHECK_LOW_MEMORY=1`, all 7 layers |
`6e45a08573` | Exit 0, 0 errors, 62 seconds, peak 3.52 GiB |
| `node scripts/typecheck-test-projects.mjs --low-memory` | `a3306bd13e`
| Exit 0, 0 errors, 42 seconds, peak 3.25 GiB |
| The same script with `--reuse-declarations` | `1b878aabc0` | Exit 0, 0
errors |
| `typecheck-layers.test.mjs` and `live-recovery-work.test.ts` |
`01db5634e4` | 90 passed. These include real compiler runs for a pass, a
type error, and an invalid tsconfig. |
| `tsconfig.declarations.json` after a full server typecheck |
`0fb1e4fb0a` | It references only `below`, `cycle`, and `above`. No
generated config names a `tsconfig.layers.json` file. |
| Owned runtime test in `idle-completed-history` | `e8f2f448ac` |
Passed, with the fix that master later replaced |
| `idle-incoming-wake`, `plugin-idle-manager`, and the changed
`chat-channels` test | `6e45a08573` | 30 passed |
| Runner `native-execution.test.ts` | `eab4dcc1f4` | 114 passed |
| The 19 server test files that changed since `eab4dcc1f4`, and
`typecheck-layers.test.mjs` | `259737b700` | 4,275 of 4,277 passed. The
2 failures are in `chat-channels` and are in the list of 7 below. |

The peak is the largest single process, from `/usr/bin/time -l`. Peaks
for the server typecheck were between 3.42 GiB and 3.56 GiB across 8
runs. Peaks for the test projects were 3.25 GiB and 3.37 GiB across 2
runs. I did not measure a cgroup.

**Runtime check of the fixes.** Types do not prove that a test still
works. So I ran all 309 changed server test files, 11,929 tests, before
the rebase onto paperclipai/paperclip#18737:

| Result | Tests | Detail |
| --- | --- | --- |
| Passed | 11,913 | Includes the 2 tests and the 54 `dot-runner` tests
that passed in a later run, as described below. |
| Failed | 7 | The same 7 tests also fail on the commit before the
fixes. |
| Skipped | 9 | These tests have their own skip conditions: `sentry` 5,
and 1 each in `bundled-plugin-registration`, `customer-success-cloud`,
`onepassword-connection`, and `workspace-runtime-https-live-exercise`. |

The 7 tests that fail with and without this change, on my machine:

- 3 tests in `chat-channels` and `email-channels` stop with `ENOENT` on
a `SKILL.md` file. The path is in the parent checkout, above the git
worktree that I used, so I expect that the worktree is the cause. I did
not prove this.
- `workspace-instance-cleanup` compares `/private/var/...` with
`/var/...`. This is a macOS symlink difference.
- 2 tests in `git-reproducible-managed-checkouts` get
`unknown_base_git_files` and expect `unpushed_managed_checkout`. I did
not find the cause.
- 1 more test in `chat-channels`, `materializes direct external-chat
finals once`, gets `undefined`. I did not find the cause.

CI is the check for these 7 tests. `ci / verify` passed on `eab4dcc1f4`.

Failures during this work:

- My fix to `agent-runtime-connector-access` changed an invalid
permission key in the setup, but not in the assertion. The runtime check
found this. I corrected the assertion, and the file passes.
- `heartbeat-plugin-environment` failed one wait in the full run. It
passed three times alone, so I think that load caused the failure. It
can fail again under load.
- `dot-runner` skipped all 54 tests in the full run because `cargo` was
not on my `PATH`. It then passed 54 of 54 with the toolchain on the
`PATH`.
- My first `lib` value removed the default DOM types, and the error
count went up by 375. I added the DOM libraries.
- My Daytona stub with bare `any` left 48 errors, because generic
helpers then inferred `unknown`. I added shapes that return promises.
- One fix to `agent-secrets-routes` used `class_3_static_lease`, and the
test failed. That class allows only specific paths. I reverted to
`unclassified`.
- `ci / General tests (server (8/12))` failed on `259737b700` because of
the flaky port in `idle-completed-history`. paperclipai/paperclip#18853
fixed this test on master, so this pull request keeps that fix.

**Audit of the diff.** I counted these patterns in added and removed
lines, to find fixes that only hide an error:

| Pattern | Added | Removed |
| --- | --- | --- |
| `@ts-ignore` | 0 | 0 |
| `@ts-expect-error` | 0 | 1 |
| `.skip` | 0 | 0 |
| `as any` | 9 | 9 |
| `: any` | 11 | 2 |
| `as never` | 8 | 2 |
| `as unknown as` | 35 | 4 |
| `Promise<unknown>` | 16 | 5 |
| `expect(` | 128 | 113 |

No hunk removes more `expect(` calls than it adds. Three removals of
test content were intentional, and I checked each one:

- `muse-control` removed `signalToken`. Line 1012 already asserts that
it is absent.
- `merged-pr-confirmation-sweep` removed legacy aliases. Other tests
cover them.
- `heartbeat-workspace-branch-containment` removed a `finalize` branch
that no test row can reach.

Some partial fixtures stay unchecked through `as unknown as` and
`Promise<unknown>`, mostly in `issue-agent-mutation-ownership-routes`
and `issue-comment-reopen-routes`.

**Accuracy of the check.** One program over the tree and the three
shards reported the same errors at the same positions. Memory, as the
peak of the largest process on one thread, was 3.93 GiB for one program
and 2.43 GiB for the largest shard. I measured these two values before
the fixes.

Not run or not proven:

- I did not run the full `pnpm test:run`, or a root `pnpm build`. I
expect CI to run the full suites.
- I did not run the 4 GiB container check, or the full
`scripts/typecheck-low-memory.mjs`. The peaks above come from macOS, so
they are not a Linux cgroup measurement.
- I did not run the UI typecheck after the merges.
- `workspace-runtime-https-live-exercise` is skipped, so its `cleanup`
fix did not run.

## Risks

- **A large diff in test files.** 328 files change. A pull request that
edits the same tests can get merge conflicts. New tests on master can
also add type errors before this merges. Any such error fails this check
and needs a fix here.
- **A higher cost for changes to source types.** A change to a type can
add errors in test files that the author did not touch. The author must
then fix them. This is the purpose of the check, but it is new work.
- **Changed test behavior.** Some tests now run paths that they did not
run before, such as the 9 chat wizard fixtures and the 3 span tests.
They pass here, but they can be more sensitive to timing or to the
environment.
- **The Daytona stub can go stale.** The stub is written by hand. If the
plugin uses a new SDK member, the typecheck reports an error until
someone updates the stub.
- **The release path.** `release-verify.yml` and `scripts/release.sh`
run `pnpm -r typecheck`, so they now run this check.
- **The tsconfig change.** The test transform reads
`server/src/__tests__/tsconfig.json`. The options that I changed are for
type checks, and the runs above passed.
- **A gap that remains.** Tsconfigs in `packages/paperclip-runner` and
in most sandbox provider plugins exclude `*.test.ts`. This check does
not read most of those test files, so they can still drift. That work is
separate from this pull request.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

Anthropic Claude Opus 5.5 (`claude-opus-5-5`) through Claude Code, with
reasoning, tool use, code execution, and subagents. The runtime does not
show the context window size.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [ ] I have run tests locally and they pass (7 tests fail locally, with
and without this change. See Verification.)
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-03 15:27:38 -08:00

1407 lines
53 KiB
TypeScript

import fs from "node:fs/promises";
import os from "node:os";
import path from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
import { LOW_TRUST_REVIEW_PRESET, buildSkillMentionHref } from "@paperclipai/shared";
import {
applyRunScopedMentionedSkillKeys,
buildReferencedProjectRunObservability,
buildRunWorkspaceHints,
extractMentionedSkillIdsFromSources,
resolveAdditionalProjectWorkspace,
resolveAdditionalRunWorkspaces,
resolveExecutionRunAdapterConfig,
type ResolveAdditionalProjectWorkspaceDeps,
type ResolveAdditionalRunWorkspacesOptions,
type ResolvedAdditionalWorkspace,
type RunReferencedProject,
} from "../services/heartbeat.ts";
import type { AuthorizationActor, AuthorizationDecision } from "../services/authorization.ts";
import { resolveManagedProjectWorkspaceDir } from "../home-paths.ts";
describe("resolveExecutionRunAdapterConfig", () => {
it("strips stored task shell selectors before secret resolution and provider projection", async () => {
const unsafe = {BASH_ENV:"/workspace/hook.sh",ZDOTDIR:"/workspace",GH_CONFIG_DIR:"/workspace/gh",PAPERCLIP_GITHUB_LAUNCHER_DIR:"/workspace/forged"};
const resolveAdapterConfigForRuntime = vi.fn(async (_companyId, config) => ({config,secretKeys:new Set(),manifest:[]}));
const result = await resolveExecutionRunAdapterConfig({companyId:"company-1",adapterType:"paperclip_runner",
executionRunConfig:{env:{...unsafe,CUSTOM_VALUE:"allowed"}},projectEnv:null,
secretsSvc:{resolveAdapterConfigForRuntime} as any});
expect(resolveAdapterConfigForRuntime.mock.calls[0]?.[1]).toMatchObject({env:{CUSTOM_VALUE:"allowed"}});
for (const key of Object.keys(unsafe)) {
expect(result.resolvedConfig.env).not.toHaveProperty(key);
expect(result.configuredTaskEnvironment).not.toHaveProperty(key);
expect((resolveAdapterConfigForRuntime.mock.calls[0]?.[1] as {env:object}).env).not.toHaveProperty(key);
}
});
it.each(["many variables", "large value"])("keeps legacy adapter configuration compatible with %s", async kind => {
const env = kind === "many variables"
? Object.fromEntries(Array.from({ length: 129 }, (_, index) => [`CUSTOM_${index}`, "value"]))
: { CUSTOM_VALUE: "x".repeat(65_536) };
const result = await resolveExecutionRunAdapterConfig({ companyId: "company-1", adapterType: "process", executionRunConfig: { env }, projectEnv: null, secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn(async (_companyId, config) => ({ config, secretKeys: new Set(), manifest: [] })),
} as any });
expect(result.resolvedConfig.env).toEqual(env);
});
it("captures scoped resolved task values and rejects configured markers", async () => {
const key = "PAPERCLIP_CONFIGURED_ENV_KEYS";
const secret = { type: "secret_ref", secretId: "pages-secret" };
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1", agentId: "agent-1", environmentId: "environment-1", projectId: "project-1", routineId: "routine-1",
executionRunConfig: { env: { PAPERCLIP_PAGE_AWS_SECRET_ACCESS_KEY: secret, SHARED: "agent", [key]: '["HOST_SECRET"]' } },
environmentEnv: { SHARED: "environment", [key]: '["HOST_SECRET"]' },
projectEnv: { SHARED: "project", [key]: '["HOST_SECRET"]' },
routineEnv: { SHARED: "routine", [key]: '["HOST_SECRET"]' },
secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn(async (companyId, config) => {
expect(companyId).toBe("company-1");
expect(config.env[key]).toBeUndefined();
return { config: { ...config, env: { ...config.env, PAPERCLIP_PAGE_AWS_SECRET_ACCESS_KEY: "resolved-task-secret" } }, secretKeys: new Set(["PAPERCLIP_PAGE_AWS_SECRET_ACCESS_KEY"]), manifest: [] };
}),
resolveEnvBindings: vi.fn(async (companyId, env) => {
expect(companyId).toBe("company-1");
expect(env[key]).toBeUndefined();
return { env, secretKeys: new Set(), manifest: [] };
}),
} as any,
});
expect(result.configuredTaskEnvironment).toEqual({
PAPERCLIP_PAGE_AWS_SECRET_ACCESS_KEY: "resolved-task-secret", SHARED: "routine",
});
expect(result.resolvedConfig.env).not.toHaveProperty(key);
expect(result.configuredTaskEnvironment).not.toHaveProperty(key);
});
it("does not preflight or resolve legacy GitHub token bindings for managed executions", async () => {
const assertNoGitHubBinding = (env: Record<string, unknown>) => {
for (const key of Object.keys(env)) if (/^(GH_TOKEN|GITHUB_TOKEN|GH_ENTERPRISE_TOKEN|GITHUB_ENTERPRISE_TOKEN|PAPERCLIP_GIT_TOKEN)$/.test(key)) {
throw new Error("Unavailable legacy GitHub secret must not be resolved at startup");
}
};
const missing = { type: "user_secret_ref", key: "old-github-token", required: true };
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1", agentId: "agent-1", environmentId: "environment-1",
projectId: "project-1", routineId: "routine-1", managedGitHubCredentials: true,
executionRunConfig: { env: { GH_TOKEN: missing, AGENT_VALUE: "ok" } },
environmentEnv: { GITHUB_TOKEN: missing, ENVIRONMENT_VALUE: "ok" },
projectEnv: { GH_ENTERPRISE_TOKEN: missing, PROJECT_VALUE: "ok" },
routineEnv: { GITHUB_ENTERPRISE_TOKEN: missing, PAPERCLIP_GIT_TOKEN: missing, ROUTINE_VALUE: "ok" },
secretsSvc: {
collectMissingRuntimeBindings: vi.fn(async (_companyId, env) => { assertNoGitHubBinding(env); return []; }),
resolveAdapterConfigForRuntime: vi.fn(async (_companyId, config) => {
assertNoGitHubBinding(config.env); return { config, secretKeys: new Set(), manifest: [] };
}),
resolveEnvBindings: vi.fn(async (_companyId, env) => {
assertNoGitHubBinding(env); return { env, secretKeys: new Set(), manifest: [] };
}),
} as any,
});
expect(result.resolvedConfig.env).toEqual({ AGENT_VALUE: "ok", ENVIRONMENT_VALUE: "ok", PROJECT_VALUE: "ok", ROUTINE_VALUE: "ok" });
});
it("overlays environment, project, and routine env on top of agent env and unions secret keys", async () => {
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: {
env: {
SHARED_KEY: "agent",
AGENT_ONLY: "agent-only",
},
other: "value",
},
secretKeys: new Set(["AGENT_SECRET"]),
manifest: [
{
configPath: "env.AGENT_SECRET",
envKey: "AGENT_SECRET",
secretId: "secret-agent",
secretKey: "agent-secret",
version: 1,
provider: "local_encrypted",
outcome: "success",
},
],
});
const resolveEnvBindings = vi
.fn()
.mockResolvedValueOnce({
env: {
SHARED_KEY: "environment",
ENV_ONLY: "environment-only",
},
secretKeys: new Set(["ENV_SECRET"]),
manifest: [
{
configPath: "env.ENV_SECRET",
envKey: "ENV_SECRET",
secretId: "secret-environment",
secretKey: "environment-secret",
version: 1,
provider: "local_encrypted",
outcome: "success",
},
],
})
.mockResolvedValueOnce({
env: {
SHARED_KEY: "project",
PROJECT_ONLY: "project-only",
},
secretKeys: new Set(["PROJECT_SECRET"]),
manifest: [
{
configPath: "env.PROJECT_SECRET",
envKey: "PROJECT_SECRET",
secretId: "secret-project",
secretKey: "project-secret",
version: 1,
provider: "local_encrypted",
outcome: "success",
},
],
})
.mockResolvedValueOnce({
env: {
SHARED_KEY: "routine",
ROUTINE_ONLY: "routine-only",
},
secretKeys: new Set(["ROUTINE_SECRET"]),
manifest: [
{
configPath: "env.ROUTINE_SECRET",
envKey: "ROUTINE_SECRET",
secretId: "secret-routine",
secretKey: "routine-secret",
version: 1,
provider: "local_encrypted",
outcome: "success",
},
],
});
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
executionRunConfig: { env: { SHARED_KEY: "agent" } },
environmentId: "environment-1",
environmentEnv: { SHARED_KEY: "environment" },
projectEnv: { SHARED_KEY: "project" },
routineEnv: { SHARED_KEY: "routine" },
routineId: "routine-1",
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
} as any,
});
expect(result.resolvedConfig).toMatchObject({
other: "value",
env: {
SHARED_KEY: "routine",
ENV_ONLY: "environment-only",
AGENT_ONLY: "agent-only",
PROJECT_ONLY: "project-only",
ROUTINE_ONLY: "routine-only",
},
});
expect(Array.from(result.secretKeys).sort()).toEqual(["AGENT_SECRET", "ENV_SECRET", "PROJECT_SECRET", "ROUTINE_SECRET"]);
expect(result.secretManifest.map((entry) => entry.secretId).sort()).toEqual([
"secret-agent",
"secret-environment",
"secret-project",
"secret-routine",
]);
expect(JSON.stringify(result.secretManifest)).not.toContain("agent-only");
expect(JSON.stringify(result.secretManifest)).not.toContain("environment-only");
expect(JSON.stringify(result.secretManifest)).not.toContain("project-only");
expect(JSON.stringify(result.secretManifest)).not.toContain("routine-only");
expect(resolveEnvBindings.mock.calls[0]?.[2]).toMatchObject({
consumerType: "environment",
consumerId: "environment-1",
});
expect(resolveEnvBindings.mock.calls[2]?.[2]).toMatchObject({
consumerType: "routine",
consumerId: "routine-1",
});
});
it("drops PAPERCLIP_API_KEY bindings but forwards other PAPERCLIP_-named env to resolution", async () => {
const resolveAdapterConfigForRuntime = vi.fn(async (_companyId, config: Record<string, unknown>) => ({
config: {
...config,
env: { ...(config.env as Record<string, unknown>) },
},
secretKeys: new Set<string>(),
manifest: [],
}));
const resolveEnvBindings = vi.fn(async (_companyId, env: Record<string, unknown>) => ({
env: Object.fromEntries(
Object.entries(env).filter((entry): entry is [string, string] => typeof entry[1] === "string"),
),
secretKeys: new Set<string>(),
manifest: [],
}));
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
environmentId: "environment-1",
environmentEnv: {
PAPERCLIP_API_KEY: "environment-api-key",
PAPERCLIP_RUNNER_NETWORK_ACCESS: "enabled",
PAPERCLIP_RUNNER_PREPARED_HARNESS_HOME: "/environment/claude",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ENV: "environment-cloud",
ENV_ONLY: "environment-only",
},
executionRunConfig: {
env: {
PAPERCLIP_API_KEY: { type: "secret_ref", secretId: "secret-api-key", version: "latest" },
PAPERCLIP_CLOUD_PROVIDER_TOKEN_AGENT: "agent-cloud",
PAPERCLIP_RUNNER_PREPARED_HARNESS_HOME: "/agent/claude",
AGENT_ONLY: "agent-only",
},
},
projectEnv: {
PAPERCLIP_API_KEY: "project-api-key",
paperclip_runner_prepared_harness_home: "/project/claude",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_PROJECT: "project-cloud",
PROJECT_ONLY: "project-only",
},
routineEnv: {
PAPERCLIP_API_KEY: "routine-api-key",
PAPERCLIP_RUNNER_PREPARED_HARNESS_HOME: "/routine/claude",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ROUTINE: "routine-cloud",
ROUTINE_ONLY: "routine-only",
},
routineId: "routine-1",
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
} as any,
});
expect(resolveEnvBindings.mock.calls[0]?.[1]).toEqual({
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ENV: "environment-cloud",
ENV_ONLY: "environment-only",
});
expect(resolveAdapterConfigForRuntime.mock.calls[0]?.[1]).toEqual({
env: {
PAPERCLIP_CLOUD_PROVIDER_TOKEN_AGENT: "agent-cloud",
AGENT_ONLY: "agent-only",
},
});
expect(resolveEnvBindings.mock.calls[1]?.[1]).toEqual({
PAPERCLIP_CLOUD_PROVIDER_TOKEN_PROJECT: "project-cloud",
PROJECT_ONLY: "project-only",
});
expect(resolveEnvBindings.mock.calls[2]?.[1]).toEqual({
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ROUTINE: "routine-cloud",
ROUTINE_ONLY: "routine-only",
});
expect(result.resolvedConfig.env).toEqual({
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ENV: "environment-cloud",
ENV_ONLY: "environment-only",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_AGENT: "agent-cloud",
AGENT_ONLY: "agent-only",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_PROJECT: "project-cloud",
PROJECT_ONLY: "project-only",
PAPERCLIP_CLOUD_PROVIDER_TOKEN_ROUTINE: "routine-cloud",
ROUTINE_ONLY: "routine-only",
});
expect(JSON.stringify(result.resolvedConfig.env)).not.toContain("PAPERCLIP_API_KEY");
expect(JSON.stringify(result.resolvedConfig.env)).not.toContain("PAPERCLIP_RUNNER_NETWORK_ACCESS");
});
it("skips project env resolution when the project has no bindings", async () => {
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { env: { AGENT_ONLY: "agent-only" } },
secretKeys: new Set<string>(),
manifest: [],
});
const resolveEnvBindings = vi.fn();
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
executionRunConfig: { env: { AGENT_ONLY: "agent-only" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
} as any,
});
expect(result.resolvedConfig.env).toEqual({ AGENT_ONLY: "agent-only" });
expect(result.secretManifest).toEqual([]);
expect(resolveEnvBindings).not.toHaveBeenCalled();
});
it("passes low-trust allowed secret binding ids into all runtime secret contexts", async () => {
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { env: {} },
secretKeys: new Set<string>(),
manifest: [],
});
const resolveEnvBindings = vi.fn().mockResolvedValue({
env: {},
secretKeys: new Set<string>(),
manifest: [],
});
await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
heartbeatRunId: "run-1",
environmentId: "environment-1",
projectId: "project-1",
routineId: "routine-1",
executionRunConfig: { env: {} },
environmentEnv: { ENVIRONMENT_FLAG: "plain" },
projectEnv: { PROJECT_FLAG: "plain" },
routineEnv: { ROUTINE_FLAG: "plain" },
trustPreset: {
kind: "low_trust_review",
preset: LOW_TRUST_REVIEW_PRESET,
boundary: {
mode: LOW_TRUST_REVIEW_PRESET,
companyId: "company-1",
issueIds: ["issue-1"],
allowedSecretBindingIds: ["binding-1"],
},
sourcePresets: {},
},
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
} as any,
});
expect(resolveAdapterConfigForRuntime.mock.calls[0]?.[2]).toMatchObject({
allowedBindingIds: ["binding-1"],
});
expect(resolveEnvBindings.mock.calls[0]?.[2]).toMatchObject({
allowedBindingIds: ["binding-1"],
});
expect(resolveEnvBindings.mock.calls[1]?.[2]).toMatchObject({
allowedBindingIds: ["binding-1"],
});
expect(resolveEnvBindings.mock.calls[2]?.[2]).toMatchObject({
allowedBindingIds: ["binding-1"],
});
});
it("does not project brokered GitHub credentials across a low-trust boundary", async () => {
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
executionRunConfig: { env: {} },
projectEnv: null,
trustPreset: {
kind: "low_trust_review",
preset: LOW_TRUST_REVIEW_PRESET,
boundary: {
mode: LOW_TRUST_REVIEW_PRESET,
companyId: "company-1",
issueIds: ["issue-1"],
allowedSecretBindingIds: [],
},
sourcePresets: {},
},
trustedEnvProjection: {
GH_TOKEN: "brokered-github-token",
GITHUB_TOKEN: "brokered-github-token",
},
trustedEnvSecretKeys: ["GH_TOKEN", "GITHUB_TOKEN"],
secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn().mockResolvedValue({
config: { env: {} },
secretKeys: new Set<string>(),
manifest: [],
}),
resolveEnvBindings: vi.fn(),
} as any,
});
expect(result.resolvedConfig.env).toEqual({});
expect(result.secretKeys).toEqual(new Set());
});
it("does not let a brokered projection satisfy low-trust push preflight", async () => {
await expect(resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
executionRunConfig: { env: {} },
projectEnv: null,
trustPreset: {
kind: "low_trust_review",
preset: LOW_TRUST_REVIEW_PRESET,
boundary: {
mode: LOW_TRUST_REVIEW_PRESET,
companyId: "company-1",
issueIds: ["issue-1"],
allowedSecretBindingIds: [],
},
sourcePresets: {},
},
requiredScopedEnvBinding: {
keys: ["GH_TOKEN", "GITHUB_TOKEN"],
consumerScopes: ["agent", "project"],
reason: "push_write_credential_missing",
remediation: "Bind an explicitly allowed GitHub write credential.",
},
trustedEnvProjection: { GH_TOKEN: "brokered-github-token" },
trustedEnvSecretKeys: ["GH_TOKEN"],
secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn(),
resolveEnvBindings: vi.fn(),
} as any,
})).rejects.toMatchObject({
code: "configuration_incomplete",
resultJson: {
configurationIncomplete: { reason: "push_write_credential_missing" },
},
});
});
it("blocks required missing user secrets before runtime env resolution", async () => {
const resolveAdapterConfigForRuntime = vi.fn();
const resolveEnvBindings = vi.fn();
const collectMissingRuntimeBindings = vi.fn(async (_companyId, _env, context) =>
context.consumerType === "agent"
? [
{
consumerType: "agent",
consumerId: "agent-1",
configPath: "env.GITHUB_TOKEN",
envKey: "GITHUB_TOKEN",
bindingType: "user_secret_ref",
secretId: null,
secretName: null,
userSecretDefinitionId: "definition-1",
userSecretDefinitionKey: "github_token",
userSecretDefinitionName: "GitHub token",
responsibleUserId: context.responsibleUserId,
errorCode: "user_secret_missing",
},
]
: [],
);
await expect(resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
heartbeatRunId: "run-1",
responsibleUserId: "user-1",
executionRunConfig: {
env: {
GITHUB_TOKEN: { type: "user_secret_ref", key: "github_token", required: true },
},
},
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
collectMissingRuntimeBindings,
} as any,
})).rejects.toMatchObject({
code: "configuration_incomplete",
resultJson: {
configurationIncomplete: {
reason: "secret_binding_missing",
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
missingBindings: [
expect.objectContaining({
bindingType: "user_secret_ref",
userSecretDefinitionKey: "github_token",
responsibleUserId: "user-1",
}),
],
},
},
});
expect(collectMissingRuntimeBindings.mock.calls[0]?.[2]).toMatchObject({
responsibleUserId: "user-1",
});
expect(resolveAdapterConfigForRuntime).not.toHaveBeenCalled();
expect(resolveEnvBindings).not.toHaveBeenCalled();
});
it("rejects inline sensitive env values for low-trust runs", async () => {
await expect(resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
executionRunConfig: {
env: {
OPENAI_API_KEY: "inline-secret",
},
},
projectEnv: null,
trustPreset: {
kind: "low_trust_review",
preset: LOW_TRUST_REVIEW_PRESET,
boundary: {
mode: LOW_TRUST_REVIEW_PRESET,
companyId: "company-1",
issueIds: ["issue-1"],
},
sourcePresets: {},
},
secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn(),
resolveEnvBindings: vi.fn(),
} as any,
})).rejects.toMatchObject({
status: 422,
details: { code: "low_trust_inline_sensitive_env_denied" },
});
});
it("fails push-capability preflight when no GitHub write credential is bound at agent or project scope", async () => {
await expect(resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
executionRunConfig: { env: { AGENT_ONLY: "agent-only" } },
projectEnv: { PROJECT_ONLY: "project-only" },
requiredScopedEnvBinding: {
keys: ["GH_TOKEN", "GITHUB_TOKEN"],
consumerScopes: ["agent", "project"],
reason: "push_write_credential_missing",
remediation: "GitHub PR workflow requires GH_TOKEN or GITHUB_TOKEN bound at project or agent scope.",
},
secretsSvc: {
resolveAdapterConfigForRuntime: vi.fn(),
resolveEnvBindings: vi.fn(),
} as any,
})).rejects.toMatchObject({
code: "configuration_incomplete",
message: expect.stringContaining("GitHub PR workflow requires GH_TOKEN or GITHUB_TOKEN"),
resultJson: {
configurationIncomplete: {
reason: "push_write_credential_missing",
requiredEnvKeys: ["GH_TOKEN", "GITHUB_TOKEN"],
requiredScopes: ["agent", "project"],
missingBindings: [],
},
},
});
});
it("passes push-capability preflight when a project-scoped GitHub credential is configured", async () => {
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { env: { AGENT_ONLY: "agent-only" } },
secretKeys: new Set<string>(),
manifest: [],
});
const resolveEnvBindings = vi.fn().mockResolvedValue({
env: { GH_TOKEN: "github-token" },
secretKeys: new Set(["GH_TOKEN"]),
manifest: [],
});
const collectMissingRuntimeBindings = vi.fn().mockResolvedValue([]);
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
projectId: "project-1",
executionRunConfig: { env: { AGENT_ONLY: "agent-only" } },
projectEnv: { GH_TOKEN: { type: "plain", value: "github-token" } },
requiredScopedEnvBinding: {
keys: ["GH_TOKEN", "GITHUB_TOKEN"],
consumerScopes: ["agent", "project"],
reason: "push_write_credential_missing",
remediation: "GitHub PR workflow requires GH_TOKEN or GITHUB_TOKEN bound at project or agent scope.",
},
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings,
collectMissingRuntimeBindings,
} as any,
});
expect(result.resolvedConfig.env).toEqual({
AGENT_ONLY: "agent-only",
GH_TOKEN: "github-token",
});
expect(resolveEnvBindings).toHaveBeenCalledOnce();
expect(collectMissingRuntimeBindings).toHaveBeenCalledTimes(2);
expect(collectMissingRuntimeBindings.mock.calls[1]?.[2]).toMatchObject({
consumerType: "project",
consumerId: "project-1",
});
});
});
describe("resolveExecutionRunAdapterConfig codex_local credential pre-dispatch gate", () => {
const cleanupDirs: string[] = [];
afterEach(async () => {
vi.unstubAllEnvs();
while (cleanupDirs.length > 0) {
const dir = cleanupDirs.pop();
if (!dir) continue;
await fs.rm(dir, { recursive: true, force: true }).catch(() => undefined);
}
});
async function stubManagedCodexEnv(options: { seedSharedAuth: boolean }) {
const root = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-codex-gate-"));
cleanupDirs.push(root);
const paperclipHome = path.join(root, "paperclip-home");
const sharedCodexHome = path.join(root, "shared-codex-home");
await fs.mkdir(sharedCodexHome, { recursive: true });
if (options.seedSharedAuth) {
await fs.writeFile(
path.join(sharedCodexHome, "auth.json"),
'{"OPENAI_API_KEY":"sk-shared"}\n',
"utf8",
);
}
vi.stubEnv("PAPERCLIP_HOME", paperclipHome);
vi.stubEnv("PAPERCLIP_INSTANCE_ID", "default");
vi.stubEnv("CODEX_HOME", sharedCodexHome);
const managedAgentHome = path.join(
paperclipHome,
"instances",
"default",
"companies",
"company-1",
"agents",
"agent-1",
"codex-home",
);
return { root, managedAgentHome };
}
it("does not gate sandbox-destined runs on host credentials — the sandbox image may carry its own login", async () => {
const { managedAgentHome } = await stubManagedCodexEnv({ seedSharedAuth: false });
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
secretKeys: new Set<string>(),
manifest: [],
});
await expect(
resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "codex_local",
issueId: "issue-1",
responsibleUserId: "user-1",
environmentDriver: "sandbox",
executionRunConfig: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
}),
).resolves.toMatchObject({
resolvedConfig: expect.objectContaining({ command: "codex" }),
});
});
it("surfaces a configuration-incomplete blocker when a managed home has no auth and OPENAI_API_KEY is empty", async () => {
const { managedAgentHome } = await stubManagedCodexEnv({ seedSharedAuth: false });
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
secretKeys: new Set<string>(),
manifest: [],
});
await expect(
resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "codex_local",
issueId: "issue-1",
responsibleUserId: "user-1",
executionRunConfig: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
}),
).rejects.toMatchObject({
code: "configuration_incomplete",
message: expect.stringContaining("no Codex credentials available"),
resultJson: {
configurationIncomplete: {
reason: "codex_credentials_missing",
adapterType: "codex_local",
companyId: "company-1",
agentId: "agent-1",
issueId: "issue-1",
responsibleUserId: "user-1",
requiredEnvKeys: ["OPENAI_API_KEY"],
},
},
});
// The blocker message must not leak any secret value.
await expect(
resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "codex_local",
executionRunConfig: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
}).catch((err) => err.message),
).resolves.not.toContain("sk-");
});
it("dispatches normally when a per-agent OPENAI_API_KEY is resolved", async () => {
const { managedAgentHome } = await stubManagedCodexEnv({ seedSharedAuth: false });
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "sk-agent-resolved" } },
secretKeys: new Set(["OPENAI_API_KEY"]),
manifest: [],
});
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "codex_local",
executionRunConfig: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: { type: "secret_ref" } } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
});
expect(result.resolvedConfig.env).toMatchObject({ OPENAI_API_KEY: "sk-agent-resolved" });
});
it("dispatches normally when the shared host home carries subscription auth", async () => {
const { managedAgentHome } = await stubManagedCodexEnv({ seedSharedAuth: true });
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
secretKeys: new Set<string>(),
manifest: [],
});
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "codex_local",
executionRunConfig: { command: "codex", env: { CODEX_HOME: managedAgentHome, OPENAI_API_KEY: "" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
});
expect(result.resolvedConfig.command).toBe("codex");
});
it("does not gate non-codex adapters", async () => {
await stubManagedCodexEnv({ seedSharedAuth: false });
const resolveAdapterConfigForRuntime = vi.fn().mockResolvedValue({
config: { command: "claude", env: { OPENAI_API_KEY: "" } },
secretKeys: new Set<string>(),
manifest: [],
});
const result = await resolveExecutionRunAdapterConfig({
companyId: "company-1",
agentId: "agent-1",
adapterType: "claude_local",
executionRunConfig: { command: "claude", env: { OPENAI_API_KEY: "" } },
projectEnv: null,
secretsSvc: {
resolveAdapterConfigForRuntime,
resolveEnvBindings: vi.fn(),
collectMissingRuntimeBindings: vi.fn().mockResolvedValue([]),
} as any,
});
expect(result.resolvedConfig.command).toBe("claude");
});
});
describe("extractMentionedSkillIdsFromSources", () => {
it("collects UUID skill mention ids across issue sources", () => {
const releaseSkillId = "11111111-1111-4111-8111-111111111111";
const browserSkillId = "22222222-2222-4222-8222-222222222222";
const releaseHref = buildSkillMentionHref(releaseSkillId, "release-changelog");
const browserHref = buildSkillMentionHref(browserSkillId, "agent-browser");
expect(
extractMentionedSkillIdsFromSources([
`Please use [/release-changelog](${releaseHref})`,
`And also [/agent-browser](${browserHref})`,
`Duplicate mention [/release-changelog](${releaseHref})`,
]),
).toEqual([releaseSkillId, browserSkillId]);
});
it("ignores legacy non-UUID skill mention ids before runtime database lookup", () => {
const validSkillId = "33333333-3333-4333-8333-333333333333";
const validHref = buildSkillMentionHref(validSkillId, "greploop");
const legacyHref = buildSkillMentionHref("skill-greploop", "greploop");
expect(
extractMentionedSkillIdsFromSources([
`Use [/greploop](${legacyHref}) and [/prcheckloop](${validHref})`,
]),
).toEqual([validSkillId]);
});
});
describe("applyRunScopedMentionedSkillKeys", () => {
it("adds mentioned skills without mutating the original config", () => {
const originalConfig = {
command: "codex",
paperclipSkillSync: {
desiredSkills: ["paperclipai/paperclip/paperclip"],
},
};
const updatedConfig = applyRunScopedMentionedSkillKeys(originalConfig, [
"company/company-1/release-changelog",
"paperclipai/paperclip/paperclip",
"company/company-1/release-changelog",
]);
expect(updatedConfig).toEqual({
command: "codex",
paperclipSkillSync: {
desiredSkills: [
"paperclipai/paperclip/paperclip",
"company/company-1/release-changelog",
],
},
});
expect(originalConfig).toEqual({
command: "codex",
paperclipSkillSync: {
desiredSkills: ["paperclipai/paperclip/paperclip"],
},
});
});
it("preserves existing version pins when adding mentioned skills", () => {
const originalConfig = {
command: "codex",
paperclipSkillSync: {
desiredSkills: [
{ key: "company/company-1/release-changelog", versionId: "version-1" },
],
},
};
const updatedConfig = applyRunScopedMentionedSkillKeys(originalConfig, [
"company/company-1/security-review",
]);
expect(updatedConfig).toEqual({
command: "codex",
paperclipSkillSync: {
desiredSkills: [
{ key: "company/company-1/release-changelog", versionId: "version-1" },
{ key: "company/company-1/security-review", versionId: null },
],
},
});
});
});
describe("resolveAdditionalRunWorkspaces", () => {
const companyId = "company-1";
const issueId = "issue-1";
const allowDecision: AuthorizationDecision = {
allowed: true,
action: "project:read",
reason: "allow_company_agent",
explanation: "test allow",
};
// Build injectable dependencies. Every mentioned project is available and authorized by default.
function buildOptions(
overrides: Partial<ResolveAdditionalRunWorkspacesOptions> & { mentionedIds?: string[] },
): ResolveAdditionalRunWorkspacesOptions {
const mentionedIds = overrides.mentionedIds ?? [];
const actor: AuthorizationActor = {
type: "agent",
agentId: "agent-1",
companyId,
source: "agent_key",
};
const issues: ResolveAdditionalRunWorkspacesOptions["issues"] = {
findMentionedProjectIds: async () => mentionedIds,
};
const projects: ResolveAdditionalRunWorkspacesOptions["projects"] = {
listByIds: async (_companyId, ids) =>
ids.map((id) => ({ id })) as unknown as Awaited<
ReturnType<ResolveAdditionalRunWorkspacesOptions["projects"]["listByIds"]>
>,
};
const access: ResolveAdditionalRunWorkspacesOptions["access"] = {
decide: async () => allowDecision,
};
const resolveProjectWorkspace = async (
project: RunReferencedProject,
): Promise<ResolvedAdditionalWorkspace> => ({
cwd: `/managed/${project.projectId}`,
projectId: project.projectId,
workspaceId: `${project.projectId}-ws`,
repoUrl: null,
repoRef: null,
});
return {
enabled: true,
companyId,
actor,
issues,
projects,
access,
resolveProjectWorkspace,
...overrides,
};
}
it("resolves additionalWorkspaces for each mentioned project when the sync flag is ON", async () => {
const options = buildOptions({ mentionedIds: ["project-a", "project-b"] });
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result.additionalWorkspaces).toEqual([
{
cwd: "/managed/project-a",
projectId: "project-a",
workspaceId: "project-a-ws",
repoUrl: null,
repoRef: null,
},
{
cwd: "/managed/project-b",
projectId: "project-b",
workspaceId: "project-b-ws",
repoUrl: null,
repoRef: null,
},
]);
expect(result.warnings).toEqual([]);
});
it("returns empty additionalWorkspaces when the sync flag is OFF (anchor-only, unchanged)", async () => {
let mentionLookups = 0;
let workspaceResolves = 0;
const options = buildOptions({
enabled: false,
mentionedIds: ["project-a", "project-b"],
issues: {
findMentionedProjectIds: async () => {
mentionLookups += 1;
return ["project-a", "project-b"];
},
},
resolveProjectWorkspace: async (project) => {
workspaceResolves += 1;
return {
cwd: `/managed/${project.projectId}`,
projectId: project.projectId,
workspaceId: null,
repoUrl: null,
repoRef: null,
};
},
});
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result).toEqual({ additionalWorkspaces: [], warnings: [], failures: [] });
// The flag-off path must be inert: no mention lookup and no workspace resolution run.
expect(mentionLookups).toBe(0);
expect(workspaceResolves).toBe(0);
});
it("isolates a failing mentioned-project clone with a warning, run still resolves", async () => {
const options = buildOptions({
mentionedIds: ["project-a", "project-b"],
resolveProjectWorkspace: async (project) => {
if (project.projectId === "project-a") {
throw new Error("clone exploded");
}
return {
cwd: `/managed/${project.projectId}`,
projectId: project.projectId,
workspaceId: null,
repoUrl: null,
repoRef: null,
};
},
});
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result.additionalWorkspaces).toEqual([
{
cwd: "/managed/project-b",
projectId: "project-b",
workspaceId: null,
repoUrl: null,
repoRef: null,
},
]);
expect(result.warnings).toHaveLength(1);
expect(result.warnings[0]).toContain("project-a");
expect(result.warnings[0]).toContain("clone exploded");
expect(result.failures).toEqual([{ projectId: "project-a", reason: "resolution" }]);
});
it("aggregates per-layer warnings onto the run's surfaced warnings", async () => {
// Two valid projects sync; one is dropped by authorization and one fails to resolve. The run
// still resolves, and both dropped projects are named in the surfaced warnings, one per layer.
const options = buildOptions({
mentionedIds: ["project-a", "project-b", "denied-project", "broken-project"],
access: {
decide: async (input) =>
input.scope?.projectId === "denied-project"
? { allowed: false, action: "project:read", reason: "deny_no_grant", explanation: "denied" }
: allowDecision,
},
resolveProjectWorkspace: async (project) => {
if (project.projectId === "broken-project") {
throw new Error("clone exploded");
}
return {
cwd: `/managed/${project.projectId}`,
projectId: project.projectId,
workspaceId: null,
repoUrl: null,
repoRef: null,
};
},
});
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result.additionalWorkspaces.map((workspace) => workspace.projectId)).toEqual([
"project-a",
"project-b",
]);
// Each dropped project is named in a surfaced warning, across both layers.
expect(result.warnings.some((warning) => warning.includes("denied-project"))).toBe(true);
expect(result.warnings.some((warning) => warning.includes("broken-project"))).toBe(true);
// The structured failures carry the layer that dropped each project.
expect(result.failures).toEqual([
{ projectId: "denied-project", reason: "authorization" },
{ projectId: "broken-project", reason: "resolution" },
]);
});
it("skips referenced-project work on a remote target and warns when the issue mentions a project", async () => {
let mentionLookups = 0;
let workspaceResolves = 0;
const options = buildOptions({
executionTargetIsRemote: true,
mentionedIds: ["project-a", "project-b"],
issues: {
findMentionedProjectIds: async () => {
mentionLookups += 1;
return ["project-a", "project-b"];
},
},
resolveProjectWorkspace: async (project) => {
workspaceResolves += 1;
return {
cwd: `/managed/${project.projectId}`,
projectId: project.projectId,
workspaceId: null,
repoUrl: null,
repoRef: null,
};
},
});
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result.additionalWorkspaces).toEqual([]);
expect(result.warnings).toHaveLength(1);
expect(result.warnings[0]).toContain("local execution target");
// The remote path drops every referenced project at the staging layer. Each dropped project
// keeps a structured failure so the requested-vs-synced accounting counts the whole set and the
// run still emits its structured sync log.
expect(result.failures).toEqual([
{ projectId: "project-a", reason: "staging" },
{ projectId: "project-b", reason: "staging" },
]);
// The remote path must skip the per-project clone work whose result the target cannot receive.
expect(mentionLookups).toBe(1);
expect(workspaceResolves).toBe(0);
});
it("drops a duplicate remote referenced mention to a single staging failure and ignores the anchor", async () => {
const options = buildOptions({
executionTargetIsRemote: true,
mentionedIds: ["anchor-project", "project-a", "project-a"],
});
const result = await resolveAdditionalRunWorkspaces(issueId, "anchor-project", options);
// The anchor is not a referenced drop, and a repeated mention counts once.
expect(result.failures).toEqual([{ projectId: "project-a", reason: "staging" }]);
expect(result.warnings).toHaveLength(1);
});
it("stays silent on a remote target when the issue mentions no referenced project", async () => {
const options = buildOptions({
executionTargetIsRemote: true,
mentionedIds: [],
});
const result = await resolveAdditionalRunWorkspaces(issueId, null, options);
expect(result).toEqual({ additionalWorkspaces: [], warnings: [], failures: [] });
});
});
describe("buildReferencedProjectRunObservability", () => {
it("emits referenced_projects_requested vs referenced_projects_synced with failure reason", () => {
const observability = buildReferencedProjectRunObservability({
syncedProjectIds: ["project-a"],
failures: [
{ projectId: "project-b", reason: "authorization" },
{ projectId: "project-c", reason: "resolution" },
{ projectId: "project-d", reason: "staging", error: "extract failed: boom" },
],
});
// Requested is the synced count plus every dropped project, so the counts reconcile.
expect(observability.referenced_projects_requested).toBe(4);
expect(observability.referenced_projects_synced).toBe(1);
// A staging failure carries its error message; a failure without one omits the field.
expect(observability.referenced_project_failures).toEqual([
{ project_id: "project-b", reason: "authorization" },
{ project_id: "project-c", reason: "resolution" },
{ project_id: "project-d", reason: "staging", error: "extract failed: boom" },
]);
});
it("emits zero counts and no failures when no project is referenced", () => {
const observability = buildReferencedProjectRunObservability({
syncedProjectIds: [],
failures: [],
});
expect(observability.referenced_projects_requested).toBe(0);
expect(observability.referenced_projects_synced).toBe(0);
expect(observability.referenced_project_failures).toEqual([]);
});
});
describe("buildRunWorkspaceHints", () => {
const anchorHints = [
{ workspaceId: "anchor-ws", cwd: "/anchor", repoUrl: "https://example.test/anchor.git", repoRef: "main" },
];
it("returns only the anchor hints when no referenced project resolves (flag OFF, inert)", () => {
const hints = buildRunWorkspaceHints({ workspaceHints: anchorHints, additionalWorkspaces: [] });
expect(hints).toEqual(anchorHints);
});
it("appends each referenced project workspace so the agent sees its path", () => {
const hints = buildRunWorkspaceHints({
workspaceHints: anchorHints,
additionalWorkspaces: [
{
cwd: "/managed/project-b",
projectId: "project-b",
workspaceId: "project-b-ws",
repoUrl: "https://example.test/b.git",
repoRef: "main",
},
// The hint builder passes each field through unchanged, including a null workspaceId.
{ cwd: "/managed/project-c", projectId: "project-c", workspaceId: null, repoUrl: null, repoRef: null },
],
});
expect(hints).toEqual([
{ workspaceId: "anchor-ws", cwd: "/anchor", repoUrl: "https://example.test/anchor.git", repoRef: "main" },
{
workspaceId: "project-b-ws",
cwd: "/managed/project-b",
repoUrl: "https://example.test/b.git",
repoRef: "main",
projectId: "project-b",
},
{ workspaceId: null, cwd: "/managed/project-c", repoUrl: null, repoRef: null, projectId: "project-c" },
]);
});
});
describe("resolveAdditionalProjectWorkspace", () => {
const companyId = "company-1";
function referencedProject(projectId: string): RunReferencedProject {
return { projectId, project: { id: projectId } as RunReferencedProject["project"] };
}
type WorkspaceRow = Awaited<ReturnType<ResolveAdditionalProjectWorkspaceDeps["loadProjectWorkspaceRows"]>>[number];
function workspaceRow(overrides: Partial<WorkspaceRow>): WorkspaceRow {
return { id: "workspace-x", cwd: null, repoUrl: null, repoRef: null, ...overrides } as WorkspaceRow;
}
// Build deps whose managed and configured resolvers are pure, so no database or filesystem runs.
function buildDeps(
overrides: Partial<ResolveAdditionalProjectWorkspaceDeps>,
): ResolveAdditionalProjectWorkspaceDeps {
return {
loadProjectWorkspaceRows: async () => [],
resolveConfiguredOrManagedProjectCwd: async (input) => ({ cwd: input.cwd ?? "/unset", warning: null }),
ensureManagedProjectWorkspace: async (input) => ({
cwd: `/managed/${input.projectId}`,
warning: null,
}),
directoryHasContents: async () => true,
...overrides,
};
}
it("throws instead of creating an empty managed directory when the project has no workspace rows", async () => {
let ensureCalls = 0;
const deps = buildDeps({
loadProjectWorkspaceRows: async () => [],
ensureManagedProjectWorkspace: async (input) => {
ensureCalls += 1;
return { cwd: `/managed/${input.projectId}`, warning: null };
},
});
await expect(
resolveAdditionalProjectWorkspace({ companyId, project: referencedProject("project-b") }, deps),
).rejects.toThrow(/project-b/);
// The fallback must not fabricate an empty managed directory for a project with no real source.
expect(ensureCalls).toBe(0);
});
it("throws when a workspace row supplies neither a checkout directory nor a repository URL", async () => {
let ensureCalls = 0;
const deps = buildDeps({
loadProjectWorkspaceRows: async () => [workspaceRow({ id: "ws-empty", cwd: null, repoUrl: null })],
resolveConfiguredOrManagedProjectCwd: async (input) => ({ cwd: input.cwd ?? "/unset", warning: null }),
// directoryHasContents returns true for any path; the row must still be skipped before this runs.
directoryHasContents: async () => true,
ensureManagedProjectWorkspace: async (input) => {
ensureCalls += 1;
return { cwd: `/managed/${input.projectId}`, warning: null };
},
});
await expect(
resolveAdditionalProjectWorkspace({ companyId, project: referencedProject("project-c") }, deps),
).rejects.toThrow(/project-c/);
// The row without a real source neither resolves a checkout nor triggers a managed fallback.
expect(ensureCalls).toBe(0);
});
it("throws when a configured checkout directory exists but has no content", async () => {
let ensureCalls = 0;
const deps = buildDeps({
loadProjectWorkspaceRows: async () => [
workspaceRow({ id: "ws-empty-dir", cwd: "/checkout/empty", repoUrl: null }),
],
resolveConfiguredOrManagedProjectCwd: async (input) => ({ cwd: input.cwd ?? "/unset", warning: null }),
// The configured directory exists but holds no content, so it is not a realized workspace.
directoryHasContents: async () => false,
ensureManagedProjectWorkspace: async (input) => {
ensureCalls += 1;
return { cwd: `/managed/${input.projectId}`, warning: null };
},
});
await expect(
resolveAdditionalProjectWorkspace({ companyId, project: referencedProject("project-d") }, deps),
).rejects.toThrow(/project-d/);
// An empty configured directory must not mask a missing workspace, and the row has no
// repository URL, so the managed fallback never runs.
expect(ensureCalls).toBe(0);
});
it("returns the first workspace row whose directory has content", async () => {
const deps = buildDeps({
loadProjectWorkspaceRows: async () => [
workspaceRow({ id: "ws-1", cwd: "/checkout/a", repoUrl: "https://example.test/a.git", repoRef: "main" }),
],
resolveConfiguredOrManagedProjectCwd: async (input) => ({ cwd: input.cwd ?? "/unset", warning: null }),
directoryHasContents: async (cwd) => cwd === "/checkout/a",
});
const result = await resolveAdditionalProjectWorkspace({ companyId, project: referencedProject("project-a") }, deps);
expect(result).toEqual({
cwd: "/checkout/a",
projectId: "project-a",
workspaceId: "ws-1",
repoUrl: "https://example.test/a.git",
repoRef: "main",
});
});
it("clones into the managed directory when configured rows point at missing paths", async () => {
let ensuredRepoUrl: string | null | undefined;
const deps = buildDeps({
loadProjectWorkspaceRows: async () => [
workspaceRow({ id: "ws-1", cwd: "/checkout/missing", repoUrl: "https://example.test/a.git", repoRef: "release" }),
],
resolveConfiguredOrManagedProjectCwd: async (input) => ({ cwd: input.cwd ?? "/unset", warning: null }),
directoryHasContents: async () => false,
ensureManagedProjectWorkspace: async (input) => {
ensuredRepoUrl = input.repoUrl;
return { cwd: `/managed/${input.projectId}`, warning: null };
},
});
const result = await resolveAdditionalProjectWorkspace({ companyId, project: referencedProject("project-a") }, deps);
expect(result).toEqual({
cwd: "/managed/project-a",
projectId: "project-a",
workspaceId: "ws-1",
repoUrl: "https://example.test/a.git",
repoRef: "release",
});
// The fallback clone reuses the repository URL from the first configured workspace row.
expect(ensuredRepoUrl).toBe("https://example.test/a.git");
});
});
describe("resolveManagedProjectWorkspaceDir isolation", () => {
it("resolves distinct, non-nested managed dirs for two projects", () => {
const companyId = "company-1";
const dirA = resolveManagedProjectWorkspaceDir({ companyId, projectId: "project-a", repoName: null });
const dirB = resolveManagedProjectWorkspaceDir({ companyId, projectId: "project-b", repoName: null });
expect(dirA).not.toBe(dirB);
// Neither directory is a path prefix of the other: append a separator so a shared leading
// string (for example "project-a" vs "project-ab") never reads as nesting.
expect(`${dirB}${path.sep}`.startsWith(`${dirA}${path.sep}`)).toBe(false);
expect(`${dirA}${path.sep}`.startsWith(`${dirB}${path.sep}`)).toBe(false);
});
it("keeps a project id that prefixes another project id in a sibling, non-nested dir", () => {
const companyId = "company-1";
const dir = resolveManagedProjectWorkspaceDir({ companyId, projectId: "project", repoName: null });
const dirLonger = resolveManagedProjectWorkspaceDir({ companyId, projectId: "project-extra", repoName: null });
expect(`${dirLonger}${path.sep}`.startsWith(`${dir}${path.sep}`)).toBe(false);
expect(`${dir}${path.sep}`.startsWith(`${dirLonger}${path.sep}`)).toBe(false);
});
});