@jupyter/chat 0.25.0-alpha.6 → 0.25.0-rc.0

package/lib/__tests__/writers.spec.js

@@ -35,18 +35,16 @@ describe('writers state', () => {
         model.setWritingStatus(userA, { typingIndicator: 'x' });
         expect(changes.length).toBe(count);
     });
-    it('auto-clears a writer after the timeout unless refreshed', () => {
+    it('keeps a writer until it is explicitly cleared (no auto-expiry)', () => {
         jest.useFakeTimers();
         try {
-            model.setWritingStatus(userA, undefined, 2000);
+            model.setWritingStatus(userA);
             expect(model.writers).toHaveLength(1);
-            // Refresh before expiry keeps it alive.
-            jest.advanceTimersByTime(1500);
-            model.setWritingStatus(userA, undefined, 2000);
-            jest.advanceTimersByTime(1500);
+            // A single call persists like any other update: no timer drops it.
+            jest.advanceTimersByTime(60000);
             expect(model.writers).toHaveLength(1);
-            // No refresh -> auto-cleared after the timeout (the WS anti-stuck path).
-            jest.advanceTimersByTime(2000);
+            // Only an explicit clear removes it.
+            model.clearWritingStatus(userA);
             expect(model.writers).toHaveLength(0);
         }
         finally {

package/lib/model.d.ts

@@ -169,14 +169,14 @@ export interface IChatModel extends IDisposable {
     /**
      * Mark a user as currently writing (add or update their writer entry).
      *
+     * The writer stays until explicitly removed via {@link clearWritingStatus}
+     * (or replaced by a new snapshot in {@link updateWriters}); there is no
+     * auto-expiry, so a single call persists like any other update.
+     *
      * @param user - the writing user.
      * @param status - optional writing status (messageID, custom typingIndicator).
-     * @param timeout - optional auto-clear delay in ms. When set, the user is
-     *   automatically cleared after `timeout` unless refreshed by another call.
-     *   Used by transports without their own liveness signal (e.g. WebSocket) to
-     *   avoid a stuck "is typing" if a clear message is never received.
      */
-    setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus, timeout?: number): void;
+    setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus): void;
     /**
      * Remove a user from the writers list.
      */
@@ -184,7 +184,7 @@ export interface IChatModel extends IDisposable {
     /**
      * Broadcast the *current user's* writing status to other clients, or clear it
      * with `null`. Implemented per transport (RTC sets awareness; WebSocket sends
-     * a periodic writing frame). Default implementation is a no-op.
+     * a single writing frame). Default implementation is a no-op.
      */
     broadcastWritingStatus(status: IChatModel.IWritingStatus | null): void;
     /**
@@ -375,7 +375,7 @@ export declare abstract class AbstractChatModel implements IChatModel {
     /**
      * Mark a user as currently writing. See IChatModel.setWritingStatus.
      */
-    setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus, timeout?: number): void;
+    setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus): void;
     /**
      * Remove a user from the writers list. See IChatModel.clearWritingStatus.
      */
@@ -386,8 +386,6 @@ export declare abstract class AbstractChatModel implements IChatModel {
      */
     broadcastWritingStatus(_status: IChatModel.IWritingStatus | null): void;
     private _removeWriter;
-    private _clearWriterTimer;
-    private _clearAllWriterTimers;
     /**
      * Create the chat context that will be passed to the input model.
      */
@@ -438,7 +436,6 @@ export declare abstract class AbstractChatModel implements IChatModel {
     private _documentManager;
     private _notificationId;
     private _writers;
-    private _writerTimers;
     private _messageEditions;
     private _messagesUpdated;
     private _messageChanged;

package/lib/model.js

@@ -30,7 +30,6 @@ export class AbstractChatModel {
         this._isDisposed = false;
         this._notificationId = null;
         this._writers = new Map();
-        this._writerTimers = new Map();
         this._messageEditions = new Map();
         this._messagesUpdated = new Signal(this);
         this._messageChanged = new Signal(this);
@@ -402,9 +401,7 @@ export class AbstractChatModel {
      */
     updateWriters(writers) {
         // Reconcile the writers map with the provided snapshot (used by
-        // snapshot-style transports such as RTC awareness). Any auto-clear timers
-        // are dropped, since the snapshot is authoritative.
-        this._clearAllWriterTimers();
+        // snapshot-style transports such as RTC awareness).
         const next = new Map();
         for (const writer of writers) {
             next.set(writer.user.username, writer);
@@ -417,16 +414,12 @@ export class AbstractChatModel {
     /**
      * Mark a user as currently writing. See IChatModel.setWritingStatus.
      */
-    setWritingStatus(user, status, timeout) {
+    setWritingStatus(user, status) {
         const writer = {
             user,
             messageID: status === null || status === void 0 ? void 0 : status.messageID,
             typingIndicator: status === null || status === void 0 ? void 0 : status.typingIndicator
         };
-        this._clearWriterTimer(user.username);
-        if (timeout !== undefined) {
-            this._writerTimers.set(user.username, window.setTimeout(() => this._removeWriter(user.username), timeout));
-        }
         const previous = this._writers.get(user.username);
         this._writers.set(user.username, writer);
         if (!previous || !Private.writerEqual(previous, writer)) {
@@ -447,24 +440,10 @@ export class AbstractChatModel {
         // no-op by default
     }
     _removeWriter(username) {
-        this._clearWriterTimer(username);
         if (this._writers.delete(username)) {
             this._writersChanged.emit(this.writers);
         }
     }
-    _clearWriterTimer(username) {
-        const timer = this._writerTimers.get(username);
-        if (timer !== undefined) {
-            window.clearTimeout(timer);
-            this._writerTimers.delete(username);
-        }
-    }
-    _clearAllWriterTimers() {
-        for (const timer of this._writerTimers.values()) {
-            window.clearTimeout(timer);
-        }
-        this._writerTimers.clear();
-    }
     /**
      * Get the input model of the edited message, given its id.
      */

package/package.json

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

package/src/__tests__/writers.spec.ts

@@ -47,20 +47,18 @@ describe('writers state', () => {
     expect(changes.length).toBe(count);
   });
 
-  it('auto-clears a writer after the timeout unless refreshed', () => {
+  it('keeps a writer until it is explicitly cleared (no auto-expiry)', () => {
     jest.useFakeTimers();
     try {
-      model.setWritingStatus(userA, undefined, 2000);
+      model.setWritingStatus(userA);
       expect(model.writers).toHaveLength(1);
 
-      // Refresh before expiry keeps it alive.
-      jest.advanceTimersByTime(1500);
-      model.setWritingStatus(userA, undefined, 2000);
-      jest.advanceTimersByTime(1500);
+      // A single call persists like any other update: no timer drops it.
+      jest.advanceTimersByTime(60_000);
       expect(model.writers).toHaveLength(1);
 
-      // No refresh -> auto-cleared after the timeout (the WS anti-stuck path).
-      jest.advanceTimersByTime(2000);
+      // Only an explicit clear removes it.
+      model.clearWritingStatus(userA);
       expect(model.writers).toHaveLength(0);
     } finally {
       jest.useRealTimers();

package/src/model.ts

@@ -226,18 +226,14 @@ export interface IChatModel extends IDisposable {
   /**
    * Mark a user as currently writing (add or update their writer entry).
    *
+   * The writer stays until explicitly removed via {@link clearWritingStatus}
+   * (or replaced by a new snapshot in {@link updateWriters}); there is no
+   * auto-expiry, so a single call persists like any other update.
+   *
    * @param user - the writing user.
    * @param status - optional writing status (messageID, custom typingIndicator).
-   * @param timeout - optional auto-clear delay in ms. When set, the user is
-   *   automatically cleared after `timeout` unless refreshed by another call.
-   *   Used by transports without their own liveness signal (e.g. WebSocket) to
-   *   avoid a stuck "is typing" if a clear message is never received.
    */
-  setWritingStatus(
-    user: IUser,
-    status?: IChatModel.IWritingStatus,
-    timeout?: number
-  ): void;
+  setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus): void;
 
   /**
    * Remove a user from the writers list.
@@ -247,7 +243,7 @@ export interface IChatModel extends IDisposable {
   /**
    * Broadcast the *current user's* writing status to other clients, or clear it
    * with `null`. Implemented per transport (RTC sets awareness; WebSocket sends
-   * a periodic writing frame). Default implementation is a no-op.
+   * a single writing frame). Default implementation is a no-op.
    */
   broadcastWritingStatus(status: IChatModel.IWritingStatus | null): void;
 
@@ -722,9 +718,7 @@ export abstract class AbstractChatModel implements IChatModel {
    */
   updateWriters(writers: IChatModel.IWriter[]): void {
     // Reconcile the writers map with the provided snapshot (used by
-    // snapshot-style transports such as RTC awareness). Any auto-clear timers
-    // are dropped, since the snapshot is authoritative.
-    this._clearAllWriterTimers();
+    // snapshot-style transports such as RTC awareness).
     const next = new Map<string, IChatModel.IWriter>();
     for (const writer of writers) {
       next.set(writer.user.username, writer);
@@ -738,23 +732,12 @@ export abstract class AbstractChatModel implements IChatModel {
   /**
    * Mark a user as currently writing. See IChatModel.setWritingStatus.
    */
-  setWritingStatus(
-    user: IUser,
-    status?: IChatModel.IWritingStatus,
-    timeout?: number
-  ): void {
+  setWritingStatus(user: IUser, status?: IChatModel.IWritingStatus): void {
     const writer: IChatModel.IWriter = {
       user,
       messageID: status?.messageID,
       typingIndicator: status?.typingIndicator
     };
-    this._clearWriterTimer(user.username);
-    if (timeout !== undefined) {
-      this._writerTimers.set(
-        user.username,
-        window.setTimeout(() => this._removeWriter(user.username), timeout)
-      );
-    }
     const previous = this._writers.get(user.username);
     this._writers.set(user.username, writer);
     if (!previous || !Private.writerEqual(previous, writer)) {
@@ -778,27 +761,11 @@ export abstract class AbstractChatModel implements IChatModel {
   }
 
   private _removeWriter(username: string): void {
-    this._clearWriterTimer(username);
     if (this._writers.delete(username)) {
       this._writersChanged.emit(this.writers);
     }
   }
 
-  private _clearWriterTimer(username: string): void {
-    const timer = this._writerTimers.get(username);
-    if (timer !== undefined) {
-      window.clearTimeout(timer);
-      this._writerTimers.delete(username);
-    }
-  }
-
-  private _clearAllWriterTimers(): void {
-    for (const timer of this._writerTimers.values()) {
-      window.clearTimeout(timer);
-    }
-    this._writerTimers.clear();
-  }
-
   /**
    * Create the chat context that will be passed to the input model.
    */
@@ -914,7 +881,6 @@ export abstract class AbstractChatModel implements IChatModel {
   private _documentManager: IDocumentManager | null;
   private _notificationId: string | null = null;
   private _writers = new Map<string, IChatModel.IWriter>();
-  private _writerTimers = new Map<string, number>();
   private _messageEditions = new Map<string, IInputModel>();
   private _messagesUpdated = new Signal<IChatModel, void>(this);
   private _messageChanged = new Signal<IChatModel, IMessage>(this);