mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-31 22:24:16 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Paperclip runs the server and runner test suites with Vitest. > - Vitest 5 removes the deprecated `describe.sequential` property, so the pending Vitest 5 upgrade fails the type-check and test jobs. > - `describe.sequential` only changes behaviour inside a `describe.concurrent` suite, or when `sequence.concurrent` is on. > - This repository has neither, so the modifier changed nothing at run time. > - The benefit is that the Vitest 5 upgrade can land, and the test files lose a modifier that did no work. ## Linked Issues or Issue Description Refs: #12969 ## What Changed - Replace every `describe.sequential` use with a plain `describe` call. - Drop the `{ concurrent: false }` suite option from the two runner test files. - Add a comment to `server/vitest.config.ts` that records why these suites must run one test at a time. - Leave the package manifests and the lockfile unchanged. ## Why the modifier did nothing The Vitest documentation states that `describe.sequential` is useful to run tests in sequence inside a `describe.concurrent` suite, or with the `--sequence.concurrent` option. `sequence.concurrent` defaults to `false`. This repository satisfies neither condition: - No test file uses `describe.concurrent`, `it.concurrent`, or `test.concurrent`. - `server/vitest.config.ts` sets `sequence.concurrent: false`, with `maxWorkers: 1`, `maxConcurrency: 1`, and `isolate: true`. - `packages/paperclip-runner/vitest.config.ts` sets no `sequence` block, so the `false` default applies. `packages/db` and `cli` already run the same embedded-Postgres suites with a plain `describe`, and those jobs are green. The server package was the only outlier. The modifier did carry one real piece of knowledge: these suites need their tests to run one at a time. The new comment in `server/vitest.config.ts` records that reason next to the setting that enforces it. ## Verification - `git grep` for `describe.sequential` returns nothing outside `node_modules`. - The author ran the changed server test files under the installed Vitest 4, and the results match the results without this change. - Two very large embedded-Postgres test files exceeded the author's local memory limit, so the CI test jobs cover those two. - The two changed runner test files have pre-existing local failures caused by a missing Rust toolchain and a missing global `pnpm` binary. The failures are identical with and without this change. - The author type-checked the changed files and found no new error. - CI must pass the typecheck, build, server test, and runner verify jobs. ## Risks - Low risk. Suite execution stays serial, because the Vitest config enforces it. - The change adds no dependency and changes no package manifest or lockfile. - A future change that turns `sequence.concurrent` on would break these suites. The new config comment warns against it. ## Model Used - Claude Sonnet 5 — code edits and local verification. - OpenAI Codex, GPT-5 — the earlier revision of this branch. ## Test plan - [x] Every CI check reaches a terminal green state. A pending or queued check is not a pass. - [x] The `Typecheck + Release Registry` job passes. This change must not introduce a type error. - [x] The `Build` job passes. - [x] The server test jobs and the runner verify jobs pass. - [x] Greptile re-reviews this commit set and posts a passing verdict. The dependabot waiver does not apply to this pull request. - [x] `mergeable` reads `MERGEABLE` as a terminal value. ## 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 linked the related public issue with `Refs: #12969` - [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 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: Priya Raman <priya.raman@paperclip.ing> --------- Co-authored-by: Priya Raman <priya.raman@paperclip.ing> Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: nickyleach <331803+nickyleach@users.noreply.github.com>
196 lines
6.6 KiB
TypeScript
196 lines
6.6 KiB
TypeScript
import express from "express";
|
|
import request from "supertest";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
function createSelectChain(rows: unknown[]) {
|
|
const query = {
|
|
then(resolve: (value: unknown[]) => unknown) {
|
|
return Promise.resolve(rows).then(resolve);
|
|
},
|
|
where() {
|
|
return query;
|
|
},
|
|
};
|
|
return {
|
|
from() {
|
|
return query;
|
|
},
|
|
};
|
|
}
|
|
|
|
function createDbStub(inviteRows: unknown[]) {
|
|
return {
|
|
select() {
|
|
return createSelectChain(inviteRows);
|
|
},
|
|
};
|
|
}
|
|
|
|
function createInvite(overrides: Record<string, unknown> = {}) {
|
|
return {
|
|
id: "invite-1",
|
|
companyId: "company-1",
|
|
inviteType: "company_join",
|
|
allowedJoinTypes: "agent",
|
|
tokenHash: "hash",
|
|
defaultsPayload: null,
|
|
expiresAt: new Date("2027-03-07T00:10:00.000Z"),
|
|
invitedByUserId: null,
|
|
revokedAt: null,
|
|
acceptedAt: null,
|
|
createdAt: new Date("2026-03-07T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-03-07T00:00:00.000Z"),
|
|
...overrides,
|
|
};
|
|
}
|
|
|
|
async function createApp(
|
|
db: Record<string, unknown>,
|
|
network: {
|
|
lookup: ReturnType<typeof vi.fn>;
|
|
requestHead: ReturnType<typeof vi.fn>;
|
|
},
|
|
) {
|
|
const [access, middleware] = await Promise.all([
|
|
import("../routes/access.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
const app = express();
|
|
app.use((req, _res, next) => {
|
|
(req as any).actor = { type: "anon" };
|
|
next();
|
|
});
|
|
app.use(
|
|
"/api",
|
|
access.accessRoutes(db as any, {
|
|
deploymentMode: "local_trusted",
|
|
deploymentExposure: "private",
|
|
bindHost: "127.0.0.1",
|
|
allowedHostnames: [],
|
|
inviteResolutionNetwork: network,
|
|
}),
|
|
);
|
|
app.use(middleware.errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("GET /invites/:token/test-resolution", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("rejects private, local, multicast, and reserved targets before probing", async () => {
|
|
const cases = [
|
|
["localhost", "http://localhost:3100/api/health", "127.0.0.1"],
|
|
["IPv4 loopback", "http://127.0.0.1:3100/api/health", "127.0.0.1"],
|
|
["IPv6 loopback", "http://[::1]:3100/api/health", "::1"],
|
|
["IPv4-mapped IPv6 loopback hex", "http://[::ffff:7f00:1]/api/health", "::ffff:7f00:1"],
|
|
["IPv4-mapped IPv6 RFC1918 hex", "http://[::ffff:c0a8:101]/api/health", "::ffff:c0a8:101"],
|
|
["RFC1918 10/8", "http://10.0.0.5/api/health", "10.0.0.5"],
|
|
["RFC1918 172.16/12", "http://172.16.10.5/api/health", "172.16.10.5"],
|
|
["RFC1918 192.168/16", "http://192.168.1.10/api/health", "192.168.1.10"],
|
|
["link-local metadata", "http://169.254.169.254/latest/meta-data", "169.254.169.254"],
|
|
["multicast", "http://224.0.0.1/probe", "224.0.0.1"],
|
|
["NAT64 well-known prefix", "https://gateway.example.test/health", "64:ff9b::0a00:0001"],
|
|
["NAT64 local-use prefix", "https://gateway.example.test/health", "64:ff9b:1::0a00:0001"],
|
|
] as const;
|
|
|
|
for (const [label, url, address] of cases) {
|
|
const lookup = vi.fn().mockResolvedValue([{ address, family: address.includes(":") ? 6 : 4 }]);
|
|
const requestHead = vi.fn();
|
|
const app = await createApp(createDbStub([createInvite()]), { lookup, requestHead });
|
|
|
|
const res = await request(app)
|
|
.get("/api/invites/pcp_invite_test/test-resolution")
|
|
.query({ url });
|
|
|
|
expect(res.status, label).toBe(400);
|
|
expect(res.body.error).toBe(
|
|
"url resolves to a private, local, multicast, or reserved address",
|
|
);
|
|
expect(requestHead).not.toHaveBeenCalled();
|
|
}
|
|
}, 20_000);
|
|
|
|
it.sequential("rejects hostnames that resolve to private addresses", async () => {
|
|
const lookup = vi.fn().mockResolvedValue([{ address: "10.1.2.3", family: 4 }]);
|
|
const requestHead = vi.fn();
|
|
const app = await createApp(createDbStub([createInvite()]), { lookup, requestHead });
|
|
|
|
const res = await request(app)
|
|
.get("/api/invites/pcp_invite_test/test-resolution")
|
|
.query({ url: "https://gateway.example.test/health" });
|
|
|
|
expect(res.status).toBe(400);
|
|
expect(res.body.error).toBe(
|
|
"url resolves to a private, local, multicast, or reserved address",
|
|
);
|
|
expect(lookup).toHaveBeenCalledWith("gateway.example.test");
|
|
expect(requestHead).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.sequential("rejects hostnames when any resolved address is private", async () => {
|
|
const lookup = vi.fn().mockResolvedValue([
|
|
{ address: "127.0.0.1", family: 4 },
|
|
{ address: "93.184.216.34", family: 4 },
|
|
]);
|
|
const requestHead = vi.fn();
|
|
const app = await createApp(createDbStub([createInvite()]), { lookup, requestHead });
|
|
|
|
const res = await request(app)
|
|
.get("/api/invites/pcp_invite_test/test-resolution")
|
|
.query({ url: "https://mixed.example.test/health" });
|
|
|
|
expect(res.status).toBe(400);
|
|
expect(requestHead).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.sequential("allows public HTTPS targets through the resolved and pinned probe path", async () => {
|
|
const lookup = vi.fn().mockResolvedValue([{ address: "93.184.216.34", family: 4 }]);
|
|
const requestHead = vi.fn().mockResolvedValue({ httpStatus: 204 });
|
|
const app = await createApp(createDbStub([createInvite()]), { lookup, requestHead });
|
|
|
|
const res = await request(app)
|
|
.get("/api/invites/pcp_invite_test/test-resolution")
|
|
.query({ url: "https://gateway.example.test/health", timeoutMs: "2500" });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
inviteId: "invite-1",
|
|
requestedUrl: "https://gateway.example.test/health",
|
|
timeoutMs: 2500,
|
|
status: "reachable",
|
|
method: "HEAD",
|
|
httpStatus: 204,
|
|
});
|
|
expect(requestHead).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
resolvedAddress: "93.184.216.34",
|
|
resolvedAddresses: ["93.184.216.34"],
|
|
hostHeader: "gateway.example.test",
|
|
tlsServername: "gateway.example.test",
|
|
}),
|
|
2500,
|
|
);
|
|
});
|
|
|
|
it.sequential.each([
|
|
["missing invite", []],
|
|
["revoked invite", [createInvite({ revokedAt: new Date("2026-03-07T00:05:00.000Z") })]],
|
|
["expired invite", [createInvite({ expiresAt: new Date("2020-03-07T00:10:00.000Z") })]],
|
|
])("returns not found for %s tokens before DNS lookup", async (_label, inviteRows) => {
|
|
const lookup = vi.fn();
|
|
const requestHead = vi.fn();
|
|
const app = await createApp(createDbStub(inviteRows), { lookup, requestHead });
|
|
|
|
const res = await request(app)
|
|
.get("/api/invites/pcp_invite_test/test-resolution")
|
|
.query({ url: "https://gateway.example.test/health" });
|
|
|
|
expect(res.status).toBe(404);
|
|
expect(res.body.error).toBe("Invite not found");
|
|
expect(lookup).not.toHaveBeenCalled();
|
|
expect(requestHead).not.toHaveBeenCalled();
|
|
});
|
|
});
|