Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
fix(nodejs-client): reject streamed API errors in toText (#44199)
青阳寻雪dae390d119d2
diff --git a/sdks/nodejs-client/README.md b/sdks/nodejs-client/README.mdindex d889c653191..c6e15fc9acb 100644--- a/sdks/nodejs-client/README.md+++ b/sdks/nodejs-client/README.md@@ -98,6 +98,7 @@ Notes:- App endpoints use an app API token; knowledge base and workspace endpoints use a dataset API token.- Chat/completion require a stable `user` identifier in the request payload.- For streaming responses, iterate the returned AsyncIterable. Use `stream.toText()` to collect text.+- `stream.toText()` rejects with `APIError` when Dify sends an `error` event, even if the HTTP status is 200. Iterating the stream directly still yields these events for custom handling.## Maintainersdiff --git a/sdks/nodejs-client/src/http/sse.test.ts b/sdks/nodejs-client/src/http/sse.test.tsindex c14ac8ad262..e3bbdd3f405 100644--- a/sdks/nodejs-client/src/http/sse.test.ts+++ b/sdks/nodejs-client/src/http/sse.test.ts@@ -1,5 +1,6 @@import { Readable } from 'node:stream'import { describe, expect, it } from 'vite-plus/test'+import { APIError } from '../errors/dify-error'import { createBinaryStream, createSseStream, parseSseStream } from './sse'describe('sse parsing', () => {@@ -83,6 +84,67 @@ describe('sse parsing', () => {expect(text).toBe('hello world')})+ it.each([+ '',+ 'data: {"event":"message","answer":"partial answer"}\n\n',+ [+ 'data: {"event":"text_chunk","data":{"text":"partial answer"}}\n\n',+ 'data: {"event":"message_replace","answer":"replacement"}\n\n',+ ].join(''),+ ])('toText rejects a streamed API error after %j', async (prefix) => {+ const error = {+ event: 'error',+ status: 429,+ code: 'rate_limit_error',+ message: 'Rate limit reached',+ }+ const stream = Readable.from([prefix, `data: ${JSON.stringify(error)}\n\n`])+ const sseStream = createSseStream(stream, {+ status: 200,+ headers: {},+ requestId: 'req-stream',+ })++ const result = sseStream.toText()+ await expect(result).rejects.toBeInstanceOf(APIError)+ await expect(result).rejects.toMatchObject({+ message: error.message,+ statusCode: error.status,+ responseBody: error,+ requestId: 'req-stream',+ })+ })++ it('keeps streamed API errors available to event consumers', async () => {+ const error = { event: 'error', status: 400, code: 'invalid_param', message: 'Invalid input' }+ const stream = createSseStream(Readable.from([`data: ${JSON.stringify(error)}\n\n`]), {+ status: 200,+ headers: {},+ })+ const events = []+ for await (const event of stream) {+ events.push(event.data)+ }++ expect(events).toEqual([error])+ })++ it('rejects malformed error metadata without collecting its text', async () => {+ const error = { event: 'error', message: null, status: '429', answer: 'not a success' }+ const stream = createSseStream(Readable.from([`data: ${JSON.stringify(error)}\n\n`]), {+ status: 200,+ headers: {},+ })++ await expect(stream.toText()).rejects.toMatchObject({+ name: 'APIError',+ message: 'Stream returned an error',+ statusCode: undefined,+ responseBody: error,+ requestId: undefined,+ })+ })+it('toText extracts text from string data', async () => {const stream = Readable.from(['data: plain text\n\n'])const sseStream = createSseStream(stream, { status: 200, headers: {} })diff --git a/sdks/nodejs-client/src/http/sse.ts b/sdks/nodejs-client/src/http/sse.tsindex 1962e1f8dcd..04584b9b80f 100644--- a/sdks/nodejs-client/src/http/sse.ts+++ b/sdks/nodejs-client/src/http/sse.ts@@ -1,6 +1,7 @@import type { Readable } from 'node:stream'import type { BinaryStream, DifyStream, Headers, JsonValue, StreamEvent } from '../types/common'import { StringDecoder } from 'node:string_decoder'+import { APIError } from '../errors/dify-error'import { isRecord } from '../internal/type-guards'const toBufferChunk = (chunk: unknown): Buffer => {@@ -124,6 +125,18 @@ export const createSseStream = <T>(toText: async () => {let text = ''for await (const event of iterable) {+ if (isRecord(event.data) && event.data.event === 'error') {+ throw new APIError(+ typeof event.data.message === 'string'+ ? event.data.message+ : 'Stream returned an error',+ {+ statusCode: typeof event.data.status === 'number' ? event.data.status : undefined,+ responseBody: event.data,+ requestId: meta.requestId,+ },+ )+ }// Output moderation sends `message_replace` with the full answer that replaces everything streamed so far.if (isRecord(event.data) && event.data.event === 'message_replace') {text = typeof event.data.answer === 'string' ? event.data.answer : ''