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

package/lib/browser/indexeddb-file-system-store.js

@@ -0,0 +1,181 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+/** Out-of-line keys, so a key is the store path and the value is the content. */
+const OBJECT_STORE_NAME = 'files';
+/**
+ * The schema version. A bump needs a migration in `onupgradeneeded`, or every
+ * returning visitor's rows are left in a store the new code never reads.
+ */
+const DATABASE_VERSION = 1;
+/**
+ * A {@link FileSystemStore} in `IndexedDB`, so an edit survives a reload.
+ *
+ * # Why IndexedDB and not OPFS
+ *
+ * OPFS is the tempting answer, because `createSyncAccessHandle` gives
+ * SYNCHRONOUS file reads in a worker, which is what Langium's
+ * `FileSystemProvider` needs. It buys nothing here: directory enumeration
+ * (`FileSystemDirectoryHandle.entries()`) is async-only, so a directory index
+ * still has to live in memory, and once it does the file reads are being served
+ * from memory too. IndexedDB is the smaller dependency for the same shape.
+ *
+ * # It holds the DELTA, not the workspace
+ *
+ * Only what has been written lands here, and `PersistentFileSystemProvider` lays
+ * it over the host's seed. So a fixture edited in the host's bundle still
+ * reaches a returning visitor, and this database stays a few kilobytes rather
+ * than a copy of the workspace.
+ *
+ * # A failure is loud, deliberately
+ *
+ * Nothing here degrades to non-persistent operation. A refused open, a blocked
+ * upgrade or an aborted transaction, which is what a quota overrun looks like,
+ * rejects the call, which fails the worker's bootstrap or the save that asked.
+ * The alternative, carrying on without a store, would report a saved workspace
+ * and lose it on the next load. An origin EVICTED between visits is not a
+ * failure this class can see: its database opens empty, which is a first visit,
+ * and the provider is correct in that state. Evicted mid-session, the next
+ * transaction rejects like any other failure.
+ *
+ * # The database is origin-scoped
+ *
+ * Every page on the origin shares a database of the same name, and the user
+ * agent may evict it. The name is the one per-app value and is REQUIRED for
+ * that reason: a default would let two apps on one origin overwrite each
+ * other's edits with nothing reporting it.
+ */
+export class IndexedDbFileSystemStore {
+    databaseName;
+    /**
+     * Opened once and shared, and NOT kept when it fails: a refused or blocked
+     * open rejects the call that needed it and the next call opens again, so a
+     * cause that has cleared, such as the other tab closing, does not fail every
+     * later save with the first error.
+     */
+    connection;
+    constructor(databaseName) {
+        this.databaseName = databaseName;
+    }
+    async load() {
+        const database = await this.open();
+        return new Promise((resolve, reject) => {
+            const transaction = database.transaction(OBJECT_STORE_NAME, 'readonly');
+            const files = transaction.objectStore(OBJECT_STORE_NAME);
+            const keyRequest = files.getAllKeys();
+            const valueRequest = files.getAll();
+            // Resolved on the TRANSACTION rather than on either request, which is
+            // what guarantees both have landed, and `getAllKeys` and `getAll`
+            // enumerate in the same key order, so they zip.
+            transaction.oncomplete = () => {
+                const keys = keyRequest.result;
+                const values = valueRequest.result;
+                const seed = {};
+                keys.forEach((key, index) => {
+                    const value = values[index];
+                    // Guarded rather than cast: this database outlives the code that
+                    // wrote it, so a row from an older shape must be skipped instead
+                    // of reaching the filesystem as non-string content.
+                    if (typeof key === 'string' && typeof value === 'string') {
+                        seed[key] = value;
+                    }
+                });
+                resolve(seed);
+            };
+            transaction.onabort = () => reject(this.failure(transaction, 'read the stored workspace'));
+        });
+    }
+    async write(path, content) {
+        await this.mutate('store', files => files.put(content, path));
+    }
+    async remove(path) {
+        await this.mutate('drop', files => files.delete(path));
+    }
+    /**
+     * Drop everything, returning the next load to the seed.
+     *
+     * The escape hatch a persistent host needs and a seeded one does not: a saved
+     * document that no longer parses is otherwise restored on every load, and
+     * clearing site data is the only other way out. Not on {@link FileSystemStore},
+     * which the provider never clears.
+     */
+    async clear() {
+        await this.mutate('clear', files => files.clear());
+    }
+    /**
+     * Run one write transaction and settle on its COMPLETION.
+     *
+     * Not on the request's `success`: a request can succeed inside a transaction
+     * that then aborts, which is exactly what a quota overrun looks like, so
+     * resolving early would report a save the database never kept.
+     */
+    async mutate(operation, act) {
+        const database = await this.open();
+        return new Promise((resolve, reject) => {
+            const transaction = database.transaction(OBJECT_STORE_NAME, 'readwrite');
+            transaction.oncomplete = () => resolve();
+            transaction.onabort = () => reject(this.failure(transaction, operation));
+            act(transaction.objectStore(OBJECT_STORE_NAME));
+        });
+    }
+    open() {
+        this.connection ??= this.openDatabase().catch((error) => {
+            this.connection = undefined;
+            throw error;
+        });
+        return this.connection;
+    }
+    openDatabase() {
+        return new Promise((resolve, reject) => {
+            const request = indexedDB.open(this.databaseName, DATABASE_VERSION);
+            let blocked = false;
+            request.onupgradeneeded = () => {
+                // Runs on a first visit and on a version bump. `createObjectStore`
+                // throws if it already exists, so the guard is not defensive: a page
+                // opened twice with the store created once gets here only when the
+                // version moved.
+                if (!request.result.objectStoreNames.contains(OBJECT_STORE_NAME)) {
+                    request.result.createObjectStore(OBJECT_STORE_NAME);
+                }
+            };
+            request.onsuccess = () => {
+                const database = request.result;
+                if (blocked) {
+                    // Went through once the other tab closed, after this call had
+                    // rejected. Nobody holds it, so it is closed rather than left
+                    // open to block the NEXT upgrade.
+                    database.close();
+                    return;
+                }
+                // A newer version opening in another tab asks this one to let go,
+                // and holding on would block that upgrade for as long as this tab
+                // lives. Dropped, so every later call here rejects, which is loud.
+                database.onversionchange = () => {
+                    database.close();
+                    this.connection = undefined;
+                };
+                resolve(database);
+            };
+            request.onerror = () => reject(request.error ?? new Error(`Cannot open ${this.databaseName}`));
+            // A tab at an older version that lacks the close above holds the
+            // upgrade indefinitely. Reported rather than waited on: the host can say
+            // so, where a hung open looks like a worker that never started.
+            request.onblocked = () => {
+                blocked = true;
+                reject(new Error(`${this.databaseName} is open in another tab at an older version`));
+            };
+        });
+    }
+    failure(transaction, operation) {
+        // `transaction.error` names the real cause (`QuotaExceededError` above
+        // all); an abort with no error is a caller-side abort, which nothing here
+        // does.
+        return transaction.error ?? new Error(`Failed to ${operation} in ${this.databaseName}`);
+    }
+}
+//# sourceMappingURL=indexeddb-file-system-store.js.map

package/lib/browser/indexeddb-file-system-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexeddb-file-system-store.js","sourceRoot":"","sources":["../../src/browser/indexeddb-file-system-store.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAKlF,iFAAiF;AACjF,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAElC;;;GAGG;AACH,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,OAAO,wBAAwB;IASH,YAAY;IAR3C;;;;;OAKG;IACO,UAAU,CAAwB;IAE5C,YAA+B,YAAoB;4BAApB,YAAY;IAAW,CAAC;IAEvD,KAAK,CAAC,IAAI;QACP,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;YACxE,MAAM,KAAK,GAAG,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;YACzD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;YACtC,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YACpC,sEAAsE;YACtE,kEAAkE;YAClE,gDAAgD;YAChD,WAAW,CAAC,UAAU,GAAG,GAAG,EAAE;gBAC3B,MAAM,IAAI,GAAkB,UAAU,CAAC,MAAM,CAAC;gBAC9C,MAAM,MAAM,GAAc,YAAY,CAAC,MAAM,CAAC;gBAC9C,MAAM,IAAI,GAA2B,EAAE,CAAC;gBACxC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;oBACzB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC5B,iEAAiE;oBACjE,iEAAiE;oBACjE,oDAAoD;oBACpD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBACxD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;oBACrB,CAAC;gBACJ,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC,CAAC;YACF,WAAW,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAC,CAAC;IACN,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAAe;QACtC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,IAAY;QACtB,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAK;QACR,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;OAMG;IACO,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,GAAoC;QAC3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;YACzE,WAAW,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;YACzC,WAAW,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;YACzE,GAAG,CAAC,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACN,CAAC;IAES,IAAI;QACX,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,YAAY,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;YAC9D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,MAAM,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,UAAU,CAAC;IAC1B,CAAC;IAES,YAAY;QACnB,OAAO,IAAI,OAAO,CAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;YACpE,IAAI,OAAO,GAAG,KAAK,CAAC;YACpB,OAAO,CAAC,eAAe,GAAG,GAAG,EAAE;gBAC5B,mEAAmE;gBACnE,qEAAqE;gBACrE,mEAAmE;gBACnE,iBAAiB;gBACjB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBAChE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;gBACvD,CAAC;YACJ,CAAC,CAAC;YACF,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE;gBACtB,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;gBAChC,IAAI,OAAO,EAAE,CAAC;oBACX,8DAA8D;oBAC9D,8DAA8D;oBAC9D,kCAAkC;oBAClC,QAAQ,CAAC,KAAK,EAAE,CAAC;oBACjB,OAAO;gBACV,CAAC;gBACD,kEAAkE;gBAClE,kEAAkE;gBAClE,mEAAmE;gBACnE,QAAQ,CAAC,eAAe,GAAG,GAAG,EAAE;oBAC7B,QAAQ,CAAC,KAAK,EAAE,CAAC;oBACjB,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;gBAC/B,CAAC,CAAC;gBACF,OAAO,CAAC,QAAQ,CAAC,CAAC;YACrB,CAAC,CAAC;YACF,OAAO,CAAC,OAAO,GAAG,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,eAAe,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;YAC/F,iEAAiE;YACjE,yEAAyE;YACzE,gEAAgE;YAChE,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE;gBACtB,OAAO,GAAG,IAAI,CAAC;gBACf,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,6CAA6C,CAAC,CAAC,CAAC;YACxF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACN,CAAC;IAES,OAAO,CAAC,WAA2B,EAAE,SAAiB;QAC7D,uEAAuE;QACvE,0EAA0E;QAC1E,QAAQ;QACR,OAAO,WAAW,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,aAAa,SAAS,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAC3F,CAAC;CACH"}

package/lib/browser/start-language-server-in-worker.d.ts

@@ -0,0 +1,32 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+import { type LatencyCollector, type TransferredMessagePort } from '@hydranium/protocol';
+import { type Connection } from 'vscode-languageserver/browser';
+import type { ServerSharedServices } from '../langium/module.js';
+export interface WorkerLanguageServerOptions {
+    /** Records every request the head answers. One collector serves every head, so a report covers them all. */
+    readonly latency?: LatencyCollector;
+}
+/**
+ * Start the LSP head on the port the page transferred for it, and return the
+ * shared tier `compose` built around its connection.
+ *
+ * `compose` is the adopter's services factory, called with the connection
+ * exactly as a Node entry calls it with a stdio one; the filesystem it spreads
+ * in must already be restored, since every read the head makes is synchronous
+ * and the transport drops a message that arrives before `startLanguageServer`
+ * listens. The page's end of the port closing ends only this head's
+ * connection, not the worker the other heads share, so the language client's
+ * documents are closed here, each reverting as its last close does.
+ *
+ * The worker holds the files, so the page cannot write them and `didSave`
+ * reports nothing: the head answers and advertises `SaveTextDocumentRequest`.
+ */
+export declare function startLanguageServerInWorker<TShared extends ServerSharedServices>(port: TransferredMessagePort, compose: (connection: Connection) => TShared, options?: WorkerLanguageServerOptions): TShared;
+//# sourceMappingURL=start-language-server-in-worker.d.ts.map

package/lib/browser/start-language-server-in-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-language-server-in-worker.d.ts","sourceRoot":"","sources":["../../src/browser/start-language-server-in-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAA8B,KAAK,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AACrH,OAAO,EAAsC,KAAK,UAAU,EAAE,MAAM,+BAA+B,CAAC;AACpG,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAMjE,MAAM,WAAW,2BAA2B;IACzC,4GAA4G;IAC5G,QAAQ,CAAC,OAAO,CAAC,EAAE,gBAAgB,CAAC;CACtC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,SAAS,oBAAoB,EAC7E,IAAI,EAAE,sBAAsB,EAC5B,OAAO,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,OAAO,EAC5C,OAAO,GAAE,2BAAgC,GACzC,OAAO,CAcT"}

package/lib/browser/start-language-server-in-worker.js

@@ -0,0 +1,40 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+import { createMessagePortTransport } from '@hydranium/protocol';
+import { createConnection, ProposedFeatures } from 'vscode-languageserver/browser';
+import { withHydraniumLspFeatures } from '../lsp/connection-features.js';
+import { lspLatencyOptions } from '../lsp/lsp-latency.js';
+import { listenToSaveTextDocument, withSaveTextDocumentCapability } from '../lsp/save-text-document.js';
+import { startLanguageServer } from '../lsp/start-language-server.js';
+/**
+ * Start the LSP head on the port the page transferred for it, and return the
+ * shared tier `compose` built around its connection.
+ *
+ * `compose` is the adopter's services factory, called with the connection
+ * exactly as a Node entry calls it with a stdio one; the filesystem it spreads
+ * in must already be restored, since every read the head makes is synchronous
+ * and the transport drops a message that arrives before `startLanguageServer`
+ * listens. The page's end of the port closing ends only this head's
+ * connection, not the worker the other heads share, so the language client's
+ * documents are closed here, each reverting as its last close does.
+ *
+ * The worker holds the files, so the page cannot write them and `didSave`
+ * reports nothing: the head answers and advertises `SaveTextDocumentRequest`.
+ */
+export function startLanguageServerInWorker(port, compose, options = {}) {
+    // Both ends use `createMessagePortTransport`; see it for why.
+    const transport = createMessagePortTransport(port);
+    const connection = createConnection(withSaveTextDocumentCapability(withHydraniumLspFeatures(ProposedFeatures.all)), transport.reader, transport.writer, lspLatencyOptions(options.latency));
+    const shared = compose(connection);
+    listenToSaveTextDocument(connection, shared);
+    startLanguageServer(shared);
+    transport.reader.onClose(() => void shared.workspace.TextDocuments.closeLanguageClientDocuments());
+    return shared;
+}
+//# sourceMappingURL=start-language-server-in-worker.js.map

package/lib/browser/start-language-server-in-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start-language-server-in-worker.js","sourceRoot":"","sources":["../../src/browser/start-language-server-in-worker.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF,OAAO,EAAE,0BAA0B,EAAsD,MAAM,qBAAqB,CAAC;AACrH,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAmB,MAAM,+BAA+B,CAAC;AAEpG,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,8BAA8B,EAAE,MAAM,8BAA8B,CAAC;AACxG,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAOtE;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,2BAA2B,CACxC,IAA4B,EAC5B,OAA4C,EAC5C,OAAO,GAAgC,EAAE;IAEzC,8DAA8D;IAC9D,MAAM,SAAS,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,UAAU,GAAG,gBAAgB,CAChC,8BAA8B,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAC9E,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAM,EAChB,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CACpC,CAAC;IACF,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACnC,wBAAwB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC7C,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC5B,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,4BAA4B,EAAE,CAAC,CAAC;IACnG,OAAO,MAAM,CAAC;AACjB,CAAC"}