fix bug with None in copilot ws messages (#530)

updates

Signed-off-by: Jessie Frazelle <github@jessfraz.com>

Author: jessfraz

generate/templates/__init__.py.jinja2

@@ -147,15 +147,15 @@ class WebSocket{{ func_name|to_pascal_case }}:
         {% if func_info.ws_request_is_dict %}
         self.ws.send(json.dumps(data))
         {% else %}
-        self.ws.send(json.dumps(data.model_dump()))
+        self.ws.send(json.dumps(data.model_dump(exclude_none=True)))
         {% endif %}
 
     def send_binary(self, data: {{ func_info.ws_request_type }}):
         """Send data as bson to the websocket."""
         {% if func_info.ws_request_is_dict %}
         self.ws.send(bson.encode(data))
         {% else %}
-        self.ws.send(bson.encode(data.model_dump()))
+        self.ws.send(bson.encode(data.model_dump(exclude_none=True)))
         {% endif %}
 
     def recv(self) -> {{ func_info.ws_response_type }}:

kittycad/__init__.py

@@ -12247,12 +12247,12 @@ def __iter__(self):
     def send(self, data: MlCopilotClientMessage):
         """Send data to the websocket."""
 
-        self.ws.send(json.dumps(data.model_dump()))
+        self.ws.send(json.dumps(data.model_dump(exclude_none=True)))
 
     def send_binary(self, data: MlCopilotClientMessage):
         """Send data as bson to the websocket."""
 
-        self.ws.send(bson.encode(data.model_dump()))
+        self.ws.send(bson.encode(data.model_dump(exclude_none=True)))
 
     def recv(self) -> MlCopilotServerMessage:
         """Receive data from the websocket."""
@@ -12317,12 +12317,12 @@ def __iter__(self):
     def send(self, data: MlCopilotClientMessage):
         """Send data to the websocket."""
 
-        self.ws.send(json.dumps(data.model_dump()))
+        self.ws.send(json.dumps(data.model_dump(exclude_none=True)))
 
     def send_binary(self, data: MlCopilotClientMessage):
         """Send data as bson to the websocket."""
 
-        self.ws.send(bson.encode(data.model_dump()))
+        self.ws.send(bson.encode(data.model_dump(exclude_none=True)))
 
     def recv(self) -> MlCopilotServerMessage:
         """Receive data from the websocket."""
@@ -12525,12 +12525,12 @@ def __iter__(self):
     def send(self, data: WebSocketRequest):
         """Send data to the websocket."""
 
-        self.ws.send(json.dumps(data.model_dump()))
+        self.ws.send(json.dumps(data.model_dump(exclude_none=True)))
 
     def send_binary(self, data: WebSocketRequest):
         """Send data as bson to the websocket."""
 
-        self.ws.send(bson.encode(data.model_dump()))
+        self.ws.send(bson.encode(data.model_dump(exclude_none=True)))
 
     def recv(self) -> WebSocketResponse:
         """Receive data from the websocket."""

kittycad/tests/test_ml_copilot_ws_regression.py

@@ -0,0 +1,53 @@
+import os
+
+import pytest
+
+from kittycad import KittyCAD
+from kittycad.models import MlCopilotClientMessage
+from kittycad.models.ml_copilot_client_message import OptionUser
+from kittycad.models.ml_copilot_server_message import (
+    ConversationId,
+    Delta,
+    EndOfStream,
+    Error,
+)
+
+
+def test_ml_copilot_ws_round_trip() -> None:
+    token = os.getenv("KITTYCAD_API_TOKEN")
+    if not token:
+        pytest.skip("requires KITTYCAD_API_TOKEN")
+
+    client = KittyCAD()
+    client.headers["Cache-Control"] = "no-cache"
+
+    prompt = "Explain why reliable CAD tooling matters in one sentence."
+
+    with client.ml.ml_copilot_ws(conversation_id=None, replay=None) as websocket:
+        websocket.send(MlCopilotClientMessage(OptionUser(content=prompt)))
+
+        deltas: list[str] = []
+        conversation_id: str | None = None
+        end_of_stream = False
+
+        for _ in range(200):
+            message = websocket.recv()
+            root = message.root
+
+            if isinstance(root, ConversationId):
+                conversation_id = root.conversation_id
+            elif isinstance(root, Delta):
+                deltas.append(root.delta)
+            elif isinstance(root, EndOfStream):
+                end_of_stream = True
+                break
+            elif isinstance(root, Error):
+                pytest.fail(f"ml_copilot_ws returned error: {root.detail}")
+        else:
+            pytest.fail("ml_copilot_ws did not emit EndOfStream within 200 messages")
+
+    response_text = "".join(deltas).strip()
+
+    assert conversation_id, "Expected ConversationId message from ml_copilot_ws"
+    assert end_of_stream, "Expected EndOfStream message from ml_copilot_ws"
+    assert response_text, "Expected non-empty streamed response from ml_copilot_ws"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "kittycad"
-version = "1.2.6"
+version = "1.2.7"
 description = "A client library for accessing KittyCAD"
 authors = []
 readme = "README.md"