mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-14 17:40:37 +02:00
DottaandPaperclip
94e4218310
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Heartbeat runs start workspace services and receive service reports from adapters. > - Service context updates and readiness notices are spread through the executor. > - These steps share a clear responsibility, while process and lease ownership already live elsewhere. > - This pull request puts service coordination in one module. > - The executor retains the same dispatch and cleanup order. ## Linked Issues or Issue Description **What existing behavior does this improve?** Maintenance of heartbeat execution. This is the first of two final focused extractions after #15973. Related #15653 changes runtime callback origins; this PR preserves that policy. **Current behavior** `heartbeat.ts` has 4,372 lines and 178,459 bytes. It validates service intents, starts services, persists adapter reports and primary URLs, and posts readiness notices inline. **Proposed behavior** `heartbeat/runtime-services.ts` owns those steps in 212 lines. `heartbeat.ts` becomes 4,215 lines and 173,657 bytes. Process registries and leases stay in `workspace-runtime.ts`. The executor still releases services in its original cleanup path. **Reason and benefit** Service coordination has named preparation and result phases. The execution path is easier to read without changing service lifetime or moving cleanup policy. **Breaking changes** None intended. All 140 named public heartbeat exports remain available, including `postWorkspaceReadyComment`. ## What Changed - Move service-intent validation, startup, adapter-result persistence, and readiness notices into one module. - Preserve mutable run context, primary URL selection, notice error handling, and release ordering. - Add four public-path tests using disposable PostgreSQL, real HTTP service processes, and a fixture adapter. - Extend browser recovery acceptance to fetch the actual service URL, check the readiness notice, and verify listener cleanup. - Update the module map and acceptance instructions. ## Verification - Before extraction: all five tests pass, including the four new characterization cases and existing notice formatting test. - After extraction: all 17 tests pass across service coordination, notice formatting, output recording, and runtime authorization. - Structural comparison confirms that all moved bodies and the reconstructed executor match the baseline. Module boundary checks pass. - `pnpm -r typecheck` and `pnpm build` pass. - Extended isolated browser acceptance: **2/2 pass** (3.7 minutes), covering actual service readiness, recovery, bounded failure, and cleanup. At `8e33e2032de681082f128470eb8ab0711b382afe`, all 55 current-head checks pass (two configured skips), including hosted full-suite tests. Greptile is 5/5 with no findings or review threads. ## Risks - Service context must be persisted before adapter dispatch and before run completion. The tests inspect both phases and preserve the first service URL when adapter reports arrive. - Notice failures must remain nonfatal. The public-path test checks both startup and result notices. - Shared services must survive run cleanup; ephemeral services must stop after success or failure. Tests use actual processes and HTTP requests. - The fixture supplies UUID service report IDs, as required by the database. The existing generated-ID fallback for reports without IDs is outside this extraction. - Test adapters and services are local fixtures; these tests make no live provider calls. ## Model Used OpenAI Codex, based on GPT-6, assisted with reasoning, code edits, tool execution, and verification. The exact deployment model ID and context-window size are not exposed in this session. ## 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 - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge Co-authored-by: Paperclip <noreply@paperclip.ing>
41 lines
3.0 KiB
JavaScript
41 lines
3.0 KiB
JavaScript
// Deterministic process adapter, not a mocked task outcome. The worker must
|
|
// actually read the prepared repository and use its run-scoped task API.
|
|
import { readFile, readdir, writeFile, access } from "node:fs/promises";
|
|
import path from "node:path";
|
|
import assert from "node:assert/strict";
|
|
import { createHash } from "node:crypto";
|
|
|
|
const env = process.env;
|
|
const headers = { Authorization: `Bearer ${env.PAPERCLIP_API_KEY}`, "X-Paperclip-Run-Id": env.PAPERCLIP_RUN_ID, "Content-Type": "application/json" };
|
|
const api = async (route, method = "GET", body) => {
|
|
const response = await fetch(`${env.PAPERCLIP_API_URL}/api${route}`, { method, headers, body: body ? JSON.stringify(body) : undefined });
|
|
assert(response.ok, `${response.status}: ${await response.clone().text()}`);
|
|
return response.json();
|
|
};
|
|
const run = await api(`/heartbeat-runs/${env.PAPERCLIP_RUN_ID}`);
|
|
assert.equal(run.contextSnapshot.paperclipEnvironment.driver, "local");
|
|
const services = run.contextSnapshot.paperclipRuntimeServices;
|
|
assert.equal(services.length, 1);
|
|
assert.equal(services[0].serviceName, "fixture-web");
|
|
assert.equal(run.contextSnapshot.paperclipRuntimePrimaryUrl, services[0].url);
|
|
assert.equal(await fetch(services[0].url).then(response => response.text()), "workspace runtime service ready");
|
|
const issueId = run.contextSnapshot.issueId;
|
|
const issue = await api(`/issues/${issueId}`);
|
|
assert.equal(run.contextSnapshot.paperclipIssue.id, issue.id);
|
|
assert.equal(run.contextSnapshot.paperclipIssue.description, issue.description);
|
|
// The fixture's title equals its description; compact prompts keep the title.
|
|
const descriptionSection = `\nIssue description:\n\`\`\`text\n${issue.description}\n\`\`\``;
|
|
assert(run.contextSnapshot.paperclipTaskMarkdown.includes(descriptionSection));
|
|
assert(run.contextSnapshot.paperclipTaskMarkdownAssignment.includes(descriptionSection));
|
|
assert(!run.contextSnapshot.paperclipTaskMarkdownCompact.includes(descriptionSection));
|
|
assert(!run.contextSnapshot.paperclipTaskMarkdownAssignmentCompact.includes(descriptionSection));
|
|
assert.equal(run.contextSnapshot.paperclipTurnContext.assignment.description.revision,
|
|
createHash("sha256").update(issue.description.trim()).digest("hex"));
|
|
const repositories = await readdir(path.join(process.cwd(), ".paperclip-repositories"));
|
|
const repo = path.join(process.cwd(), ".paperclip-repositories", repositories.find((name) => !name.includes(".clone-")));
|
|
assert.equal(await readFile(path.join(repo, "README.md"), "utf8"), "Existing uncommitted work\n");
|
|
await assert.rejects(access(path.join(repo, "private.secret")));
|
|
await writeFile(path.join(repo, "recovery-proof.txt"), "Workspace recovered; existing work preserved; private files excluded.\n", { flag: "wx" });
|
|
await api(`/issues/${issueId}`, "PATCH", { status: "done", comment: "Workspace recovered automatically. I read the preserved uncommitted work, verified private files were excluded, and wrote recovery-proof.txt exactly once." });
|
|
console.log("Workspace recovery verification complete.");
|