quick refactor

Author: RulaKhaled

dev-packages/node-integration-tests/suites/tracing/openai/scenario.mjs

@@ -222,7 +222,7 @@ class MockOpenAI {
         user: null,
         metadata: {},
         output: [],
-        output_text: `Streaming response to: ${params.input}`,
+        output_text: params.input,
         usage: {
           input_tokens: 6,
           output_tokens: 10,

dev-packages/node-integration-tests/suites/tracing/openai/test.ts

@@ -84,7 +84,7 @@ describe('OpenAI integration', () => {
           'gen_ai.request.stream': true,
           'gen_ai.response.model': 'gpt-4',
           'gen_ai.response.id': 'chatcmpl-stream-123',
-          'gen_ai.response.finish_reasons': 'stop',
+          'gen_ai.response.finish_reasons': '["stop"]',
           'gen_ai.usage.input_tokens': 12,
           'gen_ai.usage.output_tokens': 18,
           'gen_ai.usage.total_tokens': 30,
@@ -110,7 +110,7 @@ describe('OpenAI integration', () => {
           'gen_ai.request.stream': true,
           'gen_ai.response.model': 'gpt-4',
           'gen_ai.response.id': 'resp_stream_456',
-          'gen_ai.response.finish_reasons': 'in_progress',
+          'gen_ai.response.finish_reasons': '["in_progress"]',
           'gen_ai.usage.input_tokens': 0,
           'gen_ai.usage.output_tokens': 0,
           'gen_ai.usage.total_tokens': 0,
@@ -210,9 +210,10 @@ describe('OpenAI integration', () => {
           'gen_ai.request.model': 'gpt-4',
           'gen_ai.request.temperature': 0.8,
           'gen_ai.request.stream': true,
-          'gen_ai.request.messages': expect.stringContaining('Tell me about streaming'),
+          'gen_ai.request.messages':
+            '[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":"Tell me about streaming"}]',
           'gen_ai.response.text': 'Hello from OpenAI streaming!',
-          'gen_ai.response.finish_reasons': 'stop',
+          'gen_ai.response.finish_reasons': '["stop"]',
           'gen_ai.response.id': 'chatcmpl-stream-123',
           'gen_ai.response.model': 'gpt-4',
           'gen_ai.usage.input_tokens': 12,
@@ -240,8 +241,8 @@ describe('OpenAI integration', () => {
           'gen_ai.request.model': 'gpt-4',
           'gen_ai.request.stream': true,
           'gen_ai.request.messages': '"Test streaming responses API"',
-          'gen_ai.response.text': expect.stringContaining('Streaming response to: Test streaming responses API'),
-          'gen_ai.response.finish_reasons': 'completed',
+          'gen_ai.response.text': 'Streaming response to: Test streaming responses APITest streaming responses API',
+          'gen_ai.response.finish_reasons': '["in_progress","completed"]',
           'gen_ai.response.id': 'resp_stream_456',
           'gen_ai.response.model': 'gpt-4',
           'gen_ai.usage.input_tokens': 6,
@@ -265,7 +266,7 @@ describe('OpenAI integration', () => {
           'gen_ai.operation.name': 'chat',
           'gen_ai.request.model': 'error-model',
           'gen_ai.request.stream': true,
-          'gen_ai.request.messages': expect.stringContaining('This will fail'),
+          'gen_ai.request.messages': '[{"role":"user","content":"This will fail"}]',
           'gen_ai.system': 'openai',
           'openai.response.stream': true,
           'sentry.op': 'gen_ai.chat',

packages/core/src/utils/openai/streaming.ts

@@ -124,7 +124,7 @@ export async function* instrumentStream<T>(
 
     if (state.finishReasons.length) {
       span.setAttributes({
-        [GEN_AI_RESPONSE_FINISH_REASONS_ATTRIBUTE]: state.finishReasons[state.finishReasons.length - 1],
+        [GEN_AI_RESPONSE_FINISH_REASONS_ATTRIBUTE]: JSON.stringify(state.finishReasons),
       });
     }
 

packages/core/src/utils/openai/utils.ts

@@ -13,7 +13,13 @@ import {
   OPENAI_USAGE_PROMPT_TOKENS_ATTRIBUTE,
 } from '../gen-ai-attributes';
 import { INSTRUMENTED_METHODS } from './constants';
-import type { InstrumentedMethod, OpenAiChatCompletionObject, OpenAIResponseObject } from './types';
+import type {
+  ChatCompletionChunk,
+  InstrumentedMethod,
+  OpenAiChatCompletionObject,
+  OpenAIResponseObject,
+  ResponseStreamingEvent,
+} from './types';
 
 /**
  * Maps OpenAI method paths to Sentry operation names
@@ -78,7 +84,7 @@ export function isResponsesApiResponse(response: unknown): response is OpenAIRes
 /**
  * Check if streaming event is from the Responses API
  */
-export function isResponsesApiStreamEvent(event: unknown): boolean {
+export function isResponsesApiStreamEvent(event: unknown): event is ResponseStreamingEvent {
   return (
     event !== null &&
     typeof event === 'object' &&
@@ -91,7 +97,7 @@ export function isResponsesApiStreamEvent(event: unknown): boolean {
 /**
  * Check if streaming event is a chat completion chunk
  */
-export function isChatCompletionChunk(event: unknown): boolean {
+export function isChatCompletionChunk(event: unknown): event is ChatCompletionChunk {
   return (
     event !== null &&
     typeof event === 'object' &&