Files
Shade/packages/shade-sdk/tests/streams-integration.test.ts
Sterister fa770d3063
Some checks failed
Test / test (push) Has been cancelled
feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive
M-Files-1..6 land the full files-RPC layer + everything 0.3.0 needs to
ship. Apps keep their own UI; this layer ships the typed RPC, the
streams bridge for content I/O, and production hooks (rate limit,
retention, fingerprint gate, metrics).

@shade/files (NEW)
- Standard ops: list/stat/mkdir/delete/move/read/write/getThumbnail with
  Zod-validated wire schemas + clean user-handler types.
- Custom ops: typed via TypeScript declaration merging on CustomOpsMap
  + per-op Zod schemas; client.custom('app.foo', {...}) is fully typed.
- Content I/O: inline (≤ 256 KiB plaintext) base64-in-RPC; streams
  (> 256 KiB) ride @shade/transfer via userMetadata.shadeFilesWriteId
  / shadeFilesReadStreamId correlation. Server-side TransformStream
  bridges accept inbound transfers immediately (engine rejects chunks
  that arrive before accept) and park the readable for the matching
  RPC.
- Directory ops: walk(path, opts) async-iterable depth-first walker;
  uploadDirectory()/downloadDirectory() with bounded concurrency pool
  (default 4, cap 16), aggregated progress, abort.
- Production hooks (callback-based, vendor-neutral): rate-limit (op +
  byte), idempotency cache (LRU + TTL + in-flight de-dupe), path
  policy (traversal + percent-decode hardening), fingerprint gate
  (required/optional/reject), pluggable Ed25519 sig verification with
  ±5 min replay window, onMetric sink (standard names).
- React hooks (subpath @shade/files/react): ShadeFilesProvider,
  useShadeFiles, useFileList, useFileTransfer/Upload/Download.
- Shade.files.serve(handler) + Shade.files.client(peer) high-level
  entrypoint in @shade/sdk; lazy + memoized; one handler per Shade.

Wire format bump
- @shade/proto wire VERSION 0x01 → 0x02. Length prefixes changed from
  u16 to u32. The previous u16 silently truncated payloads above
  64 KiB — a hard correctness ceiling that blocked inline file ops
  up to 256 KiB. Wire-incompatible with 0.2.x peers; new sessions
  only. Cross-platform Kotlin port (android/shade-android) updated to
  match; test-vectors/wire-format.json regenerated.

Concurrency safety
- ShadeSessionManager.encrypt/.decrypt now run under per-peer mutex.
  Concurrent decryptions of the same peer raced ratchet state
  (manifested as sporadic "Failed to decrypt — wrong key or tampered
  data" under load — surfaced once concurrent uploadDirectory pumped
  many writes in flight). Encrypt was already serialized via
  Shade.send's encryptChains; decrypt is now serialized at the
  manager layer too.

@shade/streams extension
- StreamMetadata.userMetadata?: Record<string, string> for
  application-level key/value pairs that round-trip verbatim through
  stream-init plaintext. Used by @shade/files for write/read
  correlation; available to any consumer.

@shade/sdk extension
- Shade.files getter (lazy + memoized).
- BackgroundHooks.onPruneFiles + periodic timer (default 5 min) +
  BackgroundTasks.setHook(name, fn) for runtime hook registration.

Bundles in-flight 0.2.0 work
- packages/shade-streams/, packages/shade-transfer/, related
  shade-sdk streams-bridge + shade-widgets transfer hooks were
  uncommitted prior to this session. Including them keeps the
  workspace consistent at 0.3.0 since @shade/files depends on them.

Tests
- 74 new tests in @shade/files (572 → 646 workspace pass; 0 fail;
  3× stable). Coverage spans unit (inline-threshold + concurrency),
  integration (read-write inline + streams up to 1 MiB, walk +
  upload/download directory, custom-op, metrics, SDK namespace
  end-to-end), and security (tampered-envelope sig verification,
  replay window, fingerprint gate, rate-limit + quota).

Release artifacts
- All packages bumped to 0.3.0 via scripts/bump-version.ts.
- scripts/publish-all.ts PACKAGES updated with shade-files in
  topological order (after shade-transfer, before shade-sdk).
- bun run publish:dry clean (14 packed, 0 failed).
- examples/08-files-browser/ — three-process CLI demo (prekey + Bob
  server + Alice CLI) covering list/stat/mkdir/delete/upload/download.
- docs/files.md — full API + design doc.
- CHANGELOG.md 0.3.0 entry.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-02 14:00:01 +02:00

160 lines
4.9 KiB
TypeScript

import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
import { createShade, type Shade, type TransferHandle, type TransferResult } from '../src/index.js';
import {
createPrekeyServer,
MemoryPrekeyStore,
PrekeyServerEvents,
} from '@shade/server';
import { SubtleCryptoProvider } from '@shade/crypto-web';
import { sha256Once } from '@shade/streams';
const crypto = new SubtleCryptoProvider();
interface TestRig {
alice: Shade;
bob: Shade;
bobBaseUrl: string;
prekeyStop: () => void;
bobServerStop: () => void;
}
async function startPrekeyServer(): Promise<{ url: string; stop: () => void }> {
const events = new PrekeyServerEvents();
const server = createPrekeyServer({
crypto,
store: new MemoryPrekeyStore(),
disableRateLimit: true,
events,
});
const port = 21000 + Math.floor(Math.random() * 500);
const handle = Bun.serve({ port, fetch: server.fetch });
return { url: `http://localhost:${port}`, stop: () => handle.stop() };
}
async function setupRig(): Promise<TestRig> {
const prekey = await startPrekeyServer();
const alice = await createShade({ prekeyServer: prekey.url, address: 'alice' });
const bob = await createShade({ prekeyServer: prekey.url, address: 'bob' });
// Bob's transferRoute lazily creates a TransferEngine, which requires
// configureTransfers first.
bob.configureTransfers({
resolveBaseUrl: async () => {
throw new Error('bob is receive-only in this test');
},
});
// Spin up Bob's HTTP transfer endpoint.
const bobApp = await bob.transferRoute();
const port = 21500 + Math.floor(Math.random() * 500);
const bobServer = Bun.serve({ port, fetch: bobApp.fetch });
const bobBaseUrl = `http://localhost:${port}`;
// Wire up Alice's outgoing transfer routing.
alice.configureTransfers({
resolveBaseUrl: async (addr) => {
if (addr === 'bob') return bobBaseUrl;
throw new Error(`unknown peer ${addr}`);
},
});
return {
alice,
bob,
bobBaseUrl,
prekeyStop: prekey.stop,
bobServerStop: () => bobServer.stop(),
};
}
async function teardownRig(rig: TestRig): Promise<void> {
await rig.alice.shutdown();
await rig.bob.shutdown();
rig.bobServerStop();
rig.prekeyStop();
}
function hex(b: Uint8Array): string {
return Array.from(b, (x) => x.toString(16).padStart(2, '0')).join('');
}
async function uploadAndAwait(
rig: TestRig,
input: Uint8Array,
opts?: { lanes?: number; chunkSize?: number },
): Promise<{ senderResult: TransferResult; received: Uint8Array }> {
let resolveRecv!: (h: TransferHandle) => void;
const recvHandlePromise = new Promise<TransferHandle>((r) => {
resolveRecv = r;
});
const unsubscribe = await rig.bob.onIncomingTransfer(async (incoming) => {
const h = await incoming.accept({ output: { kind: 'buffer' } });
resolveRecv(h);
});
const handle = await rig.alice.upload({
to: 'bob',
input,
...(opts?.lanes !== undefined ? { lanes: opts.lanes } : {}),
...(opts?.chunkSize !== undefined ? { chunkSize: opts.chunkSize } : {}),
metadata: { name: 'integration-test.bin' },
});
const recvHandle = await recvHandlePromise;
const [senderResult, recvResult] = await Promise.all([handle.done(), recvHandle.done()]);
unsubscribe();
const received =
(recvResult as TransferResult & { bytes?: Uint8Array }).bytes ?? new Uint8Array();
return { senderResult, received };
}
describe('Shade SDK end-to-end E2EE transfer', () => {
let rig: TestRig;
beforeAll(async () => {
rig = await setupRig();
});
afterAll(async () => {
await teardownRig(rig);
});
test('64 KiB payload — 1 lane', async () => {
const input = crypto.randomBytes(64 * 1024);
const { senderResult, received } = await uploadAndAwait(rig, input, {
lanes: 1,
chunkSize: 16 * 1024,
});
expect(received).toEqual(input);
expect(senderResult.sha256).toBe(hex(sha256Once(input)));
});
test('512 KiB payload — 4 lanes range partition', async () => {
const input = crypto.randomBytes(512 * 1024);
const { senderResult, received } = await uploadAndAwait(rig, input, {
lanes: 4,
chunkSize: 32 * 1024,
});
expect(received).toEqual(input);
expect(senderResult.sha256).toBe(hex(sha256Once(input)));
});
test(
'4 MiB payload — 4 lanes, simulates Dispatch upload',
async () => {
const input = crypto.randomBytes(4 * 1024 * 1024);
const { senderResult, received } = await uploadAndAwait(rig, input, {
lanes: 4,
chunkSize: 128 * 1024,
});
expect(received).toEqual(input);
expect(senderResult.sha256).toBe(hex(sha256Once(input)));
},
30_000,
);
test('listTransfers returns empty before transfer (memory storage)', async () => {
// MemoryStorage's listActiveStreamStates is implemented but never
// populated by the engine in v0.2.0 (resume persistence is M-Stream-6).
const list = await rig.alice.listTransfers();
expect(Array.isArray(list)).toBe(true);
});
});