mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-13 13:38:01 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - App connections must work in both the operator UI and agent tool gateway. > - The first stack layer adds secure remote connections. > - Operators still need clear setup, test, and recovery states. > - This pull request adds the gateway behavior and the workspace connection experience. > - The benefit is a connection flow that is easier to understand and recover. ## Linked Issues or Issue Description Refs #11965 This is stack 2 of 11. It depends on stack 1 and replaces another reviewable part of #11965. ## What Changed - Improve remote tool gateway connection behavior. - Add clearer app setup, test, and recovery states. - Add focused server and UI tests for the new paths. - Keep the diff isolated from later identity and catalog work. - Stabilize DNS-pinned remote HTTP protocol fixtures and the managed-runtime public-origin fixture for this independently tested layer. ## Verification - `pnpm -r typecheck` - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/tool-access-service.test.ts` (150 passed) - `pnpm test:run` - `pnpm check:token-gates` - `pnpm build` ## Risks - Gateway errors now surface through new user-facing states. - A stale connection can require a new setup attempt. - The change does not add a database migration. - The injected HTTP transport and public URL are test-only fixtures; production DNS pinning and runtime behavior are unchanged. > I checked `ROADMAP.md`. This stack continues the existing app connection work from #11965 and does not duplicate another planned item. ## Model Used OpenAI Codex, GPT-5. The runtime model ID and context window were not exposed. The model used reasoning, tool use, and code execution. ## 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 - [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: Paperclip <noreply@paperclip.ing>
180 lines
5.4 KiB
TypeScript
180 lines
5.4 KiB
TypeScript
import { describe, expect, it } from "vitest";
|
|
import {
|
|
findWorkspaceCommandDefinition,
|
|
listWorkspaceCommandDefinitions,
|
|
matchWorkspaceRuntimeServiceToCommand,
|
|
} from "./workspace-commands.js";
|
|
|
|
describe("workspace command helpers", () => {
|
|
it("derives service and job commands from command-first runtime config", () => {
|
|
const commands = listWorkspaceCommandDefinitions({
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev" },
|
|
{ id: "db-migrate", name: "db:migrate", kind: "job", command: "pnpm db:migrate" },
|
|
],
|
|
});
|
|
|
|
expect(commands).toEqual([
|
|
expect.objectContaining({ id: "web", kind: "service", serviceIndex: 0 }),
|
|
expect.objectContaining({ id: "db-migrate", kind: "job", serviceIndex: null }),
|
|
]);
|
|
});
|
|
|
|
it("falls back to legacy services and jobs arrays", () => {
|
|
const commands = listWorkspaceCommandDefinitions({
|
|
services: [{ name: "web", command: "pnpm dev" }],
|
|
jobs: [{ name: "lint", command: "pnpm lint" }],
|
|
});
|
|
|
|
expect(commands).toEqual([
|
|
expect.objectContaining({ id: "service:web", kind: "service", serviceIndex: 0 }),
|
|
expect.objectContaining({ id: "job:lint", kind: "job", serviceIndex: null }),
|
|
]);
|
|
});
|
|
|
|
it("matches a configured service command to the current runtime service", () => {
|
|
const workspaceRuntime = {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev", cwd: "." },
|
|
],
|
|
};
|
|
const command = findWorkspaceCommandDefinition(workspaceRuntime, "web");
|
|
expect(command).not.toBeNull();
|
|
|
|
const match = matchWorkspaceRuntimeServiceToCommand(command!, [
|
|
{
|
|
id: "runtime-web",
|
|
serviceName: "web",
|
|
command: "pnpm dev",
|
|
cwd: "/repo",
|
|
port: null,
|
|
configIndex: null,
|
|
},
|
|
]);
|
|
|
|
expect(match).toEqual(expect.objectContaining({ id: "runtime-web" }));
|
|
});
|
|
|
|
it("does not match a stale runtime service after the configured command changes", () => {
|
|
const workspaceRuntime = {
|
|
commands: [
|
|
{ id: "web", name: "web", kind: "service", command: "pnpm dev:once --tailscale-auth", cwd: "." },
|
|
],
|
|
};
|
|
const command = findWorkspaceCommandDefinition(workspaceRuntime, "web");
|
|
expect(command).not.toBeNull();
|
|
|
|
const match = matchWorkspaceRuntimeServiceToCommand(command!, [
|
|
{
|
|
id: "runtime-web",
|
|
serviceName: "web",
|
|
command: "pnpm dev",
|
|
cwd: "/repo",
|
|
port: null,
|
|
configIndex: null,
|
|
},
|
|
]);
|
|
|
|
expect(match).toBeNull();
|
|
});
|
|
|
|
it("matches an exposed dev runtime whose bind command was hardened to loopback", () => {
|
|
const workspaceRuntime = {
|
|
commands: [
|
|
{ id: "web", name: "paperclip-dev", kind: "service", command: "pnpm dev --bind lan" },
|
|
],
|
|
};
|
|
const command = findWorkspaceCommandDefinition(workspaceRuntime, "web");
|
|
expect(command).not.toBeNull();
|
|
|
|
const match = matchWorkspaceRuntimeServiceToCommand(command!, [
|
|
{
|
|
id: "runtime-web",
|
|
serviceName: "paperclip-dev",
|
|
command: "pnpm dev --bind loopback",
|
|
cwd: "/repo",
|
|
configIndex: null,
|
|
exposure: {
|
|
provider: "tailscale_https",
|
|
state: "ready",
|
|
publicUrl: "https://paperclip-dev.example.ts.net:42012",
|
|
hostname: "paperclip-dev.example.ts.net",
|
|
listeners: [],
|
|
brokerRef: "broker-1",
|
|
lastError: null,
|
|
updatedAt: "2026-08-20T00:00:00.000Z",
|
|
},
|
|
},
|
|
]);
|
|
|
|
expect(match).toEqual(expect.objectContaining({ id: "runtime-web" }));
|
|
});
|
|
|
|
it("does not equate a loopback command with a lan command without managed exposure", () => {
|
|
const command = findWorkspaceCommandDefinition({
|
|
services: [{ name: "paperclip-dev", command: "pnpm dev --bind lan" }],
|
|
}, "service:paperclip-dev");
|
|
|
|
const match = matchWorkspaceRuntimeServiceToCommand(command!, [
|
|
{
|
|
id: "runtime-web",
|
|
serviceName: "paperclip-dev",
|
|
command: "pnpm dev --bind loopback",
|
|
cwd: "/repo",
|
|
configIndex: null,
|
|
exposure: null,
|
|
},
|
|
]);
|
|
|
|
expect(match).toBeNull();
|
|
});
|
|
|
|
it("does not revive runtime history from a previously configured port", () => {
|
|
const command = findWorkspaceCommandDefinition({
|
|
services: [
|
|
{
|
|
name: "web",
|
|
command: "pnpm dev",
|
|
port: { type: "fixed", value: 42001 },
|
|
},
|
|
],
|
|
}, "service:web");
|
|
expect(command).toEqual(expect.objectContaining({ port: 42001 }));
|
|
|
|
const match = matchWorkspaceRuntimeServiceToCommand(command!, [
|
|
{
|
|
id: "runtime-old-port",
|
|
serviceName: "web",
|
|
command: "pnpm dev",
|
|
cwd: "/repo",
|
|
port: 42013,
|
|
configIndex: 0,
|
|
},
|
|
{
|
|
id: "runtime-current-port",
|
|
serviceName: "web",
|
|
command: "pnpm dev",
|
|
cwd: "/repo",
|
|
port: 42001,
|
|
configIndex: 0,
|
|
},
|
|
]);
|
|
|
|
expect(match).toEqual(expect.objectContaining({ id: "runtime-current-port" }));
|
|
});
|
|
|
|
it("does not treat an auto port preference as a fixed runtime identity", () => {
|
|
const command = findWorkspaceCommandDefinition({
|
|
services: [
|
|
{
|
|
name: "web",
|
|
command: "pnpm dev",
|
|
port: { type: "auto", value: 42001 },
|
|
},
|
|
],
|
|
}, "service:web");
|
|
|
|
expect(command).toEqual(expect.objectContaining({ port: null }));
|
|
});
|
|
});
|