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>
162 lines
5.4 KiB
TypeScript
162 lines
5.4 KiB
TypeScript
import { describe, expect, test } from 'bun:test';
|
|
import { decideInline, INLINE_THRESHOLD } from '../../src/client/inline-threshold.js';
|
|
|
|
const KIB = 1024;
|
|
|
|
function streamOf(...chunks: Uint8Array[]): ReadableStream<Uint8Array> {
|
|
let i = 0;
|
|
return new ReadableStream<Uint8Array>({
|
|
pull(controller) {
|
|
if (i < chunks.length) {
|
|
controller.enqueue(chunks[i]!);
|
|
i++;
|
|
} else {
|
|
controller.close();
|
|
}
|
|
},
|
|
});
|
|
}
|
|
|
|
async function drainStream(s: ReadableStream<Uint8Array>): Promise<Uint8Array> {
|
|
const reader = s.getReader();
|
|
const parts: Uint8Array[] = [];
|
|
let total = 0;
|
|
while (true) {
|
|
const { value, done } = await reader.read();
|
|
if (done) break;
|
|
if (value === undefined) continue;
|
|
parts.push(value);
|
|
total += value.byteLength;
|
|
}
|
|
reader.releaseLock();
|
|
const out = new Uint8Array(total);
|
|
let offset = 0;
|
|
for (const p of parts) {
|
|
out.set(p, offset);
|
|
offset += p.byteLength;
|
|
}
|
|
return out;
|
|
}
|
|
|
|
describe('decideInline (Uint8Array)', () => {
|
|
test('1 KiB → inline', async () => {
|
|
const bytes = new Uint8Array(KIB).fill(0xab);
|
|
const decision = await decideInline(bytes);
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.bytes.byteLength).toBe(KIB);
|
|
}
|
|
});
|
|
|
|
test('exactly 256 KiB → inline (boundary)', async () => {
|
|
const bytes = new Uint8Array(INLINE_THRESHOLD).fill(0xcd);
|
|
const decision = await decideInline(bytes);
|
|
expect(decision.kind).toBe('inline');
|
|
});
|
|
|
|
test('256 KiB + 1 → streams (boundary +1)', async () => {
|
|
const bytes = new Uint8Array(INLINE_THRESHOLD + 1).fill(0xef);
|
|
const decision = await decideInline(bytes);
|
|
expect(decision.kind).toBe('streams');
|
|
if (decision.kind === 'streams') {
|
|
expect(decision.size).toBe(INLINE_THRESHOLD + 1);
|
|
const drained = await drainStream(decision.stream);
|
|
expect(drained.byteLength).toBe(INLINE_THRESHOLD + 1);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('decideInline (Blob)', () => {
|
|
test('small Blob → inline + propagates contentType', async () => {
|
|
const blob = new Blob([new Uint8Array(100).fill(7)], { type: 'application/octet-stream' });
|
|
const decision = await decideInline(blob);
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.contentType).toBe('application/octet-stream');
|
|
expect(decision.bytes.byteLength).toBe(100);
|
|
}
|
|
});
|
|
|
|
test('large Blob → streams + propagates size + contentType', async () => {
|
|
const big = new Uint8Array(INLINE_THRESHOLD + KIB).fill(1);
|
|
const blob = new Blob([big], { type: 'image/png' });
|
|
const decision = await decideInline(blob);
|
|
expect(decision.kind).toBe('streams');
|
|
if (decision.kind === 'streams') {
|
|
expect(decision.size).toBe(big.byteLength);
|
|
expect(decision.contentType).toBe('image/png');
|
|
}
|
|
});
|
|
|
|
test('empty Blob.type → no contentType', async () => {
|
|
const blob = new Blob([new Uint8Array(10)]);
|
|
const decision = await decideInline(blob);
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.contentType).toBeUndefined();
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('decideInline (ReadableStream — bare)', () => {
|
|
test('EOF before threshold → inline', async () => {
|
|
const stream = streamOf(new Uint8Array(100), new Uint8Array(200));
|
|
const decision = await decideInline(stream);
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.bytes.byteLength).toBe(300);
|
|
}
|
|
});
|
|
|
|
test('crosses threshold mid-chunk → streams + remainder available', async () => {
|
|
// 256 KiB + 1 byte across two chunks
|
|
const a = new Uint8Array(200 * KIB).fill(0x10);
|
|
const b = new Uint8Array(100 * KIB).fill(0x20);
|
|
const stream = streamOf(a, b);
|
|
const decision = await decideInline(stream);
|
|
expect(decision.kind).toBe('streams');
|
|
if (decision.kind === 'streams') {
|
|
const drained = await drainStream(decision.stream);
|
|
expect(drained.byteLength).toBe(a.byteLength + b.byteLength);
|
|
expect(drained[0]).toBe(0x10);
|
|
expect(drained[drained.length - 1]).toBe(0x20);
|
|
}
|
|
});
|
|
|
|
test('empty stream → inline (zero bytes)', async () => {
|
|
const stream = streamOf();
|
|
const decision = await decideInline(stream);
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.bytes.byteLength).toBe(0);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('decideInline ({ stream, size })', () => {
|
|
test('declared size ≤ threshold → inline', async () => {
|
|
const bytes = new Uint8Array(KIB).fill(9);
|
|
const decision = await decideInline({ stream: streamOf(bytes), size: KIB, contentType: 'text/plain' });
|
|
expect(decision.kind).toBe('inline');
|
|
if (decision.kind === 'inline') {
|
|
expect(decision.bytes.byteLength).toBe(KIB);
|
|
expect(decision.contentType).toBe('text/plain');
|
|
}
|
|
});
|
|
|
|
test('declared size > threshold → streams', async () => {
|
|
const big = new Uint8Array(500 * KIB).fill(2);
|
|
const decision = await decideInline({ stream: streamOf(big), size: big.byteLength });
|
|
expect(decision.kind).toBe('streams');
|
|
if (decision.kind === 'streams') {
|
|
expect(decision.size).toBe(big.byteLength);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('decideInline (errors)', () => {
|
|
test('unsupported input throws TypeError', async () => {
|
|
await expect(decideInline(42 as unknown as Uint8Array)).rejects.toThrow(TypeError);
|
|
});
|
|
});
|