An AI-powered search engine with a generative UI
TypeScript generative-aigenerative-uinextjsollamareactsearxngshadcn-uitailwindcsstavilytypescriptupstashvercel-ai-sdk
fix(streaming): mark the research span when the answer is empty (#937)
Yoshiki Miurabe0a38eb1d4e
diff --git a/lib/streaming/__tests__/create-ephemeral-chat-stream-response.test.ts b/lib/streaming/__tests__/create-ephemeral-chat-stream-response.test.tsindex f5e83cde..c84fe08e 100644--- a/lib/streaming/__tests__/create-ephemeral-chat-stream-response.test.ts+++ b/lib/streaming/__tests__/create-ephemeral-chat-stream-response.test.ts@@ -50,6 +50,7 @@ vi.mock('@/lib/utils/usage-logging', () => ({import { serializePublicError } from '@/lib/errors/public-error'import { createEphemeralChatStreamResponse } from '@/lib/streaming/create-ephemeral-chat-stream-response'import { describeStreamError } from '@/lib/streaming/helpers/describe-stream-error'+import { EMPTY_RESPONSE_STATUS_MESSAGE } from '@/lib/streaming/helpers/is-empty-response'type StreamOptions = {onError: (event: { error: unknown }) => void@@ -57,10 +58,25 @@ type StreamOptions = {type UIMessageStreamResponseOptions = {onError: (error: unknown) => string- onFinish: () => Promise<void>+ onFinish: (event: {+ responseMessage: {+ id: string+ role: 'assistant'+ parts: Array<{ type: string; text?: string }>+ }+ isAborted: boolean+ }) => Promise<void>}-function createFakeResult(toolError?: unknown) {+function createFakeResult({+ toolError,+ parts = [{ type: 'text', text: 'Answer' }],+ isAborted = false+}: {+ toolError?: unknown+ parts?: Array<{ type: string; text?: string }>+ isAborted?: boolean+} = {}) {return {consumeStream: vi.fn(),toUIMessageStreamResponse: vi.fn(@@ -68,7 +84,14 @@ function createFakeResult(toolError?: unknown) {if (toolError) {mocks.serializedError = options.onError(toolError)}- mocks.finishPromise = options.onFinish()+ mocks.finishPromise = options.onFinish({+ responseMessage: {+ id: 'response-id',+ role: 'assistant',+ parts+ },+ isAborted+ })return new Response()})@@ -113,7 +136,7 @@ describe('createEphemeralChatStreamResponse', () => {const toolError = Object.assign(new Error('HTTP 403: Forbidden'), {statusCode: 403})- mocks.stream.mockResolvedValue(createFakeResult(toolError))+ mocks.stream.mockResolvedValue(createFakeResult({ toolError }))await createEphemeralChatStreamResponse(createConfig())await mocks.finishPromise@@ -141,4 +164,53 @@ describe('createEphemeralChatStreamResponse', () => {expect(mocks.span.end).toHaveBeenCalledOnce()expect(mocks.forceFlush).toHaveBeenCalledOnce()})++ it('marks the span as failed for an empty response', async () => {+ mocks.stream.mockResolvedValue(createFakeResult({ parts: [] }))++ await createEphemeralChatStreamResponse(createConfig())+ await mocks.finishPromise++ expect(mocks.span.update).toHaveBeenCalledWith({+ level: 'ERROR',+ statusMessage: EMPTY_RESPONSE_STATUS_MESSAGE+ })+ })++ it('does not update the span for a response with text', async () => {+ mocks.stream.mockResolvedValue(createFakeResult())++ await createEphemeralChatStreamResponse(createConfig())+ await mocks.finishPromise++ expect(mocks.span.update).not.toHaveBeenCalled()+ })++ it('does not update the span for an aborted turn', async () => {+ mocks.stream.mockResolvedValue(+ createFakeResult({ parts: [], isAborted: true })+ )++ await createEphemeralChatStreamResponse(createConfig())+ await mocks.finishPromise++ expect(mocks.span.update).not.toHaveBeenCalled()+ })++ it('preserves the stream error when the response is empty', async () => {+ const streamError = new Error('stream failed')+ mocks.stream.mockImplementation(async (options: StreamOptions) => {+ options.onError({ error: streamError })+ return createFakeResult({ parts: [] })+ })++ await createEphemeralChatStreamResponse(createConfig())+ await mocks.finishPromise++ expect(mocks.span.update).toHaveBeenCalledOnce()+ expect(mocks.span.update).toHaveBeenCalledWith({+ level: 'ERROR',+ statusMessage: describeStreamError(streamError)+ })+ })})diff --git a/lib/streaming/create-chat-stream-response.ts b/lib/streaming/create-chat-stream-response.tsindex 94c0c49e..7b763988 100644--- a/lib/streaming/create-chat-stream-response.ts+++ b/lib/streaming/create-chat-stream-response.ts@@ -25,6 +25,10 @@ import { compactHistoricalMessages } from './helpers/compact-historical-messagesimport { convertDataPart } from './helpers/convert-data-part'import { assignDataPartNonces } from './helpers/data-part-nonce'import { describeStreamError } from './helpers/describe-stream-error'+import {+ EMPTY_RESPONSE_STATUS_MESSAGE,+ isEmptyResponse+} from './helpers/is-empty-response'import { logAPICallErrorDiagnostics } from './helpers/log-api-call-error'import { persistStreamResults } from './helpers/persist-stream-results'import { prepareMessages } from './helpers/prepare-messages'@@ -84,6 +88,7 @@ export async function createChatStreamResponse(// be attached to this trace laterconst parentTraceId = rootSpan?.traceIdlet hasStreamError = false+ let hasEmptyResponse = falselet streamError: unknownconst endTracing = async () => {@@ -93,6 +98,11 @@ export async function createChatStreamResponse(level: 'ERROR',statusMessage: describeStreamError(streamError)})+ } else if (hasEmptyResponse) {+ rootSpan.update({+ level: 'ERROR',+ statusMessage: EMPTY_RESPONSE_STATUS_MESSAGE+ })}rootSpan.end()await langfuseSpanProcessor.forceFlush()@@ -218,6 +228,8 @@ export async function createChatStreamResponse(perfTime('researchAgent.stream completed', llmStart)if (isAborted || !responseMessage) return+ hasEmptyResponse = isEmptyResponse(responseMessage)+// Persist stream results to databaseawait persistStreamResults(responseMessage,diff --git a/lib/streaming/create-ephemeral-chat-stream-response.ts b/lib/streaming/create-ephemeral-chat-stream-response.tsindex 5b892217..73bcf44e 100644--- a/lib/streaming/create-ephemeral-chat-stream-response.ts+++ b/lib/streaming/create-ephemeral-chat-stream-response.ts@@ -21,6 +21,10 @@ import { compactHistoricalMessages } from './helpers/compact-historical-messagesimport { convertDataPart } from './helpers/convert-data-part'import { assignDataPartNonces } from './helpers/data-part-nonce'import { describeStreamError } from './helpers/describe-stream-error'+import {+ EMPTY_RESPONSE_STATUS_MESSAGE,+ isEmptyResponse+} from './helpers/is-empty-response'import { logAPICallErrorDiagnostics } from './helpers/log-api-call-error'import { stripSpecFromMessages } from './helpers/strip-spec-from-messages'import { BaseStreamConfig } from './types'@@ -52,6 +56,7 @@ export async function createEphemeralChatStreamResponse(// scores can be attached to this trace laterconst parentTraceId = rootSpan?.traceIdlet hasStreamError = false+ let hasEmptyResponse = falselet streamError: unknownconst endTracing = async () => {@@ -61,6 +66,11 @@ export async function createEphemeralChatStreamResponse(level: 'ERROR',statusMessage: describeStreamError(streamError)})+ } else if (hasEmptyResponse) {+ rootSpan.update({+ level: 'ERROR',+ statusMessage: EMPTY_RESPONSE_STATUS_MESSAGE+ })}rootSpan.end()await langfuseSpanProcessor.forceFlush()@@ -128,7 +138,10 @@ export async function createEphemeralChatStreamResponse(}}},- onFinish: async () => {+ onFinish: async ({ responseMessage, isAborted }) => {+ if (!isAborted && responseMessage) {+ hasEmptyResponse = isEmptyResponse(responseMessage)+ }await endTracing()},onError: (error: unknown) => {diff --git a/lib/streaming/helpers/__tests__/is-empty-response.test.ts b/lib/streaming/helpers/__tests__/is-empty-response.test.tsnew file mode 100644index 00000000..2c7aaf7e--- /dev/null+++ b/lib/streaming/helpers/__tests__/is-empty-response.test.ts@@ -0,0 +1,55 @@+import type { UIMessage } from 'ai'+import { describe, expect, it } from 'vitest'++import { isEmptyResponse } from '@/lib/streaming/helpers/is-empty-response'++function createResponseMessage(parts: UIMessage['parts']): UIMessage {+ return {+ id: 'response-id',+ role: 'assistant',+ parts+ }+}++describe('isEmptyResponse', () => {+ it('returns false for a text part with content', () => {+ expect(+ isEmptyResponse(createResponseMessage([{ type: 'text', text: 'Answer' }]))+ ).toBe(false)+ })++ it('returns true when there are no parts', () => {+ expect(isEmptyResponse(createResponseMessage([]))).toBe(true)+ })++ it('returns true for tool-only parts', () => {+ expect(+ isEmptyResponse(+ createResponseMessage([+ {+ type: 'dynamic-tool',+ toolName: 'search',+ toolCallId: 'tool-call-id',+ state: 'output-available',+ input: {},+ output: {}+ }+ ])+ )+ ).toBe(true)+ })++ it('returns true for reasoning-only parts', () => {+ expect(+ isEmptyResponse(+ createResponseMessage([{ type: 'reasoning', text: 'Thinking' }])+ )+ ).toBe(true)+ })++ it('returns true for whitespace-only text', () => {+ expect(+ isEmptyResponse(createResponseMessage([{ type: 'text', text: ' \n\t ' }]))+ ).toBe(true)+ })+})diff --git a/lib/streaming/helpers/is-empty-response.ts b/lib/streaming/helpers/is-empty-response.tsnew file mode 100644index 00000000..182c435e--- /dev/null+++ b/lib/streaming/helpers/is-empty-response.ts@@ -0,0 +1,10 @@+import type { UIMessage } from 'ai'++export const EMPTY_RESPONSE_STATUS_MESSAGE =+ 'empty_response: The model returned no answer text.'++export function isEmptyResponse(responseMessage: UIMessage): boolean {+ return !responseMessage.parts.some(+ part => part.type === 'text' && part.text.trim().length > 0+ )+}