@jupyter/chat 0.25.0-alpha.5 → 0.25.0-alpha.6

package/lib/model.d.ts

@@ -270,6 +270,15 @@ export declare abstract class AbstractChatModel implements IChatModel {
      * shared-document metadata under RTC).
      */
     protected setReady(id: string): void;
+    /**
+     * Mark the chat as failed to become ready, rejecting `ready`.
+     *
+     * Used when the chat can never become usable - e.g. the WebSocket connection
+     * was closed by the server before the connection frame arrived. Consumers of
+     * `ready` (such as the widgets that show a loading spinner) can then react to
+     * the failure instead of hanging forever.
+     */
+    protected setError(reason: unknown): void;
     /**
      * The chat settings.
      */

package/lib/model.js

@@ -64,8 +64,13 @@ export class AbstractChatModel {
         this._selectionWatcher = (_d = options.selectionWatcher) !== null && _d !== void 0 ? _d : null;
         this._documentManager = (_e = options.documentManager) !== null && _e !== void 0 ? _e : null;
         this._readyDelegate = new PromiseDelegate();
-        this.ready.then(() => {
+        this.ready
+            .then(() => {
             this._inputModel.chatContext = this.createChatContext();
+        })
+            .catch(() => {
+            // `ready` was rejected (the chat failed to open); no context is created.
+            // The failure is surfaced to the user by the hosting widget.
         });
     }
     /**
@@ -166,6 +171,17 @@ export class AbstractChatModel {
     setReady(id) {
         this._readyDelegate.resolve(id);
     }
+    /**
+     * Mark the chat as failed to become ready, rejecting `ready`.
+     *
+     * Used when the chat can never become usable - e.g. the WebSocket connection
+     * was closed by the server before the connection frame arrived. Consumers of
+     * `ready` (such as the widgets that show a loading spinner) can then react to
+     * the failure instead of hanging forever.
+     */
+    setError(reason) {
+        this._readyDelegate.reject(reason);
+    }
     /**
      * The chat settings.
      */

package/lib/widgets/multichat-panel.js

@@ -6,7 +6,7 @@
  * Multi-chat panel for @jupyter/chat
  * Originally adapted from jupyterlab-chat's ChatPanel
  */
-import { InputDialog } from '@jupyterlab/apputils';
+import { InputDialog, Notification } from '@jupyterlab/apputils';
 import { nullTranslator } from '@jupyterlab/translation';
 import { addIcon, closeIcon, PanelWithToolbar, ReactiveToolbar, ReactWidget, Spinner, Toolbar, ToolbarButton } from '@jupyterlab/ui-components';
 import { ArrayExt } from '@lumino/algorithm';
@@ -389,8 +389,17 @@ class SidePanelWidget extends ReactivePanelWithToolbar {
         // Add spinner while loading
         const spinner = new Spinner();
         this.addWidget(spinner);
-        this._chatWidget.model.ready.then(() => {
+        this._chatWidget.model.ready
+            .then(() => {
             spinner.dispose();
+        })
+            .catch(() => {
+            // The chat could not be opened (e.g. the server closed the WebSocket
+            // because the path was invalid). Dispose the spinner and close this
+            // chat so no loading spinner is left hanging; the side panel stays open.
+            spinner.dispose();
+            Notification.error(trans.__("Unable to open chat at given path: '%1'.", this._chatWidget.model.name));
+            options.onClose(this._displayName);
         });
         // Add the chat widget
         this.addWidget(this._chatWidget);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/chat",
-  "version": "0.25.0-alpha.5",
+  "version": "0.25.0-alpha.6",
   "description": "A package that provides UI components that can be used to create a chat in a Jupyterlab extension.",
   "keywords": [
     "jupyter",

package/src/model.ts

@@ -318,9 +318,14 @@ export abstract class AbstractChatModel implements IChatModel {
 
     this._readyDelegate = new PromiseDelegate<string>();
 
-    this.ready.then(() => {
-      this._inputModel.chatContext = this.createChatContext();
-    });
+    this.ready
+      .then(() => {
+        this._inputModel.chatContext = this.createChatContext();
+      })
+      .catch(() => {
+        // `ready` was rejected (the chat failed to open); no context is created.
+        // The failure is surfaced to the user by the hosting widget.
+      });
   }
 
   /**
@@ -441,6 +446,18 @@ export abstract class AbstractChatModel implements IChatModel {
     this._readyDelegate.resolve(id);
   }
 
+  /**
+   * Mark the chat as failed to become ready, rejecting `ready`.
+   *
+   * Used when the chat can never become usable - e.g. the WebSocket connection
+   * was closed by the server before the connection frame arrived. Consumers of
+   * `ready` (such as the widgets that show a loading spinner) can then react to
+   * the failure instead of hanging forever.
+   */
+  protected setError(reason: unknown): void {
+    this._readyDelegate.reject(reason);
+  }
+
   /**
    * The chat settings.
    */

package/src/widgets/multichat-panel.tsx

@@ -8,7 +8,11 @@
  * Originally adapted from jupyterlab-chat's ChatPanel
  */
 
-import { InputDialog, ToolbarRegistry } from '@jupyterlab/apputils';
+import {
+  InputDialog,
+  Notification,
+  ToolbarRegistry
+} from '@jupyterlab/apputils';
 import { IObservableList } from '@jupyterlab/observables';
 import { nullTranslator, TranslationBundle } from '@jupyterlab/translation';
 import {
@@ -554,9 +558,23 @@ class SidePanelWidget extends ReactivePanelWithToolbar implements IChatPanel {
     // Add spinner while loading
     const spinner = new Spinner();
     this.addWidget(spinner);
-    this._chatWidget.model.ready.then(() => {
-      spinner.dispose();
-    });
+    this._chatWidget.model.ready
+      .then(() => {
+        spinner.dispose();
+      })
+      .catch(() => {
+        // The chat could not be opened (e.g. the server closed the WebSocket
+        // because the path was invalid). Dispose the spinner and close this
+        // chat so no loading spinner is left hanging; the side panel stays open.
+        spinner.dispose();
+        Notification.error(
+          trans.__(
+            "Unable to open chat at given path: '%1'.",
+            this._chatWidget.model.name
+          )
+        );
+        options.onClose(this._displayName);
+      });
 
     // Add the chat widget
     this.addWidget(this._chatWidget);