Files
PaperClipAI/ui/src/lib/import-preflight.test.ts
T
Devin Foley 916c13501f Replace host-to-host Cloud Sync with full-fidelity company Import/Export (#10507)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - A company accumulates real state — issues, labels, blockers,
documents, work products, monitors, attachments, agents, routines — and
people need to move that state between instances: self-hosted to cloud,
cloud back to self-hosted, or plain backups
> - The experimental, flag-gated Cloud Sync transport (#6548) tried to
solve this host-to-host: the source pushed into a receiver over HTTPS
with a cross-instance consent/token handshake, which required the
destination to be publicly reachable and broke for common self-hosted
topologies (plain-HTTP LAN/VPN origins); the receiver half never landed
upstream at all
> - Meanwhile the portability bundle and the existing export/import
pages already move companies offline with none of those networking
constraints — but silently dropped labels, blockers, issue documents,
work products, monitors, and every attachment
> - This pull request removes the host-to-host transport and makes
Import/Export the single data-movement path: the pages become
first-class company-settings destinations, exports declare exactly what
they do not carry, and bundle schemaVersion 6 now carries all of the
above, with attachments as content-addressed sha256 blobs verified
before a single row is written
> - The benefit is a migration and backup flow that works between any
two instances with no reachability requirements, no cross-instance auth,
and no silent data loss

## Linked Issues or Issue Description

- Refs #6548 — the original Cloud Sync sender this PR supersedes and
removes.
- Related, not duplicates: #1697 (goals in the portability manifest —
orthogonal field addition), #954 (an earlier import/export +
skill-visibility proposal predating the current portability bundle).
- No open issue describes this directly, so in brief (feature-request
shape): **Problem** — moving a company between instances silently lost
labels (imports with label references actually hard-failed), blocker
relations, issue documents, work products, monitor state, and all
attachments, and the alternative Cloud Sync transport required the
destination to be publicly reachable over HTTPS plus a consent
handshake, which failed for typical self-hosted setups. **Desired
behavior** — one Import/Export flow in company settings that produces a
portable bundle carrying all of that data, tells the operator up front
what it cannot carry, imports with automations paused, and offers real
one-click activation afterwards.

## What Changed

- New export fidelity report (`GET
/api/companies/:companyId/export/fidelity`) + an "Export fidelity" panel
on the Export page listing anything a bundle will not include (now only:
approvals, cost history, activity history)
- Imports accept `pauseAutomations`; imported agents and routines land
paused, the import result reports created routines, and the Import page
ends in an activation panel that actually resumes selected
agents/activates routines
- Export and Import pages promoted into the company-settings nav; the
Cloud Upstream wizard, ux-lab page, and API client removed; the old
settings route redirects to Export
- Host-to-host transport removed: upstream-sync/receiver-client routes
and services, CLI `cloud connect`/`cloud push` + keypair store, the
shared upstream transfer contract, and the `enableCloudSync` flag;
migration `0196` drops the two experimental `cloud_upstream_*` sender
tables
- Bundle schemaVersion 6: labels (definitions + per-task names, remapped
by name on import), blocker relations (`blockedBy` slugs,
cycle-tolerant), issue documents (`tasks/<slug>/documents/<key>.md`),
work products (system refs nulled), monitors (notes/scheduledBy
restored, imported un-armed)
- Attachments travel as content-addressed `blobs/<sha256>` entries
(deduped; comment-scoped attachments re-link via comment index); every
blob is hash-verified **before any write**, so a corrupted bundle cannot
leave a partially imported company; both zip codecs now round-trip
extensionless/binary entries byte-exactly; the Import page preflights
the inline body limit and offers continue-without-attachments
- v5 (and older) bundles still import, with an informational warning;
bundles newer than v6 are rejected cleanly
- Docs: board-operator import/export guide, CLI README, README/ROADMAP
updated

## Verification

- `pnpm -r` typechecks (shared, db incl. migration numbering/safety
checks, server, ui, cli) and `pnpm check:token-gates` — clean
- Vitest: full server + shared sweep 4,888 passed / 1 skipped, with the
only 3 failures being pre-existing on `master` (2×
heartbeat-workspace-branch-containment, 1× workspace-runtime auto-port;
reproduced identically with this change stashed); ui + cli suites green;
the embedded-Postgres export-fidelity suite applies the full migration
chain including the new `0196` against a fresh database
- Live end-to-end on a scratch instance: seeded a company with labels, a
blocker pair, an issue document, a work product, a monitor, an agent, a
routine, and two binary attachments (one comment-scoped) → export →
import into a fresh company → labels remapped to new ids, blocker edge
and document restored, monitor un-armed with notes intact, attachments
byte-identical (sha256-compared through the API), agents/routines paused
→ activation panel resumed them; a v5-shaped bundle imported with only
the info warning; flipping one byte in a blob made the import 422 with
**zero** rows created
- Reviewer repro: create a company with a labeled issue + attachment →
Settings → Export → download → Settings → Import on another
company/instance → watch the preview, apply with "start paused", then
activate

## Risks

- Migration `0196` drops
`cloud_upstream_connections`/`cloud_upstream_runs` — experimental tables
behind a default-off flag; their connection/run history is intentionally
discarded
- Breaking removals are all of experimental, flag-gated surface:
`/api/upstream-sync/*` + `/api/cloud-upstreams/*` routes, `paperclipai
cloud connect|push`, and the `enableCloudSync` flag (stale keys in
stored instance settings parse harmlessly)
- Import remains non-atomic on mid-apply errors generally (pre-existing
behavior); the new blob verification specifically moved ahead of all
writes so tampered bundles cannot create partial state
- GitHub-sourced imports do not fetch `blobs/*` and skip attachments
with a warning

## Model Used

- Claude Fable 5 (`claude-fable-5`, Anthropic), via Claude Code CLI with
extended thinking, tool use, and subagent orchestration; implementation
and review split across Fable 5 subagents, with live end-to-end
verification against a running instance

## 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 (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] 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
- [x] 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
- [x] I will address all Greptile and reviewer comments before
requesting merge
2026-07-30 11:37:00 -07:00

93 lines
3.8 KiB
TypeScript

// @vitest-environment node
import { describe, expect, it } from "vitest";
import {
INLINE_IMPORT_MAX_BYTES,
REQUEST_ENVELOPE_ALLOWANCE_BYTES,
buildInlineImportPreflight,
estimateInlineImportBytes,
isBlobStoreFilePath,
stripBlobFiles,
} from "./import-preflight";
const megabyte = 1024 * 1024;
describe("import preflight", () => {
it("recognizes blob store paths at the package root only", () => {
expect(isBlobStoreFilePath("blobs/4f2d1c9a")).toBe(true);
expect(isBlobStoreFilePath("paperclip-demo/blobs/4f2d1c9a")).toBe(true);
expect(isBlobStoreFilePath("tasks/pap-1/TASK.md")).toBe(false);
expect(isBlobStoreFilePath("blobs/nested/file")).toBe(false);
});
it("estimates inline bytes from JSON-escaped text, base64 entries, keys, and the envelope", () => {
const base = estimateInlineImportBytes({});
expect(base).toBe(REQUEST_ENVELOPE_ALLOWANCE_BYTES);
// "COMPANY.md" key = 12 serialized bytes + 2 separators; "12345" = 7 with quotes.
expect(estimateInlineImportBytes({ "COMPANY.md": "12345" }) - base).toBe(12 + 2 + 7);
// Base64 entries count their object structure and contentType, not just the payload.
expect(estimateInlineImportBytes({
"blobs/abc": { encoding: "base64", data: "QUJDRA==", contentType: "application/octet-stream" },
}) - base).toBe(11 + 2 + (48 + 8 + 24));
});
it("counts UTF-8 bytes of serialized text, not UTF-16 code units", () => {
const base = estimateInlineImportBytes({});
// Two CJK characters: String.length is 2, but each is 3 bytes of UTF-8,
// plus the surrounding JSON quotes the request body will carry.
expect(estimateInlineImportBytes({ "COMPANY.md": "汉字" }) - base).toBe(12 + 2 + 8);
// A newline serializes as the two-character escape sequence \n.
expect(estimateInlineImportBytes({ "NOTES.md": "a\nb" }) - base).toBe(10 + 2 + 6);
});
it("counts file-path keys so path-heavy packages cannot undercount", () => {
const shortKey = estimateInlineImportBytes({ B: "x" });
const longKey = estimateInlineImportBytes({ ["A".repeat(100)]: "x" });
expect(longKey - shortKey).toBe(99);
});
it("never estimates below the actual serialized files map", () => {
const files = {
"COMPANY.md": '汉字 with\nnewlines and "quotes"',
"tasks/pap-1/TASK.md": "plain text",
"blobs/abc": { encoding: "base64" as const, data: "QUJDRA==", contentType: "image/png" },
};
const serialized = new TextEncoder().encode(JSON.stringify(files)).length;
expect(estimateInlineImportBytes(files)).toBeGreaterThanOrEqual(serialized);
});
it("passes packages under the inline limit", () => {
const preflight = buildInlineImportPreflight({ "COMPANY.md": "x".repeat(megabyte) });
expect(preflight.tooLarge).toBe(false);
expect(preflight.canDropAttachments).toBe(false);
});
it("blocks oversized packages and offers to drop attachments when that fits", () => {
const preflight = buildInlineImportPreflight({
"COMPANY.md": "x".repeat(megabyte),
"blobs/abc": {
encoding: "base64",
data: "A".repeat(INLINE_IMPORT_MAX_BYTES),
contentType: "application/octet-stream",
},
});
expect(preflight.tooLarge).toBe(true);
expect(preflight.canDropAttachments).toBe(true);
});
it("blocks oversized packages without the attachment escape hatch when text alone is too big", () => {
const preflight = buildInlineImportPreflight({
"COMPANY.md": "x".repeat(INLINE_IMPORT_MAX_BYTES + 1),
});
expect(preflight.tooLarge).toBe(true);
expect(preflight.canDropAttachments).toBe(false);
});
it("strips only blob files from the package", () => {
expect(stripBlobFiles({
"COMPANY.md": "text",
"blobs/abc": { encoding: "base64", data: "QQ==", contentType: "application/octet-stream" },
})).toEqual({ "COMPANY.md": "text" });
});
});