@hydranium/core 1.0.0-next.34 → 1.0.0-next.340

package/lib/documents/document-release-scheduler.js

@@ -0,0 +1,80 @@
+/********************************************************************************
+ * Copyright (c) 2026 EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+export class DefaultDocumentReleaseScheduler {
+    clock;
+    graceMs;
+    deferred = new Map();
+    /**
+     * Per document, the clients whose close of it was caused by a lost
+     * connection and that have not opened it again, each with a stopwatch
+     * started at its loss. Every such client counts, not only the last to
+     * close: one connection's sessions all end lost together, and any of them
+     * may reopen first. A stopwatch rather than a `now()` reading, because a
+     * wall-clock step would otherwise expire a claim early or revive one past
+     * its grace, against a grace timer that the step leaves alone.
+     */
+    lostClients = new Map();
+    constructor(clock, graceMs) {
+        this.clock = clock;
+        this.graceMs = graceMs;
+    }
+    recordLoss(key, clientId) {
+        let lost = this.lostClients.get(key);
+        if (!lost) {
+            lost = new Map();
+            this.lostClients.set(key, lost);
+        }
+        lost.set(clientId, this.clock.stopwatch());
+    }
+    defer(key, release) {
+        this.cancel(key);
+        if (this.graceMs <= 0) {
+            release();
+            return;
+        }
+        this.deferred.set(key, this.clock.setTimer(() => {
+            this.deferred.delete(key);
+            release();
+        }, this.graceMs));
+    }
+    isDeferred(key) {
+        return this.deferred.has(key);
+    }
+    /**
+     * A claim past its grace counts as any other client's: without the limit,
+     * a client that returns late inherits the unsaved text of a holder lost
+     * after it. Cancelling for every open instead hands a lost client's unsaved
+     * text to whoever opens next, with nothing marking it unsaved.
+     */
+    resolveOpen(key, clientId) {
+        const lost = this.lostClients.get(key);
+        for (const [lostId, sinceLoss] of lost ?? []) {
+            if (sinceLoss.elapsedMs >= this.graceMs) {
+                lost?.delete(lostId);
+            }
+        }
+        const returning = lost?.delete(clientId) ?? false;
+        if (lost?.size === 0) {
+            this.lostClients.delete(key);
+        }
+        if (!this.deferred.has(key)) {
+            return 'none';
+        }
+        this.cancel(key);
+        return returning ? 'keep' : 'release';
+    }
+    cancel(key) {
+        this.deferred.get(key)?.dispose();
+        this.deferred.delete(key);
+    }
+    clearLosses(key) {
+        this.lostClients.delete(key);
+    }
+}
+//# sourceMappingURL=document-release-scheduler.js.map

package/lib/documents/document-release-scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-release-scheduler.js","sourceRoot":"","sources":["../../src/documents/document-release-scheduler.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAmClF,MAAM,OAAO,+BAA+B;IAcnB,KAAK;IACf,OAAO;IAdA,QAAQ,GAAG,IAAI,GAAG,EAA4B,CAAC;IAClE;;;;;;;;OAQG;IACgB,WAAW,GAAG,IAAI,GAAG,EAAwC,CAAC;IAEjF,YACsB,KAAY,EACtB,OAAe;qBADL,KAAK;uBACf,OAAO;IAChB,CAAC;IAEJ,UAAU,CAAC,GAAiB,EAAE,QAAgB;QAC3C,IAAI,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,EAAE,CAAC;YACT,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;YACjB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,GAAiB,EAAE,OAAmB;QACzC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;YACrB,OAAO,EAAE,CAAC;YACV,OAAO;QACV,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CACd,GAAG,EACH,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE;YACtB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,OAAO,EAAE,CAAC;QACb,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAClB,CAAC;IACL,CAAC;IAED,UAAU,CAAC,GAAiB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,GAAiB,EAAE,QAAgB;QAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACvC,KAAK,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC;YAC5C,IAAI,SAAS,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACvC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACxB,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAClD,IAAI,IAAI,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,MAAM,CAAC;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,GAAiB;QACrB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,GAAiB;QAC1B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;CACH"}

package/lib/documents/file-system-task-queue.d.ts

@@ -0,0 +1,52 @@
+/********************************************************************************
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+import { type CanonicalUri } from '@hydranium/protocol';
+import { type ServerSharedServices } from '../langium/module.js';
+import { type DocumentUriPolicy } from '../langium/workspace/document-uri-policy.js';
+/**
+ * One queue of file-system tasks per file, shared by every server-side reader
+ * and writer of a file whose accesses must not interleave with its saves.
+ *
+ * Two writes of one file that bypass the queue can land in either order, and
+ * the older text then stays on disk. Tasks of different files run in
+ * parallel.
+ */
+export interface FileSystemTaskQueue {
+    /**
+     * Run `task` once every task already enqueued for `uri` has settled, and
+     * before any enqueued after it. `uri` is keyed by its canonical identity, so
+     * every spelling of one file shares a queue. A task that has nothing to do
+     * still resolves once the tasks before it have settled.
+     *
+     * A task must not await a build, nor a save, another task or an open of a
+     * document no client has open, all of the same file: a build's integrity
+     * repair enqueues its own write and the build waits for it, and such an
+     * open reads the file here, so a task waiting on either never resolves,
+     * which wedges the file's queue for good.
+     */
+    enqueue<T>(uri: string, task: () => Promise<T>): Promise<T>;
+    /** Whether no task of `uri` is running or waiting. */
+    isIdle(uri: string): boolean;
+}
+export declare class DefaultFileSystemTaskQueue implements FileSystemTaskQueue {
+    /**
+     * Per canonical URI, the settling of the last task enqueued for it; the next
+     * task chains behind it. An entry leaves once its file's queue is idle. Kept
+     * outside the workspace lock, whose `write` cancels the write before it: a
+     * save cancelled that way reports success for text it never wrote.
+     */
+    protected readonly queues: Map<CanonicalUri, Promise<void>>;
+    protected readonly uriPolicy: DocumentUriPolicy;
+    constructor(services: {
+        readonly workspace: Pick<ServerSharedServices['workspace'], 'DocumentUriPolicy'>;
+    });
+    enqueue<T>(uri: string, task: () => Promise<T>): Promise<T>;
+    isIdle(uri: string): boolean;
+}
+//# sourceMappingURL=file-system-task-queue.d.ts.map

package/lib/documents/file-system-task-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system-task-queue.d.ts","sourceRoot":"","sources":["../../src/documents/file-system-task-queue.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAErF;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IACjC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5D,sDAAsD;IACtD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC/B;AAED,qBAAa,0BAA2B,YAAW,mBAAmB;IACnE;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,mCAA0C;IAEnE,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC;IAEhD,YAAY,QAAQ,EAAE;QAAE,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAA;KAAE,EAEzG;IAED,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAc1D;IAED,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE3B;CACH"}

package/lib/documents/file-system-task-queue.js

@@ -0,0 +1,37 @@
+/********************************************************************************
+ * Copyright (c) 2026 CrossBreeze, EclipseSource and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the MIT License which is available in the project root.
+ *
+ * SPDX-License-Identifier: MIT
+ ********************************************************************************/
+export class DefaultFileSystemTaskQueue {
+    /**
+     * Per canonical URI, the settling of the last task enqueued for it; the next
+     * task chains behind it. An entry leaves once its file's queue is idle. Kept
+     * outside the workspace lock, whose `write` cancels the write before it: a
+     * save cancelled that way reports success for text it never wrote.
+     */
+    queues = new Map();
+    uriPolicy;
+    constructor(services) {
+        this.uriPolicy = services.workspace.DocumentUriPolicy;
+    }
+    enqueue(uri, task) {
+        const key = this.uriPolicy.canonicalUri(uri);
+        const result = (this.queues.get(key) ?? Promise.resolve()).then(task);
+        const settled = result.then(() => undefined, () => undefined);
+        this.queues.set(key, settled);
+        void settled.then(() => {
+            if (this.queues.get(key) === settled) {
+                this.queues.delete(key);
+            }
+        });
+        return result;
+    }
+    isIdle(uri) {
+        return !this.queues.has(this.uriPolicy.canonicalUri(uri));
+    }
+}
+//# sourceMappingURL=file-system-task-queue.js.map

package/lib/documents/file-system-task-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system-task-queue.js","sourceRoot":"","sources":["../../src/documents/file-system-task-queue.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAgClF,MAAM,OAAO,0BAA0B;IACpC;;;;;OAKG;IACgB,MAAM,GAAG,IAAI,GAAG,EAA+B,CAAC;IAEhD,SAAS,CAAoB;IAEhD,YAAY,QAA8F;QACvG,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,iBAAiB,CAAC;IACzD,CAAC;IAED,OAAO,CAAI,GAAW,EAAE,IAAsB;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACxB,GAAG,EAAE,CAAC,SAAS,EACf,GAAG,EAAE,CAAC,SAAS,CACjB,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9B,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;YACpB,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;gBACpC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC3B,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,GAAW;QACf,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;CACH"}