[v3] Various chat handler and usability issues in the current `jupyterlab-chat`

[srdas]

References PR #1290

[1] When closing a chat session, a websocket error is thrown, shown in the log:

[I 2025-03-25 13:09:24.720 ServerApp] Saving the content from room text:chat:49f07d46-142c-4549-adee-b6c45d2c751e
[I 2025-03-25 13:09:24.722 YDocExtension] Saving file: sd3.chat
[E 2025-03-25 13:09:32.271 ServerApp] Failed to write message
    Traceback (most recent call last):
      File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/jupyter_server_ydoc/handlers.py", line 278, in send
        self.write_message(message, binary=True)
      File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/tornado/websocket.py", line 332, in write_message
        raise WebSocketClosedError()
    tornado.websocket.WebSocketClosedError

[2] Re-using an existing prompt fails to get a response, and throws the following error:

[E 2025-03-25 13:16:34.735 ServerApp] Document Room Exception, (room_id=text:chat:adc2cfd5-df21-4b80-bf12-ab18569413fb):
      + Exception Group Traceback (most recent call last):
      |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt_websocket/yroom.py", line 259, in serve
      |     async with create_task_group() as tg:
      |                ^^^^^^^^^^^^^^^^^^^
      |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/anyio/_backends/_asyncio.py", line 772, in __aexit__
      |     raise BaseExceptionGroup(
      | ExceptionGroup: unhandled errors in a TaskGroup (1 sub-exception)
      +-+---------------- 1 ----------------
        | Traceback (most recent call last):
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt/_base.py", line 198, in observe_callback
        |     callback(*params[:param_nb])  # type: ignore[arg-type]
        |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        |   File "/Users/sanjivda/GitHub/jupyter-ai/packages/jupyter-ai/jupyter_ai/extension.py", line 302, in on_change
        |     message = Message(**message_dict)
        |               ^^^^^^^^^^^^^^^^^^^^^^^
        | TypeError: Message.__init__() got an unexpected keyword argument 'attachments'
        | 
        | The above exception was the direct cause of the following exception:
        | 
        | Traceback (most recent call last):
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt/_base.py", line 194, in observe_callback
        |     param_nb = count_parameters(callback)
        |                ^^^^^^^^^^^^^^^^^^^^^^^^^^
        | SystemError: <functools._lru_cache_wrapper object at 0x1063a4f60> returned a result with an exception set
        | 
        | The above exception was the direct cause of the following exception:
        | 
        | Traceback (most recent call last):
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt/_base.py", line 194, in observe_callback
        |     param_nb = count_parameters(callback)
        |                ^^^^^^^^^^^^^^^^^^^^^^^^^^
        | SystemError: <functools._lru_cache_wrapper object at 0x1063a4f60> returned a result with an exception set
        | 
        | The above exception was the direct cause of the following exception:
        | 
        | SystemError: <function put_updates at 0x113f8b880> returned a result with an exception set
        | 
        | The above exception was the direct cause of the following exception:
        | 
        | Traceback (most recent call last):
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt_websocket/yroom.py", line 286, in serve
        |     reply = handle_sync_message(message[1:], self.ydoc)
        |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt/_sync.py", line 299, in handle_sync_message
        |     ydoc.apply_update(update)
        |   File "/opt/anaconda3/envs/v3/lib/python3.12/site-packages/pycrdt/_doc.py", line 163, in apply_update
        |     with self.transaction() as txn:
        |          ^^^^^^^^^^^^^^^^^^
        | SystemError: <function Transaction.__exit__ at 0x10646c040> returned a result with an exception set
        +------------------------------------

[3] Message attachments working for files but not folders:

[4] After attaching a file, and issuing a question, there is no response?

(This is all known and this issue is being opened for tracking purposes.)

[brichet]

[2] Re-using an existing prompt fails to get a response, and throws the following error:

@srdas can you provide more information about this issue and how to reproduce ? What do you mean by "Re-using an existing prompt" ?

[srdas]

[2] Re-using an existing prompt fails to get a response, and throws the following error:

@srdas can you provide more information about this issue and how to reproduce ? What do you mean by "Re-using an existing prompt" ?

@brichet Here is a small recording with the error. Editing or reusing an old prompt does not elicit a response.

Screen.Recording.2025-03-31.at.8.42.12.AM.mov

[brichet]

Thanks. The first issue we can see in the recording is that editing a message replaces the next one in UI. This should be fixed by jupyterlab/jupyter-chat#194, if you want to take a look that would be wonderful.

How do you think the message editing response should work? Should it edit its own previous response, or create a new message and mark the previous as outdated ?

[brichet]

Fixing [4]
There is an error when trying to fetch message history from server side, with messages having attachments. This is because of the missing attachments property in the Message model.
It leads to TypeError: Message.__init__() got an unexpected keyword argument 'attachments' in the console (and the response ?).
I opened jupyterlab/jupyter-chat#200 to fix it.

EDIT: actually it seems to also fix [2], because edited messages had an additional attachments properties (event if there was no attachment), and the server was not yet able to properly handle these attachments. Event if it is fixed server side, the PR also avoid adding empty attachments list when editing a message.

[dlqqq]

@srdas @brichet Hey team, I think it would be better to split this issue into separate ones first before proceeding further. Talking about multiple different issues in the same thread can become hard to follow over time.

For the issues described here,

• 1 & 2: @srdas Can you help open new issues for these?
• 3: I've opened: [v3.x.x] Support attaching directories #1300.
  • I do not think we have planned out the intended behavior for when a user attaches a directory. For now, I think we can defer support for this until after v3.0.0.
• 4: I've opened: [v3-beta] Read message attachments in backend #1299

[dlqqq]

@brichet

How do you think the message editing response should work? Should it edit its own previous response, or create a new message and mark the previous as outdated ?

I don't think we have a good answer for this right now, but we could take inspiration from ChatGPT's UI on editing messages. Check out Mike's screenshot here: #813 (comment)

[srdas]

@dlqqq As suggested, I will break [1] and [2] out into separate issues and cross-reference everything accordingly.
@brichet Thanks for the update and the reference to jupyterlab/jupyter-chat#194, I will make sure to reference it and try it as well.