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>
124 lines
4.5 KiB
TypeScript
124 lines
4.5 KiB
TypeScript
import { describe, test, expect, beforeAll, afterAll } from 'bun:test';
|
|
import { sha256 } from '@noble/hashes/sha2.js';
|
|
import { ConflictError, NotFoundError } from '../../src/index.js';
|
|
import { setupFileRig, type FileTestRig } from './helpers/rig.js';
|
|
|
|
function bytesToHex(b: Uint8Array): string {
|
|
return Array.from(b, (x) => x.toString(16).padStart(2, '0')).join('');
|
|
}
|
|
|
|
// Minimal valid PNG: 8-byte signature + IHDR + zero-byte IDAT + IEND. We
|
|
// use realistic magic bytes so the format-hardening check accepts it.
|
|
function tinyPng(): Uint8Array {
|
|
const sig = new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
|
|
const filler = new Uint8Array(20);
|
|
const out = new Uint8Array(sig.length + filler.length);
|
|
out.set(sig, 0);
|
|
out.set(filler, sig.length);
|
|
return out;
|
|
}
|
|
|
|
function tinyJpeg(): Uint8Array {
|
|
const head = new Uint8Array([0xff, 0xd8, 0xff, 0xe0]);
|
|
const filler = new Uint8Array(12);
|
|
const out = new Uint8Array(head.length + filler.length);
|
|
out.set(head, 0);
|
|
out.set(filler, head.length);
|
|
return out;
|
|
}
|
|
|
|
function tinyWebp(): Uint8Array {
|
|
// 'RIFF' + sizeLE + 'WEBP' + 'VP8 ' (or 'VP8L' / 'VP8X')
|
|
const out = new Uint8Array(20);
|
|
out.set([0x52, 0x49, 0x46, 0x46], 0); // 'RIFF'
|
|
out.set([0x0c, 0x00, 0x00, 0x00], 4); // size little-endian (12 bytes follow)
|
|
out.set([0x57, 0x45, 0x42, 0x50], 8); // 'WEBP'
|
|
out.set([0x56, 0x50, 0x38, 0x20], 12); // 'VP8 '
|
|
return out;
|
|
}
|
|
|
|
describe('Content I/O — getThumbnail E2E with format hardening', () => {
|
|
let rig: FileTestRig;
|
|
// Map: path → (size → { bytes, format })
|
|
const thumbnails = new Map<string, Map<number, { bytes: Uint8Array; format: 'png' | 'webp' | 'jpeg' }>>();
|
|
|
|
beforeAll(async () => {
|
|
thumbnails.clear();
|
|
thumbnails.set(
|
|
'/photo.png',
|
|
new Map([
|
|
[64, { bytes: tinyPng(), format: 'png' }],
|
|
[128, { bytes: tinyPng(), format: 'png' }],
|
|
]),
|
|
);
|
|
thumbnails.set(
|
|
'/holiday.jpg',
|
|
new Map([[256, { bytes: tinyJpeg(), format: 'jpeg' }]]),
|
|
);
|
|
thumbnails.set(
|
|
'/icon.webp',
|
|
new Map([[64, { bytes: tinyWebp(), format: 'webp' }]]),
|
|
);
|
|
// Mismatched format: server returns PNG bytes but claims JPEG.
|
|
thumbnails.set('/lying.png', new Map([[64, { bytes: tinyPng(), format: 'jpeg' }]]));
|
|
|
|
rig = await setupFileRig({
|
|
getThumbnail: async (ctx) => {
|
|
const sizes = thumbnails.get(ctx.path);
|
|
if (sizes === undefined) throw new NotFoundError(ctx.path);
|
|
const entry = sizes.get(ctx.args.size);
|
|
if (entry === undefined) throw new NotFoundError(`${ctx.path}@${ctx.args.size}`);
|
|
return {
|
|
bytes: entry.bytes,
|
|
format: entry.format,
|
|
width: ctx.args.size,
|
|
height: ctx.args.size,
|
|
};
|
|
},
|
|
});
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await rig.teardown();
|
|
});
|
|
|
|
test('PNG thumbnail round-trips with computed sha256', async () => {
|
|
const result = await rig.fs.getThumbnail('/photo.png', 64);
|
|
expect(result.format).toBe('png');
|
|
expect(result.width).toBe(64);
|
|
expect(result.height).toBe(64);
|
|
expect(result.sha256).toBe(bytesToHex(sha256(result.bytes)));
|
|
// Verify magic bytes survived
|
|
expect(Array.from(result.bytes.slice(0, 8))).toEqual([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]);
|
|
});
|
|
|
|
test('JPEG thumbnail round-trips', async () => {
|
|
const result = await rig.fs.getThumbnail('/holiday.jpg', 256);
|
|
expect(result.format).toBe('jpeg');
|
|
expect(result.width).toBe(256);
|
|
expect(Array.from(result.bytes.slice(0, 3))).toEqual([0xff, 0xd8, 0xff]);
|
|
});
|
|
|
|
test('WebP thumbnail round-trips', async () => {
|
|
const result = await rig.fs.getThumbnail('/icon.webp', 64);
|
|
expect(result.format).toBe('webp');
|
|
expect(Array.from(result.bytes.slice(0, 4))).toEqual([0x52, 0x49, 0x46, 0x46]);
|
|
expect(Array.from(result.bytes.slice(8, 12))).toEqual([0x57, 0x45, 0x42, 0x50]);
|
|
});
|
|
|
|
test('PNG bytes claimed as JPEG → format-hardening rejects', async () => {
|
|
await expect(rig.fs.getThumbnail('/lying.png', 64)).rejects.toBeInstanceOf(ConflictError);
|
|
});
|
|
|
|
test('non-existent path → NotFoundError', async () => {
|
|
await expect(rig.fs.getThumbnail('/missing.png', 64)).rejects.toBeInstanceOf(NotFoundError);
|
|
});
|
|
|
|
test('different sizes return different thumbnails', async () => {
|
|
const small = await rig.fs.getThumbnail('/photo.png', 64);
|
|
const big = await rig.fs.getThumbnail('/photo.png', 128);
|
|
expect(small.width).toBe(64);
|
|
expect(big.width).toBe(128);
|
|
});
|
|
});
|