forked from farhoodlabs/paperclip
e43b392a79
## Thinking Path > - Paperclip is the control plane for AI-agent companies. > - Operators need a path to move local company state toward Paperclip Cloud without losing local-first control. > - The Cloud Upstream flow needs API, persistence, CLI, and board UI surfaces that agree on the same manifest/run model. > - The existing branch had the feature work plus UX and error-handling follow-ups. > - This pull request packages the remaining Cloud Upstream sync work into one standalone branch. > - The benefit is an inspectable local-to-cloud sync workflow with preview, conflicts, activation, and captured UX review states. ## What Changed - Added Cloud Upstream shared types, server routes/services, and persisted run schema/migration. - Added Paperclip Cloud CLI sync helpers and local connection storage. - Added the Cloud Upstream board UI, settings entry points, query keys, and UX lab page. - Added preview/activation checklist behavior, redirect handling, manifest-only preview support, friendly errors, in-flight hints, and entity count summaries. ## Verification - `pnpm --filter @paperclipai/plugin-sdk build` - `NODE_ENV=test pnpm exec vitest run cli/src/__tests__/cloud.test.ts server/src/__tests__/instance-settings-routes.test.ts server/src/__tests__/instance-settings-service.test.ts ui/src/pages/CloudUpstream.test.tsx ui/src/components/CompanySettingsSidebar.test.tsx` - `NODE_ENV=test pnpm exec vitest run server/src/__tests__/cloud-upstreams.test.ts` Worktree setup note: the isolated worktree install skipped native sqlite build scripts, so I copied the already-built local sqlite binding from the main checkout before running `server/src/__tests__/cloud-upstreams.test.ts`. The test then passed. ## Risks - Medium: this adds a database migration and a broad feature path across CLI/server/UI. - Merge order: this is the only PR in this split with a DB migration; merge it before any future Cloud Upstream migration follow-up. - Mitigation: the PR is based directly on current `origin/master`, has targeted route/service/UI tests, and keeps the feature behind existing experimental Cloud Sync settings. > 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 GPT-5 Codex via `codex_local`, tool-enabled coding session; exact context window not exposed by this runtime. ## 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 - [x] If this change affects the UI, screenshot artifacts are intentionally omitted per reviewer request - [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
244 lines
8.7 KiB
TypeScript
244 lines
8.7 KiB
TypeScript
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { CompanyPortabilityExportResult } from "@paperclipai/shared";
|
|
import {
|
|
assertDiscoveryCompatible,
|
|
buildBundleFromLocalCompany,
|
|
cloudCommandExitCodes,
|
|
connectCloud,
|
|
resolveDeviceCodeExpiresAt,
|
|
} from "../commands/client/cloud.js";
|
|
import {
|
|
LocalUpstreamPushCoordinator,
|
|
normalizedContentHash,
|
|
type LocalUpstreamExportBundle,
|
|
} from "../commands/client/cloud-transfer.js";
|
|
import { getCloudConnection } from "../commands/client/cloud-store.js";
|
|
|
|
const originalEnv = { ...process.env };
|
|
const originalFetch = globalThis.fetch;
|
|
|
|
describe("cloud CLI helpers", () => {
|
|
let tempHome: string;
|
|
|
|
beforeEach(() => {
|
|
tempHome = fs.mkdtempSync(path.join(os.tmpdir(), "paperclip-cloud-cli-"));
|
|
process.env = { ...originalEnv, PAPERCLIP_HOME: tempHome };
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.env = { ...originalEnv };
|
|
globalThis.fetch = originalFetch;
|
|
vi.restoreAllMocks();
|
|
fs.rmSync(tempHome, { recursive: true, force: true });
|
|
});
|
|
|
|
it("connects with the device-code flow and stores the resulting cloud connection", async () => {
|
|
globalThis.fetch = vi.fn(async (url, init) => {
|
|
const requestUrl = String(url);
|
|
if (requestUrl.endsWith("/.well-known/paperclip-upstream")) {
|
|
return jsonResponse(discovery());
|
|
}
|
|
if (requestUrl.endsWith("/api/upstream-sync/device-code")) {
|
|
expect(JSON.parse(String(init?.body))).toMatchObject({
|
|
stackId: "stack-1",
|
|
scopes: ["upstream_import:preview", "upstream_import:write", "upstream_import:read"],
|
|
});
|
|
return jsonResponse({
|
|
deviceCode: "device-1",
|
|
userCode: "ABCD-EFGH",
|
|
verificationUri: "https://cloud.example.test/api/upstream-sync/device-code/approve",
|
|
expiresAt: new Date(Date.now() + 60_000).toISOString(),
|
|
intervalSeconds: 0,
|
|
});
|
|
}
|
|
if (requestUrl.endsWith("/api/upstream-sync/token")) {
|
|
return jsonResponse({
|
|
accessToken: "upt_test",
|
|
scopes: ["upstream_import:preview"],
|
|
token: {
|
|
id: "token-1",
|
|
companyStackId: "stack-1",
|
|
targetOrigin: "https://cloud.example.test",
|
|
sourceInstanceId: "paperclip-local-default",
|
|
sourceInstanceFingerprint: "sha256:test",
|
|
scopes: ["upstream_import:preview"],
|
|
expiresAt: new Date(Date.now() + 60_000).toISOString(),
|
|
},
|
|
});
|
|
}
|
|
return jsonResponse({ error: "not_found" }, 404);
|
|
}) as typeof fetch;
|
|
|
|
const connection = await connectCloud("https://cloud.example.test", { noBrowser: true, json: true });
|
|
|
|
expect(connection.accessToken).toBe("upt_test");
|
|
expect(getCloudConnection("https://cloud.example.test")?.token.id).toBe("token-1");
|
|
});
|
|
|
|
it("hard-blocks incompatible transfer schema versions with the stable schema exit code", () => {
|
|
expect(() => assertDiscoveryCompatible(discovery({ supportedSchemaMajor: 99 }))).toThrow(/schema mismatch/i);
|
|
expect(cloudCommandExitCodes.schemaMismatch).toBe(3);
|
|
});
|
|
|
|
it("falls back to a bounded device-code expiry when the cloud omits or malforms expiresAt", () => {
|
|
const now = Date.UTC(2026, 4, 22, 13, 0, 0);
|
|
const validExpiry = "2026-05-22T13:05:00.000Z";
|
|
|
|
expect(resolveDeviceCodeExpiresAt(validExpiry, now)).toBe(Date.parse(validExpiry));
|
|
expect(resolveDeviceCodeExpiresAt(undefined, now)).toBe(now + 15 * 60_000);
|
|
expect(resolveDeviceCodeExpiresAt("not-a-date", now)).toBe(now + 15 * 60_000);
|
|
});
|
|
|
|
it("builds deterministic chunks with validated payload hashes", async () => {
|
|
const bundle = await buildTestBundle();
|
|
|
|
expect(bundle.chunks).toHaveLength(2);
|
|
expect(bundle.chunks[0]?.sha256).toBe(normalizedContentHash(bundle.chunks[0]?.payload));
|
|
expect(bundle.manifest.chunks[0]?.manifestHash).toBe(bundle.manifest.manifestHash);
|
|
expect(bundle.manifest.idempotencyKey).toBe((await buildTestBundle()).manifest.idempotencyKey);
|
|
});
|
|
|
|
it("reuses the same manifest and chunk identity when an interrupted apply is retried", async () => {
|
|
const bundle = await buildTestBundle();
|
|
const calls: Array<{ path: string; body: unknown }> = [];
|
|
const coordinator = new LocalUpstreamPushCoordinator({
|
|
targetOrigin: "https://cloud.example.test",
|
|
paperclipCompanyId: "target-company-1",
|
|
fetch: async (url, init) => {
|
|
const parsed = new URL(String(url));
|
|
const body = init?.body ? JSON.parse(String(init.body)) as unknown : {};
|
|
calls.push({ path: parsed.pathname, body });
|
|
if (parsed.pathname.endsWith("/runs")) return jsonResponse({ run: { id: "run-1" } });
|
|
return jsonResponse({ run: { id: "run-1" }, summary: { create: 0, update: 0, adopt: 0, skip: 2, conflict: 0, staleMapping: 0 } });
|
|
},
|
|
});
|
|
|
|
await coordinator.apply(bundle);
|
|
await coordinator.apply(bundle);
|
|
|
|
const runBodies = calls.filter((call) => call.path.endsWith("/runs")).map((call) => call.body as { manifest: { idempotencyKey: string } });
|
|
const chunkBodies = calls.filter((call) => call.path.endsWith("/chunks")).map((call) => call.body as { chunkIndex: number; sha256: string });
|
|
expect(runBodies).toHaveLength(2);
|
|
expect(runBodies[0]?.manifest.idempotencyKey).toBe(runBodies[1]?.manifest.idempotencyKey);
|
|
expect(chunkBodies[0]).toEqual(chunkBodies[2]);
|
|
expect(chunkBodies[1]).toEqual(chunkBodies[3]);
|
|
});
|
|
});
|
|
|
|
async function buildTestBundle(): Promise<LocalUpstreamExportBundle> {
|
|
return buildBundleFromLocalCompany({
|
|
localCompanyId: "local-company-1",
|
|
connection: {
|
|
id: "conn-1",
|
|
remoteUrl: "https://cloud.example.test",
|
|
targetOrigin: "https://cloud.example.test",
|
|
targetHost: "cloud.example.test",
|
|
stackId: "stack-1",
|
|
targetCompanyId: "target-company-1",
|
|
accessToken: "upt_test",
|
|
token: {
|
|
id: "token-1",
|
|
companyStackId: "stack-1",
|
|
targetOrigin: "https://cloud.example.test",
|
|
sourceInstanceId: "paperclip-local-default",
|
|
sourceInstanceFingerprint: "sha256:test",
|
|
scopes: ["upstream_import:preview"],
|
|
expiresAt: new Date(Date.now() + 60_000).toISOString(),
|
|
},
|
|
privateKeyPem: "unused",
|
|
sourcePublicKey: "unused",
|
|
sourceInstanceId: "paperclip-local-default",
|
|
sourceInstanceFingerprint: "sha256:test",
|
|
scopes: ["upstream_import:preview"],
|
|
createdAt: "2026-05-18T00:00:00.000Z",
|
|
updatedAt: "2026-05-18T00:00:00.000Z",
|
|
},
|
|
discovery: discovery(),
|
|
localApi: {
|
|
post: async <T>() => portabilityExport() as T,
|
|
},
|
|
maxEntitiesPerChunk: 1,
|
|
mode: "apply",
|
|
});
|
|
}
|
|
|
|
function discovery(overrides: Partial<{ supportedSchemaMajor: number }> = {}) {
|
|
return {
|
|
schema: "paperclip-upstream-discovery-v1",
|
|
stack: {
|
|
id: "stack-1",
|
|
slug: "cloud-test",
|
|
displayName: "Cloud Test",
|
|
companyId: "target-company-1",
|
|
origin: "https://cloud.example.test",
|
|
},
|
|
auth: {
|
|
deviceCode: {
|
|
deviceCodeUrl: "https://cloud.example.test/api/upstream-sync/device-code",
|
|
verificationUrl: "https://cloud.example.test/api/upstream-sync/device-code/approve",
|
|
tokenUrl: "https://cloud.example.test/api/upstream-sync/token",
|
|
},
|
|
scopes: ["upstream_import:preview", "upstream_import:write", "upstream_import:read"],
|
|
},
|
|
transfer: {
|
|
supportedSchemaMajor: overrides.supportedSchemaMajor ?? 1,
|
|
featureFlags: ["cloud_sync"],
|
|
},
|
|
};
|
|
}
|
|
|
|
function portabilityExport(): CompanyPortabilityExportResult {
|
|
return {
|
|
rootPath: ".",
|
|
paperclipExtensionPath: ".paperclip.yaml",
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
generatedAt: "2026-05-18T00:00:00.000Z",
|
|
source: {
|
|
companyId: "local-company-1",
|
|
companyName: "Local Company",
|
|
},
|
|
includes: {
|
|
company: true,
|
|
agents: true,
|
|
projects: true,
|
|
issues: true,
|
|
skills: true,
|
|
},
|
|
company: {
|
|
path: "company.json",
|
|
name: "Local Company",
|
|
description: null,
|
|
brandColor: null,
|
|
logoPath: null,
|
|
attachmentMaxBytes: null,
|
|
requireBoardApprovalForNewAgents: false,
|
|
feedbackDataSharingEnabled: false,
|
|
feedbackDataSharingConsentAt: null,
|
|
feedbackDataSharingConsentByUserId: null,
|
|
feedbackDataSharingTermsVersion: null,
|
|
},
|
|
sidebar: null,
|
|
agents: [],
|
|
skills: [],
|
|
projects: [],
|
|
issues: [],
|
|
envInputs: [],
|
|
},
|
|
files: {
|
|
"README.md": "Local Company",
|
|
},
|
|
warnings: [],
|
|
};
|
|
}
|
|
|
|
function jsonResponse(body: unknown, status = 200): Response {
|
|
return new Response(JSON.stringify(body), {
|
|
status,
|
|
headers: { "Content-Type": "application/json" },
|
|
});
|
|
}
|