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

package/src/langium/model-service/client-session.ts

@@ -0,0 +1,718 @@
+/********************************************************************************
+ * 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 BaseVersion,
+   ConflictError,
+   isModelVersion,
+   Logger,
+   type MaybeObservableValue,
+   type MaybePromise,
+   ObservableValue,
+   type TextVersion,
+   type Tracer,
+   type TransferElement,
+   describeErrorWithStack
+} from '@hydranium/protocol';
+import { type AstNode, isOperationCancelled, UriUtils } from '@hydranium/langium';
+import { type CancellationToken, type Disposable, Emitter, type Event } from 'vscode-languageserver';
+import { type AstDocument, type SavedAstDocument } from '../../documents/ast-document-manager.js';
+import { DocumentNotOpenError, SessionClosedError } from '../../documents/client-session-errors.js';
+import { type OpenOptions, type SessionEndCause } from '../../documents/client-session-registry.js';
+import { type LogNameOptions } from '../diagnostics/logger.js';
+import { type ServerSharedServices } from '../module.js';
+import { type AstDiagnostic } from '../validation/document-validator.js';
+import { type ModelService } from './model-service.js';
+
+/** What a session's `update` and `save` write into one document; the session supplies its own client id. */
+export interface ClientSessionWriteArgs<TTransfer> {
+   uri: string;
+   /** The whole structured model root, or its serialised textual form. */
+   model: TTransfer | string;
+   /**
+    * The version the write was authored against, or `'any'` to write
+    * unconditionally. Required, so an ungated write is a decision the caller
+    * makes rather than a field it forgot.
+    */
+   baseVersion: BaseVersion;
+}
+
+/** What a session's `persist` writes: the text the store holds for `uri`. */
+export type ClientSessionPersistArgs = Omit<ClientSessionWriteArgs<never>, 'model'>;
+
+/** What a session's `delete` removes: the document at `uri`, at the version it was based on. */
+export type ClientSessionDeleteArgs = Omit<ClientSessionWriteArgs<never>, 'model'>;
+
+/** What a session's `updateAll` writes, all or none. */
+export interface ClientSessionUpdateAllArgs<TTransfer> {
+   updates: ClientSessionWriteArgs<TTransfer>[];
+}
+
+/**
+ * One participant's handle on the documents it works on, started by
+ * `ModelService.createSession`.
+ *
+ * The session writes only what it has open: `update`, `save`, `persist` and
+ * `delete` fail with `DocumentNotOpenError` unless this session has the URI
+ * open in the synchronous step that applies or takes the text, or marks the
+ * document for deletion, so a write either lands while the document is open or
+ * fails. They fail the same way while any session's `delete` of the URI is
+ * under way. A document stays open until this session closes it, the session
+ * ends, or the file is deleted.
+ *
+ * One open per URI, without reference counting: opening a URI the session
+ * already has open changes nothing, and one `close` ends it.
+ *
+ * After `dispose`, every other member throws `SessionClosedError`
+ * synchronously, before returning a promise.
+ *
+ * Reads need no session and live on `ModelService`.
+ */
+export interface ClientSession<
+   TAst extends AstNode,
+   TDiagnostic extends AstDiagnostic = AstDiagnostic,
+   TTransfer extends TransferElement = TransferElement,
+   TOpenOptions extends OpenOptions = OpenOptions
+> {
+   /** Unique in the process while the session is live: the author label on its writes and the key of its opens. */
+   readonly clientId: string;
+   readonly label: string;
+
+   /**
+    * Open `uri` for this session, reading it from disk unless some client has
+    * it open already or it holds this client's unsaved text within its release
+    * grace. `options` are kept for this open until it closes; a repeat open,
+    * concurrent or not, keeps the options of the first.
+    *
+    * Waits for the workspace to be brought up, as {@link create} does, and does
+    * not settle while nothing brings it up. So neither may be awaited from
+    * inside the bring-up, such as a workspace manager's document loading: the
+    * bring-up then waits for itself.
+    */
+   open(uri: string, options?: TOpenOptions): Promise<void>;
+   /** The options this session opened `uri` with, or `undefined` when it gave none or does not have `uri` open. */
+   openOptions(uri: string): TOpenOptions | undefined;
+   /**
+    * Create a document with `text` and open it for this session. It reaches
+    * disk on the first `save`. `text` is written as given: make it from a
+    * model with {@link ModelService.modelToText}, which gives it the ending a
+    * write would. Fails when the file exists, any client has the URI open, or
+    * the URI waits out the release grace, and of two creates of one URI at
+    * most one succeeds.
+    *
+    * Resolves with the version the created document took, which a write based
+    * on it names: once this resolves, the store's version may already be
+    * another client's write.
+    */
+   create(uri: string, text: string): Promise<TextVersion>;
+   /**
+    * Write `args.model` into a document this session has open. Resolves to the
+    * rebuilt document once it is validated, in whichever build carried the
+    * write, so the answer holds every diagnostic its update event does: that
+    * event names this session, and a client dropping its own echo would
+    * otherwise never see them.
+    */
+   update(args: ClientSessionWriteArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>>;
+   /**
+    * Write several documents this session has open, all or none: a
+    * `ConflictError` or `DocumentNotOpenError` for any of them is thrown before
+    * any text applies. Resolves to the rebuilt documents, in the order given,
+    * each validated as {@link update}'s is.
+    */
+   updateAll(args: ClientSessionUpdateAllArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>[]>;
+   /** Write `args.model` as {@link update} does, then persist the document. */
+   save(args: ClientSessionWriteArgs<TTransfer>, cancelToken?: CancellationToken): Promise<SavedAstDocument<TAst, TDiagnostic>>;
+   /**
+    * Persist the text the store holds for `args.uri` as it is, with no update
+    * and no serialisation. Resolves with the version of the text written, once
+    * it is on disk, without waiting for a build. The saved event names this
+    * session, also when another client wrote the text.
+    */
+   persist(args: ClientSessionPersistArgs): Promise<TextVersion>;
+   /**
+    * Delete `args.uri` at once: its file, then the document, as a deletion a
+    * file watcher reports removes it. Every session's open of it closes, the
+    * editor's stays, and the deletion event names this session. Resolves once
+    * the build that removes the document has run. `args.baseVersion` is gated
+    * as {@link persist} gates it; a file already gone deletes only the
+    * document, and one that cannot be removed fails the call, deleting nothing.
+    * The file removed is the one the store keys the document by: under
+    * `RealpathDocumentUriPolicy`, a symlink's target rather than the link.
+    *
+    * A change requested before that build starts, by the editor or a file
+    * watcher, keeps the document, and only this session's open of it closes.
+    * From inside a build the call fails with `ReentrantWriteLockError`,
+    * whatever `ModelServiceOptions.allowReentrantBuilds` says.
+    */
+   delete(args: ClientSessionDeleteArgs): Promise<void>;
+   /** Close this session's open of `uri`, at once. A no-op when it does not have `uri` open. */
+   close(uri: string): Promise<void>;
+   /**
+    * Open `uri`, run `fn`, and close `uri` when `fn` settles, whether it
+    * returned or threw. A URI the session already had open, or is still
+    * opening through another call, stays open: the close undoes only the open
+    * this call made.
+    */
+   withOpen<T>(uri: string, fn: () => MaybePromise<T>): Promise<T>;
+   /** Whether an event's `sourceClientId` names this session, i.e. the event echoes its own write. */
+   isOwnEcho(sourceClientId: string): boolean;
+   /**
+    * End the session: close everything it has open and free its id.
+    * Idempotent. `cause` is `'lost'` when the session ends because its
+    * client's connection went away, which lets each document it was the last
+    * to have open wait out the store's release grace; ending it for any other
+    * reason releases such a document at once.
+    */
+   dispose(cause?: SessionEndCause): void;
+   /**
+    * Fires once the session has ended, its documents closed, with the cause it
+    * ended with. A takeover through `createSession` ends it as `'lost'` from
+    * another caller, so a holder that keeps per-session state releases it here.
+    */
+   readonly onDidDispose: Event<SessionEndCause>;
+}
+
+/**
+ * The framework's {@link ClientSession}, built by
+ * {@link DefaultClientSessionFactory}.
+ *
+ * Override the protected method behind a member to change how every session
+ * writes, and return the subclass from a {@link ClientSessionFactory} bound on
+ * `model.ClientSessionFactory`. Serialising a model and rebuilding a document
+ * are the {@link ModelService}'s.
+ *
+ * An override of {@link dispose} calls `super.dispose(cause)`: that is what
+ * closes the session's opens and frees its id, and dropping `cause` reverts
+ * a lost client's documents without their grace.
+ */
+export class DefaultClientSession<
+   TAst extends AstNode,
+   TDiagnostic extends AstDiagnostic = AstDiagnostic,
+   TTransfer extends TransferElement = TransferElement,
+   TOpenOptions extends OpenOptions = OpenOptions
+> implements ClientSession<TAst, TDiagnostic, TTransfer, TOpenOptions> {
+   protected disposed = false;
+   /**
+    * This session's opens still under way, by canonical URI. Recorded before
+    * the first await, so a second open of the same URI joins the first rather
+    * than racing it, and `withOpen` can tell an open another call is making.
+    */
+   protected readonly pendingOpens = new Map<string, Promise<void>>();
+   /**
+    * The options of this session's opens, by canonical URI. A first open
+    * records its entry before the store has the URI open, and the entry goes
+    * when that open closes, whoever ends it: this session, or the store for a
+    * deleted file. A first open that fails never opens, so nothing closes it
+    * and its entry stays until the next first open of the URI overwrites it;
+    * {@link openOptions} therefore reads an entry only while the store has the
+    * URI open for this session.
+    */
+   protected readonly openOptionsByUri = new Map<string, TOpenOptions | undefined>();
+   /** Drops an open's options from {@link openOptionsByUri} when the store closes the open. */
+   protected readonly closeListener: Disposable;
+   protected readonly disposeEmitter = new Emitter<SessionEndCause>();
+   /** Logs under `logName`, `ClientSession` when none is given, with this session's id in a bracket of its own, so a line names the session that wrote. */
+   protected readonly tracer: Tracer;
+   /** The service bound on `model.ModelService`, which serialises and rebuilds for this session. */
+   protected readonly modelService: ModelService<TAst, TDiagnostic, TTransfer>;
+   /** See {@link ClientSessionFactoryOptions.slowUpdateWarnMs}; `undefined` when not set. */
+   protected readonly slowUpdateWarn?: ObservableValue<number>;
+   readonly clientId: string;
+   readonly label: string;
+
+   constructor(
+      protected readonly services: ServerSharedServices,
+      options: ClientSessionOptions
+   ) {
+      this.clientId = options.clientId;
+      this.label = options.label ?? options.clientId;
+      // The slot is shared across grammars; this session's types hold for the
+      // grammar that started it, as `createSession`'s narrowing does.
+      this.modelService = services.model.ModelService as ModelService<TAst, TDiagnostic, TTransfer>;
+      this.slowUpdateWarn = options.slowUpdateWarnMs !== undefined ? ObservableValue.from(options.slowUpdateWarnMs) : undefined;
+      this.tracer = services.Tracer.for(options.logName ?? 'ClientSession').with(this.clientId);
+      this.closeListener = services.workspace.TextDocuments.onDidClose(event => {
+         if (event.clientId === this.clientId) {
+            this.openOptionsByUri.delete(event.document.uri);
+         }
+      });
+   }
+
+   open(uri: string, options?: TOpenOptions): Promise<void> {
+      this.assertLive();
+      return this.openDocument(uri, options);
+   }
+
+   openOptions(uri: string): TOpenOptions | undefined {
+      this.assertLive();
+      return this.services.workspace.TextDocuments.isOpenInClient(uri, this.clientId)
+         ? this.openOptionsByUri.get(this.canonicalKey(uri))
+         : undefined;
+   }
+
+   create(uri: string, text: string): Promise<TextVersion> {
+      this.assertLive();
+      return this.createDocument(uri, text);
+   }
+
+   update(args: ClientSessionWriteArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>> {
+      this.assertLive();
+      return this.updateDocument(args, cancelToken);
+   }
+
+   updateAll(args: ClientSessionUpdateAllArgs<TTransfer>, cancelToken?: CancellationToken): Promise<AstDocument<TAst, TDiagnostic>[]> {
+      this.assertLive();
+      return this.updateDocuments(args, cancelToken);
+   }
+
+   save(args: ClientSessionWriteArgs<TTransfer>, cancelToken?: CancellationToken): Promise<SavedAstDocument<TAst, TDiagnostic>> {
+      this.assertLive();
+      return this.saveDocument(args, cancelToken);
+   }
+
+   persist(args: ClientSessionPersistArgs): Promise<TextVersion> {
+      this.assertLive();
+      return this.persistDocument(args);
+   }
+
+   close(uri: string): Promise<void> {
+      this.assertLive();
+      return this.closeDocument(uri);
+   }
+
+   delete(args: ClientSessionDeleteArgs): Promise<void> {
+      this.assertLive();
+      return this.deleteDocument(args);
+   }
+
+   withOpen<T>(uri: string, fn: () => MaybePromise<T>): Promise<T> {
+      this.assertLive();
+      return this.runWithOpen(uri, fn);
+   }
+
+   isOwnEcho(sourceClientId: string): boolean {
+      this.assertLive();
+      return sourceClientId === this.clientId;
+   }
+
+   dispose(cause?: SessionEndCause): void {
+      if (this.disposed) {
+         return;
+      }
+      this.disposed = true;
+      this.services.workspace.TextDocuments.closeSession(this.clientId, cause);
+      this.closeListener.dispose();
+      this.disposeEmitter.fire(cause ?? 'closed');
+      this.disposeEmitter.dispose();
+   }
+
+   get onDidDispose(): Event<SessionEndCause> {
+      return this.disposeEmitter.event;
+   }
+
+   protected assertLive(): void {
+      if (this.disposed) {
+         throw new SessionClosedError(this.clientId);
+      }
+   }
+
+   /** Throw `DocumentNotOpenError` unless this session has `uri` open and no delete of it is under way. */
+   protected assertOpen(uri: string): void {
+      const workspace = this.services.workspace;
+      if (!workspace.TextDocuments.isOpenInClient(uri, this.clientId) || workspace.AstDocumentManager.isDeleting(uri)) {
+         throw new DocumentNotOpenError(uri, this.clientId);
+      }
+   }
+
+   /**
+    * Throw `ConflictError` when `baseVersion` names a version other than
+    * `currentVersion`. A write calls it at the door and again in the
+    * synchronous step that applies the text, and has to call it synchronously
+    * there: a check separated from the apply by an await lets two writes based
+    * on one version both apply.
+    */
+   protected assertBaseVersion(uri: string, baseVersion: BaseVersion, currentVersion: number): void {
+      if (isModelVersion(baseVersion) && currentVersion !== baseVersion) {
+         // Distinct from the post-build "superseded" debug line of an update: this
+         // is a stale-base-version rejection (the write never applies), not two
+         // writes racing.
+         this.tracer.debug(`Conflict on ${uri}: stale base, model v${baseVersion} / text v${currentVersion}`);
+         throw new ConflictError(uri, baseVersion, currentVersion);
+      }
+   }
+
+   /**
+    * Serialise `args.model`, apply it to the store under this session's id,
+    * rebuild, and resolve to the rebuilt document.
+    *
+    * The open check and the `baseVersion` gate run at the door, so a write that
+    * cannot land is refused before any adopter serialiser runs, and again in
+    * the synchronous step that applies the text: made only before the
+    * serialiser's await, a close during it lets the write land on a document
+    * this session no longer has open, and two writes based on one version
+    * both apply.
+    *
+    * Resolves with the latest build of the document, which may already carry
+    * a newer write; that is logged at debug, and a slow update at warn when
+    * `ClientSessionFactoryOptions.slowUpdateWarnMs` is set. It waits for the
+    * builder's final phase rather than the write's own build: a later write
+    * cancels that build, and the one that takes over validates the document
+    * after the answer was taken.
+    */
+   protected async updateDocument(
+      args: ClientSessionWriteArgs<TTransfer>,
+      cancelToken?: CancellationToken
+   ): Promise<AstDocument<TAst, TDiagnostic>> {
+      const service = this.modelService;
+      const slowWarn = this.slowUpdateWarn && { threshold: this.slowUpdateWarn, stopwatch: this.services.Clock.stopwatch() };
+      const uri = this.canonicalKey(args.uri);
+      const profile = Logger.isLevelEnabled('debug') ? this.tracer.profile(`model-update ${uri}`) : undefined;
+      const run = async <T>(stage: string, fn: () => MaybePromise<T>): Promise<T> => (profile ? profile.scope(stage, fn) : fn());
+      const textDocuments = this.services.workspace.TextDocuments;
+      this.assertOpen(uri);
+      this.assertBaseVersion(uri, args.baseVersion, textDocuments.version(uri));
+      service.assertCanBuild(uri);
+      const text = await run('serialize', () => service.modelToText(uri, args.model, cancelToken));
+      const appliedVersion = await run('apply', () => {
+         this.assertOpen(uri);
+         this.assertBaseVersion(uri, args.baseVersion, textDocuments.version(uri));
+         return this.services.workspace.AstDocumentManager.update(uri, text, this.clientId);
+      });
+      // Through the public `rebuild`, so an override of it stays in the path.
+      // An override that awaits before calling the base can outlast the build
+      // this write already has, and then builds it twice; see
+      // `ModelService.rebuild`.
+      const doc = await run('rebuild', () => service.rebuild(uri, this.services.workspace.DocumentBuilder.finalBuildState(), cancelToken));
+      const finalVersion = textDocuments.version(uri);
+      if (finalVersion > appliedVersion) {
+         this.tracer.debug(`Update to v${appliedVersion} ready at v${finalVersion} (changed again before it settled)`);
+      } else {
+         this.tracer.debug(`Update to v${appliedVersion} ready`);
+      }
+      if (slowWarn) {
+         const elapsed = Math.round(slowWarn.stopwatch.elapsedMs);
+         const threshold = slowWarn.threshold.value;
+         if (elapsed >= threshold) {
+            this.tracer.withUri(uri).warn(`Slow update: ${elapsed}ms ≥ ${threshold}ms (v${appliedVersion}, client=${this.clientId})`);
+         }
+      }
+      profile?.report('debug');
+      return doc;
+   }
+
+   /**
+    * Write every document of `args.updates`, all or none: every model is
+    * serialised first, then every open check and `baseVersion` gate runs and every
+    * text is applied in one synchronous step. Checked at the door as well, so
+    * a stale set is refused before any adopter serialiser runs.
+    *
+    * The apply step relies on `AstDocumentManager.update` applying its text
+    * before its first await, as the default does: an override that awaits first
+    * lets another write land between two documents of the set.
+    */
+   protected async updateDocuments(
+      args: ClientSessionUpdateAllArgs<TTransfer>,
+      cancelToken?: CancellationToken
+   ): Promise<AstDocument<TAst, TDiagnostic>[]> {
+      const service = this.modelService;
+      const { updates } = args;
+      const textDocuments = this.services.workspace.TextDocuments;
+      const uris = updates.map(update => this.canonicalKey(update.uri));
+      if (new Set(uris).size !== uris.length) {
+         throw new Error(`updateAll names a document more than once: ${uris.join(', ')}`);
+      }
+      const check = (): void =>
+         updates.forEach((update, i) => {
+            this.assertOpen(uris[i]);
+            this.assertBaseVersion(uris[i], update.baseVersion, textDocuments.version(uris[i]));
+            service.assertCanBuild(uris[i]);
+         });
+      check();
+      const texts: string[] = [];
+      for (const [i, update] of updates.entries()) {
+         texts.push(await service.modelToText(uris[i], update.model, cancelToken));
+      }
+      // One synchronous step from the first check to the last apply: an await
+      // anywhere in it lets a close or another write land after its document
+      // was checked, and the set then half-applies before a later check fails.
+      check();
+      const applied = uris.map((uri, i) => this.services.workspace.AstDocumentManager.update(uri, texts[i], this.clientId));
+      await Promise.all(applied);
+      const state = this.services.workspace.DocumentBuilder.finalBuildState();
+      const rebuilt = await Promise.allSettled(uris.map(uri => service.rebuild(uri, state, cancelToken)));
+      const failures = rebuilt.flatMap((result, i) => (result.status === 'rejected' ? [{ uri: uris[i], reason: result.reason }] : []));
+      if (failures.length === 0) {
+         return rebuilt.flatMap(result => (result.status === 'fulfilled' ? [result.value] : []));
+      }
+      // The first is thrown as it is, so a typed failure keeps its type; one build
+      // usually carries the set and fails each with the same error. Any other
+      // failure reaches no one else, so it is logged here.
+      const [{ uri: firstUri, reason: firstReason }] = failures;
+      for (const { uri, reason } of failures.slice(1)) {
+         if (isOperationCancelled(reason)) {
+            this.tracer.with(uri).debug(`Rebuild of ${uri} cancelled beside that of ${firstUri}`);
+         } else if (reason !== firstReason) {
+            this.tracer.with(uri).error(`Rebuild of ${uri} failed beside that of ${firstUri}. ${describeErrorWithStack(reason)}`);
+         }
+      }
+      throw firstReason;
+   }
+
+   /**
+    * Write `args.model` through {@link updateDocument}, then persist it through
+    * {@link persistDocument}, so an override of either applies to saves too.
+    *
+    * Fails with `DocumentNotOpenError` and writes nothing when this session
+    * closes the URI while the text is being built. Persisted at `'any'`: the
+    * update already gated on `args.baseVersion` and moved the text past it.
+    */
+   protected async saveDocument(
+      args: ClientSessionWriteArgs<TTransfer>,
+      cancelToken?: CancellationToken
+   ): Promise<SavedAstDocument<TAst, TDiagnostic>> {
+      const doc = await this.updateDocument(args, cancelToken);
+      const version = await this.persistDocument({ uri: args.uri, baseVersion: 'any' });
+      return { ...doc, persisted: { version } };
+   }
+
+   /**
+    * Persist the store's text for `args.uri` under this session's id. Every
+    * write to disk a session makes goes through here, so an override sees each
+    * of them.
+    *
+    * The open check and the `baseVersion` gate sit in the same synchronous step
+    * as the manager taking the text: an await between them lets another
+    * client's write land after the gate, and its text is then persisted under
+    * this session's id without this session ever having seen it. An override
+    * that awaits before calling the base lets a diagram save take its
+    * documents' texts at different moments, and a diagram that ends during the
+    * await fails the documents not yet taken with `DocumentNotOpenError`.
+    */
+   protected async persistDocument(args: ClientSessionPersistArgs): Promise<TextVersion> {
+      const uri = this.canonicalKey(args.uri);
+      this.assertOpen(uri);
+      this.assertBaseVersion(uri, args.baseVersion, this.services.workspace.TextDocuments.version(uri));
+      return this.services.workspace.AstDocumentManager.save(uri, this.clientId);
+   }
+
+   /**
+    * Delete `args.uri` under this session's id. The open check and the
+    * `baseVersion` gate sit in the same synchronous step as the manager's
+    * mark, which refuses every later write of the URI: an await between them
+    * lets another client's write land after the gate, and the delete then
+    * discards text this session never saw.
+    */
+   protected async deleteDocument(args: ClientSessionDeleteArgs): Promise<void> {
+      const uri = this.canonicalKey(args.uri);
+      this.assertOpen(uri);
+      this.assertBaseVersion(uri, args.baseVersion, this.services.workspace.TextDocuments.version(uri));
+      return this.services.workspace.AstDocumentManager.delete(uri, this.clientId);
+   }
+
+   protected async closeDocument(uri: string): Promise<void> {
+      await this.services.workspace.AstDocumentManager.close({ uri, clientId: this.clientId });
+   }
+
+   /** Open `uri`, or join the open of it this session already has under way, whose options then stand. */
+   protected openDocument(uri: string, options: TOpenOptions | undefined): Promise<void> {
+      const key = this.canonicalKey(uri);
+      const pending = this.pendingOpens.get(key);
+      if (pending) {
+         return pending;
+      }
+      const opening = this.registerOpen(uri, options).finally(() => {
+         if (this.pendingOpens.get(key) === opening) {
+            this.pendingOpens.delete(key);
+         }
+      });
+      this.pendingOpens.set(key, opening);
+      return opening;
+   }
+
+   /**
+    * Open `uri` in the store for this session. The open path does not thread
+    * cancellation: the file read behind it takes no token, so a cancelled
+    * caller still completes the open.
+    *
+    * A first open records its options before the store opens the URI, so a
+    * listener of the store's open reads this open's options rather than an
+    * earlier one's.
+    *
+    * It waits for the workspace first, as an LSP head's open does: a document
+    * opened before the bring-up links against a workspace that holds only
+    * itself, and the bring-up does not always relink it.
+    */
+   protected async registerOpen(uri: string, options: TOpenOptions | undefined): Promise<void> {
+      await this.modelService.ready;
+      // A session ended during the wait opens nothing.
+      this.assertLive();
+      const wasOpen = this.services.workspace.TextDocuments.isOpenInClient(uri, this.clientId);
+      if (!wasOpen) {
+         this.openOptionsByUri.set(this.canonicalKey(uri), options);
+      }
+      await this.services.workspace.AstDocumentManager.open({ uri, clientId: this.clientId });
+      await this.rejectIfEnded(uri, wasOpen);
+   }
+
+   protected canonicalKey(uri: string): string {
+      return this.services.workspace.DocumentUriPolicy.canonicalUri(uri);
+   }
+
+   protected async createDocument(uri: string, text: string): Promise<TextVersion> {
+      // As `registerOpen` does, and before the checks, which read the workspace.
+      await this.modelService.ready;
+      if (await this.services.workspace.FileSystemProvider.exists(UriUtils.toUri(uri))) {
+         throw new Error(`Cannot create ${uri}: the file exists`);
+      }
+      this.assertLive();
+      if (this.services.workspace.TextDocuments.isReleaseDeferred(uri)) {
+         throw new Error(`Cannot create ${uri}: it holds the unsaved text of a lost client, waiting out the release grace`);
+      }
+      if (this.modelService.isOpen(uri)) {
+         throw new Error(`Cannot create ${uri}: it is open in a client`);
+      }
+      // The check above cannot see an open that registers while this one is
+      // under way, and opening an already-open URI only attaches, dropping
+      // `text`. Only an open that creates the document fires `onDidOpen`, so
+      // hearing it for this session, during this open, is what proves the
+      // document holds `text`; the client list afterwards cannot, since a
+      // client that registered first may have closed again by then.
+      const key = this.canonicalKey(uri);
+      let created: TextVersion | undefined;
+      const listener = this.services.workspace.TextDocuments.onDidOpen(event => {
+         if (event.clientId === this.clientId && event.document.uri === key) {
+            created = event.document.version;
+         }
+      });
+      try {
+         await this.services.workspace.AstDocumentManager.open({ uri, clientId: this.clientId, text });
+      } finally {
+         listener.dispose();
+      }
+      await this.rejectIfEnded(uri, false);
+      if (created === undefined) {
+         await this.closeDocument(uri);
+         throw new Error(`Cannot create ${uri}: it is open in a client`);
+      }
+      return created;
+   }
+
+   protected async runWithOpen<T>(uri: string, fn: () => MaybePromise<T>): Promise<T> {
+      // An open another call of this session is still making counts as made:
+      // closing it afterwards would take away an open that call asked for.
+      const alreadyOpen =
+         this.services.workspace.TextDocuments.isOpenInClient(uri, this.clientId) || this.pendingOpens.has(this.canonicalKey(uri));
+      await this.openDocument(uri, undefined);
+      try {
+         return await fn();
+      } finally {
+         if (!alreadyOpen && !this.disposed) {
+            await this.closeDocument(uri);
+         }
+      }
+   }
+
+   /**
+    * Undo an open that completed after the session ended, then fail it.
+    *
+    * Ending the session closed only what it had open at that moment. An open
+    * still reading from disk registers afterwards, under an id that is no
+    * longer a session, and nothing would ever close it.
+    *
+    * Opens are keyed by id, so once a new session holds the same id this open
+    * is indistinguishable from one of its own, and closing it would close the
+    * new session's. It is left to that session, which releases it at its end.
+    */
+   protected async rejectIfEnded(uri: string, wasOpen: boolean): Promise<void> {
+      if (!this.disposed) {
+         return;
+      }
+      if (!wasOpen && this.modelService.getSession(this.clientId) === undefined) {
+         await this.closeDocument(uri);
+      }
+      throw new SessionClosedError(this.clientId);
+   }
+}
+
+/** Constructor options for {@link DefaultClientSessionFactory}. */
+export interface ClientSessionFactoryOptions extends LogNameOptions {
+   /**
+    * The name the factory and every session it builds log under, so one
+    * option renames both. Default: `ClientSessionFactory` for the factory,
+    * and `ClientSession` for a session, which adds its client id in a bracket
+    * of its own.
+    */
+   readonly logName?: string;
+   /**
+    * When set, a session's `update` logs a `warn` line if its end-to-end wait
+    * (serialise, apply, rebuild) takes at least this many milliseconds. Default
+    * `undefined`: no warn line, and no per-update stopwatch.
+    *
+    * Observability only: the update is neither aborted nor resolved
+    * differently. A hard timeout that throws is an override of
+    * `DefaultClientSession.updateDocument` racing the parent call against a
+    * deadline.
+    *
+    * A recommended starting threshold is 2-5 seconds; workspaces with very
+    * large documents or slow validation can exceed 5 s on a cold build. A
+    * `Settings.number` binding retunes it live.
+    */
+   readonly slowUpdateWarnMs?: MaybeObservableValue<number>;
+}
+
+/**
+ * Constructor options for {@link DefaultClientSession}: the factory's options,
+ * which it forwards, plus the session's identity.
+ */
+export interface ClientSessionOptions extends ClientSessionFactoryOptions {
+   readonly clientId: string;
+   /** What the session is. Pass one: the client id stands in for it otherwise. */
+   readonly label?: string;
+}
+
+/**
+ * Builds the handle for a session `ModelService.createSession` has already
+ * registered, so registration and the uniqueness check cannot be skipped by
+ * binding a factory of one's own. Bind one on `model.ClientSessionFactory` to
+ * use a session class of your own. A factory that does not pass
+ * {@link ClientSessionFactoryOptions.slowUpdateWarnMs} on to its sessions
+ * loses their slow-update warn; subclassing {@link DefaultClientSessionFactory}
+ * keeps it.
+ *
+ * Typed for every grammar, since the slot is shared: `createSession` narrows
+ * the result to its caller's types.
+ */
+export interface ClientSessionFactory {
+   create(clientId: string, label: string): ClientSession<AstNode>;
+}
+
+/**
+ * The framework's {@link ClientSessionFactory}: a {@link DefaultClientSession}
+ * over the {@link ModelService} bound on `model.ModelService`, which the session
+ * serialises and rebuilds through. A model service constructed outside that
+ * slot therefore starts sessions that write through the bound one.
+ *
+ * A subclass that overrides {@link create} to build a session class of its
+ * own passes {@link options} on to that session's constructor; a session built
+ * without them has no slow-update warn and logs under the default name.
+ */
+export class DefaultClientSessionFactory implements ClientSessionFactory {
+   protected readonly tracer: Tracer;
+
+   constructor(
+      protected readonly services: ServerSharedServices,
+      protected readonly options: ClientSessionFactoryOptions = {}
+   ) {
+      this.tracer = services.Tracer.for(options.logName ?? 'ClientSessionFactory').trace('instantiated');
+   }
+
+   create(clientId: string, label: string): ClientSession<AstNode> {
+      return new DefaultClientSession(this.services, { ...this.options, clientId, label });
+   }
+}