Repository navigation
Expand file tree
/
Copy pathforge-adapter.ts
More file actions
402 lines (365 loc) · 17.1 KB
/
Copy pathforge-adapter.ts
File metadata and controls
402 lines (365 loc) · 17.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
import { mkdir } from 'fs/promises'
import { existsSync, readFileSync, appendFileSync, realpathSync } from 'fs'
import type { Logger, LoopSandboxSettings } from '../types'
import type { SandboxManager } from '../sandbox/manager'
import { LOOP_SANDBOX_EXTRA_KEY, readLoopSandboxSettings } from '../sandbox/loop-settings'
import { getForgeWorkspaceBaseRef, getForgeWorkspaceBranch } from './forge-worktree'
import { describeBranchInUse, describeBranchReuseConflict } from './loop-branch'
import { forgeWorktreeDir, forgeWorktreeSlug, forgeWorktreesRoot, resolveLoopBranchName } from './forge-naming'
import { cleanupLoopWorktree } from '../utils/worktree-cleanup'
import { defaultGitService, type GitService } from '../utils/git-service'
import { writeWorktreeOpencodeConfig, WORKTREE_OPENCODE_CONFIG_FILENAME } from './worktree-opencode-config'
import { commitWorktreeChanges } from './worktree-commit'
import { sandboxContainerName } from '../sandbox/msb'
import { CODE_GRAPH_LINK_NAME } from '../constants/loop'
export interface ForgeWorkspaceInfo {
id: string
type: string
name: string
branch: string | null
directory: string | null
extra: unknown | null
projectID: string
}
export interface ForgeWorkspaceAdapter {
configure(info: ForgeWorkspaceInfo): ForgeWorkspaceInfo
create(info: ForgeWorkspaceInfo): Promise<void>
remove(info: ForgeWorkspaceInfo): Promise<void>
}
/**
* Runtime context for a forge workspace teardown: whether the adapter commits
* pending changes and whether it removes the worktree directory. Populated by
* the caller (loop termination side-effects, etc.) before
* `client.workspace.remove` is invoked.
*
* When no context is registered (orphan sweep, TUI delete without an active
* loop), the adapter falls back to sensible defaults.
*/
export interface TeardownContext {
doCommit: boolean
/** When false the worktree directory stays in place for restart. */
doRemoveWorktree: boolean
}
export type TeardownContextProvider = (loopName: string) => TeardownContext | undefined
export interface ForgeAdapterDeps {
dataDir: string
logger: Logger
sandboxManager?: Pick<SandboxManager, 'start' | 'stop'> | null
/**
* Lookup runtime teardown context (doCommit, doRemoveWorktree) for a loop.
* Optional: when absent or returning undefined, the adapter uses defaults.
*/
getTeardownContext?: TeardownContextProvider
/** Inject a custom GitService (defaults to real git if omitted). */
gitService?: GitService
/** Inline opencode config written as opencode.jsonc into each worktree (skip-if-exists). */
worktreeOpencodeConfig?: Record<string, unknown>
/**
* Whether the code-graph integration is on (`isCodeGraphEnabled(config)`). A provisioned sandbox
* links `CODE_GRAPH_LINK_NAME` into the worktree, so it is excluded from git only when this is not
* `false`. Unset means on.
*/
codeGraphEnabled?: boolean
}
const DEFAULT_TEARDOWN_CONTEXT: TeardownContext = {
doCommit: true,
doRemoveWorktree: true,
}
const BRANCH_IN_USE_PATTERNS = [
/is already checked out at ['"]([^'"]+)['"]/i,
/is already used by worktree at ['"]([^'"]+)['"]/i,
]
function parseBranchInUsePath(stderr: string): string | null {
for (const pattern of BRANCH_IN_USE_PATTERNS) {
const match = pattern.exec(stderr)
if (match) return match[1]
}
return null
}
function isSameDirectory(a: string, b: string): boolean {
if (a === b) return true
try {
return realpathSync(a) === realpathSync(b)
} catch {
return false
}
}
/**
* Builds the `worktree add` failure error. A branch already held by a different worktree maps to
* the wording `validateLoopBranchRequest` uses; every other failure, and a holder that is this
* workspace's own directory (handled by the orphan reuse/cleanup path), keeps the raw git stderr.
*/
function worktreeAddFailure(branch: string, directory: string, stderr: string): Error {
const holder = parseBranchInUsePath(stderr)
if (holder !== null && !isSameDirectory(holder, directory)) {
return new Error(`forge workspace adapter: ${describeBranchInUse(branch, holder)}`)
}
return new Error(`git worktree add failed: ${stderr}`)
}
export function createForgeWorkspaceAdapter(deps: ForgeAdapterDeps): ForgeWorkspaceAdapter {
const { dataDir, logger, sandboxManager, getTeardownContext, gitService: gitServiceOpt, worktreeOpencodeConfig, codeGraphEnabled } = deps
const git = gitServiceOpt ?? defaultGitService
function deriveLoopName(info: ForgeWorkspaceInfo): string {
const extra = (info.extra ?? {}) as { loopName?: unknown }
const raw = typeof extra.loopName === 'string' ? extra.loopName : ''
if (!raw) throw new Error('forge workspace adapter: extra.loopName is required')
return forgeWorktreeSlug(raw)
}
function deriveProjectDirectory(info: ForgeWorkspaceInfo): string {
const extra = (info.extra ?? {}) as { projectDirectory?: unknown }
const dir = typeof extra.projectDirectory === 'string' ? extra.projectDirectory : ''
if (!dir) throw new Error('forge workspace adapter: extra.projectDirectory is required')
return dir
}
/**
* Reads this workspace's per-loop sandbox settings from `extra.loopSandbox`, validating the
* untrusted payload through the shared reader. Returns undefined when nothing valid is present.
*/
function readLoopSandbox(info: ForgeWorkspaceInfo): LoopSandboxSettings | undefined {
const extra = (info.extra ?? {}) as Record<string, unknown>
return readLoopSandboxSettings(extra[LOOP_SANDBOX_EXTRA_KEY])
}
/**
* Whether this workspace's loop explicitly opted out of the sandbox, via the per-loop settings
* (`extra.loopSandbox.enabled === false`) or the legacy flag (`extra.forgeLoop.sandboxEnabled
* === false`). Provisioning must honor the per-loop flag even when the config has the sandbox
* enabled.
*/
function isLoopSandboxOptedOut(info: ForgeWorkspaceInfo): boolean {
if (readLoopSandbox(info)?.enabled === false) return true
const forgeLoop = ((info.extra ?? {}) as { forgeLoop?: unknown }).forgeLoop
if (typeof forgeLoop !== 'object' || forgeLoop === null) return false
return (forgeLoop as { sandboxEnabled?: unknown }).sandboxEnabled === false
}
function addToGitExclude(directory: string, patterns: string[]): void {
if (patterns.length === 0) return
const excludeRes = git.revParseGitPath(directory, 'info/exclude')
if (!excludeRes.ok || !excludeRes.stdout) return
const excludeFile = excludeRes.stdout.trim()
try {
const content = existsSync(excludeFile) ? readFileSync(excludeFile, 'utf-8') : ''
const present = new Set(content.split('\n').map((l) => l.trim()))
const missing = patterns.filter((p) => !present.has(p))
if (missing.length > 0) {
appendFileSync(excludeFile, `\n${missing.join('\n')}\n`)
logger.log(`forge-adapter: added ${missing.join(', ')} to git exclude in ${directory}`)
}
} catch (err) {
logger.log(`forge-adapter: could not update git exclude: ${err instanceof Error ? err.message : String(err)}`)
}
}
function resolveLoopName(info: ForgeWorkspaceInfo): string {
try {
return deriveLoopName(info)
} catch {
return info.name || 'unknown'
}
}
async function stepCommitChanges(directory: string, branchLabel: string, ctx: TeardownContext): Promise<void> {
if (!ctx.doCommit || !existsSync(directory)) return
try {
const message = 'Apply remaining changes'
const outcome = commitWorktreeChanges(git, logger, directory, message)
if (outcome === 'committed') {
logger.log(`forge-adapter: committed pending changes on ${branchLabel}`)
} else if (outcome === 'no-changes') {
logger.log(`forge-adapter: no pending changes to commit on ${branchLabel}`)
} else {
logger.log(`forge-adapter: commit failed on ${branchLabel}`)
}
} catch (err) {
logger.error('forge-adapter: commit step threw during teardown', err)
}
}
async function stepStopSandbox(sandboxManager: Pick<SandboxManager, 'start' | 'stop'> | null | undefined, name: string | undefined): Promise<void> {
if (!sandboxManager || !name) return
await sandboxManager.stop(name).catch((err) => {
logger.log(`forge-adapter: sandbox stop failed for ${name}: ${err instanceof Error ? err.message : String(err)}`)
})
}
/**
* Stamps the attach timestamps with the creation time. `configure` runs
* exactly once at creation, so it is the single normalization point for the
* attach/pending-start grace windows evaluated in classify-stale.ts.
*/
function restampAttachTimestamps(extra: unknown): unknown {
if (typeof extra !== 'object' || extra === null) return extra
const now = Date.now()
const record = extra as Record<string, unknown>
const result: Record<string, unknown> = { ...record, workspaceCreatedAt: now }
const forgeLoop = record.forgeLoop
if (
typeof forgeLoop === 'object' &&
forgeLoop !== null &&
typeof (forgeLoop as Record<string, unknown>).pendingAttachStartedAt === 'number'
) {
result.forgeLoop = { ...(forgeLoop as Record<string, unknown>), pendingAttachStartedAt: now }
}
return result
}
async function stepRemoveWorktree(worktreeDir: string, ctx: TeardownContext): Promise<void> {
if (!ctx.doRemoveWorktree) return
const result = await cleanupLoopWorktree({
worktreeDir,
logPrefix: 'forge-adapter',
logger,
git,
})
if (result.error) {
throw new Error(result.error)
}
}
return {
configure(info) {
const loopName = deriveLoopName(info)
return {
...info,
name: loopName,
branch: resolveLoopBranchName(loopName, getForgeWorkspaceBranch(info)),
directory: forgeWorktreeDir(dataDir, loopName),
extra: restampAttachTimestamps(info.extra),
}
},
async create(info) {
if (!info.directory || !info.branch) {
throw new Error('forge workspace adapter: configure must set directory and branch')
}
const projectDir = deriveProjectDirectory(info)
await mkdir(forgeWorktreesRoot(dataDir), { recursive: true })
if (!git.isInsideWorkTree(projectDir)) {
throw new Error(`forge workspace adapter: projectDirectory ${projectDir} is not a git work tree`)
}
// Detect orphan state from a prior failed run: branch may exist without a live worktree.
const branchExists = git.branchExists(projectDir, info.branch)
const baseRef = getForgeWorkspaceBaseRef(info)
// Prune dead worktree records first so `git worktree add` can re-use an orphaned branch.
git.worktreePrune(projectDir)
if (baseRef) {
if (branchExists) {
const conflict = describeBranchReuseConflict(git, projectDir, info.branch, baseRef)
if (conflict !== null) {
throw new Error(`forge workspace adapter: ${conflict}`)
}
const forceRes = git.branchForceUpdate(projectDir, info.branch, baseRef)
if (!forceRes.ok) {
const stderr = forceRes.stderr.trim() || 'unknown error'
logger.error(`forge-adapter: git branch -f failed: ${stderr}`)
throw new Error(`git branch -f failed: ${stderr}`)
}
}
const res = branchExists
? git.worktreeAdd(projectDir, info.directory, info.branch, false)
: git.worktreeAdd(projectDir, info.directory, info.branch, true, baseRef)
if (!res.ok) {
const stderr = res.stderr.trim() || 'unknown error'
logger.error(`forge-adapter: git worktree add failed: ${stderr}`)
if (existsSync(info.directory)) {
const cleanup = await cleanupLoopWorktree({
worktreeDir: info.directory,
logPrefix: 'forge-adapter:create:based-cleanup',
logger,
git,
})
if (!cleanup.removed) {
logger.error(`forge-adapter: cleanup after failed based create failed for ${info.directory}: ${cleanup.error ?? 'unknown error'}`)
}
}
git.worktreePrune(projectDir)
throw worktreeAddFailure(info.branch, info.directory, stderr)
}
logger.log(`forge-adapter: created worktree ${info.directory} on branch ${info.branch} (based on ${baseRef})${branchExists ? ` (fast-forwarded existing branch to ${baseRef})` : ''}`)
} else {
let res = git.worktreeAdd(projectDir, info.directory, info.branch, !branchExists)
let reusedOrphan = false
if (!res.ok) {
const stderr = res.stderr.trim() || 'unknown error'
const isAlreadyExists = /already exists/i.test(stderr) || /is already (checked out|registered)/i.test(stderr)
if (isAlreadyExists && existsSync(info.directory)) {
const existingBranch = git.currentBranch(info.directory)
if (existingBranch === info.branch) {
logger.log(`forge-adapter: reusing existing worktree ${info.directory} on branch ${info.branch}`)
reusedOrphan = true
} else {
logger.log(`forge-adapter: worktree directory ${info.directory} already exists; cleaning up orphan and retrying`)
const cleanup = await cleanupLoopWorktree({
worktreeDir: info.directory,
logPrefix: 'forge-adapter:create:orphan-cleanup',
logger,
git,
})
if (!cleanup.removed) {
logger.error(`forge-adapter: orphan cleanup failed for ${info.directory}: ${cleanup.error ?? 'unknown error'}`)
throw new Error(`git worktree add failed: ${stderr}`)
}
res = git.worktreeAdd(projectDir, info.directory, info.branch, !branchExists)
if (!res.ok) {
const retryStderr = res.stderr.trim() || 'unknown error'
logger.error(`forge-adapter: git worktree add still failed after orphan cleanup: ${retryStderr}`)
throw worktreeAddFailure(info.branch, info.directory, retryStderr)
}
reusedOrphan = true
}
} else {
logger.error(`forge-adapter: git worktree add failed: ${stderr}`)
throw worktreeAddFailure(info.branch, info.directory, stderr)
}
}
logger.log(`forge-adapter: created worktree ${info.directory} on branch ${info.branch}${branchExists ? ' (reused existing branch)' : ''}${reusedOrphan ? ' (after orphan cleanup)' : ''}`)
}
// Idempotently add .forge/ (overflow/scratch), the sandbox code-graph link,
// and any forge-written opencode config to git exclude so they never enter
// loop commits.
const excludePatterns = ['.forge/']
const sandboxProvisioned = Boolean(sandboxManager) && !isLoopSandboxOptedOut(info)
if (sandboxProvisioned && codeGraphEnabled !== false) {
excludePatterns.push(CODE_GRAPH_LINK_NAME)
}
const cfgResult = writeWorktreeOpencodeConfig({
directory: info.directory,
config: worktreeOpencodeConfig,
sandboxContainerName: sandboxProvisioned ? sandboxContainerName(info.name) : undefined,
logger,
})
if (cfgResult.written) {
excludePatterns.push(WORKTREE_OPENCODE_CONFIG_FILENAME)
}
addToGitExclude(info.directory, excludePatterns)
if (sandboxManager && isLoopSandboxOptedOut(info)) {
logger.log(`forge-adapter: skipping sandbox provisioning for ${info.name} (loop opted out via sandboxEnabled=false)`)
} else if (sandboxManager) {
try {
const startedAt = new Date().toISOString()
const sandbox = await sandboxManager.start(info.name, info.directory, startedAt, readLoopSandbox(info))
logger.log(`forge-adapter: sandbox container ${sandbox.containerName} started for ${info.name}`)
} catch (err) {
logger.error(`forge-adapter: sandbox provisioning failed for ${info.name}`, err)
await sandboxManager.stop(info.name).catch((stopErr) => {
logger.error(`forge-adapter: failed to stop sandbox after provisioning failure for ${info.name}`, stopErr)
})
if (existsSync(info.directory)) {
const cleanup = git.worktreeRemove(projectDir, info.directory)
if (!cleanup.ok) {
logger.error(`forge-adapter: failed to remove worktree after sandbox failure: ${cleanup.stderr.trim() || 'unknown error'}`)
}
}
git.worktreePrune(projectDir)
throw err
}
}
},
async remove(info) {
if (!info.directory) return
const loopName = resolveLoopName(info)
const ctx = getTeardownContext?.(loopName) ?? DEFAULT_TEARDOWN_CONTEXT
// Always commit changes so work isn't lost — skip only when the worktree
// directory itself is already gone.
await stepCommitChanges(info.directory, info.branch ?? '<branch>', ctx)
// Stop sandbox container if running.
await stepStopSandbox(sandboxManager, info.name)
// Remove the worktree directory and prune dead records.
// Skip on error/stall/abort so restart can reuse it.
await stepRemoveWorktree(info.directory, ctx)
// Branches are never deleted — `forge/*` scratch branches stay in place for potential restart.
},
}
}