jupyterlab-chat 0.23.0 → 0.23.2

package/lib/__tests__/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/__tests__/utils.spec.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { resolveChatRenamePath } from '../utils';
+describe('resolveChatRenamePath', () => {
+    it('keeps a renamed chat in its original directory', () => {
+        expect(resolveChatRenamePath('chats/untitled.chat', 'test')).toBe('chats/test.chat');
+    });
+    it('ensures the .chat extension', () => {
+        expect(resolveChatRenamePath('chats/untitled.chat', 'test.chat')).toBe('chats/test.chat');
+    });
+    it('leaves root-level chats at the root', () => {
+        expect(resolveChatRenamePath('untitled.chat', 'test')).toBe('test.chat');
+    });
+    it('respects an explicit directory in the new name', () => {
+        expect(resolveChatRenamePath('chats/untitled.chat', 'archive/test')).toBe('archive/test.chat');
+    });
+    it('preserves nested directories', () => {
+        expect(resolveChatRenamePath('chats/2024/untitled.chat', 'test')).toBe('chats/2024/test.chat');
+    });
+});

package/lib/model.d.ts

@@ -64,6 +64,21 @@ export declare class LabChatModel extends AbstractChatModel implements DocumentR
     get readOnly(): boolean;
     set readOnly(value: boolean);
     set id(value: string | undefined);
+    /**
+     * Notify the model that its shared document has been synchronized with the
+     * server, and give it an ID if the document does not carry one yet.
+     *
+     * The model is only ready once it has an ID, so this must be called as soon as
+     * the document content is known - the ID cannot be created earlier, or a chat
+     * that already has one stored would end up with a conflicting ID.
+     *
+     * Callers should hook this to `IDocumentProvider.ready` (or the document
+     * context's `ready`) rather than to the document becoming clean: since
+     * jupyter-collaboration 5 a room stays dirty after being loaded, so the
+     * transition out of the dirty state may only happen on the first save, about a
+     * second later, leaving the chat unusable until then.
+     */
+    markDocumentSynced(): void;
     dispose(): void;
     toString(): string;
     fromString(data: string): void;

package/lib/model.js

@@ -226,6 +226,10 @@ export class LabChatModel extends AbstractChatModel {
                 });
             }
             // Create a chat ID if not created when the document is not dirty.
+            //
+            // This is a fallback for chats whose document is not backed by a
+            // collaborative provider, and so never reports being synchronized. When
+            // there is one, `markDocumentSynced()` gets there first.
             if (changes.stateChange && !this._sharedModel.id) {
                 if (changes.stateChange.some(change => change.name === 'dirty' && !change.newValue)) {
                     this._sharedModel.id = UUID.uuid4();
@@ -295,6 +299,27 @@ export class LabChatModel extends AbstractChatModel {
             this.setReady();
         }
     }
+    /**
+     * Notify the model that its shared document has been synchronized with the
+     * server, and give it an ID if the document does not carry one yet.
+     *
+     * The model is only ready once it has an ID, so this must be called as soon as
+     * the document content is known - the ID cannot be created earlier, or a chat
+     * that already has one stored would end up with a conflicting ID.
+     *
+     * Callers should hook this to `IDocumentProvider.ready` (or the document
+     * context's `ready`) rather than to the document becoming clean: since
+     * jupyter-collaboration 5 a room stays dirty after being loaded, so the
+     * transition out of the dirty state may only happen on the first save, about a
+     * second later, leaving the chat unusable until then.
+     */
+    markDocumentSynced() {
+        if (!this._sharedModel.id) {
+            // Assigning the shared ID emits a metadata change, which sets the model
+            // ID - and therefore resolves `ready` - through `_onchange`.
+            this._sharedModel.id = UUID.uuid4();
+        }
+    }
     dispose() {
         if (this.isDisposed) {
             return;

package/lib/utils.d.ts

@@ -6,3 +6,17 @@
  * @returns - the display name of the chat.
  */
 export declare function getDisplayName(path: string, defaultDirectory?: string): string;
+/**
+ * Resolve the target path for a chat rename.
+ *
+ * When the new name is a bare basename (the usual case when renaming via the
+ * dialog), the chat must stay in the same directory as the original file.
+ * Otherwise `Contents.rename` treats the name as root-relative and moves the
+ * chat out of its directory (e.g. the configured `defaultDirectory`).
+ *
+ * @param oldPath - the current path of the chat file (e.g. `chats/untitled.chat`).
+ * @param newName - the new name or path entered by the user (e.g. `test`).
+ * @returns - the resolved path, with the `.chat` extension ensured and the
+ *   original directory preserved when `newName` has no directory component.
+ */
+export declare function resolveChatRenamePath(oldPath: string, newName: string): string;

package/lib/utils.js

@@ -22,3 +22,29 @@ export function getDisplayName(path, defaultDirectory) {
             : path
         : '/' + path).replace(pattern, '');
 }
+/**
+ * Resolve the target path for a chat rename.
+ *
+ * When the new name is a bare basename (the usual case when renaming via the
+ * dialog), the chat must stay in the same directory as the original file.
+ * Otherwise `Contents.rename` treats the name as root-relative and moves the
+ * chat out of its directory (e.g. the configured `defaultDirectory`).
+ *
+ * @param oldPath - the current path of the chat file (e.g. `chats/untitled.chat`).
+ * @param newName - the new name or path entered by the user (e.g. `test`).
+ * @returns - the resolved path, with the `.chat` extension ensured and the
+ *   original directory preserved when `newName` has no directory component.
+ */
+export function resolveChatRenamePath(oldPath, newName) {
+    let newPath = newName;
+    // Ensure the `.chat` extension.
+    if (!newPath.endsWith(chatFileType.extensions[0])) {
+        newPath = `${newPath}${chatFileType.extensions[0]}`;
+    }
+    // Bare basename (no separator) -> keep it in the original file's directory.
+    // An explicit directory in `newName` is respected as-is.
+    if (!newPath.includes('/')) {
+        newPath = PathExt.join(PathExt.dirname(oldPath), newPath);
+    }
+    return newPath;
+}

package/lib/widget.js

@@ -27,6 +27,11 @@ export class LabChatPanel extends DocumentWidget {
         this.addClass(MAIN_PANEL_CLASS);
         this.model.name = this.context.localPath;
         this.model.unreadChanged.connect(this._unreadChanged);
+        // The context is ready once the document content has been loaded, which is
+        // when the chat can be given an ID and become usable.
+        this.context.ready
+            .then(() => this.model.markDocumentSynced())
+            .catch(e => console.error('The chat document failed to load', e));
     }
     /**
      * Dispose of the resources held by the widget.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-chat",
-  "version": "0.23.0",
+  "version": "0.23.2",
   "description": "The library to build a chat based on shared document",
   "keywords": [
     "jupyter",
@@ -42,21 +42,21 @@
     "watch:src": "tsc -w --sourceMap"
   },
   "dependencies": {
-    "@jupyter/chat": "^0.23.0",
-    "@jupyter/collaborative-drive": "^4.4.0 || ^5.0.0-alpha.0",
+    "@jupyter/chat": "^0.23.2",
+    "@jupyter/collaborative-drive": "^4.4.0 || ^5.0.0",
     "@jupyter/ydoc": "^3.0.0 || ^4.0.0",
-    "@jupyterlab/application": "^4.6.0",
-    "@jupyterlab/apputils": "^4.7.0",
-    "@jupyterlab/coreutils": "^6.6.0",
-    "@jupyterlab/docmanager": "^4.6.0",
-    "@jupyterlab/docregistry": "^4.6.0",
-    "@jupyterlab/launcher": "^4.6.0",
-    "@jupyterlab/notebook": "^4.6.0",
-    "@jupyterlab/rendermime": "^4.6.0",
-    "@jupyterlab/services": "^7.6.0",
-    "@jupyterlab/settingregistry": "^4.6.0",
-    "@jupyterlab/translation": "^4.6.0",
-    "@jupyterlab/ui-components": "^4.6.0",
+    "@jupyterlab/application": "^4.5.0",
+    "@jupyterlab/apputils": "^4.6.0",
+    "@jupyterlab/coreutils": "^6.5.0",
+    "@jupyterlab/docmanager": "^4.5.0",
+    "@jupyterlab/docregistry": "^4.5.0",
+    "@jupyterlab/launcher": "^4.5.0",
+    "@jupyterlab/notebook": "^4.5.0",
+    "@jupyterlab/rendermime": "^4.5.0",
+    "@jupyterlab/services": "^7.5.0",
+    "@jupyterlab/settingregistry": "^4.5.0",
+    "@jupyterlab/translation": "^4.5.0",
+    "@jupyterlab/ui-components": "^4.5.0",
     "@lumino/commands": "^2.3.3",
     "@lumino/coreutils": "^2.2.2",
     "@lumino/signaling": "^2.1.5",
@@ -66,7 +66,7 @@
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/testing": "^4.6.0",
+    "@jupyterlab/testing": "^4.5.0",
     "@types/jest": "^29.2.0",
     "@types/json-schema": "^7.0.11",
     "@types/react": "^18.2.0",

package/src/__tests__/utils.spec.ts

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import { resolveChatRenamePath } from '../utils';
+
+describe('resolveChatRenamePath', () => {
+  it('keeps a renamed chat in its original directory', () => {
+    expect(resolveChatRenamePath('chats/untitled.chat', 'test')).toBe(
+      'chats/test.chat'
+    );
+  });
+
+  it('ensures the .chat extension', () => {
+    expect(resolveChatRenamePath('chats/untitled.chat', 'test.chat')).toBe(
+      'chats/test.chat'
+    );
+  });
+
+  it('leaves root-level chats at the root', () => {
+    expect(resolveChatRenamePath('untitled.chat', 'test')).toBe('test.chat');
+  });
+
+  it('respects an explicit directory in the new name', () => {
+    expect(resolveChatRenamePath('chats/untitled.chat', 'archive/test')).toBe(
+      'archive/test.chat'
+    );
+  });
+
+  it('preserves nested directories', () => {
+    expect(resolveChatRenamePath('chats/2024/untitled.chat', 'test')).toBe(
+      'chats/2024/test.chat'
+    );
+  });
+});

package/src/model.ts

@@ -169,6 +169,28 @@ export class LabChatModel
     }
   }
 
+  /**
+   * Notify the model that its shared document has been synchronized with the
+   * server, and give it an ID if the document does not carry one yet.
+   *
+   * The model is only ready once it has an ID, so this must be called as soon as
+   * the document content is known - the ID cannot be created earlier, or a chat
+   * that already has one stored would end up with a conflicting ID.
+   *
+   * Callers should hook this to `IDocumentProvider.ready` (or the document
+   * context's `ready`) rather than to the document becoming clean: since
+   * jupyter-collaboration 5 a room stays dirty after being loaded, so the
+   * transition out of the dirty state may only happen on the first save, about a
+   * second later, leaving the chat unusable until then.
+   */
+  markDocumentSynced(): void {
+    if (!this._sharedModel.id) {
+      // Assigning the shared ID emits a metadata change, which sets the model
+      // ID - and therefore resolves `ready` - through `_onchange`.
+      this._sharedModel.id = UUID.uuid4();
+    }
+  }
+
   dispose(): void {
     if (this.isDisposed) {
       return;
@@ -563,6 +585,10 @@ export class LabChatModel
     }
 
     // Create a chat ID if not created when the document is not dirty.
+    //
+    // This is a fallback for chats whose document is not backed by a
+    // collaborative provider, and so never reports being synchronized. When
+    // there is one, `markDocumentSynced()` gets there first.
     if (changes.stateChange && !this._sharedModel.id) {
       if (
         changes.stateChange.some(

package/src/utils.ts

@@ -31,3 +31,36 @@ export function getDisplayName(
       : '/' + path
   ).replace(pattern, '');
 }
+
+/**
+ * Resolve the target path for a chat rename.
+ *
+ * When the new name is a bare basename (the usual case when renaming via the
+ * dialog), the chat must stay in the same directory as the original file.
+ * Otherwise `Contents.rename` treats the name as root-relative and moves the
+ * chat out of its directory (e.g. the configured `defaultDirectory`).
+ *
+ * @param oldPath - the current path of the chat file (e.g. `chats/untitled.chat`).
+ * @param newName - the new name or path entered by the user (e.g. `test`).
+ * @returns - the resolved path, with the `.chat` extension ensured and the
+ *   original directory preserved when `newName` has no directory component.
+ */
+export function resolveChatRenamePath(
+  oldPath: string,
+  newName: string
+): string {
+  let newPath = newName;
+
+  // Ensure the `.chat` extension.
+  if (!newPath.endsWith(chatFileType.extensions[0])) {
+    newPath = `${newPath}${chatFileType.extensions[0]}`;
+  }
+
+  // Bare basename (no separator) -> keep it in the original file's directory.
+  // An explicit directory in `newName` is respected as-is.
+  if (!newPath.includes('/')) {
+    newPath = PathExt.join(PathExt.dirname(oldPath), newPath);
+  }
+
+  return newPath;
+}

package/src/widget.tsx

@@ -23,6 +23,11 @@ export class LabChatPanel
     this.addClass(MAIN_PANEL_CLASS);
     this.model.name = this.context.localPath;
     this.model.unreadChanged.connect(this._unreadChanged);
+    // The context is ready once the document content has been loaded, which is
+    // when the chat can be given an ID and become usable.
+    this.context.ready
+      .then(() => this.model.markDocumentSynced())
+      .catch(e => console.error('The chat document failed to load', e));
   }
 
   /**