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

feat: include request in events #31

Merged
merged 1 commit into from
Jan 3, 2025
Merged

feat: include request in events #31

Show file tree
Hide file tree
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
44 changes: 43 additions & 1 deletion src/eventsource.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ describe('EventSource', () => {
};
});

it('includes request and response in open event', (done) => {
mockChunks();

const ev = new EventSource('http://localhost/sse', {
disableRetry: true,
});

ev.onopen = (event) => {
expect(event).toBeInstanceOf(Event);
expect(event.request).toBeInstanceOf(Request);
expect(event.response).toBeInstanceOf(Response);
done();
};
});


it('sends custom headers to the backend', (done) => {
server.use(
http.get('http://localhost/sse', (request) => {
Expand Down Expand Up @@ -83,6 +99,32 @@ describe('EventSource', () => {
};
});

it('fails fatally if wrong status code is returned', (done) => {
server.use(
http.get('http://localhost/sse', () => {
return new MswHttpResponse(new ReadableStream(), {
status: 401,
headers: {
'Content-Type': 'text/event-stream',
},
});
}),
);

const ev = new EventSource('http://localhost/sse', {
disableRetry: true,
});

ev.onerror = (event: CustomEvent) => {
expect(ev.readyState).toEqual(ev.CLOSED);
expect(event.request).toBeInstanceOf(Request);
expect(event.request?.url).toEqual("http://localhost/sse");
expect(event.response).toBeInstanceOf(Response);
expect(event.response?.status).toEqual(401);
done();
};
});

it('fails fatally if wrong content type is returned', (done) => {
server.use(
http.get('http://localhost/sse', () => {
Expand All @@ -104,7 +146,7 @@ describe('EventSource', () => {
};
});

it('fails fatally if wrong status code is returned', (done) => {
it('return request and ', (done) => {
server.use(
http.get('http://localhost/sse', () => {
return new MswHttpResponse(new ReadableStream(), {
Expand Down
79 changes: 46 additions & 33 deletions src/eventsource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ export type EventSourceOptions = {
} & Omit<RequestInit, 'cache' | 'credentials' | 'signal'>;

export type CustomEvent = Event & {
request?: Request;
response?: Response;
};

Expand Down Expand Up @@ -109,40 +110,43 @@ export class CustomEventSource extends EventTarget implements EventSource {
return;
}

this.abortController = new AbortController();
this.readyState = this.CONNECTING;

const fetchOptions: RequestInit = {
...this.options,
headers: lastEventId
? {
...this.options.headers,
Accept: ContentTypeEventStream,
'Last-Event-ID': lastEventId,
}
: {
...this.options.headers,
Accept: ContentTypeEventStream,
},
cache: 'no-store',
credentials: this.options.omitCredentials
? 'omit'
: this.withCredentials
? 'include'
: 'same-origin',
signal: this.abortController?.signal,
};

const request = new Request(this.url, fetchOptions);

try {
// https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource
this.abortController = new AbortController();
this.readyState = this.CONNECTING;

const fetchOptions: RequestInit = {
...this.options,
headers: lastEventId
? {
...this.options.headers,
Accept: ContentTypeEventStream,
'Last-Event-ID': lastEventId,
}
: {
...this.options.headers,
Accept: ContentTypeEventStream,
},
cache: 'no-store',
credentials: this.options.omitCredentials
? 'omit'
: this.withCredentials
? 'include'
: 'same-origin',
signal: this.abortController?.signal,
};

const response = this.options.fetch
? await this.options.fetch(this.url, fetchOptions)
: await globalThis.fetch(this.url, fetchOptions);
? await this.options.fetch(request)
: await globalThis.fetch(request);

// https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource (Step 15)
if (response.status !== 200) {
return this.failConnection(
`Request failed with status code ${response.status}`,
request,
response,
);
} else if (
Expand All @@ -152,16 +156,18 @@ export class CustomEventSource extends EventTarget implements EventSource {
`Request failed with wrong content type '${response.headers.get(
'Content-Type',
)}'`,
request,
response,
);
} else if (!response?.body) {
return this.failConnection(
`Request failed with empty response body'`,
request,
response,
);
}

this.announceConnection(response);
this.announceConnection(request, response);

const reader: ReadableStreamDefaultReader<Uint8Array> =
response.body.getReader();
Expand Down Expand Up @@ -194,16 +200,21 @@ export class CustomEventSource extends EventTarget implements EventSource {
return;
}

await this.reconnect('Reconnecting EventSource because of error', error);
await this.reconnect(
'Reconnecting EventSource because of error',
error,
request,
);
return;
}

await this.reconnect('Reconnecting because EventSource connection closed');
await this.reconnect('Reconnecting because EventSource connection closed', request);
}

// https://html.spec.whatwg.org/multipage/server-sent-events.html#reestablish-the-connection
private async reconnect(msg?: string, error?: unknown) {
const event = new Event('error');
private async reconnect(msg?: string, error?: unknown, request?: Request) {
const event: CustomEvent = new Event('error');
event.request = request;
this.dispatchEvent(event);
this.onerror?.(event);

Expand Down Expand Up @@ -246,20 +257,22 @@ export class CustomEventSource extends EventTarget implements EventSource {
}

// https://html.spec.whatwg.org/multipage/server-sent-events.html#fail-the-connection
private failConnection(error: unknown, response: Response) {
private failConnection(error: unknown, request: Request, response: Response) {
this.logger?.error('Fatal error occurred in EventSource', error);
this.readyState = this.CLOSED;
const event: CustomEvent = new Event('error');
event.request = request;
event.response = response;
this.dispatchEvent(event);
this.onerror?.(event);
}

// https://html.spec.whatwg.org/multipage/server-sent-events.html#announce-the-connection
private announceConnection(response: Response) {
private announceConnection(request: Request, response: Response) {
this.logger?.debug('Connection established');
this.readyState = this.OPEN;
const event: CustomEvent = new Event('open');
event.request = request;
event.response = response;
this.dispatchEvent(event);
this.onopen?.(event);
Expand Down
Loading