forked from farhoodlabs/paperclip
7f893ac4ec
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - Reliable execution depends on heartbeat routing, issue lifecycle semantics, telemetry, and a fast enough local verification loop to keep regressions visible > - The remaining commits on this branch were mostly server/runtime correctness fixes plus test and documentation follow-ups in that area > - Those changes are logically separate from the UI-focused issue-detail and workspace/navigation branches even when they touch overlapping issue APIs > - This pull request groups the execution reliability, heartbeat, telemetry, and tooling changes into one standalone branch > - The benefit is a focused review of the control-plane correctness work, including the follow-up fix that restored the implicit comment-reopen helpers after branch splitting ## What Changed - Hardened issue/heartbeat execution behavior, including self-review stage skipping, deferred mention wakes during active execution, stranded execution recovery, active-run scoping, assignee resolution, and blocked-to-todo wake resumption - Reduced noisy polling/logging overhead by trimming issue run payloads, compacting persisted run logs, silencing high-volume request logs, and capping heartbeat-run queries in dashboard/inbox surfaces - Expanded telemetry and status semantics with adapter/model fields on task completion plus clearer status guidance in docs/onboarding material - Updated test infrastructure and verification defaults with faster route-test module isolation, cheaper default `pnpm test`, e2e isolation from local state, and repo verification follow-ups - Included docs/release housekeeping from the branch and added a small follow-up commit restoring the implicit comment-reopen helpers that were dropped during branch reconstruction ## Verification - `pnpm vitest run server/src/__tests__/issue-comment-reopen-routes.test.ts server/src/__tests__/issue-telemetry-routes.test.ts` - `pnpm vitest run server/src/__tests__/http-log-policy.test.ts server/src/__tests__/heartbeat-run-log.test.ts server/src/__tests__/health.test.ts` - `server/src/__tests__/activity-service.test.ts`, `server/src/__tests__/heartbeat-comment-wake-batching.test.ts`, and `server/src/__tests__/heartbeat-process-recovery.test.ts` were attempted on this host but the embedded Postgres harness reported init-script/data-dir problems and skipped or failed to start, so they are noted as environment-limited ## Risks - Medium: this branch changes core issue/heartbeat routing and reopen/wakeup behavior, so regressions would affect agent execution flow rather than isolated UI polish - Because it also updates verification infrastructure, reviewers should pay attention to whether the new tests are asserting the right failure modes and not just reshaping harness behavior ## Model Used - OpenAI Codex coding agent (GPT-5-class runtime in Codex CLI; exact deployed model ID is not exposed in this environment), reasoning enabled, tool use and local code execution enabled ## 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) - [ ] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [ ] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
324 lines
11 KiB
TypeScript
324 lines
11 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockCompanyService = vi.hoisted(() => ({
|
|
list: vi.fn(),
|
|
stats: vi.fn(),
|
|
getById: vi.fn(),
|
|
create: vi.fn(),
|
|
update: vi.fn(),
|
|
archive: vi.fn(),
|
|
remove: vi.fn(),
|
|
}));
|
|
|
|
const mockAgentService = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
}));
|
|
|
|
const mockAccessService = vi.hoisted(() => ({
|
|
ensureMembership: vi.fn(),
|
|
}));
|
|
|
|
const mockBudgetService = vi.hoisted(() => ({
|
|
upsertPolicy: vi.fn(),
|
|
}));
|
|
|
|
const mockCompanyPortabilityService = vi.hoisted(() => ({
|
|
exportBundle: vi.fn(),
|
|
previewExport: vi.fn(),
|
|
previewImport: vi.fn(),
|
|
importBundle: vi.fn(),
|
|
}));
|
|
|
|
const mockLogActivity = vi.hoisted(() => vi.fn());
|
|
const mockFeedbackService = vi.hoisted(() => ({
|
|
listIssueVotesForUser: vi.fn(),
|
|
listFeedbackTraces: vi.fn(),
|
|
getFeedbackTraceById: vi.fn(),
|
|
saveIssueVote: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/index.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
agentService: () => mockAgentService,
|
|
budgetService: () => mockBudgetService,
|
|
companyPortabilityService: () => mockCompanyPortabilityService,
|
|
companyService: () => mockCompanyService,
|
|
feedbackService: () => mockFeedbackService,
|
|
logActivity: mockLogActivity,
|
|
}));
|
|
|
|
function registerModuleMocks() {
|
|
vi.doMock("../services/index.js", () => ({
|
|
accessService: () => mockAccessService,
|
|
agentService: () => mockAgentService,
|
|
budgetService: () => mockBudgetService,
|
|
companyPortabilityService: () => mockCompanyPortabilityService,
|
|
companyService: () => mockCompanyService,
|
|
feedbackService: () => mockFeedbackService,
|
|
logActivity: mockLogActivity,
|
|
}));
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>) {
|
|
const [{ companyRoutes }, { errorHandler }] = await Promise.all([
|
|
vi.importActual<typeof import("../routes/companies.js")>("../routes/companies.js"),
|
|
vi.importActual<typeof import("../middleware/index.js")>("../middleware/index.js"),
|
|
]);
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = actor;
|
|
next();
|
|
});
|
|
app.use("/api/companies", companyRoutes({} as any));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("company portability routes", () => {
|
|
beforeEach(() => {
|
|
vi.resetModules();
|
|
vi.doUnmock("../routes/companies.js");
|
|
vi.doUnmock("../routes/authz.js");
|
|
vi.doUnmock("../middleware/index.js");
|
|
registerModuleMocks();
|
|
vi.resetAllMocks();
|
|
});
|
|
|
|
it("rejects non-CEO agents from CEO-safe export preview routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "engineer",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/exports/preview")
|
|
.send({ include: { company: true, agents: true, projects: true } });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Only CEO agents");
|
|
expect(mockCompanyPortabilityService.previewExport).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("allows CEO agents to use company-scoped export preview routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "ceo",
|
|
});
|
|
mockCompanyPortabilityService.previewExport.mockResolvedValue({
|
|
rootPath: "paperclip",
|
|
manifest: { agents: [], skills: [], projects: [], issues: [], envInputs: [], includes: { company: true, agents: true, projects: true, issues: false, skills: false }, company: null, schemaVersion: 1, generatedAt: new Date().toISOString(), source: null },
|
|
files: {},
|
|
fileInventory: [],
|
|
counts: { files: 0, agents: 0, skills: 0, projects: 0, issues: 0 },
|
|
warnings: [],
|
|
paperclipExtensionPath: ".paperclip.yaml",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/exports/preview")
|
|
.send({ include: { company: true, agents: true, projects: true } });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body.rootPath).toBe("paperclip");
|
|
});
|
|
|
|
it("rejects replace collision strategy on CEO-safe import routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "ceo",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/imports/preview")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "existing_company", companyId: "11111111-1111-4111-8111-111111111111" },
|
|
collisionStrategy: "replace",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("does not allow replace");
|
|
expect(mockCompanyPortabilityService.previewImport).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("keeps global import preview routes board-only", async () => {
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/import/preview")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "existing_company", companyId: "11111111-1111-4111-8111-111111111111" },
|
|
collisionStrategy: "rename",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Board access required");
|
|
});
|
|
|
|
it("requires instance admin for new-company import preview", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["11111111-1111-4111-8111-111111111111"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/import/preview")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "new_company", newCompanyName: "Imported Test" },
|
|
collisionStrategy: "rename",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Instance admin");
|
|
expect(mockCompanyPortabilityService.previewImport).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects replace collision strategy on CEO-safe import apply routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "ceo",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/imports/apply")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "existing_company", companyId: "11111111-1111-4111-8111-111111111111" },
|
|
collisionStrategy: "replace",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("does not allow replace");
|
|
expect(mockCompanyPortabilityService.importBundle).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects non-CEO agents from CEO-safe import preview routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "engineer",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/imports/preview")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "existing_company", companyId: "11111111-1111-4111-8111-111111111111" },
|
|
collisionStrategy: "rename",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Only CEO agents");
|
|
expect(mockCompanyPortabilityService.previewImport).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects non-CEO agents from CEO-safe import apply routes", async () => {
|
|
mockAgentService.getById.mockResolvedValue({
|
|
id: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
role: "engineer",
|
|
});
|
|
const app = await createApp({
|
|
type: "agent",
|
|
agentId: "agent-1",
|
|
companyId: "11111111-1111-4111-8111-111111111111",
|
|
source: "agent_key",
|
|
runId: "run-1",
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/11111111-1111-4111-8111-111111111111/imports/apply")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "existing_company", companyId: "11111111-1111-4111-8111-111111111111" },
|
|
collisionStrategy: "rename",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Only CEO agents");
|
|
expect(mockCompanyPortabilityService.importBundle).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("requires instance admin for new-company import apply", async () => {
|
|
const app = await createApp({
|
|
type: "board",
|
|
userId: "user-1",
|
|
companyIds: ["11111111-1111-4111-8111-111111111111"],
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
});
|
|
|
|
const res = await request(app)
|
|
.post("/api/companies/import")
|
|
.send({
|
|
source: { type: "inline", files: { "COMPANY.md": "---\nname: Test\n---\n" } },
|
|
include: { company: true, agents: true, projects: false, issues: false },
|
|
target: { mode: "new_company", newCompanyName: "Imported Test" },
|
|
collisionStrategy: "rename",
|
|
});
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toContain("Instance admin");
|
|
expect(mockCompanyPortabilityService.importBundle).not.toHaveBeenCalled();
|
|
});
|
|
});
|