@zenfs/core 0.5.2 → 0.5.4

package/dist/backends/AsyncStore.d.ts

@@ -4,41 +4,31 @@ import { FileSystem, type FileSystemMetadata } from '../filesystem.js';
 import { type Ino } from '../inode.js';
 import { type Stats } from '../stats.js';
 /**
- * Represents an *asynchronous* key-value store.
+ * Represents an asynchronous key-value store.
  */
 export interface AsyncStore {
     /**
-     * The name of the key-value store.
+     * The name of the store.
      */
     name: string;
     /**
-     * Empties the key-value store completely.
+     * Empties the store completely.
      */
     clear(): Promise<void>;
     /**
-     * Begins a read-write transaction.
+     * Begins a transaction.
      */
-    beginTransaction(type: 'readwrite'): AsyncRWTransaction;
-    /**
-     * Begins a read-only transaction.
-     */
-    beginTransaction(type: 'readonly'): AsyncROTransaction;
-    beginTransaction(type: string): AsyncROTransaction;
+    beginTransaction(): AsyncTransaction;
 }
 /**
- * Represents an asynchronous read-only transaction.
+ * Represents an asynchronous transaction.
  */
-export interface AsyncROTransaction {
+export interface AsyncTransaction {
     /**
      * Retrieves the data at the given key.
      * @param key The key to look under for data.
      */
     get(key: Ino): Promise<Uint8Array>;
-}
-/**
- * Represents an asynchronous read-write transaction.
- */
-export interface AsyncRWTransaction extends AsyncROTransaction {
     /**
      * Adds the data to the store under the given key. Overwrites any existing
      * data.

package/dist/backends/AsyncStore.js

@@ -123,7 +123,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
             c.reset();
         }
         try {
-            const tx = this.store.beginTransaction('readwrite'), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
+            const tx = this.store.beginTransaction(), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
             // 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)) {
@@ -190,7 +190,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
         }
     }
     async stat(p, cred) {
-        const tx = this.store.beginTransaction('readonly');
+        const tx = this.store.beginTransaction();
         const inode = await this.findINode(tx, p);
         if (!inode) {
             throw ApiError.ENOENT(p);
@@ -202,12 +202,12 @@ export class AsyncStoreFS extends Async(FileSystem) {
         return stats;
     }
     async createFile(p, flag, mode, cred) {
-        const tx = this.store.beginTransaction('readwrite'), data = new Uint8Array(0), newFile = await this.commitNewFile(tx, p, FileType.FILE, mode, cred, data);
+        const tx = this.store.beginTransaction(), data = new Uint8Array(0), newFile = await this.commitNewFile(tx, p, FileType.FILE, mode, cred, data);
         // Open the file.
         return new AsyncFile(this, p, flag, newFile.toStats(), data);
     }
     async openFile(p, flag, cred) {
-        const tx = this.store.beginTransaction('readonly'), node = await this.findINode(tx, p), data = await tx.get(node.ino);
+        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);
         }
@@ -228,11 +228,11 @@ export class AsyncStoreFS extends Async(FileSystem) {
         await this.removeEntry(p, true, cred);
     }
     async mkdir(p, mode, cred) {
-        const tx = this.store.beginTransaction('readwrite'), data = encode('{}');
+        const tx = this.store.beginTransaction(), data = encode('{}');
         await this.commitNewFile(tx, p, FileType.DIRECTORY, mode, cred, data);
     }
     async readdir(p, cred) {
-        const tx = this.store.beginTransaction('readonly');
+        const tx = this.store.beginTransaction();
         const node = await this.findINode(tx, p);
         if (!node.toStats().hasAccess(R_OK, cred)) {
             throw ApiError.EACCES(p);
@@ -244,7 +244,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
      * @todo Ensure mtime updates properly, and use that to determine if a data update is required.
      */
     async sync(p, data, stats) {
-        const tx = this.store.beginTransaction('readwrite'), 
+        const tx = this.store.beginTransaction(), 
         // We use the _findInode helper because we actually need the INode id.
         fileInodeId = await this._findINode(tx, dirname(p), basename(p)), fileInode = await this.getINode(tx, fileInodeId, p), inodeChanged = fileInode.update(stats);
         try {
@@ -262,7 +262,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
         await tx.commit();
     }
     async link(existing, newpath, cred) {
-        const tx = this.store.beginTransaction('readwrite'), existingDir = dirname(existing), existingDirNode = await this.findINode(tx, existingDir);
+        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);
         }
@@ -291,7 +291,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
      * Checks if the root directory exists. Creates it if it doesn't.
      */
     async makeRootDirectory() {
-        const tx = this.store.beginTransaction('readwrite');
+        const tx = this.store.beginTransaction();
         if ((await tx.get(rootIno)) === undefined) {
             // Create new inode. o777, owned by root:root
             const dirInode = new Inode();
@@ -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
@@ -490,7 +482,7 @@ export class AsyncStoreFS extends Async(FileSystem) {
         if (this._cache) {
             this._cache.remove(p);
         }
-        const tx = this.store.beginTransaction('readwrite'), parent = dirname(p), parentNode = await this.findINode(tx, parent), parentListing = await this.getDirListing(tx, parentNode, parent), fileName = basename(p);
+        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);
         }

package/dist/backends/InMemory.d.ts

@@ -1,6 +1,6 @@
 import type { Ino } from '../inode.js';
 import type { Backend } from './backend.js';
-import { SyncStore, SimpleSyncStore, SyncRWTransaction } from './SyncStore.js';
+import { SyncStore, SimpleSyncStore, SyncTransaction } from './SyncStore.js';
 /**
  * A simple in-memory store
  */
@@ -9,7 +9,7 @@ export declare class InMemoryStore implements SyncStore, SimpleSyncStore {
     private store;
     constructor(name?: string);
     clear(): void;
-    beginTransaction(): SyncRWTransaction;
+    beginTransaction(): SyncTransaction;
     get(key: Ino): Uint8Array;
     put(key: Ino, data: Uint8Array, overwrite: boolean): boolean;
     remove(key: Ino): void;

package/dist/backends/InMemory.js

@@ -1,4 +1,4 @@
-import { SimpleSyncRWTransaction, SyncStoreFS } from './SyncStore.js';
+import { SimpleSyncTransaction, SyncStoreFS } from './SyncStore.js';
 /**
  * A simple in-memory store
  */
@@ -11,7 +11,7 @@ export class InMemoryStore {
         this.store.clear();
     }
     beginTransaction() {
-        return new SimpleSyncRWTransaction(this);
+        return new SimpleSyncTransaction(this);
     }
     get(key) {
         return this.store.get(key);

package/dist/backends/SyncStore.d.ts

@@ -16,19 +16,14 @@ export interface SyncStore {
      */
     clear(): void;
     /**
-     * Begins a new read-only transaction.
+     * Begins a new transaction.
      */
-    beginTransaction(type: 'readonly'): SyncROTransaction;
-    /**
-     * Begins a new read-write transaction.
-     */
-    beginTransaction(type: 'readwrite'): SyncRWTransaction;
-    beginTransaction(type: string): SyncROTransaction;
+    beginTransaction(): SyncTransaction;
 }
 /**
- * A read-only transaction for a synchronous key value store.
+ * A transaction for a synchronous key value store.
  */
-export interface SyncROTransaction {
+export interface SyncTransaction {
     /**
      * Retrieves the data at the given key. Throws an ApiError if an error occurs
      * or if the key does not exist.
@@ -36,11 +31,6 @@ export interface SyncROTransaction {
      * @return The data stored under the key, or undefined if not present.
      */
     get(ino: Ino): Uint8Array | undefined;
-}
-/**
- * A read-write transaction for a synchronous key value store.
- */
-export interface SyncRWTransaction extends SyncROTransaction {
     /**
      * Adds the data to the store under the given key.
      * @param ino The key to add the data under.
@@ -76,7 +66,7 @@ export interface SimpleSyncStore {
 /**
  * A simple RW transaction for simple synchronous key-value stores.
  */
-export declare class SimpleSyncRWTransaction implements SyncRWTransaction {
+export declare class SimpleSyncTransaction implements SyncTransaction {
     protected store: SimpleSyncStore;
     /**
      * Stores data in the keys we modify prior to modifying them.
@@ -186,25 +176,25 @@ export declare class SyncStoreFS extends SyncStoreFS_base {
      *   the parent.
      * @return string The ID of the file's inode in the file system.
      */
-    protected _findINode(tx: SyncROTransaction, parent: string, filename: string, visited?: Set<string>): Ino;
+    protected _findINode(tx: SyncTransaction, parent: string, filename: string, visited?: Set<string>): Ino;
     /**
      * Finds the Inode of the given path.
      * @param p The path to look up.
      * @return The Inode of the path p.
      * @todo memoize/cache
      */
-    protected findINode(tx: SyncROTransaction, p: string): Inode;
+    protected findINode(tx: SyncTransaction, p: string): Inode;
     /**
      * Given the ID of a node, retrieves the corresponding Inode.
      * @param tx The transaction to use.
      * @param p The corresponding path to the file (used for error messages).
      * @param id The ID to look up.
      */
-    protected getINode(tx: SyncROTransaction, id: Ino, p?: string): Inode;
+    protected getINode(tx: SyncTransaction, id: Ino, p?: string): Inode;
     /**
      * Given the Inode of a directory, retrieves the corresponding directory listing.
      */
-    protected getDirListing(tx: SyncROTransaction, inode: Inode, p?: string): {
+    protected getDirListing(tx: SyncTransaction, inode: Inode, p?: string): {
         [fileName: string]: Ino;
     };
     /**
@@ -212,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: SyncRWTransaction, 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.

package/dist/backends/SyncStore.js

@@ -10,7 +10,7 @@ import { rootIno } from '../inode.js';
 /**
  * A simple RW transaction for simple synchronous key-value stores.
  */
-export class SimpleSyncRWTransaction {
+export class SimpleSyncTransaction {
     constructor(store) {
         this.store = store;
         /**
@@ -130,7 +130,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
         this.makeRootDirectory();
     }
     renameSync(oldPath, newPath, cred) {
-        const tx = this.store.beginTransaction('readwrite'), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
+        const tx = this.store.beginTransaction(), oldParent = dirname(oldPath), oldName = basename(oldPath), newParent = dirname(newPath), newName = basename(newPath), 
         // Remove oldPath from parent's directory listing.
         oldDirNode = this.findINode(tx, oldParent), oldDirList = this.getDirListing(tx, oldDirNode, oldParent);
         if (!oldDirNode.toStats().hasAccess(W_OK, cred)) {
@@ -192,7 +192,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
     }
     statSync(p, cred) {
         // Get the inode to the item, convert it into a Stats object.
-        const stats = this.findINode(this.store.beginTransaction('readonly'), p).toStats();
+        const stats = this.findINode(this.store.beginTransaction(), p).toStats();
         if (!stats.hasAccess(R_OK, cred)) {
             throw ApiError.EACCES(p);
         }
@@ -203,7 +203,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
         return this.openFileSync(p, flag, cred);
     }
     openFileSync(p, flag, cred) {
-        const tx = this.store.beginTransaction('readonly'), node = this.findINode(tx, p), data = tx.get(node.ino);
+        const tx = this.store.beginTransaction(), node = this.findINode(tx, p), data = tx.get(node.ino);
         if (!node.toStats().hasAccess(flagToMode(flag), cred)) {
             throw ApiError.EACCES(p);
         }
@@ -228,7 +228,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
         this.commitNewFile(p, FileType.DIRECTORY, mode, cred, encode('{}'));
     }
     readdirSync(p, cred) {
-        const tx = this.store.beginTransaction('readonly');
+        const tx = this.store.beginTransaction();
         const node = this.findINode(tx, p);
         if (!node.toStats().hasAccess(R_OK, cred)) {
             throw ApiError.EACCES(p);
@@ -238,7 +238,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
     syncSync(p, data, stats) {
         // @todo Ensure mtime updates properly, and use that to determine if a data
         //       update is required.
-        const tx = this.store.beginTransaction('readwrite'), 
+        const tx = this.store.beginTransaction(), 
         // We use the _findInode helper because we actually need the INode id.
         fileInodeId = this._findINode(tx, dirname(p), basename(p)), fileInode = this.getINode(tx, fileInodeId, p), inodeChanged = fileInode.update(stats);
         try {
@@ -256,7 +256,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
         tx.commit();
     }
     linkSync(existing, newpath, cred) {
-        const tx = this.store.beginTransaction('readwrite'), existingDir = dirname(existing), existingDirNode = this.findINode(tx, existingDir);
+        const tx = this.store.beginTransaction(), existingDir = dirname(existing), existingDirNode = this.findINode(tx, existingDir);
         if (!existingDirNode.toStats().hasAccess(R_OK, cred)) {
             throw ApiError.EACCES(existingDir);
         }
@@ -285,7 +285,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
      * Checks if the root directory exists. Creates it if it doesn't.
      */
     makeRootDirectory() {
-        const tx = this.store.beginTransaction('readwrite');
+        const tx = this.store.beginTransaction();
         if (tx.get(rootIno)) {
             return;
         }
@@ -371,18 +371,13 @@ export class SyncStoreFS extends Sync(FileSystem) {
      * the exceedingly unlikely chance that we try to reuse a random GUID.
      * @return The GUID that the data was stored under.
      */
-    addNewNode(tx, data) {
-        const retries = 0;
-        let ino;
-        while (retries < 5) {
-            try {
-                ino = randomIno();
-                tx.put(ino, data, false);
-                return ino;
-            }
-            catch (e) {
-                // Ignore and reroll.
+    addNewNode(tx, data, _maxAttempts = 5) {
+        for (let i = 0; i < _maxAttempts; i++) {
+            const ino = randomIno();
+            if (!tx.put(ino, data, false)) {
+                continue;
             }
+            return ino;
         }
         throw new ApiError(ErrorCode.EIO, 'Unable to commit data to key-value store.');
     }
@@ -396,7 +391,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
      * @return The Inode for the new file.
      */
     commitNewFile(p, type, mode, cred, data = new Uint8Array()) {
-        const tx = this.store.beginTransaction('readwrite'), parentDir = dirname(p), fname = basename(p), parentNode = this.findINode(tx, parentDir), dirListing = this.getDirListing(tx, parentNode, parentDir);
+        const tx = this.store.beginTransaction(), parentDir = dirname(p), fname = basename(p), parentNode = this.findINode(tx, parentDir), dirListing = this.getDirListing(tx, parentNode, parentDir);
         //Check that the creater has correct access
         if (!parentNode.toStats().hasAccess(W_OK, cred)) {
             throw ApiError.EACCES(p);
@@ -438,7 +433,7 @@ export class SyncStoreFS extends Sync(FileSystem) {
      * @todo Update mtime.
      */
     removeEntry(p, isDir, cred) {
-        const tx = this.store.beginTransaction('readwrite'), parent = dirname(p), parentNode = this.findINode(tx, parent), parentListing = this.getDirListing(tx, parentNode, parent), fileName = basename(p), fileIno = parentListing[fileName];
+        const tx = this.store.beginTransaction(), parent = dirname(p), parentNode = this.findINode(tx, parent), parentListing = this.getDirListing(tx, parentNode, parent), fileName = basename(p), fileIno = parentListing[fileName];
         if (!fileIno) {
             throw ApiError.ENOENT(p);
         }