Files
Shade/packages/shade-streams/tests/partition.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
5.2 KiB
TypeScript

import { describe, test, expect } from 'bun:test';
import { ValidationError } from '@shade/core';
import {
planRangePartition,
planRoundRobinPartition,
chunkRange,
partitionsEqual,
} from '../src/index.js';
describe('planRangePartition', () => {
test('evenly divisible totalBytes', () => {
const lanes = planRangePartition(100, 4);
expect(lanes).toHaveLength(4);
expect(lanes[0]!.partition).toEqual({ kind: 'range', startByte: 0, endByte: 25, startChunk: 0 });
expect(lanes[3]!.partition).toEqual({ kind: 'range', startByte: 75, endByte: 100, startChunk: 0 });
});
test('non-divisible: extra bytes go to early lanes', () => {
const lanes = planRangePartition(10, 3);
const ranges = lanes.map((l) => l.partition);
// 10 / 3 = 3 remainder 1 — lane 0 gets 4, lanes 1+2 get 3 each
expect(ranges[0]).toEqual({ kind: 'range', startByte: 0, endByte: 4, startChunk: 0 });
expect(ranges[1]).toEqual({ kind: 'range', startByte: 4, endByte: 7, startChunk: 0 });
expect(ranges[2]).toEqual({ kind: 'range', startByte: 7, endByte: 10, startChunk: 0 });
});
test('lanes cover entire range without gaps or overlap', () => {
for (const total of [0, 1, 7, 100, 1024 * 1024]) {
for (const count of [1, 2, 4, 16]) {
const lanes = planRangePartition(total, count);
let cursor = 0;
for (const lane of lanes) {
if (lane.partition.kind !== 'range') throw new Error('expected range');
expect(lane.partition.startByte).toBe(cursor);
cursor = lane.partition.endByte;
}
expect(cursor).toBe(total);
}
}
});
test('1-lane partition spans entire input', () => {
const lanes = planRangePartition(500, 1);
expect(lanes).toHaveLength(1);
expect(lanes[0]!.partition).toEqual({ kind: 'range', startByte: 0, endByte: 500, startChunk: 0 });
});
test('rejects negative totalBytes / fractional / non-positive count', () => {
expect(() => planRangePartition(-1, 1)).toThrow(ValidationError);
expect(() => planRangePartition(1.5, 1)).toThrow(ValidationError);
expect(() => planRangePartition(100, 0)).toThrow(ValidationError);
expect(() => planRangePartition(100, -1)).toThrow(ValidationError);
});
test('laneIds are 0..count-1 in order', () => {
const lanes = planRangePartition(64, 16);
for (let i = 0; i < 16; i++) expect(lanes[i]!.laneId).toBe(i);
});
});
describe('planRoundRobinPartition', () => {
test('produces N lanes labeled 0..N-1', () => {
const lanes = planRoundRobinPartition(8);
expect(lanes).toHaveLength(8);
for (let i = 0; i < 8; i++) {
expect(lanes[i]!.laneId).toBe(i);
expect(lanes[i]!.partition).toEqual({ kind: 'round-robin', lane: i, count: 8 });
}
});
test('rejects non-positive count', () => {
expect(() => planRoundRobinPartition(0)).toThrow(ValidationError);
expect(() => planRoundRobinPartition(-1)).toThrow(ValidationError);
});
});
describe('chunkRange', () => {
test('splits an even range into chunkSize slices', () => {
expect(chunkRange(0, 1024, 256)).toEqual([
{ start: 0, end: 256 },
{ start: 256, end: 512 },
{ start: 512, end: 768 },
{ start: 768, end: 1024 },
]);
});
test('last chunk truncated for non-divisible range', () => {
expect(chunkRange(0, 1000, 256)).toEqual([
{ start: 0, end: 256 },
{ start: 256, end: 512 },
{ start: 512, end: 768 },
{ start: 768, end: 1000 },
]);
});
test('non-zero start offset is preserved', () => {
expect(chunkRange(100, 350, 100)).toEqual([
{ start: 100, end: 200 },
{ start: 200, end: 300 },
{ start: 300, end: 350 },
]);
});
test('empty range produces a single empty chunk (so isLast can be carried)', () => {
expect(chunkRange(50, 50, 100)).toEqual([{ start: 50, end: 50 }]);
});
test('rejects non-positive chunkSize', () => {
expect(() => chunkRange(0, 100, 0)).toThrow(ValidationError);
expect(() => chunkRange(0, 100, -1)).toThrow(ValidationError);
});
});
describe('partitionsEqual', () => {
test('identical range partitions', () => {
expect(
partitionsEqual(
{ kind: 'range', startByte: 0, endByte: 100, startChunk: 0 },
{ kind: 'range', startByte: 0, endByte: 100, startChunk: 0 },
),
).toBe(true);
});
test('different range bounds', () => {
expect(
partitionsEqual(
{ kind: 'range', startByte: 0, endByte: 100, startChunk: 0 },
{ kind: 'range', startByte: 0, endByte: 200, startChunk: 0 },
),
).toBe(false);
});
test('range vs round-robin → false', () => {
expect(
partitionsEqual(
{ kind: 'range', startByte: 0, endByte: 100, startChunk: 0 },
{ kind: 'round-robin', lane: 0, count: 1 },
),
).toBe(false);
});
test('identical round-robin partitions', () => {
expect(
partitionsEqual(
{ kind: 'round-robin', lane: 2, count: 4 },
{ kind: 'round-robin', lane: 2, count: 4 },
),
).toBe(true);
});
test('different round-robin lane index', () => {
expect(
partitionsEqual(
{ kind: 'round-robin', lane: 1, count: 4 },
{ kind: 'round-robin', lane: 2, count: 4 },
),
).toBe(false);
});
});