@openclaw/fs-safe 0.17.0 → 0.18.0

package/dist/file-hash.js

@@ -1,3 +1,55 @@
+var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
+    if (value !== null && value !== void 0) {
+        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
+        var dispose, inner;
+        if (async) {
+            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
+            dispose = value[Symbol.asyncDispose];
+        }
+        if (dispose === void 0) {
+            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
+            dispose = value[Symbol.dispose];
+            if (async) inner = dispose;
+        }
+        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
+        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
+        env.stack.push({ value: value, dispose: dispose, async: async });
+    }
+    else if (async) {
+        env.stack.push({ async: true });
+    }
+    return value;
+};
+var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
+    return function (env) {
+        function fail(e) {
+            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
+            env.hasError = true;
+        }
+        var r, s = 0;
+        function next() {
+            while (r = env.stack.pop()) {
+                try {
+                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
+                    if (r.dispose) {
+                        var result = r.dispose.call(r.value);
+                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
+                    }
+                    else s |= 1;
+                }
+                catch (e) {
+                    fail(e);
+                }
+            }
+            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
+            if (env.hasError) throw env.error;
+        }
+        return next();
+    };
+})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+});
 import { createHash } from "node:crypto";
 import fsSync from "node:fs";
 import fs from "node:fs/promises";
@@ -7,58 +59,99 @@ import { getNativeBinding } from "./native.js";
 import { resolveReadOpenFlags } from "./read-open-flags.js";
 import { inspectFileIdentity, inspectFileIdentitySync } from "./strict-file-identity.js";
 import { assertNoWindowsPathAlias } from "./windows-path-alias.js";
-export async function hashFileHandle(handle, native = getNativeBinding(), { maxBytes = Infinity, signal } = {}) {
-    signal?.throwIfAborted();
-    const stat = fsSync.fstatSync(handle.fd);
-    if (!stat.isFile()) {
-        throw new FsSafeError("not-file", "SHA-256 input is not a regular file");
+// Idle storage is bounded independently of caller concurrency. A pending read
+// retains its exclusive borrow until the async hasher settles.
+const hashScratchBuffers = [];
+function takeHashScratch(size) {
+    const index = hashScratchBuffers.findIndex((buffer) => buffer.length >= size);
+    return index < 0 ? Buffer.allocUnsafe(size) : hashScratchBuffers.splice(index, 1)[0];
+}
+class HashScratch {
+    #storage;
+    buffer;
+    constructor(size) {
+        this.#storage = takeHashScratch(size);
+        this.buffer = this.#storage.subarray(0, size);
     }
-    if (stat.size > maxBytes) {
-        throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
+    grow(size) {
+        const storage = takeHashScratch(size);
+        this[Symbol.dispose]();
+        this.#storage = storage;
+        return this.buffer = storage.subarray(0, size);
     }
-    if (native) {
-        // A completed N-API task can mask later aborts on the same signal.
-        const nativeSignal = signal ? AbortSignal.any([signal]) : undefined;
-        try {
-            const result = await native.sha256File(handle.fd, Number.isFinite(maxBytes) ? maxBytes : undefined, nativeSignal);
-            signal?.throwIfAborted();
-            return result;
-        }
-        catch (error) {
-            // N-API settles only after compute stops; never race descriptor cleanup.
-            signal?.throwIfAborted();
-            if (error?.code === "too-large") {
-                throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`, { cause: error });
-            }
-            throw error;
-        }
-        finally {
-            // Node retains composite signals while N-API's abort listener is attached.
-            if (nativeSignal)
-                nativeSignal.onabort = null;
-        }
+    [Symbol.dispose]() {
+        // Clear the used view before retention; a larger unused tail was cleared
+        // by its previous borrower, without making tiny hashes clear large buffers.
+        this.buffer.fill(0);
+        hashScratchBuffers.push(this.#storage);
+        hashScratchBuffers.sort((left, right) => left.length - right.length);
+        if (hashScratchBuffers.length > 4)
+            hashScratchBuffers.shift();
     }
-    const hash = createHash("sha256");
-    let buffer = Buffer.allocUnsafe(Math.min(256 * 1024, Math.max(1, stat.size + 1), maxBytes + 1));
-    let position = 0;
-    while (true) {
-        signal?.throwIfAborted();
-        const length = Math.min(buffer.length, maxBytes - position + 1);
-        const { bytesRead } = await handle.read(buffer, 0, length, position);
+}
+export async function hashFileHandle(handle, native = getNativeBinding(), { maxBytes = Infinity, signal } = {}) {
+    const env_1 = { stack: [], error: void 0, hasError: false };
+    try {
         signal?.throwIfAborted();
-        if (bytesRead > maxBytes - position) {
+        const stat = fsSync.fstatSync(handle.fd);
+        if (!stat.isFile()) {
+            throw new FsSafeError("not-file", "SHA-256 input is not a regular file");
+        }
+        if (stat.size > maxBytes) {
             throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
         }
-        if (bytesRead === 0) {
-            return { bytes: position, digest: hash.digest("hex") };
+        if (native) {
+            // A completed N-API task can mask later aborts on the same signal.
+            const nativeSignal = signal ? AbortSignal.any([signal]) : undefined;
+            try {
+                const result = await native.sha256File(handle.fd, Number.isFinite(maxBytes) ? maxBytes : undefined, nativeSignal);
+                signal?.throwIfAborted();
+                return result;
+            }
+            catch (error) {
+                // N-API settles only after compute stops; never race descriptor cleanup.
+                signal?.throwIfAborted();
+                if (error?.code === "too-large") {
+                    throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`, { cause: error });
+                }
+                throw error;
+            }
+            finally {
+                // Node retains composite signals while N-API's abort listener is attached.
+                if (nativeSignal)
+                    nativeSignal.onabort = null;
+            }
         }
-        hash.update(buffer.subarray(0, bytesRead));
-        position += bytesRead;
-        // A full small buffer can mean growth or a virtual file with an unhelpful size.
-        if (bytesRead === buffer.length && buffer.length < 64 * 1024) {
-            buffer = Buffer.allocUnsafe(Math.min(64 * 1024, maxBytes + 1));
+        const hash = createHash("sha256");
+        const scratch = __addDisposableResource(env_1, new HashScratch(Math.min(256 * 1024, Math.max(1, stat.size + 1), maxBytes + 1)), false);
+        let buffer = scratch.buffer;
+        let position = 0;
+        while (true) {
+            signal?.throwIfAborted();
+            const length = Math.min(buffer.length, maxBytes - position + 1);
+            const { bytesRead } = await handle.read(buffer, 0, length, position);
+            signal?.throwIfAborted();
+            if (bytesRead > maxBytes - position) {
+                throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
+            }
+            if (bytesRead === 0) {
+                return { bytes: position, digest: hash.digest("hex") };
+            }
+            hash.update(buffer.subarray(0, bytesRead));
+            position += bytesRead;
+            // A full small buffer can mean growth or a virtual file with an unhelpful size.
+            if (bytesRead === buffer.length && buffer.length < 64 * 1024) {
+                buffer = scratch.grow(Math.min(64 * 1024, maxBytes + 1));
+            }
         }
     }
+    catch (e_1) {
+        env_1.error = e_1;
+        env_1.hasError = true;
+    }
+    finally {
+        __disposeResources(env_1);
+    }
 }
 function hashPathIdentity(filePath, afterOpen = false) {
     const stat = fsSync.lstatSync(filePath, { bigint: true });
@@ -123,34 +216,45 @@ export async function sha256File(input, options = {}) {
         : await hashFileHandle(input, getNativeBinding(), normalized);
 }
 function hashDescriptorSync(fd, { maxBytes = Infinity, signal }) {
-    signal?.throwIfAborted();
-    const stat = fsSync.fstatSync(fd);
-    if (!stat.isFile()) {
-        throw new FsSafeError("not-file", "SHA-256 input is not a regular file");
-    }
-    if (stat.size > maxBytes) {
-        throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
-    }
-    const hash = createHash("sha256");
-    let buffer = Buffer.allocUnsafe(Math.min(256 * 1024, Math.max(1, stat.size + 1), maxBytes + 1));
-    let position = 0;
-    while (true) {
-        signal?.throwIfAborted();
-        const length = Math.min(buffer.length, maxBytes - position + 1);
-        const bytesRead = fsSync.readSync(fd, buffer, 0, length, position);
+    const env_2 = { stack: [], error: void 0, hasError: false };
+    try {
         signal?.throwIfAborted();
-        if (bytesRead > maxBytes - position) {
-            throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
+        const stat = fsSync.fstatSync(fd);
+        if (!stat.isFile()) {
+            throw new FsSafeError("not-file", "SHA-256 input is not a regular file");
         }
-        if (bytesRead === 0) {
-            return { bytes: position, digest: hash.digest("hex") };
+        if (stat.size > maxBytes) {
+            throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
         }
-        hash.update(buffer.subarray(0, bytesRead));
-        position += bytesRead;
-        if (bytesRead === buffer.length && buffer.length < 64 * 1024) {
-            buffer = Buffer.allocUnsafe(Math.min(64 * 1024, maxBytes + 1));
+        const hash = createHash("sha256");
+        const scratch = __addDisposableResource(env_2, new HashScratch(Math.min(256 * 1024, Math.max(1, stat.size + 1), maxBytes + 1)), false);
+        let buffer = scratch.buffer;
+        let position = 0;
+        while (true) {
+            signal?.throwIfAborted();
+            const length = Math.min(buffer.length, maxBytes - position + 1);
+            const bytesRead = fsSync.readSync(fd, buffer, 0, length, position);
+            signal?.throwIfAborted();
+            if (bytesRead > maxBytes - position) {
+                throw new FsSafeError("too-large", `SHA-256 input exceeds ${maxBytes} bytes`);
+            }
+            if (bytesRead === 0) {
+                return { bytes: position, digest: hash.digest("hex") };
+            }
+            hash.update(buffer.subarray(0, bytesRead));
+            position += bytesRead;
+            if (bytesRead === buffer.length && buffer.length < 64 * 1024) {
+                buffer = scratch.grow(Math.min(64 * 1024, maxBytes + 1));
+            }
         }
     }
+    catch (e_2) {
+        env_2.error = e_2;
+        env_2.hasError = true;
+    }
+    finally {
+        __disposeResources(env_2);
+    }
 }
 function hashPathSync(filePath, options) {
     assertNoWindowsPathAlias(filePath, "filesystem", "SHA-256 path uses a Windows filesystem namespace alias");

package/dist/file-identity.d.ts

@@ -5,4 +5,3 @@ export type FileIdentityStat = {
 export declare function sha256Hex(data: string | Buffer, encoding?: BufferEncoding): string;
 export declare function sameFileIdentity(left: FileIdentityStat, right: FileIdentityStat, platform?: NodeJS.Platform): boolean;
 export declare function sameFileIdentityForCleanup(left: FileIdentityStat, right: FileIdentityStat, platform?: NodeJS.Platform): boolean;
-//# sourceMappingURL=file-identity.d.ts.map

package/dist/file-lock-sync-acquisition.d.ts

@@ -0,0 +1,22 @@
+import type { FileLockSyncHandle } from "./file-lock-sync.js";
+import type { SidecarLockCompromisedInfo, SidecarLockRetryOptions } from "./sidecar-lock-types.js";
+/** Owns local arbitration and retry state, independently of filesystem authority. */
+export declare class SyncLockAcquisition {
+    #private;
+    readonly lockPath: string;
+    readonly normalizedTargetPath: string;
+    private readonly retry;
+    private readonly timeoutMs;
+    constructor(lockPath: string, normalizedTargetPath: string, retry: SidecarLockRetryOptions, timeoutMs: number | undefined);
+    get owns(): boolean;
+    hasToken(): boolean;
+    assert(): void;
+    reserve(): void;
+    release(): void;
+    run<T>(callback: () => T): T;
+    waitForRetry(): void;
+    retryDenial(error: unknown): boolean;
+    monitor(held: {
+        timer?: NodeJS.Timeout;
+    }, handle: FileLockSyncHandle, callback: ((info: SidecarLockCompromisedInfo) => void) | undefined, interval: number | undefined, receiver: object, recordTimer?: (timer: NodeJS.Timeout) => void): void;
+}

package/dist/file-lock-sync-acquisition.js

@@ -0,0 +1,98 @@
+import { getSyncLockAdmissions } from "./file-lock-sync-admission.js";
+import { isTransientLockFileDenial, maxTransientLockDenials, sidecarLockRetryDelay, sidecarLockTimeout, } from "./sidecar-lock-policy.js";
+import { sleepSync } from "./timing.js";
+/** Owns local arbitration and retry state, independently of filesystem authority. */
+export class SyncLockAcquisition {
+    lockPath;
+    normalizedTargetPath;
+    retry;
+    timeoutMs;
+    #admissions = getSyncLockAdmissions();
+    #token = {};
+    #owns = false;
+    #startedAt = Date.now();
+    #attempt = 0;
+    #transientDenials = 0;
+    constructor(lockPath, normalizedTargetPath, retry, timeoutMs) {
+        this.lockPath = lockPath;
+        this.normalizedTargetPath = normalizedTargetPath;
+        this.retry = retry;
+        this.timeoutMs = timeoutMs;
+    }
+    get owns() { return this.#owns; }
+    hasToken() { return this.#admissions.get(this.normalizedTargetPath) === this.#token; }
+    assert() {
+        if (!this.hasToken())
+            throw sidecarLockTimeout(this.lockPath, this.normalizedTargetPath);
+    }
+    reserve() {
+        if (this.#owns)
+            return;
+        // An existing synchronous owner can finish only after this stack unwinds.
+        if (this.#admissions.has(this.normalizedTargetPath)) {
+            throw sidecarLockTimeout(this.lockPath, this.normalizedTargetPath);
+        }
+        this.#admissions.set(this.normalizedTargetPath, this.#token);
+        this.#owns = true;
+    }
+    release() {
+        if (this.#owns && this.hasToken())
+            this.#admissions.delete(this.normalizedTargetPath);
+        this.#owns = false;
+    }
+    run(callback) {
+        this.assert();
+        try {
+            return callback();
+        }
+        finally {
+            this.assert();
+        }
+    }
+    waitForRetry() {
+        this.release();
+        const delay = sidecarLockRetryDelay(this.retry, this.timeoutMs, Date.now() - this.#startedAt, this.#attempt);
+        if (delay === undefined)
+            throw sidecarLockTimeout(this.lockPath, this.normalizedTargetPath);
+        sleepSync(delay);
+        this.#attempt += 1;
+    }
+    retryDenial(error) {
+        if (!isTransientLockFileDenial(error, this.lockPath) ||
+            ++this.#transientDenials > maxTransientLockDenials)
+            return false;
+        try {
+            this.waitForRetry();
+        }
+        catch (waitError) {
+            // Exhausted backoff must preserve the filesystem denial diagnosis.
+            if (waitError.code === "file_lock_timeout")
+                throw error;
+            throw waitError;
+        }
+        return true;
+    }
+    monitor(held, handle, callback, interval, receiver, recordTimer) {
+        if (!callback || (interval ?? 0) <= 0)
+            return;
+        const { lockPath, normalizedTargetPath } = this;
+        const timer = setInterval(() => {
+            let stillHeld;
+            try {
+                stillHeld = handle.verifyStillHeld();
+            }
+            catch {
+                stillHeld = false;
+            }
+            if (!stillHeld && held.timer) {
+                clearInterval(held.timer);
+                held.timer = undefined;
+                Reflect.apply(callback, receiver, [{ lockPath, normalizedTargetPath }]);
+            }
+        }, interval);
+        // Root cleanup retains a separate provisional receipt before unref can fail.
+        recordTimer?.(timer);
+        held.timer = timer;
+        timer.unref();
+    }
+}

package/dist/file-lock-sync-admission.d.ts

@@ -12,8 +12,6 @@ export type SyncHeldLock = {
 export declare function foreignSyncHeldLock(route: "raw" | "root", target: string): object | undefined;
 export declare function getSyncHeldLocks(): Map<string, SyncHeldLock>;
 export declare function getSyncLockAdmissions(): Map<string, object>;
-export declare function syncLockTimeout(lockPath: string, normalizedTargetPath: string): Error;
 export declare function defaultSyncShouldReclaim(snapshot: SidecarLockSnapshot, staleMs: number, nowMs: number): boolean;
 export declare function syncReclaimGuardExists(reclaimGuardPath: string): boolean;
 export declare function ensureSyncLockExitCleanupRegistered(cleanup: () => void, lockPath: string, normalizedTargetPath: string): void;
-//# sourceMappingURL=file-lock-sync-admission.d.ts.map

package/dist/file-lock-sync-admission.js

@@ -1,5 +1,6 @@
 import fs from "node:fs";
-import { sidecarLockPayloadCreatedAtMs } from "./sidecar-lock-policy.js";
+import { sidecarLockPayloadCreatedAtMs, sidecarLockTimeout } from "./sidecar-lock-policy.js";
+import { ensureSidecarLockCleanupRegistered } from "./sidecar-lock-registration.js";
 const SYNC_HELD_LOCKS_KEY = Symbol.for("fsSafe.syncSidecarLocks");
 const SYNC_ADMISSIONS_KEY = Symbol.for("fsSafe.syncSidecarLockAdmissions");
 const SYNC_CLEANUP_REGISTERED_KEY = Symbol.for("fsSafe.syncSidecarLockCleanupRegistered");
@@ -25,13 +26,6 @@ export function getSyncLockAdmissions() {
     }
     return globalWithState[SYNC_ADMISSIONS_KEY];
 }
-export function syncLockTimeout(lockPath, normalizedTargetPath) {
-    return Object.assign(new Error(`file lock timeout for ${normalizedTargetPath}`), {
-        code: "file_lock_timeout",
-        lockPath,
-        normalizedTargetPath,
-    });
-}
 export function defaultSyncShouldReclaim(snapshot, staleMs, nowMs) {
     const createdAtMs = sidecarLockPayloadCreatedAtMs(snapshot.payload);
     if (createdAtMs !== null)
@@ -50,44 +44,11 @@ export function syncReclaimGuardExists(reclaimGuardPath) {
     }
 }
 export function ensureSyncLockExitCleanupRegistered(cleanup, lockPath, normalizedTargetPath) {
-    const globalWithCleanup = globalThis;
-    if (globalWithCleanup[SYNC_CLEANUP_REGISTERED_KEY])
-        return;
-    if (globalWithCleanup[SYNC_CLEANUP_REGISTRATION_KEY]) {
-        // process.on() emits newListener synchronously. A nested synchronous
-        // acquisition cannot wait for this stack to finish registering.
-        throw syncLockTimeout(lockPath, normalizedTargetPath);
-    }
-    const registration = {};
-    globalWithCleanup[SYNC_CLEANUP_REGISTRATION_KEY] = registration;
-    try {
-        process.on("exit", cleanup);
-        globalWithCleanup[SYNC_CLEANUP_HANDLER_KEY] = cleanup;
-        globalWithCleanup[SYNC_CLEANUP_REGISTERED_KEY] = true;
-    }
-    catch (error) {
-        if (process.listeners("exit").includes(cleanup)) {
-            try {
-                process.off("exit", cleanup);
-            }
-            catch {
-                // Reconcile the marker with the actual listener below.
-            }
-        }
-        if (process.listeners("exit").includes(cleanup)) {
-            globalWithCleanup[SYNC_CLEANUP_HANDLER_KEY] = cleanup;
-            globalWithCleanup[SYNC_CLEANUP_REGISTERED_KEY] = true;
-        }
-        else {
-            if (globalWithCleanup[SYNC_CLEANUP_HANDLER_KEY] === cleanup) {
-                delete globalWithCleanup[SYNC_CLEANUP_HANDLER_KEY];
-            }
-        }
-        throw error;
-    }
-    finally {
-        if (globalWithCleanup[SYNC_CLEANUP_REGISTRATION_KEY] === registration) {
-            delete globalWithCleanup[SYNC_CLEANUP_REGISTRATION_KEY];
-        }
-    }
+    ensureSidecarLockCleanupRegistered({
+        event: "exit",
+        registered: SYNC_CLEANUP_REGISTERED_KEY,
+        registering: SYNC_CLEANUP_REGISTRATION_KEY,
+        handler: SYNC_CLEANUP_HANDLER_KEY,
+        reentryError: () => sidecarLockTimeout(lockPath, normalizedTargetPath),
+    }, cleanup, true);
 }

package/dist/file-lock-sync-root-acquire.d.ts

@@ -1,4 +1,3 @@
 import type { FileLockSyncAcquireOptions, FileLockSyncHandle } from "./file-lock-sync.js";
 import type { Root } from "./root-impl.js";
 export declare function acquireFileLockSyncWithRoot<TPayload extends Record<string, unknown>>(targetPath: string, inputOptions: FileLockSyncAcquireOptions<TPayload>, lockRoot: Root): FileLockSyncHandle;
-//# sourceMappingURL=file-lock-sync-root-acquire.d.ts.map