feat(files): @shade/files 0.3.0 — E2EE filesystem RPC primitive
Some checks failed
Test / test (push) Has been cancelled
Some checks failed
Test / test (push) Has been cancelled
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>
This commit is contained in:
142
packages/shade-files/tests/integration/helpers/rig.ts
Normal file
142
packages/shade-files/tests/integration/helpers/rig.ts
Normal file
@@ -0,0 +1,142 @@
|
||||
import { createShade, type Shade } from '@shade/sdk';
|
||||
import {
|
||||
createPrekeyServer,
|
||||
MemoryPrekeyStore,
|
||||
PrekeyServerEvents,
|
||||
} from '@shade/server';
|
||||
import { SubtleCryptoProvider } from '@shade/crypto-web';
|
||||
import {
|
||||
PendingRpcRegistry,
|
||||
ShadeFileRpcChannel,
|
||||
attachClientRouting,
|
||||
attachFileHandler,
|
||||
createClientStreamsBridge,
|
||||
createFileClient,
|
||||
createFileHandler,
|
||||
createServerStreamsBridge,
|
||||
type ClientStreamsBridge,
|
||||
type FileClient,
|
||||
type FileHandler,
|
||||
type FileHandlerConfig,
|
||||
type ServerStreamsBridge,
|
||||
} from '../../../src/index.js';
|
||||
|
||||
const crypto = new SubtleCryptoProvider();
|
||||
|
||||
export interface FileTestRig {
|
||||
alice: Shade;
|
||||
bob: Shade;
|
||||
fs: FileClient;
|
||||
bobHandler: FileHandler;
|
||||
/** Server-side streams bridge (Bob). */
|
||||
bobStreamsBridge: ServerStreamsBridge;
|
||||
/** Client-side streams bridge (Alice). */
|
||||
aliceStreamsBridge: ClientStreamsBridge;
|
||||
/** Tear everything down (kills servers, shuts down shades). */
|
||||
teardown(): Promise<void>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Setup options.
|
||||
*
|
||||
* Defaults to wiring streams-bridges on both sides so content I/O tests
|
||||
* (`read-write-streams.test.ts`) work transparently. Pass `withStreams: false`
|
||||
* to skip — useful for the legacy `std-ops` tests that don't need them.
|
||||
*/
|
||||
export interface SetupRigOptions {
|
||||
withStreams?: boolean;
|
||||
}
|
||||
|
||||
export async function setupFileRig(
|
||||
bobConfig: Omit<FileHandlerConfig, 'streamsBridge'>,
|
||||
options: SetupRigOptions = {},
|
||||
): Promise<FileTestRig> {
|
||||
const withStreams = options.withStreams ?? true;
|
||||
// 1. Prekey server
|
||||
const prekeyEvents = new PrekeyServerEvents();
|
||||
const prekey = createPrekeyServer({
|
||||
crypto,
|
||||
store: new MemoryPrekeyStore(),
|
||||
disableRateLimit: true,
|
||||
events: prekeyEvents,
|
||||
});
|
||||
const prekeyServer = Bun.serve({ port: 0, fetch: prekey.fetch });
|
||||
const prekeyUrl = `http://localhost:${prekeyServer.port}`;
|
||||
|
||||
// 2. Two Shades
|
||||
const alice = await createShade({ prekeyServer: prekeyUrl, address: 'alice' });
|
||||
const bob = await createShade({ prekeyServer: prekeyUrl, address: 'bob' });
|
||||
|
||||
// 3. BOTH sides need a transferRoute mounted because file-RPC is
|
||||
// request/response — Bob's reply must reach Alice's HTTP endpoint
|
||||
// just as Alice's request reached Bob's.
|
||||
let bobBaseUrl = '';
|
||||
let aliceBaseUrl = '';
|
||||
|
||||
alice.configureTransfers({
|
||||
resolveBaseUrl: async (peer) => {
|
||||
if (peer === 'bob') return bobBaseUrl;
|
||||
throw new Error(`alice: unknown peer ${peer}`);
|
||||
},
|
||||
});
|
||||
bob.configureTransfers({
|
||||
resolveBaseUrl: async (peer) => {
|
||||
if (peer === 'alice') return aliceBaseUrl;
|
||||
throw new Error(`bob: unknown peer ${peer}`);
|
||||
},
|
||||
});
|
||||
|
||||
const bobApp = await bob.transferRoute();
|
||||
const aliceApp = await alice.transferRoute();
|
||||
const bobServer = Bun.serve({ port: 0, fetch: bobApp.fetch });
|
||||
const aliceServer = Bun.serve({ port: 0, fetch: aliceApp.fetch });
|
||||
bobBaseUrl = `http://localhost:${bobServer.port}`;
|
||||
aliceBaseUrl = `http://localhost:${aliceServer.port}`;
|
||||
|
||||
// 4. Streams bridges (both sides) — required for content I/O > 256 KiB.
|
||||
let bobStreamsBridge: ServerStreamsBridge | undefined;
|
||||
let aliceStreamsBridge: ClientStreamsBridge | undefined;
|
||||
if (withStreams) {
|
||||
bobStreamsBridge = await createServerStreamsBridge(bob);
|
||||
aliceStreamsBridge = await createClientStreamsBridge(alice);
|
||||
}
|
||||
|
||||
// 5. Bob: file handler + channel
|
||||
const bobChannel = new ShadeFileRpcChannel(bob);
|
||||
const fullBobConfig: FileHandlerConfig = {
|
||||
...bobConfig,
|
||||
...(bobStreamsBridge !== undefined ? { streamsBridge: bobStreamsBridge } : {}),
|
||||
};
|
||||
const bobHandler = createFileHandler(bob, fullBobConfig);
|
||||
attachFileHandler(bobChannel, bobHandler);
|
||||
|
||||
// 6. Alice: client + channel + pending registry
|
||||
const aliceChannel = new ShadeFileRpcChannel(alice);
|
||||
const alicePending = new PendingRpcRegistry();
|
||||
attachClientRouting(aliceChannel, alicePending);
|
||||
const fs = createFileClient(alice, aliceChannel, alicePending, 'bob', {
|
||||
defaultTimeoutMs: 5000,
|
||||
...(aliceStreamsBridge !== undefined ? { streamsBridge: aliceStreamsBridge } : {}),
|
||||
});
|
||||
|
||||
return {
|
||||
alice,
|
||||
bob,
|
||||
fs,
|
||||
bobHandler,
|
||||
bobStreamsBridge: bobStreamsBridge as ServerStreamsBridge,
|
||||
aliceStreamsBridge: aliceStreamsBridge as ClientStreamsBridge,
|
||||
async teardown() {
|
||||
bobChannel.destroy();
|
||||
aliceChannel.destroy();
|
||||
bobHandler.destroy();
|
||||
if (bobStreamsBridge !== undefined) await bobStreamsBridge.destroy();
|
||||
if (aliceStreamsBridge !== undefined) await aliceStreamsBridge.destroy();
|
||||
await alice.shutdown();
|
||||
await bob.shutdown();
|
||||
bobServer.stop();
|
||||
aliceServer.stop();
|
||||
prekeyServer.stop();
|
||||
},
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user