@zenfs/core 2.8.0 → 2.8.2

package/dist/node/types.d.ts

@@ -1,4 +1,5 @@
 import type * as fs from 'node:fs';
+import type { Stream } from 'node:stream';
 /**
  * @hidden
  */
@@ -11,11 +12,15 @@ export type NodeReaddirOptions = {
  * Notes on omissions and exclusions:
  *	- `__promisify__` is omitted since it is type metadata
  *	- `native` is omitted since zenfs isn't native
+ *	- Static members that `ReadStream` and `WriteStream` inherit from `node:stream` are omitted since they aren't part of the `fs` API
  * @internal @hidden
  */
 export type NodeFS = {
     [K in keyof typeof fs]: (typeof fs)[K] extends (...args: any[]) => any ? // Some kind of wizardry: by using a union with a regular function, overloads are preserved but the properties disappear.
-    (typeof fs)[K] | ((...args: any[]) => any) : (typeof fs)[K] extends object ? Omit<(typeof fs)[K], '__promisify__' | 'native'> : (typeof fs)[K];
+    (typeof fs)[K] | ((...args: any[]) => any) : (typeof fs)[K] extends object ? Omit<(typeof fs)[K], '__promisify__' | 'native' | (K extends 'ReadStream' | 'WriteStream' ? StreamStatics : never)> : (typeof fs)[K];
 };
+/** @internal @hidden */
+type StreamStatics = Exclude<keyof typeof Stream, 'prototype'>;
 /** Helper union @hidden */
 export type GlobOptionsU = fs.GlobOptionsWithFileTypes | fs.GlobOptionsWithoutFileTypes | fs.GlobOptions;
+export {};

package/eslint.shared.js

@@ -3,6 +3,7 @@ import eslint from '@eslint/js';
 import globals from 'globals';
 import { configs } from 'typescript-eslint';
 
+/** @deprecated Use `@zenfs/devel/eslint` */
 export default [
 	{
 		name: 'ZenFS',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "2.8.0",
+	"version": "2.8.2",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -66,8 +66,8 @@
 		"spdx:check": "npx lice -a src tests/*.ts tests/**/*.test.ts",
 		"spdx:fix": "npx lice -aw src tests/*.ts tests/**/*.test.ts",
 		"lint": "eslint src tests",
-		"test": "npx -s zenfs-test --clean; npx -s zenfs-test -abcpn; tests/fetch/run.sh; npx -s zenfs-test --report-only",
-		"test:native": "npx -s zenfs-test -n tests/native-setup.ts --verbose",
+		"test": "npx -s zenfs-test -abc --report",
+		"test:native": "npx -s zenfs-test tests/native-setup.ts --verbose",
 		"test:perf": "zbench",
 		"build": "tsc --build",
 		"dev": "tsc --build --watch",
@@ -75,7 +75,7 @@
 	},
 	"dependencies": {
 		"@types/node": "^26.0.0",
-		"@zenfs/streams": "^1.0.0",
+		"@zenfs/streams": "^1.0.2",
 		"buffer": "^6.0.3",
 		"eventemitter3": "^5.0.1",
 		"kerium": "^1.5.0",
@@ -83,17 +83,18 @@
 		"utilium": "^3.7.0"
 	},
 	"devDependencies": {
-		"@eslint/js": "^10.0.1",
-		"@octokit/action": "^8.0.4",
-		"c8": "^12.0.0",
+		"@zenfs/devel": "^0.1.0",
 		"eslint": "^10.1.0",
-		"globals": "^17.3.0",
 		"prettier": "^3.2.5",
 		"typedoc": "^0.28.18",
 		"typescript": "^6.0.0",
-		"typescript-eslint": "^8.58.0",
 		"zbench-js": "^0.2.0"
 	},
+	"overrides": {
+		"@zenfs/devel": {
+			"@zenfs/core": "file:../../.."
+		}
+	},
 	"prettier": {
 		"singleQuote": true,
 		"useTabs": true,

package/scripts/ci-cli.js

@@ -1,7 +1,11 @@
 #!/usr/bin/env node
 import { spawnSync } from 'node:child_process';
 import { parseArgs } from 'node:util';
-import * as ci from './ci.js';
+import { useDevel } from './deprecated.js';
+
+await useDevel('zci');
+
+const ci = await import('./ci.js');
 
 const {
 	values: options,

package/scripts/make-index.js

@@ -2,6 +2,9 @@
 import { constants as c, lstatSync, readdirSync, writeFileSync } from 'node:fs';
 import { join, matchesGlob, relative, resolve } from 'node:path/posix';
 import { parseArgs, styleText } from 'node:util';
+import { useDevel } from './deprecated.js';
+
+await useDevel('make-index');
 
 const { values: options, positionals } = parseArgs({
 	options: {

package/scripts/test.js

@@ -4,6 +4,9 @@ import { execFileSync } from 'node:child_process';
 import { existsSync, globSync, mkdirSync, rmSync } from 'node:fs';
 import { join, parse, basename } from 'node:path';
 import { parseArgs, styleText } from 'node:util';
+import { useDevel } from './deprecated.js';
+
+await useDevel('zenfs-test');
 
 const { values: options, positionals } = parseArgs({
 	options: {

package/tests/backend/config.worker.js

@@ -1,7 +1,7 @@
 import { parentPort } from 'node:worker_threads';
 import { resolveRemoteMount } from '../../dist/backends/port.js';
 import { InMemory } from '../../dist/backends/memory.js';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs('<config>');
 

package/tests/backend/cow.test.ts

@@ -2,7 +2,7 @@
 import { CopyOnWriteFS, InMemoryStore, StoreFS } from '@zenfs/core';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 setupLogs();
 
 const size = 1 << 20;

package/tests/backend/fetch.test.ts

@@ -1,17 +1,25 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 import { CopyOnWrite, Fetch, InMemory, configureSingle, fs, mounts, resolveMountConfig, type FetchFS } from '@zenfs/core';
+import { setupLogs } from '@zenfs/devel/tests/logs';
+import { data } from '@zenfs/devel/tests/setup';
 import assert from 'node:assert/strict';
+import { once } from 'node:events';
+import { readdirSync } from 'node:fs';
 import { join } from 'node:path';
 import { after, suite, test } from 'node:test';
 import { Worker } from 'node:worker_threads';
-import { baseUrl, defaultEntries, indexPath, whenServerReady } from '../fetch/config.js';
-import { setupLogs } from '../logs.js';
 
 setupLogs();
 
-const server = new Worker(join(import.meta.dirname, '../fetch/server.js'));
+const server = new Worker(join(import.meta.dirname, 'fetch.worker.js'));
 
-await whenServerReady();
+const [port] = await once(server, 'message');
+
+const baseUrl = 'http://localhost:' + port;
+
+const indexPath = '/.index.json';
+
+const defaultEntries = readdirSync(data);
 
 await configureSingle({
 	backend: Fetch,

package/tests/{fetch/server.js → backend/fetch.worker.js}

@@ -1,24 +1,17 @@
-import { execFileSync } from 'node:child_process';
-import { readFileSync } from 'node:fs';
+import { readFileSync, lstatSync, readdirSync } from 'node:fs';
 import { createServer } from 'node:http';
+import { data } from '@zenfs/devel/tests/setup';
 import { join } from 'node:path';
-import { data, indexPath, port, tmp } from './config.js';
+import { parentPort } from 'node:worker_threads';
 
 const statusCodes = {
 	ENOENT: 404,
 };
 
-try {
-	execFileSync('npx', ['--silent', 'make-index', data, '--output', `${tmp}/index.json`, '--quiet'], { stdio: 'inherit' });
-} catch (e) {
-	if (e.signal == 'SIGINT') {
-		console.log('Aborted whilst creating index');
-		process.exit(0);
-	} else {
-		console.error('Index creation failed: ' + e.message);
-		process.exit(1);
-	}
-}
+const entries = {};
+for (const path of ['', ...readdirSync(data, { recursive: true })]) entries['/' + path] = lstatSync(join(data, path));
+
+const index = JSON.stringify({ version: 1, entries });
 
 const server = createServer((request, response) => {
 	response.statusCode = 200;
@@ -37,7 +30,12 @@ const server = createServer((request, response) => {
 		return;
 	}
 
-	const path = url == indexPath ? join(tmp, 'index.json') : join(data, url.slice(1) || '');
+	if (url == '/.index.json') {
+		response.end(index);
+		return;
+	}
+
+	const path = join(data, url.slice(1) || '');
 	try {
 		response.end(readFileSync(path));
 	} catch (e) {
@@ -46,7 +44,7 @@ const server = createServer((request, response) => {
 	}
 });
 
-server.listen(port);
+server.listen(0, () => parentPort.postMessage(server.address().port));
 
 process.on('beforeExit', () => {
 	server.close().unref();

package/tests/backend/port.test.ts

@@ -4,7 +4,7 @@ import { InMemory, Port, attachFS, configure, configureSingle, fs, resolveMountC
 import assert from 'node:assert/strict';
 import { after, suite, test } from 'node:test';
 import { MessageChannel, Worker } from 'node:worker_threads';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 setupLogs();
 
 // Tests a mis-configured `Port` using a MessageChannel

package/tests/backend/remote.worker.js

@@ -1,7 +1,7 @@
 import { parentPort } from 'node:worker_threads';
 import { attachFS } from '../../dist/backends/port.js';
 import { mounts } from '../../dist/index.js';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs('<remote>');
 

package/tests/backend/single-buffer-rotate.worker.js

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 import { parentPort, workerData } from 'node:worker_threads';
 import { SuperBlock } from '../../dist/backends/single_buffer/v1.js';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs('<worker>');
 

package/tests/backend/single-buffer-v2.test.ts

@@ -7,7 +7,7 @@ import assert from 'node:assert/strict';
 import { randomBytes } from 'node:crypto';
 import { suite, test } from 'node:test';
 import { Worker } from 'worker_threads';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs();
 

package/tests/backend/single-buffer-v2.worker.js

@@ -3,7 +3,7 @@ import { writeFileSync as _write } from 'node:fs';
 import { parentPort, workerData } from 'node:worker_threads';
 import { SingleBufferStore as SingleBufferStoreV2, SuperBlock } from '../../dist/backends/single_buffer/v2.js';
 import { configureSingle, fs, SingleBuffer } from '../../dist/index.js';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs('<worker>');
 

package/tests/backend/single-buffer.test.ts

@@ -6,7 +6,7 @@ import { Worker } from 'worker_threads';
 import { sizeof } from 'memium';
 import { fs, mount, resolveMountConfig, SingleBuffer, vfs } from '@zenfs/core';
 import { MetadataBlock, SuperBlock } from '@zenfs/core/backends/single_buffer/v1';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs();
 

package/tests/backend/single-buffer.worker.js

@@ -2,7 +2,7 @@ import assert from 'node:assert/strict';
 import { writeFileSync as _write } from 'node:fs';
 import { parentPort, workerData } from 'node:worker_threads';
 import { configureSingle, fs, SingleBuffer } from '../../dist/index.js';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 
 setupLogs('<worker>');
 

package/tests/backend/store.test.ts

@@ -2,7 +2,7 @@
 import { InMemoryStore, StoreFS } from '@zenfs/core';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import { setupLogs } from '../logs.js';
+import { setupLogs } from '@zenfs/devel/tests/logs';
 setupLogs();
 
 const fs = new StoreFS(new InMemoryStore(0x100000, 'test'));

package/tests/common/glob.test.ts

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import { fs } from '../common.ts';
+import { fs } from '@zenfs/devel/tests/common';
 
 // Set up a directory structure for glob tests
 fs.mkdirSync('/glob');

package/tests/common/utf8stream.test.ts

@@ -2,7 +2,7 @@
 import { Buffer } from 'buffer';
 import assert from 'node:assert/strict';
 import { suite, test } from 'node:test';
-import { config, fs } from '../common.ts';
+import { config, fs } from '@zenfs/devel/tests/common';
 
 suite('Utf8Stream', config('write'), () => {
 	test('writes synchronously', config('sync'), () => {

package/tests/common.ts

@@ -19,11 +19,13 @@ const setup = await import(setupPath).catch(error => {
 });
 
 // Satisfies is used to make sure that ZenFS is fully type compatible with Node.js
+/** @deprecated Use `@zenfs/devel/tests/common` */
 export const fs = (setup.fs || defaultFS) as typeof defaultFS satisfies NodeFS;
 
 /**
  * A feature or function a backend may not support.
  * Tests that need one are skipped when the backend under test does not have it.
+ * @deprecated Use `@zenfs/devel/tests/common`
  */
 export type TestFlag =
 	| 'sync'
@@ -50,13 +52,17 @@ export type TestFlag =
  *
  * `false` is for things a backend can not support, while `'skip'` is for temporarily disabling something.
  * `'todo'` is for things that should work but don't yet.
+ * @deprecated Use `@zenfs/devel/tests/common`
  */
 export type TestFlagState = boolean | 'skip' | 'todo';
 
 /** Flags are supported unless the setup says otherwise */
 const flags = (setup.flags ?? {}) as Partial<Record<TestFlag, TestFlagState>>;
 
-/** Options for `suite` and `test`. Note this is a subset of both, since they do not share a type. */
+/**
+ * Options for `suite` and `test`. Note this is a subset of both, since they do not share a type.
+ * @deprecated Use `@zenfs/devel/tests/common`
+ */
 export interface TestConfig {
 	skip?: string;
 	todo?: string;
@@ -69,6 +75,7 @@ export interface TestConfig {
  * ```ts
  * test('lchmod', config('lchmod', 'async'), async () => { ... });
  * ```
+ * @deprecated Use `@zenfs/devel/tests/common`
  */
 export function config(...required: TestFlag[]): TestConfig {
 	for (const flag of required) {

package/tests/logs.js

@@ -1,5 +1,6 @@
 import { log } from 'kerium';
 
+/** @deprecated Use `@zenfs/devel/tests/logs` */
 export function setupLogs(prefix) {
 	const { ZENFS_LOG_LEVEL } = process.env;
 

package/tests/native-setup.ts

@@ -2,10 +2,10 @@
 /* Run the FS test suite against native node:fs.
 Since the tests use absolute paths, everything is contained to a scratch directory using chroot-style path mapping. */
 import * as native from 'node:fs';
-import type { TestFlag, TestFlagState } from './common.ts';
+import type { TestFlag, TestFlagState } from '@zenfs/devel/tests/common';
 import { isAbsolute, join, relative, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { copySync, data, tmp } from './setup.ts';
+import { copySync, data, tmp } from '@zenfs/devel/tests/setup';
 import { styleText } from 'node:util';
 import { isRoot } from 'utilium/node';
 

package/tests/setup/context.ts

@@ -1,5 +1,5 @@
 import { fs as _fs, bindContext } from '@zenfs/core';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 _fs.mkdirSync('/new_root');
 

package/tests/setup/cow.ts

@@ -1,5 +1,5 @@
 import { configureSingle, CopyOnWrite, fs, InMemory, resolveMountConfig } from '@zenfs/core';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 fs.umount('/');
 const readable = await resolveMountConfig({ backend: InMemory, label: 'ro' });

package/tests/{fetch → setup}/fetch.ts

@@ -1,7 +1,18 @@
 import { configure, Fetch } from '@zenfs/core';
+import type { TestFlag, TestFlagState } from '@zenfs/devel/tests/common';
 import { log } from 'kerium';
-import type { TestFlag, TestFlagState } from '../common.ts';
-import { baseUrl } from './config.js';
+import { once } from 'node:events';
+import { join } from 'node:path';
+import { after } from 'node:test';
+import { Worker } from 'node:worker_threads';
+
+const server = new Worker(join(import.meta.dirname, '../backend/fetch.worker.js'));
+
+after(() => server.terminate());
+
+const [port] = await once(server, 'message');
+
+const baseUrl = 'http://localhost:' + port;
 
 await configure({
 	mounts: {

package/tests/setup/index.ts

@@ -2,7 +2,7 @@ import { readFileSync } from 'node:fs';
 import { join } from 'node:path/posix';
 import { configureSingle, CopyOnWrite, InMemory, InMemoryStore, mounts, Readonly, StoreFS } from '@zenfs/core';
 import { S_IFDIR } from '@zenfs/core/constants';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 copySync(data);
 

package/tests/setup/memory.ts

@@ -1,3 +1,3 @@
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 copySync(data);

package/tests/setup/port.ts

@@ -1,7 +1,7 @@
 import { InMemory, Port, configureSingle, fs, resolveMountConfig, resolveRemoteMount, sync } from '@zenfs/core';
 import { after, afterEach } from 'node:test';
 import { MessageChannel } from 'node:worker_threads';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 const { port1: localPort, port2: remotePort } = new MessageChannel();
 

package/tests/setup/single-buffer-v2.ts

@@ -1,5 +1,5 @@
 import { SingleBuffer, configureSingle } from '@zenfs/core';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 await configureSingle({
 	backend: SingleBuffer,

package/tests/setup/single-buffer.ts

@@ -1,5 +1,5 @@
 import { SingleBuffer, configureSingle } from '@zenfs/core';
-import { copySync, data } from '../setup.ts';
+import { copySync, data } from '@zenfs/devel/tests/setup';
 
 await configureSingle({
 	backend: SingleBuffer,

package/tests/setup.ts

@@ -4,12 +4,15 @@ import type { NodeFS } from '@zenfs/core/node/types';
 import { existsSync, mkdirSync, readFileSync, readdirSync, statSync } from 'node:fs';
 import { join, relative } from 'node:path';
 
+/** @deprecated Use `@zenfs/devel/tests/setup` */
 export const data = join(import.meta.dirname, 'data');
 
+/** @deprecated Use `@zenfs/devel/tests/setup` */
 export const tmp = join(import.meta.dirname, 'tmp');
 
 if (!existsSync(tmp)) mkdirSync(tmp, { recursive: true });
 
+/** @deprecated Use `@zenfs/devel/tests/setup` */
 export async function copyAsync(_path: string, fs: NodeFS = _fs): Promise<void> {
 	const path = relative(data, _path) || '/';
 	const stats = statSync(_path);
@@ -27,6 +30,7 @@ export async function copyAsync(_path: string, fs: NodeFS = _fs): Promise<void>
 	}
 }
 
+/** @deprecated Use `@zenfs/devel/tests/setup` */
 export function copySync(_path: string, fs: NodeFS = _fs): void {
 	const path = relative(data, _path) || '/';
 	const stats = statSync(_path);

package/tests/fetch/config.js

@@ -1,40 +0,0 @@
-import { existsSync, mkdirSync, readdirSync } from 'node:fs';
-import { createConnection } from 'node:net';
-import { join } from 'node:path';
-
-// Copied from setup.ts
-
-export const data = join(import.meta.dirname, '../data');
-
-export const defaultEntries = readdirSync(data);
-
-export const tmp = join(import.meta.dirname, '../tmp');
-
-if (!existsSync(tmp)) mkdirSync(tmp);
-
-export const port = 26514;
-
-export const baseUrl = 'http://localhost:' + port;
-
-export const indexPath = '/.index.json';
-
-export function whenServerReady() {
-	const { promise, resolve, reject } = Promise.withResolvers();
-
-	const timeout = setTimeout(reject, 10_000);
-
-	const interval = setInterval(() => {
-		const socket = createConnection(port)
-			.on('connect', () => {
-				socket.end();
-				clearTimeout(timeout);
-				clearInterval(interval);
-				resolve();
-			})
-			.on('error', () => {
-				// ignore
-			});
-	}, 250);
-
-	return promise;
-}

package/tests/fetch/run.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-
-# Credit: Dave Dopson, https://stackoverflow.com/a/246128/17637456
-SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-
-node $SCRIPT_DIR/server.js &
-PID=$!
-
-echo -en "Waiting for server to start...\r"
-if [ -n "$VERBOSE" ]; then echo; fi
-until nc -z localhost 26514; do
-  sleep 0.25
-done
-
-npx --silent zenfs-test $SCRIPT_DIR/fetch.ts --preserve --force --node "$@"
-
-kill $PID