mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-16 20:12:20 +01:00
> [!NOTE] > Opened by Prospector's automated issue-fix pipeline. A maintainer reviews and decides; nothing here merges on its own. ## Thinking Path - Issue #17332 reports a defect in paperclipai/paperclip. - Root cause, as the fixing agent read it: Plugin keys reached a UUID-column query, and Drizzle's nested PostgreSQL error bypassed the original error handler. The existing UUID guard fixes this; its non-multiline JavaScript regex also rejects trailing newlines. - This pull request: Preserve plugin UI UUID validation and test trailing line terminators ## What Changed - `server/src/routes/plugin-ui-static.ts`: Retain the existing guard, PostgreSQL UUID forms, and key fallback. - `server/src/__tests__/plugin-ui-static.test.ts`: Add route tests for four trailing line terminators and accepted PostgreSQL UUID forms. Confirmed the original lookup fails; all 58 focused tests and typecheck pass with the guard. ## Verification - Reproducing test(s), added in this PR: `server/src/__tests__/plugin-ui-static.test.ts` - They fail on the base commit and pass with the fix, each twice in a fresh sandbox. - 3 independent attempts wrote 3 reproductions; this fix passes every one of them. - The repository's compile command passes with the fix applied. - 2 existing test file(s) near the change passed. - The full test suite passes except for the 16 file(s) that already fail on the base commit. - Revised in 1 round(s) of automated code review. ## Risks - Written by an automated pipeline, not a person: review it as you would an outside contribution. - Risk tier of the touched paths: 2. ## Model Used - codex:gpt-6.1-sol, opus, sonnet (Anthropic Claude, via Claude Code; OpenAI, via the Codex CLI), writing and checking the change in an isolated sandbox. - opus (Anthropic Claude, via Claude Code), reviewing it independently. ## Linked Issues Fixes #17332 Other pull requests that name #17332: - #17433 (open): fix(plugins): serve a plugin UI bundle addressed by plugin key - #17335 (open): fix(server): serve plugin UI assets requested by plugin key ## 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 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) - [ ] 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 - [ ] 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 <!-- prospector:issue-fix v1 issue=17332 base=ca34bed25797 report=b2e95a170c3be729 --> Co-authored-by: commitperclip[bot] <284812584+commitperclip[bot]@users.noreply.github.com>
197 lines
6.4 KiB
TypeScript
197 lines
6.4 KiB
TypeScript
import express from "express";
|
|
import { randomUUID } from "node:crypto";
|
|
import { mkdirSync, rmSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import path from "node:path";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
|
|
const mockRegistry = vi.hoisted(() => ({
|
|
getById: vi.fn(),
|
|
getByKey: vi.fn(),
|
|
getConfig: vi.fn(),
|
|
}));
|
|
|
|
vi.mock("../services/plugin-registry.js", () => ({
|
|
pluginRegistryService: () => mockRegistry,
|
|
}));
|
|
|
|
const companyA = "22222222-2222-4222-8222-222222222222";
|
|
const companyB = "33333333-3333-4333-8333-333333333333";
|
|
const pluginId = "11111111-1111-4111-8111-111111111111";
|
|
const tempDirs: string[] = [];
|
|
let originalNodeEnv: string | undefined;
|
|
|
|
function createPluginPackage(source = "export default {};\n") {
|
|
const packageRoot = path.join(
|
|
tmpdir(),
|
|
`paperclip-plugin-ui-static-${randomUUID()}`,
|
|
);
|
|
const uiDir = path.join(packageRoot, "dist", "ui");
|
|
mkdirSync(uiDir, { recursive: true });
|
|
writeFileSync(path.join(uiDir, "index.js"), source);
|
|
tempDirs.push(packageRoot);
|
|
return packageRoot;
|
|
}
|
|
|
|
function readyPlugin(packageRoot: string) {
|
|
mockRegistry.getById.mockResolvedValue({
|
|
id: pluginId,
|
|
pluginKey: "paperclip.example",
|
|
packageName: "paperclip-plugin-example",
|
|
packagePath: packageRoot,
|
|
version: "1.0.0",
|
|
status: "ready",
|
|
manifestJson: {
|
|
id: "paperclip.example",
|
|
entrypoints: {
|
|
ui: "./dist/ui",
|
|
},
|
|
},
|
|
});
|
|
mockRegistry.getByKey.mockResolvedValue(null);
|
|
}
|
|
|
|
function boardActor(companyIds: string[]) {
|
|
return {
|
|
type: "board",
|
|
userId: "board-user",
|
|
source: "session",
|
|
isInstanceAdmin: false,
|
|
companyIds,
|
|
};
|
|
}
|
|
|
|
async function createApp(actor: Record<string, unknown>) {
|
|
const [{ pluginUiStaticRoutes }, { errorHandler }] = await Promise.all([
|
|
import("../routes/plugin-ui-static.js"),
|
|
import("../middleware/index.js"),
|
|
]);
|
|
|
|
const app = express();
|
|
app.use((req, _res, next) => {
|
|
req.actor = actor as typeof req.actor;
|
|
next();
|
|
});
|
|
app.use(pluginUiStaticRoutes({} as never, { localPluginDir: tmpdir() }));
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
describe("plugin UI static route", () => {
|
|
beforeEach(() => {
|
|
originalNodeEnv = process.env.NODE_ENV;
|
|
vi.resetAllMocks();
|
|
vi.unstubAllGlobals();
|
|
});
|
|
|
|
afterEach(() => {
|
|
vi.unstubAllGlobals();
|
|
if (originalNodeEnv === undefined) {
|
|
delete process.env.NODE_ENV;
|
|
} else {
|
|
process.env.NODE_ENV = originalNodeEnv;
|
|
}
|
|
while (tempDirs.length > 0) {
|
|
const dir = tempDirs.pop();
|
|
if (dir) rmSync(dir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("serves built UI assets publicly when no company context is requested", async () => {
|
|
readyPlugin(createPluginPackage("export const marker = 'static-bundle';\n"));
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app).get(`/_plugins/${pluginId}/ui/index.js`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toContain("static-bundle");
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it.each([200, 404])("resolves plugin keys without querying the UUID column (%s)", async (status) => {
|
|
readyPlugin(createPluginPackage("export const marker = 'key-bundle';\n"));
|
|
const plugin = await mockRegistry.getById();
|
|
mockRegistry.getById.mockClear();
|
|
mockRegistry.getById.mockRejectedValue(Object.assign(new Error("Failed query"), {
|
|
cause: Object.assign(new Error("invalid input syntax for type uuid"), { code: "22P02" }),
|
|
}));
|
|
mockRegistry.getByKey.mockResolvedValue(status === 200 ? plugin : null);
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app).get("/_plugins/paperclip.example/ui/index.js");
|
|
|
|
expect(res.status).toBe(status);
|
|
if (status === 200) expect(res.text).toContain("key-bundle");
|
|
expect(mockRegistry.getById).not.toHaveBeenCalled();
|
|
expect(mockRegistry.getByKey).toHaveBeenCalledWith("paperclip.example");
|
|
});
|
|
|
|
it("preserves key fallback for UUID-shaped plugin keys", async () => {
|
|
readyPlugin(createPluginPackage("export const marker = 'fallback-bundle';\n"));
|
|
const plugin = await mockRegistry.getById();
|
|
mockRegistry.getById.mockResolvedValue(null);
|
|
mockRegistry.getByKey.mockResolvedValue(plugin);
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app).get(`/_plugins/${pluginId}/ui/index.js`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toContain("fallback-bundle");
|
|
expect(mockRegistry.getByKey).toHaveBeenCalledWith(pluginId);
|
|
});
|
|
|
|
it("requires authentication before reading company-scoped devUiUrl config", async () => {
|
|
readyPlugin(createPluginPackage());
|
|
const app = await createApp({ type: "none", source: "none" });
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("rejects cross-company companyId before reading devUiUrl config", async () => {
|
|
readyPlugin(createPluginPackage());
|
|
const app = await createApp(boardActor([companyA]));
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyB });
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.error).toMatch(/does not have access/i);
|
|
expect(mockRegistry.getConfig).not.toHaveBeenCalled();
|
|
});
|
|
|
|
it("proxies devUiUrl only after company access succeeds", async () => {
|
|
process.env.NODE_ENV = "development";
|
|
readyPlugin(createPluginPackage());
|
|
mockRegistry.getConfig.mockResolvedValue({
|
|
configJson: {
|
|
devUiUrl: "http://localhost:5173/",
|
|
},
|
|
});
|
|
const fetchMock = vi.fn().mockResolvedValue(new Response("hot bundle", {
|
|
status: 200,
|
|
headers: { "content-type": "application/javascript" },
|
|
}));
|
|
vi.stubGlobal("fetch", fetchMock);
|
|
const app = await createApp(boardActor([companyA]));
|
|
|
|
const res = await request(app)
|
|
.get(`/_plugins/${pluginId}/ui/index.js`)
|
|
.query({ companyId: companyA });
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.text).toBe("hot bundle");
|
|
expect(mockRegistry.getConfig).toHaveBeenCalledWith(pluginId, companyA);
|
|
expect(fetchMock).toHaveBeenCalledWith(
|
|
"http://localhost:5173/index.js",
|
|
expect.objectContaining({ signal: expect.any(Object) }),
|
|
);
|
|
});
|
|
});
|