@zenfs/core 1.2.0 → 1.2.1

package/dist/config.d.ts

@@ -34,24 +34,33 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
     gid: number;
     /**
      * Whether to automatically add normal Linux devices
-     * @default false
      * @experimental
+     * @default false
      */
     addDevices: boolean;
     /**
      * If true, enables caching stats for certain operations.
      * This should reduce the number of stat calls performed.
-     * @default false
      * @experimental
+     * @default false
      */
     cacheStats: boolean;
     /**
      * If true, disables *all* permissions checking.
-     * This can increase performance
-     * @default false
+     *
+     * This can increase performance.
      * @experimental
+     * @default false
      */
     disableAccessChecks: boolean;
+    /**
+     * If true, disables `read` and `readSync` from immediately syncing the updated atime to the file system.
+     *
+     * This can increase performance.
+     * @experimental
+     * @default false
+     */
+    disableSyncOnRead: boolean;
 }
 /**
  * Configures ZenFS with single mount point /

package/dist/config.js

@@ -3,7 +3,7 @@ import { credentials } from './credentials.js';
 import { DeviceFS, fullDevice, nullDevice, randomDevice, zeroDevice } from './devices.js';
 import * as cache from './emulation/cache.js';
 import * as fs from './emulation/index.js';
-import { config } from './emulation/shared.js';
+import { config } from './emulation/config.js';
 import { Errno, ErrnoError } from './error.js';
 import { FileSystem } from './filesystem.js';
 function isMountConfig(arg) {
@@ -70,6 +70,7 @@ export async function configure(configuration) {
     Object.assign(credentials, { uid, gid, suid: uid, sgid: gid, euid: uid, egid: gid });
     cache.setEnabled(configuration.cacheStats ?? false);
     config.checkAccess = !configuration.disableAccessChecks;
+    config.syncOnRead = !configuration.disableSyncOnRead;
     if (configuration.addDevices) {
         const devfs = new DeviceFS();
         devfs.createDevice('/null', nullDevice);

package/dist/emulation/config.d.ts

@@ -0,0 +1,10 @@
+export declare const config: {
+    /**
+     * Whether to perform access checks
+     */
+    checkAccess: boolean;
+    /**
+     * Whether to sync atime updates immediately when reading from a file
+     */
+    syncOnRead: boolean;
+};

package/dist/emulation/config.js

@@ -0,0 +1,10 @@
+export const config = {
+    /**
+     * Whether to perform access checks
+     */
+    checkAccess: true,
+    /**
+     * Whether to sync atime updates immediately when reading from a file
+     */
+    syncOnRead: true,
+};

package/dist/emulation/promises.js

@@ -56,7 +56,8 @@ import * as cache from './cache.js';
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
 import { dirname, join, parse } from './path.js';
-import { _statfs, config, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
+import { _statfs, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
+import { config } from './config.js';
 import { ReadStream, WriteStream } from './streams.js';
 import { FSWatcher, emitChange } from './watchers.js';
 export * as constants from './constants.js';

package/dist/emulation/shared.d.ts

@@ -43,12 +43,6 @@ export declare function mountObject(mounts: MountObject): void;
  * @hidden
  */
 export declare function _statfs<const T extends boolean>(fs: FileSystem, bigint?: T): T extends true ? BigIntStatsFs : StatsFs;
-export declare const config: {
-    /**
-     * Whether to perform access checks
-     */
-    checkAccess: boolean;
-};
 /**
  * Options used for caching, among other things.
  * @internal *UNSTABLE*

package/dist/emulation/shared.js

@@ -115,9 +115,3 @@ export function _statfs(fs, bigint) {
         blocks: (bigint ? BigInt : Number)(md.totalSpace / bs),
     };
 }
-export const config = {
-    /**
-     * Whether to perform access checks
-     */
-    checkAccess: true,
-};

package/dist/emulation/sync.js

@@ -53,7 +53,8 @@ import { decodeUTF8, normalizeMode, normalizeOptions, normalizePath, normalizeTi
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
 import { dirname, join, parse } from './path.js';
-import { _statfs, config, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
+import { _statfs, fd2file, fdMap, file2fd, fixError, mounts, resolveMount } from './shared.js';
+import { config } from './config.js';
 import { emitChange } from './watchers.js';
 import * as cache from './cache.js';
 export function renameSync(oldPath, newPath) {

package/dist/file.d.ts

@@ -1,7 +1,7 @@
 import type { FileReadResult } from 'node:fs/promises';
 import type { FileSystem } from './filesystem.js';
-import { Stats, type FileType } from './stats.js';
 import './polyfills.js';
+import { Stats, type FileType } from './stats.js';
 /**
     Typescript does not include a type declaration for resizable array buffers.
     It has been standardized into ECMAScript though

package/dist/file.js

@@ -1,7 +1,8 @@
 import { O_APPEND, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY, S_IFMT, size_max } from './emulation/constants.js';
+import { config } from './emulation/config.js';
 import { Errno, ErrnoError } from './error.js';
-import { Stats } from './stats.js';
 import './polyfills.js';
+import { Stats } from './stats.js';
 const validFlags = ['r', 'r+', 'rs', 'rs+', 'w', 'wx', 'w+', 'wx+', 'a', 'ax', 'a+', 'ax+'];
 export function parseFlag(flag) {
     if (typeof flag === 'number') {
@@ -383,7 +384,8 @@ export class PreloadFile extends File {
      */
     async read(buffer, offset, length, position) {
         const bytesRead = this._read(buffer, offset, length, position);
-        await this.sync();
+        if (config.syncOnRead)
+            await this.sync();
         return { bytesRead, buffer };
     }
     /**
@@ -397,7 +399,8 @@ export class PreloadFile extends File {
      */
     readSync(buffer, offset, length, position) {
         const bytesRead = this._read(buffer, offset, length, position);
-        this.statSync();
+        if (config.syncOnRead)
+            this.syncSync();
         return bytesRead;
     }
     async chmod(mode) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",

package/readme.md

@@ -32,7 +32,7 @@ npm install @zenfs/core
 ```js
 import { fs } from '@zenfs/core'; // You can also use the default export
 
-fs.writeFileSync('/test.txt', 'You can do this in anywhere (including browsers)!');
+fs.writeFileSync('/test.txt', 'You can do this anywhere, including browsers!');
 
 const contents = fs.readFileSync('/test.txt', 'utf-8');
 console.log(contents);

package/scripts/test.js

@@ -31,6 +31,11 @@ options:
 
 if (options.verbose) console.debug('Forcing tests to exit (--test-force-exit)');
 
+if (!existsSync(join(import.meta.dirname, '../dist'))) {
+	console.log('ERROR: Missing build. If you are using an installed package, please submit a bug report.');
+	process.exit(1);
+}
+
 const testsGlob = join(import.meta.dirname, `../tests/fs/${options.test || '*'}.test.ts`);
 
 for (const setupFile of positionals) {

package/src/config.ts

@@ -5,7 +5,8 @@ import { DeviceFS, fullDevice, nullDevice, randomDevice, zeroDevice } from './de
 import * as cache from './emulation/cache.js';
 import * as fs from './emulation/index.js';
 import type { AbsolutePath } from './emulation/path.js';
-import { config, type MountObject } from './emulation/shared.js';
+import { type MountObject } from './emulation/shared.js';
+import { config } from './emulation/config.js';
 import { Errno, ErrnoError } from './error.js';
 import { FileSystem } from './filesystem.js';
 
@@ -95,26 +96,36 @@ export interface Configuration<T extends ConfigMounts> extends SharedConfig {
 
 	/**
 	 * Whether to automatically add normal Linux devices
-	 * @default false
 	 * @experimental
+	 * @default false
 	 */
 	addDevices: boolean;
 
 	/**
 	 * If true, enables caching stats for certain operations.
 	 * This should reduce the number of stat calls performed.
-	 * @default false
 	 * @experimental
+	 * @default false
 	 */
 	cacheStats: boolean;
 
 	/**
 	 * If true, disables *all* permissions checking.
-	 * This can increase performance
-	 * @default false
+	 *
+	 * This can increase performance.
 	 * @experimental
+	 * @default false
 	 */
 	disableAccessChecks: boolean;
+
+	/**
+	 * If true, disables `read` and `readSync` from immediately syncing the updated atime to the file system.
+	 *
+	 * This can increase performance.
+	 * @experimental
+	 * @default false
+	 */
+	disableSyncOnRead: boolean;
 }
 
 /**
@@ -142,6 +153,7 @@ export async function configure<T extends ConfigMounts>(configuration: Partial<C
 
 	cache.setEnabled(configuration.cacheStats ?? false);
 	config.checkAccess = !configuration.disableAccessChecks;
+	config.syncOnRead = !configuration.disableSyncOnRead;
 
 	if (configuration.addDevices) {
 		const devfs = new DeviceFS();

package/src/emulation/config.ts

@@ -0,0 +1,11 @@
+export const config = {
+	/**
+	 * Whether to perform access checks
+	 */
+	checkAccess: true,
+
+	/**
+	 * Whether to sync atime updates immediately when reading from a file
+	 */
+	syncOnRead: true,
+};

package/src/emulation/promises.ts

@@ -16,7 +16,8 @@ import * as cache from './cache.js';
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
 import { dirname, join, parse } from './path.js';
-import { _statfs, config, fd2file, fdMap, file2fd, fixError, mounts, resolveMount, type InternalOptions, type ReaddirOptions } from './shared.js';
+import { _statfs, fd2file, fdMap, file2fd, fixError, mounts, resolveMount, type InternalOptions, type ReaddirOptions } from './shared.js';
+import { config } from './config.js';
 import { ReadStream, WriteStream } from './streams.js';
 import { FSWatcher, emitChange } from './watchers.js';
 export * as constants from './constants.js';

package/src/emulation/shared.ts

@@ -134,13 +134,6 @@ export function _statfs<const T extends boolean>(fs: FileSystem, bigint?: T): T
 	} as T extends true ? BigIntStatsFs : StatsFs;
 }
 
-export const config = {
-	/**
-	 * Whether to perform access checks
-	 */
-	checkAccess: true,
-};
-
 /**
  * Options used for caching, among other things.
  * @internal *UNSTABLE*

package/src/emulation/sync.ts

@@ -9,7 +9,8 @@ import { decodeUTF8, normalizeMode, normalizeOptions, normalizePath, normalizeTi
 import * as constants from './constants.js';
 import { Dir, Dirent } from './dir.js';
 import { dirname, join, parse } from './path.js';
-import { _statfs, config, fd2file, fdMap, file2fd, fixError, mounts, resolveMount, type InternalOptions, type ReaddirOptions } from './shared.js';
+import { _statfs, fd2file, fdMap, file2fd, fixError, mounts, resolveMount, type InternalOptions, type ReaddirOptions } from './shared.js';
+import { config } from './config.js';
 import { emitChange } from './watchers.js';
 import * as cache from './cache.js';
 

package/src/file.ts

@@ -1,9 +1,10 @@
 import type { FileReadResult } from 'node:fs/promises';
 import { O_APPEND, O_CREAT, O_EXCL, O_RDONLY, O_RDWR, O_SYNC, O_TRUNC, O_WRONLY, S_IFMT, size_max } from './emulation/constants.js';
+import { config } from './emulation/config.js';
 import { Errno, ErrnoError } from './error.js';
 import type { FileSystem } from './filesystem.js';
-import { Stats, type FileType } from './stats.js';
 import './polyfills.js';
+import { Stats, type FileType } from './stats.js';
 
 /**
 	Typescript does not include a type declaration for resizable array buffers. 
@@ -541,7 +542,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public async read<TBuffer extends ArrayBufferView>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<{ bytesRead: number; buffer: TBuffer }> {
 		const bytesRead = this._read(buffer, offset, length, position);
-		await this.sync();
+		if (config.syncOnRead) await this.sync();
 		return { bytesRead, buffer };
 	}
 
@@ -556,7 +557,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 */
 	public readSync(buffer: ArrayBufferView, offset?: number, length?: number, position?: number): number {
 		const bytesRead = this._read(buffer, offset, length, position);
-		this.statSync();
+		if (config.syncOnRead) this.syncSync();
 		return bytesRead;
 	}
 

package/tests/common.ts

@@ -1,15 +1,5 @@
 import { join, resolve } from 'node:path';
-import { Worker } from 'node:worker_threads';
-import { fs } from '../src/index.js';
-
-/**
- * Creates a Typescript Worker
- * @see https://github.com/privatenumber/tsx/issues/354
- * @see https://github.com/nodejs/node/issues/47747#issuecomment-2287745567
- */
-export function createTSWorker(source: string): Worker {
-	return new Worker(`import('tsx/esm/api').then(tsx => {tsx.register();import('${source}');});`, { eval: true });
-}
+import { fs } from '../dist/index.js';
 
 const setupPath = resolve(process.env.SETUP || join(import.meta.dirname, 'setup/memory.ts'));
 

package/tests/fs/directory.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { ErrnoError } from '../../src/error.js';
+import { ErrnoError } from '../../dist/error.js';
 import { fs } from '../common.js';
 
 suite('Directory', () => {

package/tests/fs/errors.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { ErrnoError } from '../../src/error.js';
+import { ErrnoError } from '../../dist/error.js';
 import { fs } from '../common.js';
 
 const existingFile = '/exit.js';

package/tests/fs/links.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { join } from '../../src/emulation/path.js';
+import { join } from '../../dist/emulation/path.js';
 import { fs } from '../common.js';
 
 suite('Links', () => {

package/tests/fs/open.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { ErrnoError } from '../../src/error.js';
+import { ErrnoError } from '../../dist/error.js';
 import { fs } from '../common.js';
 
 suite('fs file opening', () => {

package/tests/fs/permissions.test.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { R_OK, W_OK, X_OK } from '../../src/emulation/constants.js';
-import { join } from '../../src/emulation/path.js';
-import { ErrnoError } from '../../src/error.js';
-import { encodeUTF8 } from '../../src/utils.js';
+import { R_OK, W_OK, X_OK } from '../../dist/emulation/constants.js';
+import { join } from '../../dist/emulation/path.js';
+import { ErrnoError } from '../../dist/error.js';
+import { encodeUTF8 } from '../../dist/utils.js';
 import { fs } from '../common.js';
 
 suite('Permissions', () => {

package/tests/fs/rename.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { ErrnoError } from '../../src/error.js';
+import { ErrnoError } from '../../dist/error.js';
 import { fs } from '../common.js';
 
 suite('Rename', () => {

package/tests/fs/stat.test.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import { Stats } from '../../src/stats.js';
+import { Stats } from '../../dist/stats.js';
 import { fs } from '../common.js';
 
 suite('Stats', () => {

package/tests/fs/times.test.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
 import { wait } from 'utilium';
-import { ErrnoError } from '../../src/error.js';
-import { _toUnixTimestamp } from '../../src/utils.js';
+import { ErrnoError } from '../../dist/error.js';
+import { _toUnixTimestamp } from '../../dist/utils.js';
 import { fs } from '../common.js';
 
 suite('times', () => {

package/tests/fs/truncate.test.ts

@@ -1,7 +1,7 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
-import type { FileHandle } from '../../src/emulation/promises.js';
 import { fs } from '../common.js';
+import type { FileHandle } from '../../dist/emulation/promises.js';
 
 const path: string = 'truncate-file.txt',
 	size = 1024 * 16,

package/tests/port/channel.test.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
 import { MessageChannel } from 'node:worker_threads';
-import { Port, attachFS } from '../../src/backends/port/fs.js';
-import type { StoreFS } from '../../src/index.js';
-import { InMemory, configureSingle, fs, resolveMountConfig, type InMemoryStore } from '../../src/index.js';
+import { Port, attachFS } from '../../dist/backends/port/fs.js';
+import type { StoreFS } from '../../dist/index.js';
+import { InMemory, configureSingle, fs, resolveMountConfig, type InMemoryStore } from '../../dist/index.js';
 
 const { port1, port2 } = new MessageChannel(),
 	content = 'FS is in a port';

package/tests/port/config.test.ts

@@ -2,14 +2,13 @@ import assert from 'node:assert';
 import { dirname } from 'node:path';
 import { suite, test } from 'node:test';
 import { fileURLToPath } from 'node:url';
-import type { Worker } from 'node:worker_threads';
-import { Port } from '../../src/backends/port/fs.js';
-import { configureSingle, fs } from '../../src/index.js';
-import { createTSWorker } from '../common.js';
+import { Worker } from 'node:worker_threads';
+import { Port } from '../../dist/backends/port/fs.js';
+import { configureSingle, fs } from '../../dist/index.js';
 
 const dir = dirname(fileURLToPath(import.meta.url));
 
-const port: Worker = createTSWorker(dir + '/config.worker.ts');
+const port = new Worker(dir + '/config.worker.js');
 
 await suite('Remote FS with resolveRemoteMount', () => {
 	const content = 'FS is in a port';

package/tests/port/config.worker.js

@@ -0,0 +1,5 @@
+import { parentPort } from 'node:worker_threads';
+import { resolveRemoteMount } from '../../dist/backends/port/fs.js';
+import { InMemory } from '../../dist/backends/memory.js';
+
+await resolveRemoteMount(parentPort, { backend: InMemory });

package/tests/port/remote.test.ts

@@ -2,14 +2,13 @@ import assert from 'node:assert';
 import { dirname } from 'node:path';
 import { suite, test } from 'node:test';
 import { fileURLToPath } from 'node:url';
-import type { Worker } from 'node:worker_threads';
-import { Port } from '../../src/backends/port/fs.js';
-import { configureSingle, fs } from '../../src/index.js';
-import { createTSWorker } from '../common.js';
+import { Worker } from 'node:worker_threads';
+import { Port } from '../../dist/backends/port/fs.js';
+import { configureSingle, fs } from '../../dist/index.js';
 
 const dir = dirname(fileURLToPath(import.meta.url));
 
-const port: Worker = createTSWorker(dir + '/remote.worker.js');
+const port = new Worker(dir + '/remote.worker.js');
 
 await suite('Remote FS', () => {
 	const content = 'FS is in a port';

package/tests/port/remote.worker.js

@@ -0,0 +1,5 @@
+import { parentPort } from 'node:worker_threads';
+import { attachFS } from '../../dist/backends/port/fs.js';
+import { mounts } from '../../dist/index.js';
+
+attachFS(parentPort, mounts.get('/'));

package/tests/port/timeout.test.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert';
 import { suite, test } from 'node:test';
 import { MessageChannel } from 'node:worker_threads';
-import { Port } from '../../src/backends/port/fs.js';
-import { ErrnoError, InMemory, configure, configureSingle, fs } from '../../src/index.js';
+import { Port } from '../../dist/backends/port/fs.js';
+import { ErrnoError, InMemory, configure, configureSingle, fs } from '../../dist/index.js';
 
 /**
  * Tests a mis-configured PortFS using a MessageChannel

package/tests/setup/common.ts

@@ -1,6 +1,6 @@
 import { join, relative } from 'node:path';
 import { statSync, readFileSync, readdirSync, existsSync, mkdirSync } from 'node:fs';
-import { fs } from '../../src/index.js';
+import { fs } from '../../dist/index.js';
 
 export const data = join(import.meta.dirname, '../data');
 

package/tests/setup/cow+fetch.ts

@@ -2,7 +2,7 @@ import { execSync } from 'node:child_process';
 import { readFileSync } from 'node:fs';
 import { createServer } from 'node:http';
 import { join } from 'node:path';
-import { configureSingle, Fetch, InMemory, Overlay } from '../../src/index.js';
+import { configureSingle, Fetch, InMemory, Overlay } from '../../dist/index.js';
 import { data, tmp } from './common.js';
 
 const port = 26514,

package/tests/port/config.worker.ts

@@ -1,5 +0,0 @@
-import { parentPort } from 'node:worker_threads';
-import { resolveRemoteMount } from '../../src/backends/port/fs.js';
-import { InMemory } from '../../src/backends/memory.js';
-
-await resolveRemoteMount(parentPort!, { backend: InMemory });

package/tests/port/remote.worker.ts

@@ -1,5 +0,0 @@
-import { parentPort } from 'node:worker_threads';
-import { attachFS } from '../../src/backends/port/fs.js';
-import { mounts } from '../../src/index.js';
-
-attachFS(parentPort!, mounts.get('/')!);