@hydranium/glsp-client-theia 1.0.0-next.10

package/src/testing/bind-recorder.ts

@@ -0,0 +1,126 @@
+/********************************************************************************
+ * 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 { interfaces } from 'inversify';
+
+/**
+ * One captured `bind(...)` or `rebind(...)` call on a {@link BindRecorder}.
+ *
+ * `chain` holds the follow-up methods in invocation order, one string per call,
+ * rendered as `name(arg, …)`. Arguments are stringified inline so assertions
+ * can compare structure without re-resolving service identifiers.
+ */
+export interface BindRecorderEntry {
+   readonly kind: 'bind' | 'rebind';
+   readonly token: unknown;
+   readonly chain: string[];
+}
+
+/**
+ * A spy set of Inversify binding hooks that records every call and its chain.
+ * Hand them to a module-factory under test — they satisfy Inversify's
+ * `interfaces.Bind` / `interfaces.Rebind` / `interfaces.Unbind` /
+ * `interfaces.IsBound` shapes at the call site but never resolve real services.
+ *
+ * Together they match GLSP's `BindingContext`, so a factory taking the whole
+ * context is called as `factory(recorder, options)` — the recorder *is*
+ * structurally a context.
+ *
+ * Use {@link captured} to assert which tokens were touched and with what
+ * fluent chain. {@link find} is a small ergonomic helper for the common
+ * lookup pattern.
+ */
+export interface BindRecorder {
+   readonly bind: interfaces.Bind;
+   readonly rebind: interfaces.Rebind;
+   readonly unbind: interfaces.Unbind;
+   readonly isBound: interfaces.IsBound;
+   readonly captured: readonly BindRecorderEntry[];
+   /** Convenience lookup — returns the first entry matching both `kind` and `token`, or `undefined`. */
+   find(kind: 'bind' | 'rebind', token: unknown): BindRecorderEntry | undefined;
+}
+
+/** Options for {@link makeBindRecorder}. */
+export interface BindRecorderOptions {
+   /**
+    * What `isBound` answers. Defaults to `true` for every token, matching
+    * production: a head registers its own module *after* the GLSP default
+    * modules, so the tokens a framework module rebinds are already bound. Pass a
+    * list to model a container where only those tokens are bound — e.g. to
+    * exercise a factory's bind-instead-of-rebind fallback.
+    */
+   readonly boundTokens?: readonly unknown[];
+}
+
+/** Methods on Inversify's binding builder that the recorder traps verbatim. */
+const RECORDED_CHAIN_METHODS = [
+   'toSelf',
+   'to',
+   'toService',
+   'toConstantValue',
+   'toDynamicValue',
+   'toFactory',
+   'toFunction',
+   'toAutoFactory',
+   'toProvider',
+   'inSingletonScope',
+   'inTransientScope',
+   'inRequestScope',
+   'whenTargetNamed',
+   'whenTargetTagged',
+   'whenInjectedInto',
+   'onActivation',
+   'onDeactivation'
+] as const;
+
+/**
+ * Build a {@link BindRecorder} for testing Inversify module factories without a
+ * real container: hand it to the factory, then assert over {@link BindRecorder.find}.
+ *
+ * The `bind` / `rebind` functions return a chained proxy that ignores its
+ * arguments structurally but records every method invocation as a string.
+ * Stringification: functions → `<className>`, symbols → `Symbol(desc).toString()`,
+ * everything else → `String(value)`. This is enough to assert which tokens are
+ * involved without dragging real service resolution into the test.
+ */
+export function makeBindRecorder(options: BindRecorderOptions = {}): BindRecorder {
+   const captured: BindRecorderEntry[] = [];
+
+   const stringifyArg = (value: unknown): string => {
+      if (typeof value === 'function') {
+         return `<${value.name || 'fn'}>`;
+      }
+      if (typeof value === 'symbol') {
+         return value.toString();
+      }
+      return String(value);
+   };
+
+   const beginEntry = (kind: 'bind' | 'rebind', token: unknown): unknown => {
+      const entry: BindRecorderEntry = { kind, token, chain: [] };
+      captured.push(entry);
+      const proxy: Record<string, (...args: unknown[]) => unknown> = {};
+      for (const method of RECORDED_CHAIN_METHODS) {
+         proxy[method] = (...args: unknown[]): unknown => {
+            entry.chain.push(`${method}(${args.map(stringifyArg).join(', ')})`);
+            return proxy;
+         };
+      }
+      return proxy;
+   };
+
+   const bind = ((token: unknown) => beginEntry('bind', token)) as interfaces.Bind;
+   const rebind = ((token: unknown) => beginEntry('rebind', token)) as interfaces.Rebind;
+   const unbind = (() => undefined) as unknown as interfaces.Unbind;
+   const isBound = ((token: unknown) => options.boundTokens?.includes(token) ?? true) as interfaces.IsBound;
+   const find = (kind: 'bind' | 'rebind', token: unknown): BindRecorderEntry | undefined =>
+      captured.find(entry => entry.kind === kind && entry.token === token);
+
+   return { bind, rebind, unbind, isBound, captured, find };
+}

package/src/testing/index.ts

@@ -0,0 +1,15 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+
+// Subpath barrel for `@hydranium/glsp-client-theia/testing` — the
+// GLSP-module-specific Inversify test double. The cross-head doubles
+// (`makeStubOutputChannelManager`, `makeStubInversifyContext`) live in
+// `@hydranium/client-theia/testing`, alongside the logger they double for.
+
+export * from './bind-recorder';

package/style/diagram-loading.css

@@ -0,0 +1,67 @@
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+
+/* Loading overlay shown by HydraniumGlspDiagramWidget until the diagram load
+   settles. Imported by the widget module itself, so an adopter cannot forget it;
+   every rule is overridable from an adopter stylesheet loaded afterwards.
+   Colours come from Theia theme variables, so light/dark follow the workbench. */
+
+.hydranium-diagram-loading {
+   position: absolute;
+   inset: 0;
+   z-index: 10;
+   display: flex;
+   flex-direction: column;
+   align-items: center;
+   justify-content: center;
+   gap: 12px;
+   background: var(--theia-editor-background);
+   color: var(--theia-descriptionForeground);
+   font-size: var(--theia-ui-font-size1);
+}
+
+.hydranium-diagram-loading-spinner {
+   width: 40px;
+   height: 40px;
+   border: 4px solid var(--theia-editorWidget-border);
+   border-top-color: var(--theia-button-background);
+   border-radius: 50%;
+   /* transform-only, so the animation runs on the compositor and keeps turning
+      through a synchronous phase that blocks the main thread — which is exactly
+      when the user most needs to see that something is still happening. */
+   animation: hydranium-diagram-loading-spin 0.9s linear infinite;
+   will-change: transform;
+}
+
+@keyframes hydranium-diagram-loading-spin {
+   from {
+      transform: rotate(0deg);
+   }
+
+   to {
+      transform: rotate(360deg);
+   }
+}
+
+/* Failure state: set only when the loader could NOT dispatch its error
+   StatusAction, so this overlay is the single remaining surface for the message.
+   The spinner goes (nothing is pending any more) and the text takes the error
+   colour. A load that failed and WAS reported never reaches this state — the
+   overlay is removed and GLSP's own status overlay shows it instead. */
+.hydranium-diagram-loading-failed .hydranium-diagram-loading-spinner {
+   display: none;
+}
+
+.hydranium-diagram-loading-failed .hydranium-diagram-loading-label {
+   /* Wrap rather than clip: a load failure message can be long (a connection
+      error carries a URI), and it is the only copy the user gets here. */
+   max-width: 80%;
+   text-align: center;
+   color: var(--theia-errorForeground);
+}