mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-15 18:30:39 +09:00
[codex] Speed up company skill detail loading (#4380)
## Thinking Path > - Paperclip orchestrates AI agents for zero-human companies > - Company skills are part of the control plane for distributing reusable capabilities > - Board flows that inspect company skill detail should stay responsive because they are operator-facing control-plane reads > - The existing detail path was doing broader work than needed for the specific detail screen > - This pull request narrows that company-skill detail loading path and adds a regression test around it > - The benefit is faster company skill detail reads without changing the external API contract ## What Changed - tightened the company-skill detail loading path in `server/src/services/company-skills.ts` - added `server/src/__tests__/company-skills-detail.test.ts` to verify the detail route only pulls the required data ## Verification - `pnpm exec vitest run --project @paperclipai/server server/src/__tests__/company-skills-detail.test.ts` ## Risks - Low risk: this only changes the company-skill detail query path, but any missed assumption in the detail consumer would surface when loading that screen > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex GPT-5-based coding agent with tool use and code execution in the Codex CLI environment ## 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 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 - [ ] 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
This commit is contained in:
Dotta
GitHub
parent
e4995bbb1c
commit
35a9dc37b0
4 changed files with 317 additions and 64 deletions
232
server/src/__tests__/company-skills-detail.test.ts
Normal file
232
server/src/__tests__/company-skills-detail.test.ts
Normal file
|
|
@ -0,0 +1,232 @@
|
|||
import { randomUUID } from "node:crypto";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { promises as fs } from "node:fs";
|
||||
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
|
||||
import { agents, companies, companySkills, createDb } from "@paperclipai/db";
|
||||
import {
|
||||
getEmbeddedPostgresTestSupport,
|
||||
startEmbeddedPostgresTestDatabase,
|
||||
} from "./helpers/embedded-postgres.js";
|
||||
import { companySkillService } from "../services/company-skills.js";
|
||||
|
||||
const mockListSkills = vi.hoisted(() => vi.fn(() => new Promise(() => {})));
|
||||
|
||||
vi.mock("../adapters/index.js", async () => {
|
||||
const actual = await vi.importActual<typeof import("../adapters/index.js")>("../adapters/index.js");
|
||||
return {
|
||||
...actual,
|
||||
findActiveServerAdapter: vi.fn(() => ({
|
||||
listSkills: mockListSkills,
|
||||
})),
|
||||
};
|
||||
});
|
||||
|
||||
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
|
||||
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
|
||||
|
||||
if (!embeddedPostgresSupport.supported) {
|
||||
console.warn(
|
||||
`Skipping embedded Postgres company skill detail tests on this host: ${embeddedPostgresSupport.reason ?? "unsupported environment"}`,
|
||||
);
|
||||
}
|
||||
|
||||
describeEmbeddedPostgres("companySkillService.detail", () => {
|
||||
let db!: ReturnType<typeof createDb>;
|
||||
let svc!: ReturnType<typeof companySkillService>;
|
||||
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
|
||||
const cleanupDirs = new Set<string>();
|
||||
|
||||
beforeAll(async () => {
|
||||
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-company-skills-detail-");
|
||||
db = createDb(tempDb.connectionString);
|
||||
svc = companySkillService(db);
|
||||
}, 20_000);
|
||||
|
||||
afterEach(async () => {
|
||||
mockListSkills.mockClear();
|
||||
await db.delete(agents);
|
||||
await db.delete(companySkills);
|
||||
await db.delete(companies);
|
||||
await Promise.all(Array.from(cleanupDirs, (dir) => fs.rm(dir, { recursive: true, force: true })));
|
||||
cleanupDirs.clear();
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await tempDb?.cleanup();
|
||||
});
|
||||
|
||||
function createTrackedDb(baseDb: ReturnType<typeof createDb>) {
|
||||
const implicitCompanySkillSelects = vi.fn();
|
||||
|
||||
const trackedDb = new Proxy(baseDb, {
|
||||
get(target, prop, receiver) {
|
||||
if (prop !== "select") {
|
||||
const value = Reflect.get(target, prop, receiver);
|
||||
return typeof value === "function" ? value.bind(target) : value;
|
||||
}
|
||||
|
||||
return ((selection?: unknown) => {
|
||||
const builder = selection === undefined ? target.select() : target.select(selection as never);
|
||||
|
||||
return new Proxy(builder as object, {
|
||||
get(builderTarget, builderProp, builderReceiver) {
|
||||
if (builderProp !== "from") {
|
||||
const value = Reflect.get(builderTarget, builderProp, builderReceiver);
|
||||
return typeof value === "function" ? value.bind(builderTarget) : value;
|
||||
}
|
||||
|
||||
return (table: unknown) => {
|
||||
const fromResult = (builderTarget as { from: (value: unknown) => unknown }).from(table);
|
||||
if (table === companySkills) {
|
||||
if (selection === undefined) {
|
||||
implicitCompanySkillSelects();
|
||||
}
|
||||
}
|
||||
|
||||
return fromResult;
|
||||
};
|
||||
},
|
||||
});
|
||||
}) as typeof target.select;
|
||||
},
|
||||
});
|
||||
|
||||
return {
|
||||
db: trackedDb as typeof baseDb,
|
||||
implicitCompanySkillSelects,
|
||||
};
|
||||
}
|
||||
|
||||
it("reports attached agents without probing adapter runtime skill state", async () => {
|
||||
const companyId = randomUUID();
|
||||
const skillId = randomUUID();
|
||||
const skillKey = `company/${companyId}/reflection-coach`;
|
||||
const skillDir = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-reflection-skill-"));
|
||||
cleanupDirs.add(skillDir);
|
||||
await fs.writeFile(path.join(skillDir, "SKILL.md"), "# Reflection Coach\n", "utf8");
|
||||
|
||||
await db.insert(companies).values({
|
||||
id: companyId,
|
||||
name: "Paperclip",
|
||||
issuePrefix: `T${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
|
||||
requireBoardApprovalForNewAgents: false,
|
||||
});
|
||||
await db.insert(companySkills).values({
|
||||
id: skillId,
|
||||
companyId,
|
||||
key: skillKey,
|
||||
slug: "reflection-coach",
|
||||
name: "Reflection Coach",
|
||||
description: null,
|
||||
markdown: "# Reflection Coach\n",
|
||||
sourceType: "local_path",
|
||||
sourceLocator: skillDir,
|
||||
trustLevel: "markdown_only",
|
||||
compatibility: "compatible",
|
||||
fileInventory: [{ path: "SKILL.md", kind: "skill" }],
|
||||
metadata: { sourceKind: "local_path" },
|
||||
});
|
||||
await db.insert(agents).values({
|
||||
id: randomUUID(),
|
||||
companyId,
|
||||
name: "Reviewer",
|
||||
role: "engineer",
|
||||
adapterType: "codex_local",
|
||||
adapterConfig: {
|
||||
paperclipSkillSync: {
|
||||
desiredSkills: [skillKey],
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const detail = await Promise.race([
|
||||
svc.detail(companyId, skillId),
|
||||
new Promise<never>((_, reject) => setTimeout(() => reject(new Error("skill detail timed out")), 1_000)),
|
||||
]);
|
||||
|
||||
expect(mockListSkills).not.toHaveBeenCalled();
|
||||
expect(detail?.usedByAgents).toEqual([
|
||||
expect.objectContaining({
|
||||
name: "Reviewer",
|
||||
desired: true,
|
||||
actualState: null,
|
||||
}),
|
||||
]);
|
||||
});
|
||||
|
||||
it("uses explicit company skill column selections when resolving detail usage", async () => {
|
||||
const companyId = randomUUID();
|
||||
const skillId = randomUUID();
|
||||
const skillKey = `company/${companyId}/reflection-coach`;
|
||||
const skillDir = await fs.mkdtemp(path.join(os.tmpdir(), "paperclip-reflection-skill-"));
|
||||
cleanupDirs.add(skillDir);
|
||||
await fs.writeFile(path.join(skillDir, "SKILL.md"), "# Reflection Coach\n", "utf8");
|
||||
|
||||
await db.insert(companies).values({
|
||||
id: companyId,
|
||||
name: "Paperclip",
|
||||
issuePrefix: `T${companyId.replace(/-/g, "").slice(0, 6).toUpperCase()}`,
|
||||
requireBoardApprovalForNewAgents: false,
|
||||
});
|
||||
await db.insert(companySkills).values([
|
||||
{
|
||||
id: skillId,
|
||||
companyId,
|
||||
key: skillKey,
|
||||
slug: "reflection-coach",
|
||||
name: "Reflection Coach",
|
||||
description: null,
|
||||
markdown: "# Reflection Coach\n",
|
||||
sourceType: "local_path",
|
||||
sourceLocator: skillDir,
|
||||
trustLevel: "markdown_only",
|
||||
compatibility: "compatible",
|
||||
fileInventory: [{ path: "SKILL.md", kind: "skill" }],
|
||||
metadata: { sourceKind: "local_path" },
|
||||
},
|
||||
{
|
||||
id: randomUUID(),
|
||||
companyId,
|
||||
key: `company/${companyId}/large-reference-skill`,
|
||||
slug: "large-reference-skill",
|
||||
name: "Large Reference Skill",
|
||||
description: null,
|
||||
markdown: `# Large Reference Skill\n\n${"x".repeat(32_000)}`,
|
||||
sourceType: "catalog",
|
||||
sourceLocator: "paperclip://catalog/large-reference-skill",
|
||||
trustLevel: "markdown_only",
|
||||
compatibility: "compatible",
|
||||
fileInventory: [{ path: "SKILL.md", kind: "skill" }],
|
||||
metadata: { sourceKind: "catalog" },
|
||||
},
|
||||
]);
|
||||
await db.insert(agents).values({
|
||||
id: randomUUID(),
|
||||
companyId,
|
||||
name: "Reviewer",
|
||||
role: "engineer",
|
||||
adapterType: "codex_local",
|
||||
adapterConfig: {
|
||||
paperclipSkillSync: {
|
||||
desiredSkills: ["reflection-coach"],
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const tracked = createTrackedDb(db);
|
||||
const trackedSvc = companySkillService(tracked.db);
|
||||
const detail = await Promise.race([
|
||||
trackedSvc.detail(companyId, skillId),
|
||||
new Promise<never>((_, reject) => setTimeout(() => reject(new Error("skill detail timed out")), 1_000)),
|
||||
]);
|
||||
|
||||
expect(detail?.usedByAgents).toEqual([
|
||||
expect.objectContaining({
|
||||
name: "Reviewer",
|
||||
desired: true,
|
||||
}),
|
||||
]);
|
||||
expect(tracked.implicitCompanySkillSelects).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
Loading…
Add table
Add a link
Reference in a new issue