@hydranium/client-theia 1.0.0-next.123 → 1.0.0-next.127

package/src/browser/editor-disk-sync.ts

@@ -0,0 +1,236 @@
+/********************************************************************************
+ * 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 { SystemClock, TIMED_OUT } from '@hydranium/protocol';
+import type { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import { ILogger } from '@theia/core/lib/common/logger';
+import URI from '@theia/core/lib/common/uri';
+import { inject, injectable, optional } from '@theia/core/shared/inversify';
+import { EditorManager } from '@theia/editor/lib/browser/editor-manager';
+import type { EditorWidget } from '@theia/editor/lib/browser/editor-widget';
+import type { FileResourceVersion } from '@theia/filesystem/lib/browser/file-resource';
+import { FileService, type TextFileContent } from '@theia/filesystem/lib/browser/file-service';
+import { Clock } from '../common/clock';
+
+/**
+ * The members of Theia's Monaco editor model {@link EditorDiskSync} reads and
+ * resets. `contentChanges`, `resourceVersion` and `run` are `protected` there,
+ * so {@link isResyncableEditorDocument} checks for them at runtime: a Theia
+ * that renames them yields a document it refuses, and the sync then leaves it
+ * alone.
+ */
+export interface ResyncableEditorDocument {
+   readonly uri: string;
+   readonly dirty: boolean;
+   getText(): string;
+   revert(options: { soft: boolean }): Promise<void>;
+   /** The edits the next save applies to the file, in place of the whole text. */
+   readonly contentChanges: unknown[];
+   /** The file version the next save expects to find on disk. */
+   resourceVersion: FileResourceVersion | undefined;
+   /** Queue `operation` behind the model's saves and syncs in progress. */
+   run(operation: () => Promise<void>): Promise<void>;
+   /** Awaited by each save before it takes the pending edits. */
+   onModelWillSaveModel(listener: () => Promise<void>): { dispose(): void };
+}
+
+/** Whether `document` carries the members of {@link ResyncableEditorDocument}. */
+export function isResyncableEditorDocument(document: object): document is ResyncableEditorDocument {
+   return (
+      'uri' in document &&
+      typeof document.uri === 'string' &&
+      'dirty' in document &&
+      'getText' in document &&
+      typeof document.getText === 'function' &&
+      'revert' in document &&
+      typeof document.revert === 'function' &&
+      'contentChanges' in document &&
+      Array.isArray(document.contentChanges) &&
+      'resourceVersion' in document &&
+      'run' in document &&
+      typeof document.run === 'function' &&
+      'onModelWillSaveModel' in document &&
+      typeof document.onModelWillSaveModel === 'function'
+   );
+}
+
+/**
+ * Keeps a dirty editor's save from applying edits its file already holds, as
+ * the file does once the server saves a document the editor shows unsaved.
+ *
+ * Theia keeps such an editor dirty, and its next save corrupts the file: the
+ * save applies the editor's pending edits to the file rather than writing the
+ * whole text, and the file already holds them, so each is applied twice.
+ * Theia's check that the file has not changed since the editor read it passes
+ * whenever the new file has the old one's size, so no conflict is reported. A
+ * revert alone keeps the pending edits.
+ *
+ * Before each save of the editor it reads the file. When the file holds the
+ * text the buffer held as the save began, it drops the edits pending then and
+ * has the save expect the file's version, so the save writes only the edits
+ * made after that point, a save participant's included, onto the file as it
+ * is. The save is not cancelled: it completes and is reported as saved. Save
+ * All relies on this check, since it saves a diagram and then an editor on the
+ * same file at once, before the file watcher has reported the diagram's write.
+ * The buffer is taken when the save calls its will-save listeners. Theia runs
+ * its save participants one after another, each behind an await, and its
+ * first one awaits before it edits, so none has changed the buffer by then. A
+ * participant ordered ahead of it that edits before its first await makes the
+ * file and the taken text differ, and the save applies every edit again.
+ *
+ * On each change the file watcher reports, it marks the editor clean when the
+ * file holds exactly its buffer. The file is compared with the buffer after
+ * it has been read, and the editor is marked in the same step, so a keystroke
+ * made while the file was read leaves the editor dirty. This sync waits behind
+ * a save in flight: that save drops the edits it sent from the pending ones
+ * when it finishes, and a sync before then would have it drop the edits typed
+ * meanwhile.
+ *
+ * An editor whose file holds neither text is left to Theia's own save,
+ * same-size gap included, and so is one whose file cannot be read within
+ * {@link readTimeoutMs}, or whose check throws.
+ *
+ * The adopter binds it as a `FrontendApplicationContribution`.
+ */
+@injectable()
+export class EditorDiskSync implements FrontendApplicationContribution {
+   @inject(FileService) protected readonly fileService!: FileService;
+   @inject(EditorManager) protected readonly editorManager!: EditorManager;
+   @inject(ILogger) protected readonly logger!: ILogger;
+   /** Times {@link readTimeoutMs}: the container's {@link Clock}, or a `SystemClock`. */
+   @inject(Clock) @optional() protected readonly clock: Clock = new SystemClock();
+   /** Whether an editor's document has failed {@link isResyncableEditorDocument}; warned of once. */
+   protected warnedUnsyncable = false;
+   /**
+    * How long a check waits for the file. The editor's save, and every later
+    * save and sync of that editor, waits for the check.
+    */
+   protected readTimeoutMs = 1_000;
+
+   onStart(): void {
+      this.fileService.onDidFilesChange(event => {
+         for (const change of event.changes) {
+            this.checkFile(change.resource);
+         }
+      });
+      this.editorManager.onCreated(widget => this.guardSaves(widget));
+      for (const widget of this.editorManager.all) {
+         this.guardSaves(widget);
+      }
+   }
+
+   /** Check `widget`'s document before each of its saves, for as long as the widget lives. */
+   protected guardSaves(widget: EditorWidget): void {
+      const document = this.resyncable(widget.editor.document);
+      if (document) {
+         const registration = document.onModelWillSaveModel(() => this.isolate(() => this.dropChangesOnDisk(document)));
+         widget.onDidDispose(() => registration.dispose());
+      }
+   }
+
+   /** Check each dirty document an editor shows on `uri`, behind that document's save in flight. */
+   protected checkFile(uri: URI): void {
+      for (const document of this.dirtyDocuments(uri)) {
+         void document.run(() => this.isolate(() => this.syncIfOnDisk(document)));
+      }
+   }
+
+   /** Read the file of `document` if it is dirty, and sync it if the file holds its buffer. */
+   protected async syncIfOnDisk(document: ResyncableEditorDocument): Promise<void> {
+      if (!document.dirty) {
+         return;
+      }
+      const content = await this.readFile(document);
+      if (content && document.getText() === content.value) {
+         this.syncFromDisk(document, { etag: content.etag, mtime: content.mtime, encoding: content.encoding });
+      }
+   }
+
+   /**
+    * Before a save of `document`, drop the edits pending now if its file holds
+    * the buffer as it is now, and take the file's version. The buffer and the
+    * count are taken before the first await, while the save is still calling
+    * its will-save listeners; an edit made after that stays pending, and the
+    * save writes it onto the file.
+    */
+   protected async dropChangesOnDisk(document: ResyncableEditorDocument): Promise<void> {
+      if (!document.dirty) {
+         return;
+      }
+      const text = document.getText();
+      const pending = document.contentChanges.length;
+      const content = await this.readFile(document);
+      if (content?.value === text) {
+         document.contentChanges.splice(0, pending);
+         document.resourceVersion = { etag: content.etag, mtime: content.mtime, encoding: content.encoding };
+      }
+   }
+
+   /**
+    * The file of `document`, or `undefined` when it is gone, cannot be read, or
+    * is not read within {@link readTimeoutMs}.
+    */
+   protected async readFile(document: ResyncableEditorDocument): Promise<TextFileContent | undefined> {
+      const read = this.fileService.read(new URI(document.uri)).catch(() => undefined);
+      const content = await this.clock.raceTimer(read, this.readTimeoutMs);
+      return content === TIMED_OUT ? undefined : content;
+   }
+
+   /**
+    * Run `check`, and log its failure rather than pass it on. A will-save
+    * listener that rejects makes Theia drop the save without writing, and a
+    * sync that rejects goes unhandled.
+    */
+   protected async isolate(check: () => Promise<void>): Promise<void> {
+      try {
+         await check();
+      } catch (err: unknown) {
+         void this.logger.error('EditorDiskSync: checking an editor against its file failed; the editor is left as it is.', err);
+      }
+   }
+
+   /** The dirty documents open in an editor on `uri`, each once however many editors show it. */
+   protected dirtyDocuments(uri: URI): ResyncableEditorDocument[] {
+      const target = uri.toString();
+      const documents = new Set<ResyncableEditorDocument>();
+      for (const widget of this.editorManager.all) {
+         const document = this.resyncable(widget.editor.document);
+         if (document && document.uri === target && document.dirty) {
+            documents.add(document);
+         }
+      }
+      return [...documents];
+   }
+
+   /** `document` if it carries the members the sync resets; otherwise `undefined`, warned of once. */
+   protected resyncable(document: object): ResyncableEditorDocument | undefined {
+      if (isResyncableEditorDocument(document)) {
+         return document;
+      }
+      if (!this.warnedUnsyncable) {
+         this.warnedUnsyncable = true;
+         void this.logger.warn(
+            'EditorDiskSync: an editor document lacks the Monaco model members the sync resets, so such editors are not synced with their files.'
+         );
+      }
+      return undefined;
+   }
+
+   /**
+    * Take `version` as the file `document` was last saved to, with nothing
+    * pending, and mark it clean. Synchronous throughout: a soft revert only
+    * marks the document clean, and reads nothing. The revert also cancels a
+    * save queued behind the sync, which would have written the same text.
+    */
+   protected syncFromDisk(document: ResyncableEditorDocument, version: FileResourceVersion): void {
+      document.contentChanges.splice(0, document.contentChanges.length);
+      document.resourceVersion = version;
+      void document.revert({ soft: true });
+   }
+}

package/src/browser/hydranium-file-service.ts

@@ -0,0 +1,56 @@
+/********************************************************************************
+ * 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 URI from '@theia/core/lib/common/uri';
+import { injectable } from '@theia/core/shared/inversify';
+import { FileService, type UpdateTextFileOptions } from '@theia/filesystem/lib/browser/file-service';
+import { ETAG_DISABLED } from '@theia/filesystem/lib/common/files';
+
+/**
+ * Theia's `FileService`, refusing an incremental save once the file has
+ * changed since the editor read it.
+ *
+ * Theia's own check, which `write` and `update` share, passes a file whose
+ * mtime moved on when its size still matches the etag the editor read. That
+ * is safe for `write`, which replaces the file with the whole text, but
+ * `update` applies the editor's pending edits to the file as it is, so after a
+ * same-size change, the server saving those very edits included, it applies
+ * them a second time. Here `update` hands that check the etag with a `!`
+ * appended, which no file's etag can match: Theia writes an etag as the mtime
+ * in base 29 followed by the size in base 31, digits and lower-case letters
+ * only. An advanced mtime is then enough for Theia to refuse with its
+ * `FILE_MODIFIED_SINCE`. The editor's save then falls back to `write` with the
+ * whole text, which Theia checks as before: it writes when the size is
+ * unchanged, and asks the user otherwise. A same-size change by another
+ * process is therefore overwritten by that write rather than merged with the
+ * editor's edits. `write` is left as it is.
+ *
+ * It is the safety net behind `EditorDiskSync`, which acts only when the
+ * file holds the editor's buffer: a file holding some of the edits, as when a
+ * save participant ordered ahead of Theia's first one edits before its first
+ * await, is left to this check.
+ *
+ * A write within the file system's mtime resolution of the read goes unseen,
+ * as it does for Theia's own check. A file whose mtime moves while its text
+ * stays the same costs a whole-text write rather than the edits.
+ *
+ * The adopter binds it with `rebind(FileService).to(HydraniumFileService).inSingletonScope()`.
+ */
+@injectable()
+export class HydraniumFileService extends FileService {
+   override update(
+      resource: URI,
+      changes: Parameters<FileService['update']>[1],
+      options: UpdateTextFileOptions
+   ): ReturnType<FileService['update']> {
+      const strict =
+         typeof options.etag === 'string' && options.etag !== ETAG_DISABLED ? { ...options, etag: `${options.etag}!` } : options;
+      return super.update(resource, changes, strict);
+   }
+}

package/src/browser/index.ts

@@ -14,3 +14,5 @@ export * from './browser-capture';
 export * from './memory-diagnostics-contribution';
 export * from './session-aware-connection-source';
 export * from './connection-diagnostics-contribution';
+export * from './editor-disk-sync';
+export * from './hydranium-file-service';

package/src/common/clock.ts

@@ -0,0 +1,20 @@
+/********************************************************************************
+ * 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 { Clock as ProtocolClock } from '@hydranium/protocol';
+
+/**
+ * The protocol's `Clock`, as a Theia container binds it: type and injection
+ * token under one identifier, as Theia declares its own. The framework's
+ * frontend and backend classes that time or bound something inject it as
+ * optional, and use a `SystemClock` when the container binds none, so a
+ * container can supply another clock.
+ */
+export type Clock = ProtocolClock;
+export const Clock = Symbol('Clock');

package/src/common/index.ts

@@ -7,8 +7,9 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 
-// Environment-neutral connection primitives, shared by the browser connection
-// source and the server connection service. Kept out of both tier barrels
-// because each side binds the same buffer for its own half of the socket.
+// Environment-neutral primitives that the browser and the server tiers each
+// bind for their own side, such as the buffer for each half of the socket.
+// Kept out of both tier barrels for that reason.
 export * from './framed-socket-write-buffer';
 export * from './connection-resilience-options';
+export * from './clock';

package/src/node/abstract-socket-forwarding-connection-handler.ts

@@ -7,6 +7,7 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 
+import { SystemClock } from '@hydranium/protocol';
 import {
    type Channel,
    CommandService,
@@ -18,8 +19,10 @@ import {
 } from '@theia/core';
 import { ForwardingChannel } from '@theia/core/lib/common/message-rpc/channel';
 import { Deferred } from '@theia/core/lib/common/promise-util';
-import { inject, injectable } from '@theia/core/shared/inversify';
+import { inject, injectable, optional } from '@theia/core/shared/inversify';
 import * as net from 'node:net';
+import { Clock } from '../common/clock';
+import { SocketChannelForwarder } from './socket-channel-forwarder';
 
 /** Resolved configuration for a {@link AbstractSocketForwardingConnectionHandler}.
  *  A head-specific subclass derives these from its own (adopter-facing) options
@@ -61,12 +64,10 @@ export interface SocketForwardingConnectionHandlerOptions {
  * the same wire protocol the server speaks, so the backend performs no semantic
  * re-proxy — it relays bytes only and stays oblivious to the server's method set.
  *
- * The single per-head variation — *which* byte forwarder bridges the channel and
- * the socket — is the abstract {@link forwardToSocketConnection} hook: the GLSP
- * head plugs in `@eclipse-glsp/theia-integration`'s `SocketConnectionForwarder`,
- * the data-server head its own `SocketChannelForwarder`. Keeping the forwarder
- * behind the hook is what lets the data head stay GLSP-free while sharing the
- * port-discovery + buffer-and-replay race fix + connect orchestration here.
+ * The byte forwarder that bridges the channel and the socket is
+ * {@link forwardToSocketConnection}; both heads use {@link SocketChannelForwarder},
+ * and the port discovery, buffer-and-replay race fix and connect orchestration
+ * here are shared.
  */
 @injectable()
 export abstract class AbstractSocketForwardingConnectionHandler implements ConnectionHandler {
@@ -76,6 +77,8 @@ export abstract class AbstractSocketForwardingConnectionHandler implements Conne
    // not the spawned language-server process, so the framework `LspLogger`
    // (which needs the Langium connection/services) is out of reach here.
    @inject(ILogger) protected readonly logger!: ILogger;
+   /** The clock each {@link SocketChannelForwarder} bounds its flush on: the container's {@link Clock}, or a `SystemClock`. */
+   @inject(Clock) @optional() protected readonly clock: Clock = new SystemClock();
 
    readonly path: string;
 
@@ -190,7 +193,9 @@ export abstract class AbstractSocketForwardingConnectionHandler implements Conne
     * relay both ways. Called once, after the socket is created and the
     * pre-forward buffer is about to be replayed.
     */
-   protected abstract forwardToSocketConnection(clientChannel: Channel, socket: net.Socket): Disposable;
+   protected forwardToSocketConnection(clientChannel: Channel, socket: net.Socket): Disposable {
+      return new SocketChannelForwarder(clientChannel, socket, this.clock);
+   }
 
    /**
     * Re-fire pre-forward buffered `MessageProvider`s on the channel's internal

package/src/node/index.ts

@@ -9,3 +9,4 @@
 
 export * from './abstract-socket-forwarding-connection-handler';
 export * from './session-bound-frontend-connection-service';
+export * from './socket-channel-forwarder';

package/src/node/socket-channel-forwarder.ts

@@ -0,0 +1,99 @@
+/********************************************************************************
+ * 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 Clock, SystemClock } from '@hydranium/protocol';
+import { type Channel, Disposable, DisposableCollection, type MessageProvider } from '@theia/core';
+import type * as net from 'node:net';
+import {
+   createMessageConnection,
+   type Message,
+   type MessageConnection,
+   SocketMessageReader,
+   SocketMessageWriter
+} from 'vscode-jsonrpc/node';
+
+/**
+ * Relays JSON-RPC messages between a Theia browser-frontend {@link Channel} and
+ * a server's TCP socket — the backend half of a head's transport. The server
+ * speaks vscode-jsonrpc (Content-Length framed) on the socket; the frontend
+ * speaks the same protocol over the channel. This forwarder decodes each side
+ * and re-emits on the other.
+ *
+ * Behaves as `@eclipse-glsp/theia-integration`'s `SocketConnectionForwarder`
+ * does, and both heads use it, except that when the channel closes, the writes
+ * still queued go out before the socket ends. A page going away sends its last
+ * messages and closes its channel in the same tick, and the writer takes
+ * several turns per message, so destroying the socket on the close loses them.
+ */
+export class SocketChannelForwarder implements Disposable {
+   protected readonly toDispose = new DisposableCollection();
+   /** The last write to the socket; the writer runs its writes one at a time, so this settles last. */
+   protected lastWrite: Promise<void> = Promise.resolve();
+   /**
+    * How long {@link endSocket} waits for the queued writes before it destroys
+    * the socket anyway. Without a bound, a server that stops reading holds the
+    * socket open for good, and with it the server's end of the connection.
+    */
+   protected readonly flushTimeoutMs: number = 10_000;
+
+   constructor(
+      protected readonly channel: Channel,
+      protected readonly socket: net.Socket,
+      /** Times {@link flushTimeoutMs}. */
+      protected readonly clock: Clock = new SystemClock()
+   ) {
+      const reader = new SocketMessageReader(socket);
+      const writer = new SocketMessageWriter(socket);
+      const connection = createMessageConnection(reader, writer);
+      // Nothing here destroys the socket directly. `SocketMessageWriter.dispose()`
+      // destroys it itself, which covers both `dispose` and `endSocket`; and
+      // `connection.onClose` fires only from the reader's or writer's own close,
+      // which for a socket means the socket has already gone — so a destroy
+      // handler there is downstream of the effect it would be trying to cause.
+      this.toDispose.pushAll([
+         reader.listen(message => this.writeToChannel(message)),
+         channel.onMessage(provider => {
+            // A failed write means the socket is gone, which its own close reports.
+            this.lastWrite = writer.write(this.decodeChannelMessage(provider)).catch(() => undefined);
+         }),
+         channel.onClose(() => void this.endSocket(connection)),
+         connection.onClose(() => channel.close()),
+         Disposable.create(() => {
+            channel.close();
+            connection.dispose();
+         })
+      ]);
+   }
+
+   /**
+    * Dispose `connection`, which destroys the socket, once the writes queued
+    * before the channel closed are out, or {@link flushTimeoutMs} has passed. A
+    * write has settled once the socket handed its bytes to the OS, and
+    * destroying the socket then loses nothing.
+    */
+   protected async endSocket(connection: MessageConnection): Promise<void> {
+      await this.clock.raceTimer(this.lastWrite, this.flushTimeoutMs);
+      connection.dispose();
+   }
+
+   protected decodeChannelMessage(provider: MessageProvider): Message {
+      const buffer = provider().readBytes();
+      return JSON.parse(new TextDecoder().decode(buffer)) as Message;
+   }
+
+   protected writeToChannel(message: Message): void {
+      const writeBuffer = this.channel.getWriteBuffer();
+      writeBuffer.writeBytes(new TextEncoder().encode(JSON.stringify(message)));
+      writeBuffer.commit();
+   }
+
+   dispose(): void {
+      this.toDispose.dispose();
+   }
+}