From bd1ab115ecc73bbb257937c66fd52218fd265086 Mon Sep 17 00:00:00 2001
From: Jon Saad-Falcon <41205309+jonsaadfalcon@users.noreply.github.com>
Date: Mon, 1 Jun 2026 10:11:53 -0700
Subject: [PATCH] fix(engine): convert apple_fm_shim cumulative snapshots to
 deltas (#464)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Apple FM's stream_response yields cumulative text snapshots, but
OpenAI-compatible clients concatenate delta.content — so streamed
responses were duplicated/stuttered (#378). Diff each snapshot against
the last and emit only the incremental suffix; fall back to the full
snapshot if the model revises earlier text, and skip empty deltas.

Rebased on #377 (apple_fm_sdk migration): uses the options= streaming
API. Adds a stubbed-SDK regression test asserting deltas are
incremental, not cumulative.

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 src/openjarvis/engine/apple_fm_shim.py | 17 ++++++++++--
 tests/engine/test_apple_fm_shim.py     | 36 ++++++++++++++++++++++++++
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/src/openjarvis/engine/apple_fm_shim.py b/src/openjarvis/engine/apple_fm_shim.py
index 49941a5d..9f2acee8 100644
--- a/src/openjarvis/engine/apple_fm_shim.py
+++ b/src/openjarvis/engine/apple_fm_shim.py
@@ -128,10 +128,23 @@ async def chat_completions(
 
         async def generate():
             cid = f"chatcmpl-{uuid.uuid4().hex[:12]}"
-            async for token in session.stream_response(
+            # Apple FM yields cumulative snapshots, OpenAI clients expect
+            # incremental deltas — diff against the last snapshot to convert
+            # (see #378).
+            sent = ""
+            async for snapshot in session.stream_response(
                 prompt,
                 options=options,
             ):
+                if not snapshot.startswith(sent):
+                    # Snapshot diverged (model revised earlier text);
+                    # fall back to resending the full snapshot.
+                    delta = snapshot
+                else:
+                    delta = snapshot[len(sent) :]
+                sent = snapshot
+                if not delta:
+                    continue
                 chunk = {
                     "id": cid,
                     "object": "chat.completion.chunk",
@@ -140,7 +153,7 @@ async def chat_completions(
                     "choices": [
                         {
                             "index": 0,
-                            "delta": {"content": token},
+                            "delta": {"content": delta},
                             "finish_reason": None,
                         }
                     ],
diff --git a/tests/engine/test_apple_fm_shim.py b/tests/engine/test_apple_fm_shim.py
index afd43a67..8d8447cc 100644
--- a/tests/engine/test_apple_fm_shim.py
+++ b/tests/engine/test_apple_fm_shim.py
@@ -118,6 +118,42 @@ class TestAppleFmShimSdkMigration:
         assert rec["stream_calls"][-1]["options"] is rec["options"][-1]
         assert "data: [DONE]" in body
 
+    def test_stream_emits_incremental_deltas_from_cumulative_snapshots(self, shim):
+        """Regression for #378.
+
+        Apple FM's stream_response yields CUMULATIVE text snapshots, but
+        OpenAI clients concatenate delta.content. The shim must emit the
+        incremental suffix per chunk, so concatenating the deltas
+        reconstructs the final snapshot exactly — with no duplicated or
+        dropped characters.
+        """
+        import json as _json
+
+        mod, rec = shim  # fixture streams ["Sure! ", "Sure! The ", "Sure! The answer."]
+        client = TestClient(mod.app)
+        with client.stream(
+            "POST",
+            "/v1/chat/completions",
+            json={"messages": [{"role": "user", "content": "hi"}], "stream": True},
+        ) as resp:
+            assert resp.status_code == 200
+            body = "".join(resp.iter_text())
+
+        # Collect content deltas from the SSE chunks.
+        deltas: list[str] = []
+        for line in body.splitlines():
+            if not line.startswith("data:") or "[DONE]" in line:
+                continue
+            payload = _json.loads(line[len("data:") :].strip())
+            content = payload["choices"][0]["delta"].get("content")
+            if content:
+                deltas.append(content)
+
+        # Incremental, not cumulative: concatenation equals the final
+        # snapshot, and no single delta repeats the whole prefix.
+        assert "".join(deltas) == "Sure! The answer."
+        assert deltas == ["Sure! ", "The ", "answer."]
+
     def test_health_unpacks_is_available_tuple(self, monkeypatch):
         monkeypatch.setattr(platform, "system", lambda: "Darwin")
         rec = _install_stub_sdk(available=(False, "Apple Intelligence disabled"))