Add test and changeset for onFinal callback fix (#985)

vercel · Feb 20, 2024 · 141f0ce · 141f0ce
1 parent 4afa012
commit 141f0ce
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/.changeset/ten-sloths-perform.md b/.changeset/ten-sloths-perform.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+Fix: onFinal callback is invoked with text from onToolCall when onToolCall returns string
diff --git a/packages/core/streams/openai-stream.test.ts b/packages/core/streams/openai-stream.test.ts
@@ -353,6 +353,25 @@ describe('OpenAIStream', () => {
         ],
       });
     });
+
+    it('should call onFinal with tool response when onToolCall returns string', async () => {
+      let finalResponse: any = undefined;
+
+      const stream = OpenAIStream(await fetch(TOOL_CALL_TEST_URL), {
+        async experimental_onToolCall(payload, appendToolCallMessage) {
+          return 'tool-response';
+        },
+
+        onFinal(response) {
+          finalResponse = response;
+        },
+      });
+
+      const response = new StreamingTextResponse(stream);
+      await createClient(response).readAll(); // consume stream
+
+      expect(finalResponse).toEqual('tool-response');
+    });
   });
 
   describe('Azure SDK', () => {