mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-25 09:41:04 +01:00
fix: resolve git credentials with the issue's identity in background jobs (#17515)
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work
> - Git cache expiration, isolated source re-home, nested clone
migration and workspace reopen fetch from the workspace's remotes to
prove history is on the remote or to rebuild workspaces
> - They built git credentials from the issue id alone, but the managed
GitHub identity is selected from the run's responsible user and agent
> - So the credential never resolved, they fell back to anonymous
access, and private repositories were unreadable
> - This pull request resolves credentials with the issue's responsible
user and assigned agent, the same identity agent runs use
> - The benefit is that workspaces with private repositories can expire,
re-home, migrate and reopen like public ones
## Linked Issues or Issue Description
Refs #17464, #17407, #17369. Bug report described in-PR (bug report
template).
**What happened?**
On one instance, 18 long-closed workspaces in one project were kept on
every expiration sweep with `managed_checkout_upstream_unavailable`.
Their nested checkout is a private GitHub repository. Expiration called
`createGitRemoteAuthProvider(db, companyId, { issueId })`. With that
context, `resolveManagedGitHubCredential` returned "No managed GitHub
identity is available for this run". `withAnonymousGitFallback` then
tried anonymous access, which cannot read the private repository. Called
with the issue's `responsibleUserId` and `agentId`, the same lookup
returned a credential.
**Expected behavior**
Background workspace jobs authenticate as the issue's identity, as agent
runs do, and can verify private repositories.
**Steps to reproduce**
1. Configure a project with a private GitHub repository and a managed
GitHub identity tied to the issue's responsible user.
2. Close an issue whose workspace includes that repository and let git
cache expiration inspect it.
3. It is kept with `managed_checkout_upstream_unavailable`.
**Paperclip version or commit:** `master` at fe85fd7ac4.
**Deployment mode:** any with managed GitHub identities.
**Agent adapter(s) involved:** not adapter-specific (core).
## What Changed
- `createIssueGitRemoteAuthProvider(db, companyId, issueId)` in
`server/src/services/git-credentials.ts`:
- looks up the issue's `responsibleUserId` and `assigneeAgentId` once,
lazily, scoped to the company;
- builds `createGitRemoteAuthProvider` with `{ issueId,
responsibleUserId, agentId }`;
- falls back to the issue-only context when the issue is missing.
- Callers switched from the issue-only context:
- git cache expiration (`expirationGitAuth`);
- isolated source re-home;
- nested clone migration;
- both credential sites in
`reopenClosedIsolatedExecutionWorkspaceForIssue`.
- Anonymous fallback for public repositories is unchanged.
No code comments were added.
## Verification
- `pnpm exec vitest run src/__tests__/git-credentials.test.ts
src/__tests__/git-expiration-auth-fallback.test.ts` (in `server/`): 32
passed. New cases:
- the helper passes the issue's responsible user and agent to the
credential lookup;
- it looks the issue up once across calls;
- it falls back to the issue-only context when the issue is missing.
- **Mutation check:** dropping the identity fields from the context
fails two cases.
- **Live instance:** for an affected workspace, the managed credential
resolved only with the responsible user and agent; with the issue id
alone, or with standing delegation, it did not.
- `pnpm exec vitest run git-credentials git-expiration-auth-fallback
git-workspace-expiration git-restore-point isolated-repository-rehome
nested-clone-migration` (in `server/`): 296 passed.
- `pnpm run typecheck` (in `server/`): pass.
- Not run: server build and boot smoke.
## Risks
- **Whose identity is used:** background jobs now use the issue's
responsible user's managed GitHub identity, which agent runs on that
issue already use. They only read: fetch, ls-remote and clone for
verification and restore.
- **Unchanged failure behavior:** if the identity is unavailable (for
example, the user is no longer a member), the existing anonymous
fallback applies, as before.
## Model Used
- Claude Opus 5.5 (`claude-opus-5-5`), 1M context, through Claude Code
with tool use (shell, file edits, tests, read-only diagnosis on a live
instance).
## 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
- [x] I have run tests locally and they pass
- [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
- [ ] I will address all Greptile and reviewer comments before
requesting merge
Co-authored-by: Paperclip <noreply@paperclip.ing>
This commit is contained in:
1 parent
5c3dce09b5
commit
cb47dbb2da
6 files changed
+60
-11
No files matched your search
@@ -9,6 +9,7 @@ import {
|
||||
GIT_CREDENTIAL_TOKEN_ENV_KEY,
|
||||
buildGitAuthInvocation,
|
||||
createGitRemoteAuthProvider,
|
||||
createIssueGitRemoteAuthProvider,
|
||||
describeGitAuthFailure,
|
||||
isGitHubHttpsRemoteUrl,
|
||||
scrubGitCredentialText,
|
||||
@@ -379,3 +380,39 @@ describe("DEFAULT_GITHUB_TOKEN_SECRET_NAMES", () => {
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("createIssueGitRemoteAuthProvider", () => {
|
||||
const githubUrl = "https://github.com/paperclipai/private-repo.git";
|
||||
function issueDb(rows: unknown[]) {
|
||||
const where = vi.fn(async () => rows);
|
||||
return { db: { select: vi.fn(() => ({ from: () => ({ where }) })) } as unknown as Db, where };
|
||||
}
|
||||
|
||||
it("resolves credentials with the issue's responsible user and assigned agent", async () => {
|
||||
const { db } = issueDb([{ responsibleUserId: "user-1", assigneeAgentId: "agent-1" }]);
|
||||
const inner = vi.fn(async () => ({ env: {}, configArgs: [], source: "managed_connection" }));
|
||||
const create = vi.fn(() => inner) as unknown as typeof createGitRemoteAuthProvider;
|
||||
const provider = createIssueGitRemoteAuthProvider(db, "company-1", "issue-1", create);
|
||||
await expect(provider(githubUrl)).resolves.toMatchObject({ source: "managed_connection" });
|
||||
expect(create).toHaveBeenCalledWith(db, "company-1", { issueId: "issue-1", responsibleUserId: "user-1", agentId: "agent-1" });
|
||||
expect(inner).toHaveBeenCalledWith(githubUrl);
|
||||
});
|
||||
|
||||
it("looks the issue up once across calls", async () => {
|
||||
const { db } = issueDb([{ responsibleUserId: "user-1", assigneeAgentId: null }]);
|
||||
const inner = vi.fn(async () => null);
|
||||
const create = vi.fn(() => inner) as unknown as typeof createGitRemoteAuthProvider;
|
||||
const provider = createIssueGitRemoteAuthProvider(db, "company-1", "issue-1", create);
|
||||
await provider(githubUrl); await provider(githubUrl);
|
||||
expect(db.select).toHaveBeenCalledTimes(1);
|
||||
expect(create).toHaveBeenCalledTimes(1);
|
||||
expect(inner).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("falls back to the issue-only context when the issue is missing", async () => {
|
||||
const { db } = issueDb([]);
|
||||
const create = vi.fn(() => vi.fn(async () => null)) as unknown as typeof createGitRemoteAuthProvider;
|
||||
await createIssueGitRemoteAuthProvider(db, "company-1", "issue-1", create)(githubUrl);
|
||||
expect(create).toHaveBeenCalledWith(db, "company-1", { issueId: "issue-1", responsibleUserId: null, agentId: null });
|
||||
});
|
||||
});
|
||||
@@ -98,7 +98,7 @@ import {
|
||||
type PullRequestMergeDetailsResolver,
|
||||
} from "./github-pull-request-merge.js";
|
||||
import { visibleIssueCondition } from "./issue-visibility.js";
|
||||
import { createGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { createIssueGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { readProjectWorkspaceRuntimeConfig } from "./project-workspace-runtime-config.js";
|
||||
import { workspaceGitOperationScheduler } from "./workspace-git-operation-scheduler.js";
|
||||
import { isRuntimeOwnedGitBranch } from "./execution-workspace-branch-ownership.js";
|
||||
@@ -4113,7 +4113,7 @@ export function executionWorkspaceService(db: Db, opts: ExecutionWorkspaceServic
|
||||
try { recipe = readGitCacheRestoration(snapshot); }
|
||||
catch { return { ok: false, code: "rebuild_failed", message: new GitCacheRestorationFailure().message }; }
|
||||
const freshStart = recipe !== null && isClosedExecutionWorkspaceStatus(snapshot.status) && gitRestorePointExpired(recipe);
|
||||
const gitAuth = createGitRemoteAuthProvider(db, snapshot.companyId, { issueId: issue.id });
|
||||
const gitAuth = createIssueGitRemoteAuthProvider(db, snapshot.companyId, issue.id);
|
||||
const [
|
||||
{ ensurePersistedExecutionWorkspaceAvailable },
|
||||
{ workspaceOperationService },
|
||||
@@ -4168,9 +4168,7 @@ export function executionWorkspaceService(db: Db, opts: ExecutionWorkspaceServic
|
||||
});
|
||||
};
|
||||
},
|
||||
resolveGitAuth: createGitRemoteAuthProvider(db, snapshot.companyId, {
|
||||
issueId: issue.id,
|
||||
}),
|
||||
resolveGitAuth: createIssueGitRemoteAuthProvider(db, snapshot.companyId, issue.id),
|
||||
});
|
||||
resolvedBaseCwd = managedWorkspace.cwd;
|
||||
} catch {
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import {
|
||||
companySecrets,
|
||||
heartbeatRuns,
|
||||
issues,
|
||||
companyMemberships,
|
||||
connectionGrantDelegations,
|
||||
connectionGrants,
|
||||
@@ -207,6 +208,19 @@ type GitCredentialSecretsDeps = {
|
||||
* provider instance so one run performs at most one secret resolution (and writes at most
|
||||
* one audit event) no matter how many git operations it authenticates.
|
||||
*/
|
||||
export function createIssueGitRemoteAuthProvider(db: Db, companyId: string, issueId: string,
|
||||
create: typeof createGitRemoteAuthProvider = createGitRemoteAuthProvider): GitRemoteAuthProvider {
|
||||
let provider: Promise<GitRemoteAuthProvider> | null = null;
|
||||
return async (remoteUrl: string) => {
|
||||
provider ??= db.select({ responsibleUserId: issues.responsibleUserId, assigneeAgentId: issues.assigneeAgentId }).from(issues)
|
||||
.where(and(eq(issues.id, issueId), eq(issues.companyId, companyId)))
|
||||
.then(([issue]) => create(db, companyId, {
|
||||
issueId, responsibleUserId: issue?.responsibleUserId ?? null, agentId: issue?.assigneeAgentId ?? null,
|
||||
}));
|
||||
return (await provider)(remoteUrl);
|
||||
};
|
||||
}
|
||||
|
||||
export function createGitRemoteAuthProvider(
|
||||
db: Db,
|
||||
companyId: string,
|
||||
|
||||
@@ -6,7 +6,7 @@ import { acquireGitExpirationLocks } from "./git-workspace-expiration-locks.js";
|
||||
import { and, eq, inArray, ne, sql } from "drizzle-orm";
|
||||
import { executionWorkspaces, issues, heartbeatRuns, nativeRunFinalizations, environmentLeases,
|
||||
workspaceRuntimeServices, issueRecoveryActions, projectWorkspaces, withDedicatedDbConnection, type Db } from "@paperclipai/db";
|
||||
import { createGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { createIssueGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import type { StorageService } from "../storage/types.js";
|
||||
import { TASK_DIRECTORY_RETENTION_KEY } from "./isolated-task-directory-snapshot.js";
|
||||
import { currentRestorePointSnapshot, RestorePointSkip, type RestorePointLimits } from "./git-restore-point.js";
|
||||
@@ -37,7 +37,7 @@ export function withAnonymousGitFallback(provider: GitRemoteAuthProvider): GitRe
|
||||
}
|
||||
|
||||
function expirationGitAuth(db: Db, workspace: Workspace) {
|
||||
return withAnonymousGitFallback(createGitRemoteAuthProvider(db, workspace.companyId, { issueId: workspace.sourceIssueId! }));
|
||||
return withAnonymousGitFallback(createIssueGitRemoteAuthProvider(db, workspace.companyId, workspace.sourceIssueId!));
|
||||
}
|
||||
|
||||
const EXPIRATION_KEY = "gitCacheExpiration";
|
||||
|
||||
@@ -23,7 +23,7 @@ import { withExecutionWorkspaceLifecycleLock } from "./execution-workspace-lifec
|
||||
import { loadGitRestorePoint } from "./git-restore-point-storage.js";
|
||||
import { nestedWorktreeBranchPrefix, readLinkedNestedCheckout, repairMovedNestedRepositoryWorktree, withNestedRepositoryBaseLock } from "./nested-repository-worktrees.js";
|
||||
import { getStorageService } from "../storage/index.js";
|
||||
import { createGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { createIssueGitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { resolvePaperclipInstanceRoot } from "../home-paths.js";
|
||||
|
||||
const execFile = promisify(execFileCallback);
|
||||
@@ -598,7 +598,7 @@ async function worktreeOfClone(worktree: string, cloneReal: string, signal?: Abo
|
||||
}
|
||||
|
||||
function upstreamCheck(db: Db, companyId: string, issueId: string, clone: string, repoUrl: string, signal?: AbortSignal): MissingUpstream {
|
||||
const auth = withAnonymousGitFallback(createGitRemoteAuthProvider(db, companyId, { issueId }));
|
||||
const auth = withAnonymousGitFallback(createIssueGitRemoteAuthProvider(db, companyId, issueId));
|
||||
return (commits, covered) => hasCommitsMissingUpstream(clone, commits, repoUrl, auth, signal, covered);
|
||||
}
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ import { GIT_CACHE_RESTORATION_KEY, readGitCacheRestoration, type GitCacheRestor
|
||||
import { readManagedCheckoutContents, selectRestoredProjectRepositories } from "./git-workspace-contents.js";
|
||||
import { applyRestorePoint, captureRestorePoint, currentRestorePointSnapshot, importRestorePoint } from "./git-restore-point.js";
|
||||
import { managedProjectCheckoutName } from "./managed-project-checkout-name.js";
|
||||
import { createGitRemoteAuthProvider, type GitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { createIssueGitRemoteAuthProvider, type GitRemoteAuthProvider } from "./git-credentials.js";
|
||||
import { isNestedWorktreeBranchName, isVerifiedNestedRepositoryBase, moveNestedRepositoryWorktree, nestedRepositoryBaseCandidates, nestedWorktreeBranchPrefix,
|
||||
readLinkedNestedCheckout, removeStaleNestedRegistrations, trackNestedWorktreeUpstream, withNestedRepositoryBaseLock } from "./nested-repository-worktrees.js";
|
||||
import { assertSafeBaseConfig, assertTransferredItems, historyKey, linkedCheckoutBases, moveTransferItems, presentCommits, returnTransferItems,
|
||||
@@ -442,7 +442,7 @@ export async function migrateNestedRepositoryClone(db: Db, snapshot: Workspace,
|
||||
const base = source.base;
|
||||
await assertSafeBaseConfig(base, signal);
|
||||
await fetchBase(base, source.repoUrl, options.resolveGitAuth
|
||||
?? withAnonymousGitFallback(createGitRemoteAuthProvider(db, row!.companyId, { issueId: row!.sourceIssueId! })), signal);
|
||||
?? withAnonymousGitFallback(createIssueGitRemoteAuthProvider(db, row!.companyId, row!.sourceIssueId!)), signal);
|
||||
await assertSafeBaseConfig(base, signal);
|
||||
await assertNoBranchOnlyReflogHistory(inspected, signal);
|
||||
const planned = await planRefs(inspected, base, prefix, signal);
|
||||
|
||||
Reference in new issue
Block a user