src/vs/base/common/sseParser.ts
245 LOC · 241 covered · 4 uncovered · 56 ranges · 54 concepts · 17 introducers · 46 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
1
>
/*---------------------------------------------------------------------------------------------
sseParser.ts ×9
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
/**
7
>
* Parser for Server-Sent Events (SSE) streams according to the HTML specification.
8
>
* @see https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation
9
>
*/
10
>
11
>
/**
12
>
* Represents an event dispatched from an SSE stream.
13
>
*/
14
>
export interface ISSEEvent {
15
>
/**
16
>
* The event type. If not specified, the type is "message".
17
>
*/
18
>
type: string;
19
>
20
>
/**
21
>
* The event data.
22
>
*/
23
>
data: string;
24
>
25
>
/**
26
>
* The last event ID, used for reconnection.
27
>
*/
28
>
id?: string;
29
>
30
>
/**
31
>
* Reconnection time in milliseconds.
32
>
*/
33
>
retry?: number;
34
>
}
35
>
36
>
/**
37
>
* Callback function type for event dispatch.
38
>
*/
39
>
export type SSEEventHandler = (event: ISSEEvent) => void;
40
>
41
>
const enum Chr {
42
>
CR = 13, // '\r'
43
>
LF = 10, // '\n'
44
>
COLON = 58, // ':'
45
>
SPACE = 32, // ' '
46
>
}
47
>
48
>
/**
49
>
* Parser for Server-Sent Events (SSE) streams.
50
>
*/
51
>
export class SSEParser {
52
>
private dataBuffer = '';
53
>
private eventTypeBuffer = '';
54
>
private currentEventId?: string;
55
>
private lastEventIdBuffer?: string;
56
>
private reconnectionTime?: number;
57
>
private buffer: Uint8Array[] = [];
58
>
private endedOnCR = false;
59
>
private readonly onEventHandler: SSEEventHandler;
60
>
private readonly decoder: TextDecoder;
61
>
/**
62
>
* Creates a new SSE parser.
63
>
* @param onEvent The callback to invoke when an event is dispatched.
64
>
*/
65
>
constructor(onEvent: SSEEventHandler) {
67
>
this.decoder = new TextDecoder('utf-8');
68
>
}
70
>
/**
71
>
* Gets the last event ID received by this parser.
72
>
*/
73
>
public getLastEventId(): string | undefined {
75
>
}
77
>
* Gets the reconnection time in milliseconds, if one was specified by the server.
78
>
*/
79
>
public getReconnectionTime(): number | undefined {
81
>
}
83
>
/**
84
>
* Feeds a chunk of the SSE stream to the parser.
85
>
* @param chunk The chunk to parse as a Uint8Array of UTF-8 encoded data.
86
>
*/
87
>
public feed(chunk: Uint8Array): void {
89
return;
90
}
92
>
let offset = 0;
93
>
94
>
// If the data stream was bifurcated between a CR and LF, avoid processing the CR as an extra newline
95
>
if (this.endedOnCR && chunk[0] === Chr.LF) {
97
>
}
99
>
100
>
// Process complete lines from the buffer
101
>
while (offset < chunk.length) {
102
>
const indexCR = chunk.indexOf(Chr.CR, offset);
103
>
const indexLF = chunk.indexOf(Chr.LF, offset);
104
>
const index = indexCR === -1 ? indexLF : (indexLF === -1 ? indexCR : Math.min(indexCR, indexLF));
105
>
if (index === -1) {
107
>
}
109
>
let str = '';
110
>
for (const buf of this.buffer) {
112
>
}
114
>
this.processLine(str);
115
>
116
>
this.buffer.length = 0;
117
>
offset = index + (chunk[index] === Chr.CR && chunk[index + 1] === Chr.LF ? 2 : 1);
118
>
}
119
>
120
>
121
>
if (offset < chunk.length) {
124
>
this.endedOnCR = chunk[chunk.length - 1] === Chr.CR;
125
>
}
126
>
}
128
>
* Processes a single line from the SSE stream.
129
>
*/
130
>
private processLine(line: string): void {
132
>
this.dispatchEvent();
133
>
return;
134
>
}
135
>
136
>
if (line.startsWith(':')) {
138
>
}
140
>
// Parse the field name and value
141
>
let field: string;
142
>
let value: string;
143
>
144
>
const colonIndex = line.indexOf(':');
145
>
if (colonIndex === -1) {
147
>
field = line;
148
>
value = '';
151
>
field = line.substring(0, colonIndex);
152
>
value = line.substring(colonIndex + 1);
153
>
154
>
// If value starts with a space, remove it
155
>
if (value.startsWith(' ')) {
157
>
}
160
>
this.processField(field, value);
161
>
}
163
>
* Processes a field with the given name and value.
164
>
*/
165
>
private processField(field: string, value: string): void {
167
>
case 'event':
169
>
break;
171
>
case 'data':
173
>
this.dataBuffer += value;
174
>
this.dataBuffer += '\n';
175
>
break;
177
>
case 'id':
179
>
if (!value.includes('\0')) {
183
>
}
186
>
case 'retry':
187
>
// If the field value consists only of ASCII digits, set the reconnection time
sseParser.ts ×3
188
>
if (/^\d+$/.test(value)) {
190
>
}
193
>
// Ignore any other fields
194
>
}
195
>
}
197
>
* Dispatches the event based on the current buffer states.
198
>
*/
199
>
private dispatchEvent(): void {
201
>
if (this.dataBuffer === '') {
203
>
this.eventTypeBuffer = '';
204
>
return;
205
>
}
207
>
// If the data buffer's last character is a newline, remove it
208
>
if (this.dataBuffer.endsWith('\n')) {
209
>
this.dataBuffer = this.dataBuffer.substring(0, this.dataBuffer.length - 1);
210
>
}
211
>
212
>
// Create and dispatch the event
213
>
const event: ISSEEvent = {
214
>
type: this.eventTypeBuffer || 'message',
216
>
};
217
>
218
>
// Add optional fields if they exist
219
>
if (this.currentEventId !== undefined) {
221
>
}
223
>
if (this.reconnectionTime !== undefined) {
225
>
}
227
>
// Dispatch the event
228
>
this.onEventHandler(event);
229
>
230
>
// Reset the data and event type buffers
231
>
this.reset();
234
>
/**
235
>
* Resets the parser state.
236
>
*/
237
>
public reset(): void {
239
>
this.eventTypeBuffer = '';
240
>
this.currentEventId = undefined;
241
>
// Note: lastEventIdBuffer is not reset as it's used for reconnection
242
>
}
244
245