Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(client): correctly handle errors during streaming #379

Merged
merged 1 commit into from
Oct 16, 2023
Merged

fix(client): correctly handle errors during streaming #379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion src/streaming.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { ReadableStream, type Response } from './_shims/index';
import { OpenAIError } from './error';

import { APIError } from 'openai/error';

type Bytes = string | ArrayBuffer | Uint8Array | Buffer | null | undefined;

type ServerSentEvent = {
Expand Down Expand Up @@ -58,13 +60,21 @@ export class Stream<Item> implements AsyncIterable<Item> {
}

if (sse.event === null) {
let data;

try {
yield JSON.parse(sse.data);
data = JSON.parse(sse.data);
} catch (e) {
console.error(`Could not parse message into JSON:`, sse.data);
console.error(`From chunk:`, sse.raw);
throw e;
}

if (data && data.error) {
throw new APIError(undefined, data.error, undefined, undefined);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we're not setting the APIError.message here, is that intentional?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I was under the impression that the API error data will include a message property. That property will then be used by the APIError class if a message isn't explicitly passed in the constructor. If the message property isn't set, then we'll default to stringifying the error object to raw JSON.

Is that assumption correct?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assumption is correct, but I don't see code in APIError to assign message from the error object:

openai-node/src/error.ts

Lines 16 to 41 in 6484039

constructor(
status: number | undefined,
error: Object | undefined,
message: string | undefined,
headers: Headers | undefined,
) {
super(`${status} ${APIError.makeMessage(error, message)}`);
this.status = status;
this.headers = headers;
const data = error as Record<string, any>;
this.error = data;
this.code = data?.['code'];
this.param = data?.['param'];
this.type = data?.['type'];
}
private static makeMessage(error: any, message: string | undefined) {
return (
error?.message ?
typeof error.message === 'string' ? error.message
: JSON.stringify(error.message)
: error ? JSON.stringify(error)
: message || 'status code (no body)'
);
}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's this line

openai-node/src/error.ts

Line 36 in 6484039

typeof error.message === 'string' ? error.message

The error argument there is the data that the API responded with

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, thanks!

When status is undefined, should we skip the space in the error message here?

openai-node/src/error.ts

Line 22 in 6484039

super(`${status} ${APIError.makeMessage(error, message)}`);

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we can probably clean that up; I'll file a ticket

}

yield data;
}
}
done = true;
Expand Down