@zenfs/core 0.12.0 → 0.12.2

package/src/filesystem.ts

@@ -30,6 +30,41 @@ export interface FileSystemMetadata {
 	 * The available space
 	 */
 	freeSpace: number;
+
+	/**
+	 * If set, disables File from using a resizable array buffer.
+	 * @default false
+	 */
+	noResizableBuffers: boolean;
+
+	/**
+	 * If set, disables caching on async file systems.
+	 * This means *sync operations will not work*.
+	 * It has no affect on sync file systems.
+	 * @default false
+	 */
+	noAsyncCache: boolean;
+
+	/**
+	 * The optimal block size to use with the file system
+	 * @default 4096
+	 */
+	blockSize?: number;
+
+	/**
+	 * Total number of (file) nodes available
+	 */
+	totalNodes?: number;
+
+	/**
+	 * Number of free (file) nodes available
+	 */
+	freeNodes?: number;
+
+	/**
+	 * The type of the FS
+	 */
+	type?: number;
 }
 
 /**
@@ -44,7 +79,13 @@ export interface FileSystemMetadata {
  */
 export abstract class FileSystem {
 	/**
-	 * Get metadata about the current file syste,
+	 * Numeric type, used for statfs
+	 * @internal @protected
+	 */
+	_type?: number;
+
+	/**
+	 * Get metadata about the current file system
 	 */
 	public metadata(): FileSystemMetadata {
 		return {
@@ -52,12 +93,13 @@ export abstract class FileSystem {
 			readonly: false,
 			totalSpace: 0,
 			freeSpace: 0,
+			noResizableBuffers: false,
+			noAsyncCache: false,
+			type: this._type,
 		};
 	}
 
-	public constructor(options?: object) {
-		// unused
-	}
+	public constructor() {}
 
 	public async ready(): Promise<void> {}
 
@@ -157,7 +199,7 @@ export abstract class FileSystem {
 			await this.stat(path, cred);
 			return true;
 		} catch (e) {
-			return false;
+			return (e as ErrnoError).code != 'ENOENT';
 		}
 	}
 
@@ -169,7 +211,7 @@ export abstract class FileSystem {
 			this.statSync(path, cred);
 			return true;
 		} catch (e) {
-			return false;
+			return (e as ErrnoError).code != 'ENOENT';
 		}
 	}
 
@@ -198,19 +240,19 @@ export abstract class FileSystem {
  * @internal
  */
 declare abstract class SyncFS extends FileSystem {
-	metadata(): FileSystemMetadata;
-	ready(): Promise<void>;
-	exists(path: string, cred: Cred): Promise<boolean>;
-	rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
-	stat(path: string, cred: Cred): Promise<Stats>;
-	createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
-	openFile(path: string, flag: string, cred: Cred): Promise<File>;
-	unlink(path: string, cred: Cred): Promise<void>;
-	rmdir(path: string, cred: Cred): Promise<void>;
-	mkdir(path: string, mode: number, cred: Cred): Promise<void>;
-	readdir(path: string, cred: Cred): Promise<string[]>;
-	link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
-	sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
+	public metadata(): FileSystemMetadata;
+	public ready(): Promise<void>;
+	public exists(path: string, cred: Cred): Promise<boolean>;
+	public rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
+	public stat(path: string, cred: Cred): Promise<Stats>;
+	public createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
+	public openFile(path: string, flag: string, cred: Cred): Promise<File>;
+	public unlink(path: string, cred: Cred): Promise<void>;
+	public rmdir(path: string, cred: Cred): Promise<void>;
+	public mkdir(path: string, mode: number, cred: Cred): Promise<void>;
+	public readdir(path: string, cred: Cred): Promise<string[]>;
+	public link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
+	public sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
 }
 
 /**
@@ -268,25 +310,33 @@ export function Sync<T extends abstract new (...args: any[]) => FileSystem>(FS:
 
 /**
  * @internal
+ * Note: `_*` should be treated like protected.
+ * Protected can't be used because of TS quirks however.
  */
 declare abstract class AsyncFS extends FileSystem {
 	/**
+	 * @access protected
 	 * @hidden
 	 */
-	abstract _sync: FileSystem;
-	queueDone(): Promise<void>;
-	metadata(): FileSystemMetadata;
-	ready(): Promise<void>;
-	renameSync(oldPath: string, newPath: string, cred: Cred): void;
-	statSync(path: string, cred: Cred): Stats;
-	createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
-	openFileSync(path: string, flag: string, cred: Cred): File;
-	unlinkSync(path: string, cred: Cred): void;
-	rmdirSync(path: string, cred: Cred): void;
-	mkdirSync(path: string, mode: number, cred: Cred): void;
-	readdirSync(path: string, cred: Cred): string[];
-	linkSync(srcpath: string, dstpath: string, cred: Cred): void;
-	syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
+	_disableSync: boolean;
+	/**
+	 * @access protected
+	 * @hidden
+	 */
+	abstract _sync?: FileSystem;
+	public queueDone(): Promise<void>;
+	public metadata(): FileSystemMetadata;
+	public ready(): Promise<void>;
+	public renameSync(oldPath: string, newPath: string, cred: Cred): void;
+	public statSync(path: string, cred: Cred): Stats;
+	public createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
+	public openFileSync(path: string, flag: string, cred: Cred): File;
+	public unlinkSync(path: string, cred: Cred): void;
+	public rmdirSync(path: string, cred: Cred): void;
+	public mkdirSync(path: string, mode: number, cred: Cred): void;
+	public readdirSync(path: string, cred: Cred): string[];
+	public linkSync(srcpath: string, dstpath: string, cred: Cred): void;
+	public syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -331,14 +381,18 @@ export function Async<T extends abstract new (...args: any[]) => FileSystem>(FS:
 
 		private _isInitialized: boolean = false;
 
-		abstract _sync: FileSystem;
+		_disableSync: boolean = false;
+
+		abstract _sync?: FileSystem;
 
 		public async ready(): Promise<void> {
-			await this._sync.ready();
 			await super.ready();
-			if (this._isInitialized) {
+			if (this._isInitialized || this._disableSync) {
 				return;
 			}
+			this.checkSync();
+
+			await this._sync.ready();
 
 			try {
 				await this.crossCopy('/');
@@ -349,22 +403,42 @@ export function Async<T extends abstract new (...args: any[]) => FileSystem>(FS:
 			}
 		}
 
+		public metadata(): FileSystemMetadata {
+			return {
+				...super.metadata(),
+				noAsyncCache: this._disableSync,
+			};
+		}
+
+		protected checkSync(path?: string, syscall?: string): asserts this is { _sync: FileSystem } {
+			if (this._disableSync) {
+				throw new ErrnoError(Errno.ENOTSUP, 'Sync caching has been disabled for this async file system', path, syscall);
+			}
+			if (!this._sync) {
+				throw new ErrnoError(Errno.ENOTSUP, 'No sync cache is attached to this async file system', path, syscall);
+			}
+		}
+
 		public renameSync(oldPath: string, newPath: string, cred: Cred): void {
+			this.checkSync(oldPath, 'rename');
 			this._sync.renameSync(oldPath, newPath, cred);
 			this.queue('rename', oldPath, newPath, cred);
 		}
 
 		public statSync(path: string, cred: Cred): Stats {
+			this.checkSync(path, 'stat');
 			return this._sync.statSync(path, cred);
 		}
 
 		public createFileSync(path: string, flag: string, mode: number, cred: Cred): PreloadFile<this> {
+			this.checkSync(path, 'createFile');
 			this._sync.createFileSync(path, flag, mode, cred);
 			this.queue('createFile', path, flag, mode, cred);
 			return this.openFileSync(path, flag, cred);
 		}
 
 		public openFileSync(path: string, flag: string, cred: Cred): PreloadFile<this> {
+			this.checkSync(path, 'openFile');
 			const file = this._sync.openFileSync(path, flag, cred);
 			const stats = file.statSync();
 			const buffer = new Uint8Array(stats.size);
@@ -373,35 +447,42 @@ export function Async<T extends abstract new (...args: any[]) => FileSystem>(FS:
 		}
 
 		public unlinkSync(path: string, cred: Cred): void {
+			this.checkSync(path, 'unlinkSync');
 			this._sync.unlinkSync(path, cred);
 			this.queue('unlink', path, cred);
 		}
 
 		public rmdirSync(path: string, cred: Cred): void {
+			this.checkSync(path, 'rmdir');
 			this._sync.rmdirSync(path, cred);
 			this.queue('rmdir', path, cred);
 		}
 
 		public mkdirSync(path: string, mode: number, cred: Cred): void {
+			this.checkSync(path, 'mkdir');
 			this._sync.mkdirSync(path, mode, cred);
 			this.queue('mkdir', path, mode, cred);
 		}
 
 		public readdirSync(path: string, cred: Cred): string[] {
+			this.checkSync(path, 'readdir');
 			return this._sync.readdirSync(path, cred);
 		}
 
 		public linkSync(srcpath: string, dstpath: string, cred: Cred): void {
+			this.checkSync(srcpath, 'link');
 			this._sync.linkSync(srcpath, dstpath, cred);
 			this.queue('link', srcpath, dstpath, cred);
 		}
 
 		public syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void {
+			this.checkSync(path, 'sync');
 			this._sync.syncSync(path, data, stats);
 			this.queue('sync', path, data, stats);
 		}
 
 		public existsSync(path: string, cred: Cred): boolean {
+			this.checkSync(path, 'exists');
 			return this._sync.existsSync(path, cred);
 		}
 
@@ -409,6 +490,7 @@ export function Async<T extends abstract new (...args: any[]) => FileSystem>(FS:
 		 * @internal
 		 */
 		protected async crossCopy(path: string): Promise<void> {
+			this.checkSync(path, 'crossCopy');
 			const stats = await this.stat(path, rootCred);
 			if (stats.isDirectory()) {
 				if (path !== '/') {
@@ -463,21 +545,21 @@ export function Async<T extends abstract new (...args: any[]) => FileSystem>(FS:
  * @internal
  */
 declare abstract class ReadonlyFS extends FileSystem {
-	metadata(): FileSystemMetadata;
-	rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
-	renameSync(oldPath: string, newPath: string, cred: Cred): void;
-	createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
-	createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
-	unlink(path: string, cred: Cred): Promise<void>;
-	unlinkSync(path: string, cred: Cred): void;
-	rmdir(path: string, cred: Cred): Promise<void>;
-	rmdirSync(path: string, cred: Cred): void;
-	mkdir(path: string, mode: number, cred: Cred): Promise<void>;
-	mkdirSync(path: string, mode: number, cred: Cred): void;
-	link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
-	linkSync(srcpath: string, dstpath: string, cred: Cred): void;
-	sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
-	syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
+	public metadata(): FileSystemMetadata;
+	public rename(oldPath: string, newPath: string, cred: Cred): Promise<void>;
+	public renameSync(oldPath: string, newPath: string, cred: Cred): void;
+	public createFile(path: string, flag: string, mode: number, cred: Cred): Promise<File>;
+	public createFileSync(path: string, flag: string, mode: number, cred: Cred): File;
+	public unlink(path: string, cred: Cred): Promise<void>;
+	public unlinkSync(path: string, cred: Cred): void;
+	public rmdir(path: string, cred: Cred): Promise<void>;
+	public rmdirSync(path: string, cred: Cred): void;
+	public mkdir(path: string, mode: number, cred: Cred): Promise<void>;
+	public mkdirSync(path: string, mode: number, cred: Cred): void;
+	public link(srcpath: string, dstpath: string, cred: Cred): Promise<void>;
+	public linkSync(srcpath: string, dstpath: string, cred: Cred): void;
+	public sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void>;
+	public syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
 }
 
 /**

package/src/stats.ts

@@ -1,6 +1,7 @@
 import type * as Node from 'fs';
 import { Cred } from './cred.js';
-import { S_IFDIR, S_IFLNK, S_IFMT, S_IFREG, S_IRWXG, S_IRWXO, S_IRWXU } from './emulation/constants.js';
+import { S_IFBLK, S_IFCHR, S_IFDIR, S_IFIFO, S_IFLNK, S_IFMT, S_IFREG, S_IFSOCK, S_IRWXG, S_IRWXO, S_IRWXU } from './emulation/constants.js';
+import { size_max } from './inode.js';
 
 /**
  * Indicates the type of the given file. Applied to 'mode'.
@@ -60,21 +61,15 @@ export interface StatsLike<T extends number | bigint = number | bigint> {
  * Common code used by both Stats and BigIntStats.
  */
 export abstract class StatsCommon<T extends number | bigint> implements Node.StatsBase<T>, StatsLike {
-	protected abstract _isBigint: boolean;
-
-	protected get _typename(): string {
-		return this._isBigint ? 'bigint' : 'number';
-	}
-
-	protected get _typename_inverse(): string {
-		return this._isBigint ? 'number' : 'bigint';
-	}
+	protected abstract _isBigint: T extends bigint ? true : false;
 
 	protected _convert(arg: number | bigint | string | boolean): T {
-		return <T>(this._isBigint ? BigInt(arg) : Number(arg));
+		return (this._isBigint ? BigInt(arg) : Number(arg)) as T;
 	}
 
-	public blocks: T;
+	public get blocks(): T {
+		return this._convert(Math.ceil(Number(this.size) / 512));
+	}
 
 	/**
 	 * Unix-style file mode (e.g. 0o644) that includes the type of the item.
@@ -184,17 +179,15 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 	 * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
 	 */
 	constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino }: Partial<StatsLike> = {}) {
-		const currentTime = Date.now();
-		const resolveT = (val: number | bigint | undefined, _default: number) =>
-			<T>(typeof val == this._typename ? val : this._convert(typeof val == this._typename_inverse ? val! : _default));
-		this.atimeMs = resolveT(atimeMs, currentTime);
-		this.mtimeMs = resolveT(mtimeMs, currentTime);
-		this.ctimeMs = resolveT(ctimeMs, currentTime);
-		this.birthtimeMs = resolveT(birthtimeMs, currentTime);
-		this.uid = resolveT(uid, 0);
-		this.gid = resolveT(gid, 0);
-		this.size = resolveT(size, 0);
-		this.ino = resolveT(ino, 0);
+		const now = Date.now();
+		this.atimeMs = this._convert(atimeMs ?? now);
+		this.mtimeMs = this._convert(mtimeMs ?? now);
+		this.ctimeMs = this._convert(ctimeMs ?? now);
+		this.birthtimeMs = this._convert(birthtimeMs ?? now);
+		this.uid = this._convert(uid ?? 0);
+		this.gid = this._convert(gid ?? 0);
+		this.size = this._convert(size ?? 0);
+		this.ino = this._convert(ino ?? 0);
 		const itemType: FileType = Number(mode) & S_IFMT || FileType.FILE;
 
 		if (mode) {
@@ -209,11 +202,9 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 					this.mode = this._convert(0o777);
 			}
 		}
-		// number of 512B blocks allocated
-		this.blocks = this._convert(Math.ceil(Number(size) / 512));
 		// Check if mode also includes top-most bits, which indicate the file's type.
 		if ((this.mode & S_IFMT) == 0) {
-			this.mode = <T>(this.mode | this._convert(itemType));
+			this.mode = (this.mode | this._convert(itemType)) as T;
 		}
 	}
 
@@ -241,19 +232,19 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 	// Currently unsupported
 
 	public isSocket(): boolean {
-		return false;
+		return (this.mode & S_IFMT) === S_IFSOCK;
 	}
 
 	public isBlockDevice(): boolean {
-		return false;
+		return (this.mode & S_IFMT) === S_IFBLK;
 	}
 
 	public isCharacterDevice(): boolean {
-		return false;
+		return (this.mode & S_IFMT) === S_IFCHR;
 	}
 
 	public isFIFO(): boolean {
-		return false;
+		return (this.mode & S_IFMT) === S_IFIFO;
 	}
 
 	/**
@@ -315,16 +306,16 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 	}
 
 	public get atimeNs(): bigint {
-		return BigInt(this.atimeMs);
+		return BigInt(this.atimeMs) * 1000n;
 	}
 	public get mtimeNs(): bigint {
-		return BigInt(this.mtimeMs);
+		return BigInt(this.mtimeMs) * 1000n;
 	}
 	public get ctimeNs(): bigint {
-		return BigInt(this.ctimeMs);
+		return BigInt(this.ctimeMs) * 1000n;
 	}
 	public get birthtimeNs(): bigint {
-		return BigInt(this.birthtimeMs);
+		return BigInt(this.birthtimeMs) * 1000n;
 	}
 }
 
@@ -334,41 +325,35 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
  * Attribute descriptions are from `man 2 stat'
  * @see http://nodejs.org/api/fs.html#fs_class_fs_stats
  * @see http://man7.org/linux/man-pages/man2/stat.2.html
+ * @internal
  */
 export class Stats extends StatsCommon<number> implements Node.Stats, StatsLike {
-	protected _isBigint = false;
-
-	/**
-	 * Clones the stats object.
-	 * @deprecated use `new Stats(stats)`
-	 */
-	public static clone(stats: Stats): Stats {
-		return new Stats(stats);
-	}
+	protected _isBigint = false as const;
 }
 Stats satisfies typeof Node.Stats;
 
 /**
  * Stats with bigint
  * @todo Implement with bigint instead of wrapping Stats
+ * @internal
  */
 export class BigIntStats extends StatsCommon<bigint> implements Node.BigIntStats, StatsLike {
-	protected _isBigint = true;
-
-	/**
-	 * Clone a stats object.
-	 * @deprecated use `new BigIntStats(stats)`
-	 */
-	public static clone(stats: BigIntStats | Stats): BigIntStats {
-		return new BigIntStats(stats);
-	}
+	protected _isBigint = true as const;
 }
 
+/**
+ * @internal
+ */
+export const ZenFsType = 0x7a656e6673; // 'z' 'e' 'n' 'f' 's'
+
+/**
+ * @hidden
+ */
 export class StatsFs implements Node.StatsFsBase<number> {
 	/** Type of file system. */
-	public type: number = 0;
+	public type: number = 0x7a656e6673;
 	/**  Optimal transfer block size. */
-	public bsize: number = 0;
+	public bsize: number = 4096;
 	/**  Total data blocks in file system. */
 	public blocks: number = 0;
 	/** Free blocks in file system. */
@@ -376,16 +361,19 @@ export class StatsFs implements Node.StatsFsBase<number> {
 	/** Available blocks for unprivileged users */
 	public bavail: number = 0;
 	/** Total file nodes in file system. */
-	public files: number = 0;
+	public files: number = size_max;
 	/** Free file nodes in file system. */
-	public ffree: number = 0;
+	public ffree: number = size_max;
 }
 
+/**
+ * @hidden
+ */
 export class BigIntStatsFs implements Node.StatsFsBase<bigint> {
 	/** Type of file system. */
-	public type: bigint = 0n;
+	public type: bigint = 0x7a656e6673n;
 	/**  Optimal transfer block size. */
-	public bsize: bigint = 0n;
+	public bsize: bigint = 4096n;
 	/**  Total data blocks in file system. */
 	public blocks: bigint = 0n;
 	/** Free blocks in file system. */
@@ -393,7 +381,7 @@ export class BigIntStatsFs implements Node.StatsFsBase<bigint> {
 	/** Available blocks for unprivileged users */
 	public bavail: bigint = 0n;
 	/** Total file nodes in file system. */
-	public files: bigint = 0n;
+	public files: bigint = BigInt(size_max);
 	/** Free file nodes in file system. */
-	public ffree: bigint = 0n;
+	public ffree: bigint = BigInt(size_max);
 }