wip: handles error in stream test

Author: amychisholm03

test/versioned/openai/chat-completions-v5.test.js

@@ -408,6 +408,48 @@ test('responses.create', async (t) => {
     })
   })
 
+  await t.test('handles error in stream', (t, end) => {
+    const { client, agent } = t.nr
+    helper.runInTransaction(agent, async (tx) => {
+      const content = 'bad stream'
+      const model = 'gpt-4'
+
+      try {
+        const stream = await client.responses.create({
+          max_tokens: 100,
+          temperature: 0.5,
+          model,
+          input: [
+            { role: 'user', content },
+            { role: 'user', content: 'What does 1 plus 1 equal?' }
+          ],
+          stream: true
+        })
+        for await (const chunk of stream) {
+          continue
+        }
+      } catch (err) {
+        assert.ok(err.message, 'exceeded count')
+        const events = agent.customEventAggregator.events.toArray()
+        assert.equal(events.length, 4)
+        const chatSummary = events.filter(([{ type }]) => type === 'LlmChatCompletionSummary')[0]
+        assertChatCompletionSummary({ tx, model, chatSummary, error: true })
+        assert.equal(tx.exceptions.length, 1)
+        // only asserting message and completion_id as the rest of the attrs
+        // are asserted in other tests
+        match(tx.exceptions[0], {
+          customAttributes: {
+            'error.message': /terminated|Premature close/,
+            completion_id: /\w{32}/
+          }
+        })
+
+        tx.end()
+        end()
+      }
+    })
+  })
+
   await t.test('should not create llm events when ai_monitoring.streaming.enabled is false', (t, end) => {
     const { client, agent } = t.nr
     agent.config.ai_monitoring.streaming.enabled = false

test/versioned/openai/mock-server-v5.js

@@ -9,7 +9,7 @@ module.exports = openaiMockServer
 
 const http = require('node:http')
 const RESPONSES = require('./mock-responses-api-responses')
-const STREAM_CHUNKS = require('./stream-chunks-v5')
+const { chunks, errorChunk } = require('./stream-chunks-v5')
 const { Readable } = require('node:stream')
 
 /**
@@ -79,11 +79,7 @@ function handler(req, res) {
       } else {
         outStream = new Readable({
           read() {
-            for (let i = 0; i < STREAM_CHUNKS.length; i++) {
-              const chunkString = JSON.stringify(STREAM_CHUNKS[i])
-              this.push(`data: ${chunkString}\n\n`)
-              // TODO: send an error chunk instead
-            }
+            this.push(`data: ${JSON.stringify(errorChunk)}\n\n`)
             this.push('data: [DONE]\n\n')
             this.push(null)
           }
@@ -109,8 +105,8 @@ function finiteStream() {
   return new Readable({
     read() {
       // This is how the data is streamed from openai
-      for (let i = 0; i < STREAM_CHUNKS.length; i++) {
-        const chunkString = JSON.stringify(STREAM_CHUNKS[i])
+      for (let i = 0; i < chunks.length; i++) {
+        const chunkString = JSON.stringify(chunks[i])
         this.push(`data: ${chunkString}\n\n`)
       }
       this.push('data: [DONE]\n\n')

test/versioned/openai/stream-chunks-v5.js

@@ -5,9 +5,19 @@
 
 'use strict'
 
-const chunks = []
-module.exports = chunks
+const errorChunk = {
+  response: {
+    message: 'fetch failed',
+    stack: 'TypeError: fetch failed',
+    cause: {
+      code: 'BAD_STREAM',
+      reason: 'internal error',
+      library: 'opeani',
+    }
+  }
+}
 
+const chunks = []
 // Setup chunks
 chunks.push({
   response: {
@@ -139,3 +149,5 @@ chunks.push({
   sequence_number: 9,
   type: 'response_completed',
 })
+
+module.exports = { chunks, errorChunk }