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:
@@ -1,5 +1,5 @@
|
||||
import { Database } from 'bun:sqlite';
|
||||
import type { StorageProvider, IdentityKeyPair, SignedPreKey, OneTimePreKey, SessionState, RetiredIdentity } from '@shade/core';
|
||||
import type { StorageProvider, IdentityKeyPair, SignedPreKey, OneTimePreKey, SessionState, RetiredIdentity, PersistedStreamState } from '@shade/core';
|
||||
import {
|
||||
toBase64, fromBase64,
|
||||
constantTimeEqual,
|
||||
@@ -42,6 +42,12 @@ export class SQLiteStorage implements StorageProvider {
|
||||
addRetired: ReturnType<Database['prepare']>;
|
||||
listRetired: ReturnType<Database['prepare']>;
|
||||
pruneRetired: ReturnType<Database['prepare']>;
|
||||
saveStreamState: ReturnType<Database['prepare']>;
|
||||
getStreamState: ReturnType<Database['prepare']>;
|
||||
removeStreamState: ReturnType<Database['prepare']>;
|
||||
listActiveStreamStates: ReturnType<Database['prepare']>;
|
||||
listActiveStreamStatesByDirection: ReturnType<Database['prepare']>;
|
||||
pruneStreamStates: ReturnType<Database['prepare']>;
|
||||
};
|
||||
|
||||
constructor(dbPath?: string) {
|
||||
@@ -87,6 +93,24 @@ export class SQLiteStorage implements StorageProvider {
|
||||
retired_at INTEGER NOT NULL
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_retired_at ON retired_identities(retired_at);
|
||||
CREATE TABLE IF NOT EXISTS stream_state (
|
||||
stream_id TEXT PRIMARY KEY,
|
||||
direction TEXT NOT NULL,
|
||||
peer_address TEXT NOT NULL,
|
||||
status TEXT NOT NULL,
|
||||
metadata_json TEXT NOT NULL,
|
||||
partition_json TEXT NOT NULL,
|
||||
lane_state_json TEXT NOT NULL,
|
||||
io_descriptor_json TEXT NOT NULL,
|
||||
secret_enc BLOB NOT NULL,
|
||||
secret_nonce BLOB NOT NULL,
|
||||
overall_hash_state TEXT,
|
||||
created_at INTEGER NOT NULL,
|
||||
updated_at INTEGER NOT NULL
|
||||
);
|
||||
CREATE INDEX IF NOT EXISTS idx_stream_state_peer ON stream_state(peer_address);
|
||||
CREATE INDEX IF NOT EXISTS idx_stream_state_updated ON stream_state(updated_at);
|
||||
CREATE INDEX IF NOT EXISTS idx_stream_state_status ON stream_state(status, direction);
|
||||
`);
|
||||
}
|
||||
|
||||
@@ -111,6 +135,24 @@ export class SQLiteStorage implements StorageProvider {
|
||||
addRetired: this.db.prepare('INSERT INTO retired_identities (data_json, retired_at) VALUES (?, ?)'),
|
||||
listRetired: this.db.prepare('SELECT data_json, retired_at FROM retired_identities ORDER BY retired_at DESC'),
|
||||
pruneRetired: this.db.prepare('DELETE FROM retired_identities WHERE retired_at < ?'),
|
||||
saveStreamState: this.db.prepare(
|
||||
`INSERT OR REPLACE INTO stream_state (
|
||||
stream_id, direction, peer_address, status,
|
||||
metadata_json, partition_json, lane_state_json, io_descriptor_json,
|
||||
secret_enc, secret_nonce, overall_hash_state, created_at, updated_at
|
||||
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`,
|
||||
),
|
||||
getStreamState: this.db.prepare('SELECT * FROM stream_state WHERE stream_id = ?'),
|
||||
removeStreamState: this.db.prepare('DELETE FROM stream_state WHERE stream_id = ?'),
|
||||
listActiveStreamStates: this.db.prepare(
|
||||
"SELECT * FROM stream_state WHERE status IN ('active', 'paused') ORDER BY updated_at DESC",
|
||||
),
|
||||
listActiveStreamStatesByDirection: this.db.prepare(
|
||||
"SELECT * FROM stream_state WHERE status IN ('active', 'paused') AND direction = ? ORDER BY updated_at DESC",
|
||||
),
|
||||
pruneStreamStates: this.db.prepare(
|
||||
"DELETE FROM stream_state WHERE status IN ('finished', 'aborted') AND updated_at < ?",
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -235,4 +277,78 @@ export class SQLiteStorage implements StorageProvider {
|
||||
async pruneRetiredIdentities(olderThan: number): Promise<void> {
|
||||
this.stmts.pruneRetired.run(olderThan);
|
||||
}
|
||||
|
||||
// ─── Stream-transfer resume state (v0.2.0) ────────────────
|
||||
|
||||
async saveStreamState(state: PersistedStreamState): Promise<void> {
|
||||
this.stmts.saveStreamState.run(
|
||||
state.streamId,
|
||||
state.direction,
|
||||
state.peerAddress,
|
||||
state.status,
|
||||
state.metadataJson,
|
||||
state.partitionJson,
|
||||
state.laneStateJson,
|
||||
state.ioDescriptorJson,
|
||||
state.secretEnc,
|
||||
state.secretNonce,
|
||||
state.overallHashState ?? null,
|
||||
state.createdAt,
|
||||
state.updatedAt,
|
||||
);
|
||||
}
|
||||
|
||||
async getStreamState(streamId: string): Promise<PersistedStreamState | null> {
|
||||
const row = this.stmts.getStreamState.get(streamId) as any;
|
||||
if (!row) return null;
|
||||
return rowToStreamState(row);
|
||||
}
|
||||
|
||||
async removeStreamState(streamId: string): Promise<void> {
|
||||
this.stmts.removeStreamState.run(streamId);
|
||||
}
|
||||
|
||||
async listActiveStreamStates(direction?: 'send' | 'receive'): Promise<PersistedStreamState[]> {
|
||||
const rows = (
|
||||
direction === undefined
|
||||
? (this.stmts.listActiveStreamStates.all() as any[])
|
||||
: (this.stmts.listActiveStreamStatesByDirection.all(direction) as any[])
|
||||
);
|
||||
return rows.map(rowToStreamState);
|
||||
}
|
||||
|
||||
async pruneStreamStates(olderThan: number): Promise<void> {
|
||||
this.stmts.pruneStreamStates.run(olderThan);
|
||||
}
|
||||
}
|
||||
|
||||
function rowToStreamState(row: any): PersistedStreamState {
|
||||
const out: PersistedStreamState = {
|
||||
streamId: row.stream_id,
|
||||
direction: row.direction,
|
||||
peerAddress: row.peer_address,
|
||||
status: row.status,
|
||||
metadataJson: row.metadata_json,
|
||||
partitionJson: row.partition_json,
|
||||
laneStateJson: row.lane_state_json,
|
||||
ioDescriptorJson: row.io_descriptor_json,
|
||||
secretEnc: toBytes(row.secret_enc),
|
||||
secretNonce: toBytes(row.secret_nonce),
|
||||
createdAt: Number(row.created_at),
|
||||
updatedAt: Number(row.updated_at),
|
||||
};
|
||||
if (row.overall_hash_state !== null && row.overall_hash_state !== undefined) {
|
||||
out.overallHashState = row.overall_hash_state;
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
function toBytes(value: unknown): Uint8Array {
|
||||
if (value instanceof Uint8Array) return value;
|
||||
if (value instanceof ArrayBuffer) return new Uint8Array(value);
|
||||
if (Array.isArray(value)) return new Uint8Array(value);
|
||||
if (typeof value === 'string') {
|
||||
return new Uint8Array(value.split('').map((c) => c.charCodeAt(0)));
|
||||
}
|
||||
throw new Error(`Unsupported BLOB representation: ${typeof value}`);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user