@hydranium/core 1.0.0-next.23 → 1.0.0-next.232

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

@@ -0,0 +1,49 @@
+/********************************************************************************
+ * 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>;
+}
+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>;
+}
+//# 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;CAC9D;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;CACH"}

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

@@ -0,0 +1,34 @@
+/********************************************************************************
+ * 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;
+    }
+}
+//# 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;AA8BlF,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;CACH"}