@zenfs/core 0.5.3 → 0.5.5

package/dist/ApiError.d.ts

@@ -80,9 +80,10 @@ export declare const ErrorStrings: {
 interface ApiErrorJSON {
     errno: ErrorCode;
     message: string;
-    path: string;
+    path?: string;
     code: string;
     stack: string;
+    syscall: string;
 }
 /**
  * Represents a ZenFS error. Passed back to applications after a failed
@@ -91,18 +92,10 @@ interface ApiErrorJSON {
 export declare class ApiError extends Error implements NodeJS.ErrnoException {
     errno: ErrorCode;
     path?: string;
+    syscall: string;
     static fromJSON(json: ApiErrorJSON): ApiError;
-    static OnPath(code: ErrorCode, path: string): ApiError;
-    static EACCES(path: string): ApiError;
-    static ENOENT(path: string): ApiError;
-    static EEXIST(path: string): ApiError;
-    static EISDIR(path: string): ApiError;
-    static ENOTDIR(path: string): ApiError;
-    static EPERM(path: string): ApiError;
-    static ENOTEMPTY(path: string): ApiError;
+    static With(code: string, path: string, syscall?: string): ApiError;
     code: string;
-    syscall: string;
-    stack?: string;
     /**
      * Represents a ZenFS error. Passed back to applications after a failed
      * call to the ZenFS API.
@@ -113,7 +106,7 @@ export declare class ApiError extends Error implements NodeJS.ErrnoException {
      * @param type The type of the error.
      * @param message A descriptive error message.
      */
-    constructor(errno: ErrorCode, message?: string, path?: string);
+    constructor(errno: ErrorCode, message?: string, path?: string, syscall?: string);
     /**
      * @return A friendly error message.
      */

package/dist/ApiError.js

@@ -98,34 +98,13 @@ export const ErrorStrings = {
  */
 export class ApiError extends Error {
     static fromJSON(json) {
-        const err = new ApiError(json.errno, json.message, json.path);
+        const err = new ApiError(json.errno, json.message, json.path, json.syscall);
         err.code = json.code;
         err.stack = json.stack;
         return err;
     }
-    static OnPath(code, path) {
-        return new ApiError(code, ErrorStrings[code], path);
-    }
-    static EACCES(path) {
-        return this.OnPath(ErrorCode.EACCES, path);
-    }
-    static ENOENT(path) {
-        return this.OnPath(ErrorCode.ENOENT, path);
-    }
-    static EEXIST(path) {
-        return this.OnPath(ErrorCode.EEXIST, path);
-    }
-    static EISDIR(path) {
-        return this.OnPath(ErrorCode.EISDIR, path);
-    }
-    static ENOTDIR(path) {
-        return this.OnPath(ErrorCode.ENOTDIR, path);
-    }
-    static EPERM(path) {
-        return this.OnPath(ErrorCode.EPERM, path);
-    }
-    static ENOTEMPTY(path) {
-        return this.OnPath(ErrorCode.ENOTEMPTY, path);
+    static With(code, path, syscall) {
+        return new ApiError(ErrorCode[code], ErrorStrings[ErrorCode[code]], path, syscall);
     }
     /**
      * Represents a ZenFS error. Passed back to applications after a failed
@@ -137,12 +116,11 @@ export class ApiError extends Error {
      * @param type The type of the error.
      * @param message A descriptive error message.
      */
-    constructor(errno, message = ErrorStrings[errno], path) {
+    constructor(errno, message = ErrorStrings[errno], path, syscall = '') {
         super(message);
         this.errno = errno;
         this.path = path;
-        // Unsupported.
-        this.syscall = '';
+        this.syscall = syscall;
         this.code = ErrorCode[errno];
         this.message = `${this.code}: ${message}${this.path ? `, '${this.path}'` : ''}`;
     }
@@ -159,6 +137,7 @@ export class ApiError extends Error {
             path: this.path,
             stack: this.stack,
             message: this.message,
+            syscall: this.syscall,
         };
     }
     /**

package/dist/FileIndex.js

@@ -306,7 +306,7 @@ export class FileIndexFS extends Readonly(FileSystem) {
     async stat(path) {
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'stat');
         }
         if (inode.isDirectory()) {
             return inode.stats;
@@ -319,7 +319,7 @@ export class FileIndexFS extends Readonly(FileSystem) {
     statSync(path) {
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'statSync');
         }
         if (inode.isDirectory()) {
             return inode.stats;
@@ -337,10 +337,10 @@ export class FileIndexFS extends Readonly(FileSystem) {
         // Check if the path exists, and is a file.
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'openFile');
         }
         if (!inode.toStats().hasAccess(flagToMode(flag), cred)) {
-            throw ApiError.EACCES(path);
+            throw ApiError.With('EACCESS', path, 'openFile');
         }
         if (inode.isDirectory()) {
             const stats = inode.stats;
@@ -356,10 +356,10 @@ export class FileIndexFS extends Readonly(FileSystem) {
         // Check if the path exists, and is a file.
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'openFileSync');
         }
         if (!inode.toStats().hasAccess(flagToMode(flag), cred)) {
-            throw ApiError.EACCES(path);
+            throw ApiError.With('EACCES', path, 'openFileSync');
         }
         if (inode.isDirectory()) {
             const stats = inode.stats;
@@ -371,23 +371,23 @@ export class FileIndexFS extends Readonly(FileSystem) {
         // Check if it exists.
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'readdir');
         }
         if (inode.isDirectory()) {
             return inode.listing;
         }
-        throw ApiError.ENOTDIR(path);
+        throw ApiError.With('ENOTDIR', path, 'readdir');
     }
     readdirSync(path) {
         // Check if it exists.
         const inode = this._index.get(path);
         if (!inode) {
-            throw ApiError.ENOENT(path);
+            throw ApiError.With('ENOENT', path, 'readdirSync');
         }
         if (inode.isDirectory()) {
             return inode.listing;
         }
-        throw ApiError.ENOTDIR(path);
+        throw ApiError.With('ENOTDIR', path, 'readdirSync');
     }
 }
 export class SyncFileIndexFS extends Sync((FileIndexFS)) {

package/dist/backends/AsyncStore.js

@@ -127,10 +127,10 @@ export class AsyncStoreFS extends Async(FileSystem) {
             // Remove oldPath from parent's directory listing.
             oldDirNode = await this.findINode(tx, oldParent), oldDirList = await this.getDirListing(tx, oldDirNode, oldParent);
             if (!oldDirNode.toStats().hasAccess(W_OK, cred)) {
-                throw ApiError.EACCES(oldPath);
+                throw ApiError.With('EACCES', oldPath, 'rename');
             }
             if (!oldDirList[oldName]) {
-                throw ApiError.ENOENT(oldPath);
+                throw ApiError.With('ENOENT', oldPath, 'rename');
             }
             const nodeId = oldDirList[oldName];
             delete oldDirList[oldName];
@@ -168,7 +168,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
                 }
                 else {
                     // If it's a directory, throw a permissions error.
-                    throw ApiError.EPERM(newPath);
+                    throw ApiError.With('EPERM', newPath, 'rename');
                 }
             }
             newDirList[newName] = nodeId;
@@ -193,11 +193,11 @@ export class AsyncStoreFS extends Async(FileSystem) {
         const tx = this.store.beginTransaction();
         const inode = await this.findINode(tx, p);
         if (!inode) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'stat');
         }
         const stats = inode.toStats();
         if (!stats.hasAccess(R_OK, cred)) {
-            throw ApiError.EACCES(p);
+            throw ApiError.With('EACCES', p, 'stat');
         }
         return stats;
     }
@@ -209,10 +209,10 @@ export class AsyncStoreFS extends Async(FileSystem) {
     async openFile(p, flag, cred) {
         const tx = this.store.beginTransaction(), node = await this.findINode(tx, p), data = await tx.get(node.ino);
         if (!node.toStats().hasAccess(flagToMode(flag), cred)) {
-            throw ApiError.EACCES(p);
+            throw ApiError.With('EACCES', p, 'openFile');
         }
         if (!data) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'openFile');
         }
         return new AsyncFile(this, p, flag, node.toStats(), data);
     }
@@ -223,7 +223,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
         // Check first if directory is empty.
         const list = await this.readdir(p, cred);
         if (list.length > 0) {
-            throw ApiError.ENOTEMPTY(p);
+            throw ApiError.With('ENOTEMPTY', p, 'rmdir');
         }
         await this.removeEntry(p, true, cred);
     }
@@ -235,7 +235,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
         const tx = this.store.beginTransaction();
         const node = await this.findINode(tx, p);
         if (!node.toStats().hasAccess(R_OK, cred)) {
-            throw ApiError.EACCES(p);
+            throw ApiError.With('EACCES', p, 'readdur');
         }
         return Object.keys(await this.getDirListing(tx, node, p));
     }
@@ -264,16 +264,16 @@ export class AsyncStoreFS extends Async(FileSystem) {
     async link(existing, newpath, cred) {
         const tx = this.store.beginTransaction(), existingDir = dirname(existing), existingDirNode = await this.findINode(tx, existingDir);
         if (!existingDirNode.toStats().hasAccess(R_OK, cred)) {
-            throw ApiError.EACCES(existingDir);
+            throw ApiError.With('EACCES', existingDir, 'link');
         }
         const newDir = dirname(newpath), newDirNode = await this.findINode(tx, newDir), newListing = await this.getDirListing(tx, newDirNode, newDir);
         if (!newDirNode.toStats().hasAccess(W_OK, cred)) {
-            throw ApiError.EACCES(newDir);
+            throw ApiError.With('EACCES', newDir, 'link');
         }
         const ino = await this._findINode(tx, existingDir, basename(existing));
         const node = await this.getINode(tx, ino, existing);
         if (!node.toStats().hasAccess(W_OK, cred)) {
-            throw ApiError.EACCES(newpath);
+            throw ApiError.With('EACCES', newpath, 'link');
         }
         node.nlink++;
         newListing[basename(newpath)] = ino;
@@ -341,7 +341,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
                     return id;
                 }
                 else {
-                    throw ApiError.ENOENT(resolve(parent, filename));
+                    throw ApiError.With('ENOENT', resolve(parent, filename), '_findINode');
                 }
             }
         }
@@ -358,7 +358,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
                 return id;
             }
             else {
-                throw ApiError.ENOENT(resolve(parent, filename));
+                throw ApiError.With('ENOENT', resolve(parent, filename), '_findINode');
             }
         }
     }
@@ -380,7 +380,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
     async getINode(tx, id, p) {
         const data = await tx.get(id);
         if (!data) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'getINode');
         }
         return new Inode(data.buffer);
     }
@@ -390,7 +390,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
      */
     async getDirListing(tx, inode, p) {
         if (!inode.toStats().isDirectory()) {
-            throw ApiError.ENOTDIR(p);
+            throw ApiError.With('ENOTDIR', p, 'getDirListing');
         }
         const data = await tx.get(inode.ino);
         if (!data) {
@@ -399,7 +399,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
                 than a directory listing. The latter should never occur unless
                 the file system is corrupted.
              */
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'getDirListing');
         }
         return decodeDirListing(data);
     }
@@ -407,26 +407,18 @@ export class AsyncStoreFS extends Async(FileSystem) {
      * Adds a new node under a random ID. Retries 5 times before giving up in
      * the exceedingly unlikely chance that we try to reuse a random ino.
      */
-    async addNewNode(tx, data) {
-        let retries = 0;
-        const reroll = async () => {
-            if (++retries === 5) {
-                // Max retries hit. Return with an error.
-                throw new ApiError(ErrorCode.EIO, 'Unable to commit data to key-value store.');
-            }
-            else {
-                // Try again.
-                const ino = randomIno();
-                const committed = await tx.put(ino, data, false);
-                if (!committed) {
-                    return reroll();
-                }
-                else {
-                    return ino;
-                }
-            }
-        };
-        return reroll();
+    async addNewNode(tx, data, _maxAttempts = 5) {
+        if (_maxAttempts <= 0) {
+            // Max retries hit. Return with an error.
+            throw new ApiError(ErrorCode.EIO, 'Unable to commit data to key-value store.');
+        }
+        // Make an attempt
+        const ino = randomIno();
+        const isCommited = await tx.put(ino, data, false);
+        if (!isCommited) {
+            return await this.addNewNode(tx, data, --_maxAttempts);
+        }
+        return ino;
     }
     /**
      * Commits a new file (well, a FILE or a DIRECTORY) to the file system with
@@ -442,18 +434,18 @@ export class AsyncStoreFS extends Async(FileSystem) {
         const parentDir = dirname(p), fname = basename(p), parentNode = await this.findINode(tx, parentDir), dirListing = await this.getDirListing(tx, parentNode, parentDir);
         //Check that the creater has correct access
         if (!parentNode.toStats().hasAccess(W_OK, cred)) {
-            throw ApiError.EACCES(p);
+            throw ApiError.With('EACCES', p, 'commitNewFile');
         }
         // Invariant: The root always exists.
         // If we don't check this prior to taking steps below, we will create a
         // file with name '' in root should p == '/'.
         if (p === '/') {
-            throw ApiError.EEXIST(p);
+            throw ApiError.With('EEXIST', p, 'commitNewFile');
         }
         // Check if file already exists.
         if (dirListing[fname]) {
             await tx.abort();
-            throw ApiError.EEXIST(p);
+            throw ApiError.With('EEXIST', p, 'commitNewFile');
         }
         try {
             // Commit data.
@@ -492,21 +484,21 @@ export class AsyncStoreFS extends Async(FileSystem) {
         }
         const tx = this.store.beginTransaction(), parent = dirname(p), parentNode = await this.findINode(tx, parent), parentListing = await this.getDirListing(tx, parentNode, parent), fileName = basename(p);
         if (!parentListing[fileName]) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'removeEntry');
         }
         const fileIno = parentListing[fileName];
         // Get file inode.
         const fileNode = await this.getINode(tx, fileIno, p);
         if (!fileNode.toStats().hasAccess(W_OK, cred)) {
-            throw ApiError.EACCES(p);
+            throw ApiError.With('EACCES', p, 'removeEntry');
         }
         // Remove from directory listing of parent.
         delete parentListing[fileName];
         if (!isDir && fileNode.toStats().isDirectory()) {
-            throw ApiError.EISDIR(p);
+            throw ApiError.With('EISDIR', p, 'removeEntry');
         }
         if (isDir && !fileNode.toStats().isDirectory()) {
-            throw ApiError.ENOTDIR(p);
+            throw ApiError.With('ENOTDIR', p, 'removeEntry');
         }
         try {
             await tx.put(parentNode.ino, encodeDirListing(parentListing), true);

package/dist/backends/Overlay.js

@@ -134,7 +134,7 @@ export class UnlockedOverlayFS extends FileSystem {
         }
         catch (e) {
             if (this._deletedFiles.has(oldPath)) {
-                throw ApiError.ENOENT(oldPath);
+                throw ApiError.With('ENOENT', oldPath, 'rename');
             }
         }
     }
@@ -147,7 +147,7 @@ export class UnlockedOverlayFS extends FileSystem {
         }
         catch (e) {
             if (this._deletedFiles.has(oldPath)) {
-                throw ApiError.ENOENT(oldPath);
+                throw ApiError.With('ENOENT', oldPath, 'renameSync');
             }
         }
     }
@@ -158,7 +158,7 @@ export class UnlockedOverlayFS extends FileSystem {
         }
         catch (e) {
             if (this._deletedFiles.has(p)) {
-                throw ApiError.ENOENT(p);
+                throw ApiError.With('ENOENT', p, 'stat');
             }
             const oldStat = new Stats(await this._readable.stat(p, cred));
             // Make the oldStat's mode writable. Preserve the topmost part of the mode, which specifies the type
@@ -173,7 +173,7 @@ export class UnlockedOverlayFS extends FileSystem {
         }
         catch (e) {
             if (this._deletedFiles.has(p)) {
-                throw ApiError.ENOENT(p);
+                throw ApiError.With('ENOENT', p, 'statSync');
             }
             const oldStat = new Stats(this._readable.statSync(p, cred));
             // Make the oldStat's mode writable. Preserve the topmost part of the mode, which specifies the type.
@@ -224,7 +224,7 @@ export class UnlockedOverlayFS extends FileSystem {
         this.checkInitialized();
         this.checkPath(p);
         if (!(await this.exists(p, cred))) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'unlink');
         }
         if (await this._writable.exists(p, cred)) {
             await this._writable.unlink(p, cred);
@@ -238,7 +238,7 @@ export class UnlockedOverlayFS extends FileSystem {
         this.checkInitialized();
         this.checkPath(p);
         if (!this.existsSync(p, cred)) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'unlinkSync');
         }
         if (this._writable.existsSync(p, cred)) {
             this._writable.unlinkSync(p, cred);
@@ -251,7 +251,7 @@ export class UnlockedOverlayFS extends FileSystem {
     async rmdir(p, cred) {
         this.checkInitialized();
         if (!(await this.exists(p, cred))) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'rmdir');
         }
         if (await this._writable.exists(p, cred)) {
             await this._writable.rmdir(p, cred);
@@ -259,7 +259,7 @@ export class UnlockedOverlayFS extends FileSystem {
         if (await this.exists(p, cred)) {
             // Check if directory is empty.
             if ((await this.readdir(p, cred)).length > 0) {
-                throw ApiError.ENOTEMPTY(p);
+                throw ApiError.With('ENOTEMPTY', p, 'rmdir');
             }
             else {
                 this.deletePath(p, cred);
@@ -269,7 +269,7 @@ export class UnlockedOverlayFS extends FileSystem {
     rmdirSync(p, cred) {
         this.checkInitialized();
         if (!this.existsSync(p, cred)) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'rmdirSync');
         }
         if (this._writable.existsSync(p, cred)) {
             this._writable.rmdirSync(p, cred);
@@ -277,7 +277,7 @@ export class UnlockedOverlayFS extends FileSystem {
         if (this.existsSync(p, cred)) {
             // Check if directory is empty.
             if (this.readdirSync(p, cred).length > 0) {
-                throw ApiError.ENOTEMPTY(p);
+                throw ApiError.With('ENOTEMPTY', p, 'rmdirSync');
             }
             else {
                 this.deletePath(p, cred);
@@ -287,7 +287,7 @@ export class UnlockedOverlayFS extends FileSystem {
     async mkdir(p, mode, cred) {
         this.checkInitialized();
         if (await this.exists(p, cred)) {
-            throw ApiError.EEXIST(p);
+            throw ApiError.With('EEXIST', p, 'mkdir');
         }
         // The below will throw should any of the parent directories fail to exist on _writable.
         await this.createParentDirectories(p, cred);
@@ -296,7 +296,7 @@ export class UnlockedOverlayFS extends FileSystem {
     mkdirSync(p, mode, cred) {
         this.checkInitialized();
         if (this.existsSync(p, cred)) {
-            throw ApiError.EEXIST(p);
+            throw ApiError.With('EEXIST', p, 'mkdirSync');
         }
         // The below will throw should any of the parent directories fail to exist on _writable.
         this.createParentDirectoriesSync(p, cred);
@@ -306,7 +306,7 @@ export class UnlockedOverlayFS extends FileSystem {
         this.checkInitialized();
         const dirStats = await this.stat(p, cred);
         if (!dirStats.isDirectory()) {
-            throw ApiError.ENOTDIR(p);
+            throw ApiError.With('ENOTDIR', p, 'readdir');
         }
         // Readdir in both, check delete log on RO file system's listing, merge, return.
         const contents = [];
@@ -333,7 +333,7 @@ export class UnlockedOverlayFS extends FileSystem {
         this.checkInitialized();
         const dirStats = this.statSync(p, cred);
         if (!dirStats.isDirectory()) {
-            throw ApiError.ENOTDIR(p);
+            throw ApiError.With('ENOTDIR', p, 'readdirSync');
         }
         // Readdir in both, check delete log on RO file system's listing, merge, return.
         let contents = [];
@@ -405,7 +405,7 @@ export class UnlockedOverlayFS extends FileSystem {
     }
     checkPath(path) {
         if (path == deletionLogPath) {
-            throw ApiError.EPERM(path);
+            throw ApiError.With('EPERM', path, 'checkPath');
         }
     }
     /**
@@ -442,7 +442,7 @@ export class UnlockedOverlayFS extends FileSystem {
      */
     operateOnWritable(p, cred) {
         if (!this.existsSync(p, cred)) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'operateOnWriteable');
         }
         if (!this._writable.existsSync(p, cred)) {
             // File is on readable storage. Copy to writable storage before
@@ -452,7 +452,7 @@ export class UnlockedOverlayFS extends FileSystem {
     }
     async operateOnWritableAsync(p, cred) {
         if (!(await this.exists(p, cred))) {
-            throw ApiError.ENOENT(p);
+            throw ApiError.With('ENOENT', p, 'operateOnWritableAsync');
         }
         if (!(await this._writable.exists(p, cred))) {
             return this.copyToWritable(p, cred);

package/dist/backends/SyncStore.d.ts

@@ -202,7 +202,7 @@ export declare class SyncStoreFS extends SyncStoreFS_base {
      * the exceedingly unlikely chance that we try to reuse a random GUID.
      * @return The GUID that the data was stored under.
      */
-    protected addNewNode(tx: SyncTransaction, data: Uint8Array): Ino;
+    protected addNewNode(tx: SyncTransaction, data: Uint8Array, _maxAttempts?: number): Ino;
     /**
      * Commits a new file (well, a FILE or a DIRECTORY) to the file system with the given mode.
      * Note: This will commit the transaction.