Files

171 lines
5.1 KiB
TypeScript
Raw Permalink Normal View History

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
/**
* Bob the file SERVER. Mounts a virtual filesystem rooted in this
* directory's `./files-root/` dir (created on first run) and serves it
* over `@shade/files` E2EE RPC.
*
* Demonstrates: list/stat/mkdir/delete/move + read/write inline+streams.
*/
import { mkdir, readdir, readFile, rename, rm, stat, writeFile } from 'node:fs/promises';
import { createReadStream } from 'node:fs';
import { Readable } from 'node:stream';
import { join, basename, dirname } from 'node:path';
import { createShade } from '@shade/sdk';
import {
ConflictError,
NotFoundError,
type FileEntry,
type UserReadResult,
} from '@shade/files';
const ROOT = join(import.meta.dir, 'files-root');
await mkdir(ROOT, { recursive: true });
const PREKEY = 'http://localhost:9992';
const BOB_BASE_URL = 'http://localhost:9994';
const ALICE_BASE_URL = 'http://localhost:9993';
const bob = await createShade({ prekeyServer: PREKEY, address: 'bob' });
bob.configureTransfers({
resolveBaseUrl: async (peer) => {
if (peer === 'alice') return ALICE_BASE_URL;
throw new Error(`bob: unknown peer ${peer}`);
},
});
const app = await bob.transferRoute();
Bun.serve({ port: 9994, fetch: app.fetch });
console.log(`[bob] listening on ${BOB_BASE_URL}, files at ${ROOT}`);
function safePath(remote: string): string {
// Strip leading slash + reject any '..' (the dispatcher already does
// this, but we defend in depth).
const segments = remote.split('/').filter((s) => s !== '' && s !== '..');
return join(ROOT, ...segments);
}
await bob.files.serve({
list: async (ctx) => {
const local = safePath(ctx.path);
let names: string[];
try {
names = await readdir(local);
} catch {
throw new NotFoundError(ctx.path);
}
const entries: FileEntry[] = [];
for (const name of names) {
const s = await stat(join(local, name));
entries.push({
name,
kind: s.isDirectory() ? 'dir' : 'file',
size: s.isDirectory() ? 0 : s.size,
mtime: s.mtimeMs,
metadata: {},
});
}
return { entries, hasMore: false };
},
stat: async (ctx) => {
let s: import('node:fs').Stats;
try {
s = await stat(safePath(ctx.path));
} catch {
throw new NotFoundError(ctx.path);
}
return {
name: basename(ctx.path),
kind: s.isDirectory() ? 'dir' : 'file',
size: s.isDirectory() ? 0 : s.size,
mtime: s.mtimeMs,
metadata: {},
};
},
mkdir: async (ctx) => {
const local = safePath(ctx.path);
await mkdir(local, { recursive: ctx.args.recursive });
return {
entry: {
name: basename(ctx.path),
kind: 'dir',
size: 0,
mtime: Date.now(),
metadata: {},
},
};
},
delete: async (ctx) => {
await rm(safePath(ctx.path), { recursive: ctx.args.recursive, force: false });
return { deletedCount: 1 };
},
move: async (ctx) => {
await rename(safePath(ctx.args.src), safePath(ctx.args.dst));
return {
entry: {
name: basename(ctx.args.dst),
kind: 'file',
size: 0,
mtime: Date.now(),
metadata: {},
},
};
},
read: async (ctx): Promise<UserReadResult> => {
const local = safePath(ctx.path);
const s = await stat(local);
if (s.isDirectory()) throw new ConflictError(`${ctx.path} is a directory`);
if (s.size <= 256 * 1024) {
const bytes = new Uint8Array(await readFile(local));
return { kind: 'inline', bytes };
}
// Stream the file.
const sha256 = await computeSha256OfFile(local);
const stream = Readable.toWeb(createReadStream(local)) as ReadableStream<Uint8Array>;
return { kind: 'streams', stream, size: s.size, sha256 };
},
write: async (ctx) => {
const local = safePath(ctx.args.path);
await mkdir(dirname(local), { recursive: true });
if (ctx.args.content.kind === 'inline') {
await writeFile(local, ctx.args.content.bytes);
} else {
// Drain stream → temp buffer → file. For huge files use createWriteStream.
const reader = ctx.args.content.stream.getReader();
const chunks: Uint8Array[] = [];
let total = 0;
while (true) {
const { value, done } = await reader.read();
if (done) break;
if (value !== undefined) {
chunks.push(value);
total += value.byteLength;
}
}
reader.releaseLock();
const out = new Uint8Array(total);
let offset = 0;
for (const c of chunks) {
out.set(c, offset);
offset += c.byteLength;
}
await writeFile(local, out);
// Verify integrity (optional)
await ctx.args.content.sha256;
}
const s = await stat(local);
return {
entry: {
name: basename(ctx.args.path),
kind: 'file',
size: s.size,
mtime: s.mtimeMs,
metadata: {},
},
};
},
});
async function computeSha256OfFile(path: string): Promise<string> {
const { sha256 } = await import('@noble/hashes/sha2.js');
const data = new Uint8Array(await readFile(path));
return Array.from(sha256(data), (b) => b.toString(16).padStart(2, '0')).join('');
}