File size: 15,608 Bytes
20dbb3c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 | /**
* EventSource/Server-Sent Events parser
* @see https://html.spec.whatwg.org/multipage/server-sent-events.html
*/
import {ParseError} from './errors.ts'
import type {EventSourceParser, ParserConfig} from './types.ts'
// ASCII codes used in the hot parsing paths.
const LF = 10
const CR = 13
const SPACE = 32
// oxlint-disable-next-line no-unused-vars
function noop(_arg: unknown) {
// intentional noop
}
/**
* Creates a new EventSource parser.
*
* @param config - Parser configuration. Accepts callbacks (see {@link ParserCallbacks})
* and options like `maxBufferSize` (see {@link ParserConfig}).
*
* @returns A new EventSource parser, with `feed` and `reset` methods.
* @public
*/
export function createParser(config: ParserConfig): EventSourceParser {
if (typeof config === 'function') {
throw new TypeError(
'`config` must be an object, got a function instead. Did you mean `createParser({onEvent: fn})`?',
)
}
const {onEvent = noop, onError = noop, onRetry = noop, onComment, maxBufferSize} = config
// Trailing bytes from prior `feed()` calls that did not yet form a complete line.
// Stored as an array of fragments and only joined when a line terminator arrives.
// Concatenating per-feed (`prefix + chunk`) is O(N²) when a single SSE line spans
// many chunks (e.g. a large `data:` payload streamed in tiny slices, or an MCP-style
// server that emits one giant content block). Buffering as fragments + joining once
// makes the same workload linear.
const pendingFragments: string[] = []
// Running total of `pendingFragments` lengths, kept in sync with the array so the
// `maxBufferSize` check doesn't have to walk the fragment list on every feed.
let pendingFragmentsLength = 0
let isFirstChunk = true
let id: string | undefined
let data = ''
let dataLines = 0
let eventType: string | undefined
// Set after a `maxBufferSize` overflow. Once tripped, `feed()` throws until
// `reset()` is called — see the comment on `maxBufferSize` in `ParserConfig`.
let terminated = false
/**
* Feeds a chunk of the SSE stream to the parser. Any trailing bytes that do
* not yet form a complete line are held back and prepended to the next chunk,
* so callers can pass arbitrary slices of the stream without worrying about
* line boundaries.
*
* Per the SSE spec, a UTF-8 BOM (0xEF 0xBB 0xBF) at the start of the very
* first chunk is stripped before parsing.
*
* @see https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
*/
function feed(chunk: string) {
if (terminated) {
throw new Error(
'Cannot feed parser: it was terminated after exceeding the configured max buffer size. Call `reset()` to resume parsing.',
)
}
if (isFirstChunk) {
isFirstChunk = false
// Match and strip UTF-8 BOM from the start of the stream, if present.
// (Per the spec, this is only valid at the very start of the stream)
if (
chunk.charCodeAt(0) === 0xef &&
chunk.charCodeAt(1) === 0xbb &&
chunk.charCodeAt(2) === 0xbf
) {
chunk = chunk.slice(3)
}
}
// Hot path: no buffered prefix from a prior partial line. Hand the chunk
// straight to `processLines`, exactly like the original implementation.
// Zero new work in the common case (every chunk ends with `\n\n`).
if (pendingFragments.length === 0) {
const trailing = processLines(chunk)
if (trailing !== '') {
pendingFragments.push(trailing)
pendingFragmentsLength = trailing.length
}
checkBufferSize()
return
}
// We have a buffered prefix. If this chunk also has no terminator, append
// to the buffer without concatenating — that's the O(N²) trap we're
// avoiding (large single `data:` payload split across many tiny chunks).
if (chunk.indexOf('\n') === -1 && chunk.indexOf('\r') === -1) {
pendingFragments.push(chunk)
pendingFragmentsLength += chunk.length
checkBufferSize()
return
}
// Terminator arrived. Join the accumulated fragments + this chunk once,
// process, and buffer any new trailing partial line.
pendingFragments.push(chunk)
const input = pendingFragments.join('')
pendingFragments.length = 0
pendingFragmentsLength = 0
const trailing = processLines(input)
if (trailing !== '') {
pendingFragments.push(trailing)
pendingFragmentsLength = trailing.length
}
checkBufferSize()
}
function checkBufferSize() {
if (maxBufferSize === undefined) return
if (pendingFragmentsLength + data.length <= maxBufferSize) return
terminated = true
pendingFragments.length = 0
pendingFragmentsLength = 0
id = undefined
data = ''
dataLines = 0
eventType = undefined
onError(
new ParseError(`Buffered data exceeded max buffer size of ${maxBufferSize} characters`, {
type: 'max-buffer-size-exceeded',
}),
)
}
/**
* Splits `chunk` into SSE lines and dispatches each to the appropriate handler.
* Returns any trailing bytes that did not terminate with a line break, so the
* caller can prepend them to the next chunk.
*
* The SSE spec permits three line terminators: `\n`, `\r`, and `\r\n`. Real-world
* streams almost always use plain `\n`, so we take a fast path when no `\r` is
* present in the chunk. The slow path is spec-correct but does more work per line.
*/
function processLines(chunk: string): string {
let searchIndex = 0
// Fast path: LF-only chunk (the common case for typical SSE servers).
// We can scan forward with a single `indexOf('\n')` per line and inline
// the hot-path branches for `data:` and `event:` without the CR bookkeeping
// the slow path needs.
if (chunk.indexOf('\r') === -1) {
let lfIndex = chunk.indexOf('\n', searchIndex)
while (lfIndex !== -1) {
// Blank line: end-of-event marker. Dispatch the accumulated event (if any)
// and reset the buffered fields. This is hoisted out of `parseLine` because
// it's the single most common line shape after `data:` lines.
if (searchIndex === lfIndex) {
if (dataLines > 0) {
onEvent({id, event: eventType, data})
}
id = undefined
data = ''
dataLines = 0
eventType = undefined
searchIndex = lfIndex + 1
lfIndex = chunk.indexOf('\n', searchIndex)
continue
}
const firstCharCode = chunk.charCodeAt(searchIndex)
if (isDataPrefix(chunk, searchIndex, firstCharCode)) {
// `data:` line — append the value to the event's data buffer.
// 'data:'.length === 5, 'data: '.length === 6
const valueStart =
chunk.charCodeAt(searchIndex + 5) === SPACE ? searchIndex + 6 : searchIndex + 5
const value = chunk.slice(valueStart, lfIndex)
// Fast path within a fast path: if this is the first data line AND the
// next char is another LF (i.e. `data:foo\n\n`), dispatch immediately
// without ever writing to the `data` buffer. This is the shape of a
// typical single-line SSE event (ChatGPT-style streams, etc.) and is
// hot enough to be worth the duplication.
if (dataLines === 0 && chunk.charCodeAt(lfIndex + 1) === LF) {
onEvent({id, event: eventType, data: value})
id = undefined
data = ''
eventType = undefined
searchIndex = lfIndex + 2
lfIndex = chunk.indexOf('\n', searchIndex)
continue
}
// Multi-line data: concatenate with newline separator per spec.
data = dataLines === 0 ? value : `${data}\n${value}`
dataLines++
} else if (isEventPrefix(chunk, searchIndex, firstCharCode)) {
// `event:` line — set the event type for the next dispatch. Per spec,
// an empty value resets `event type` to its default (undefined here).
// 'event:'.length === 6, 'event: '.length === 7
eventType =
chunk.slice(
chunk.charCodeAt(searchIndex + 6) === SPACE ? searchIndex + 7 : searchIndex + 6,
lfIndex,
) || undefined
} else {
// Everything else: `id:`, `retry:`, comment lines (`:` prefix), unknown
// fields, or malformed lines. These are rarer and go through the full
// per-line parser, which handles the SSE field grammar in detail.
parseLine(chunk, searchIndex, lfIndex)
}
searchIndex = lfIndex + 1
lfIndex = chunk.indexOf('\n', searchIndex)
}
return chunk.slice(searchIndex)
}
// Slow path: the chunk contains at least one `\r`, so lines may be terminated
// by `\r`, `\n`, or `\r\n`. We locate the next terminator by looking at both
// the nearest `\r` and `\n` and picking whichever comes first.
while (searchIndex < chunk.length) {
const crIndex = chunk.indexOf('\r', searchIndex)
const lfIndex = chunk.indexOf('\n', searchIndex)
let lineEnd = -1
if (crIndex !== -1 && lfIndex !== -1) {
lineEnd = crIndex < lfIndex ? crIndex : lfIndex
} else if (crIndex !== -1) {
// A trailing `\r` at the very end of the chunk is ambiguous: it could be
// a bare-CR terminator, or the first half of a `\r\n` whose `\n` arrives
// in the next chunk. Defer until we see more input.
if (crIndex === chunk.length - 1) {
lineEnd = -1
} else {
lineEnd = crIndex
}
} else if (lfIndex !== -1) {
lineEnd = lfIndex
}
if (lineEnd === -1) {
break
}
parseLine(chunk, searchIndex, lineEnd)
searchIndex = lineEnd + 1
// If we just consumed a `\r` and the next char is `\n`, skip it so the
// pair is treated as a single terminator rather than an empty line.
if (chunk.charCodeAt(searchIndex - 1) === CR && chunk.charCodeAt(searchIndex) === LF) {
searchIndex++
}
}
return chunk.slice(searchIndex)
}
function parseLine(chunk: string, start: number, end: number) {
if (start === end) {
dispatchEvent()
return
}
const firstCharCode = chunk.charCodeAt(start)
if (isDataPrefix(chunk, start, firstCharCode)) {
// 'data:'.length === 5, 'data: '.length === 6
const valueStart = chunk.charCodeAt(start + 5) === SPACE ? start + 6 : start + 5
const value = chunk.slice(valueStart, end)
data = dataLines === 0 ? value : `${data}\n${value}`
dataLines++
return
}
if (isEventPrefix(chunk, start, firstCharCode)) {
// 'event:'.length === 6, 'event: '.length === 7
eventType =
chunk.slice(chunk.charCodeAt(start + 6) === SPACE ? start + 7 : start + 6, end) || undefined
return
}
// Fast path for "id:" — 'i' = 105, 'd' = 100, ':' = 58
if (
firstCharCode === 105 &&
chunk.charCodeAt(start + 1) === 100 &&
chunk.charCodeAt(start + 2) === 58
) {
// 'id:'.length === 3, 'id: '.length === 4
const value = chunk.slice(chunk.charCodeAt(start + 3) === SPACE ? start + 4 : start + 3, end)
id = value.includes('\0') ? undefined : value
return
}
// Comment line — ':' = 58
if (firstCharCode === 58) {
if (onComment) {
const line = chunk.slice(start, end)
// skip ':' (+1), or ': ' (+2) when a space follows
onComment(line.slice(chunk.charCodeAt(start + 1) === SPACE ? 2 : 1))
}
return
}
const line = chunk.slice(start, end)
const fieldSeparatorIndex = line.indexOf(':')
if (fieldSeparatorIndex === -1) {
processField(line, '', line)
return
}
const field = line.slice(0, fieldSeparatorIndex)
// skip ':' (+1), or ': ' (+2) when a space follows
const offset = line.charCodeAt(fieldSeparatorIndex + 1) === SPACE ? 2 : 1
const value = line.slice(fieldSeparatorIndex + offset)
processField(field, value, line)
}
function processField(field: string, value: string, line: string) {
// Field names must be compared literally, with no case folding performed.
switch (field) {
case 'event':
// Set the `event type` buffer to field value
eventType = value || undefined
break
case 'data':
data = dataLines === 0 ? value : `${data}\n${value}`
dataLines++
break
case 'id':
// If the field value does not contain U+0000 NULL, then set the `ID` buffer to
// the field value. Otherwise, ignore the field.
id = value.includes('\0') ? undefined : value
break
case 'retry':
// If the field value consists of only ASCII digits, then interpret the field value as an
// integer in base ten, and set the event stream's reconnection time to that integer.
// Otherwise, ignore the field.
if (/^\d+$/.test(value)) {
onRetry(parseInt(value, 10))
} else {
onError(
new ParseError(`Invalid \`retry\` value: "${value}"`, {
type: 'invalid-retry',
value,
line,
}),
)
}
break
default:
// Otherwise, the field is ignored.
onError(
new ParseError(
`Unknown field "${field.length > 20 ? `${field.slice(0, 20)}…` : field}"`,
{type: 'unknown-field', field, value, line},
),
)
break
}
}
function dispatchEvent() {
if (dataLines > 0) {
onEvent({
id,
event: eventType,
data,
})
}
id = undefined
data = ''
dataLines = 0
eventType = undefined
}
function reset(options: {consume?: boolean} = {}) {
if (options.consume && pendingFragments.length > 0) {
const incompleteLine = pendingFragments.join('')
parseLine(incompleteLine, 0, incompleteLine.length)
}
isFirstChunk = true
id = undefined
data = ''
dataLines = 0
eventType = undefined
pendingFragments.length = 0
pendingFragmentsLength = 0
terminated = false
}
return {feed, reset}
}
/**
* Checks if `chunk` starts with the literal `data:` at index `i`.
*
* Equivalent to `chunk.startsWith('data:', i)`, but benchmarks show this
* hand-unrolled char-code comparison is ~20% faster on common event types.
* The caller passes `firstCharCode` (the code at `i`) so it can be reused
* across prefix checks.
*
* ASCII: 'd' = 100, 'a' = 97, 't' = 116, 'a' = 97, ':' = 58
*/
function isDataPrefix(chunk: string, i: number, firstCharCode: number): boolean {
return (
firstCharCode === 100 &&
chunk.charCodeAt(i + 1) === 97 &&
chunk.charCodeAt(i + 2) === 116 &&
chunk.charCodeAt(i + 3) === 97 &&
chunk.charCodeAt(i + 4) === 58
)
}
/**
* Checks if `chunk` starts with the literal `event:` at index `i`.
*
* See {@link isDataPrefix} for why this is hand-unrolled rather than using
* `String.prototype.startsWith`.
*
* ASCII: 'e' = 101, 'v' = 118, 'e' = 101, 'n' = 110, 't' = 116, ':' = 58
*/
function isEventPrefix(chunk: string, i: number, firstCharCode: number): boolean {
return (
firstCharCode === 101 &&
chunk.charCodeAt(i + 1) === 118 &&
chunk.charCodeAt(i + 2) === 101 &&
chunk.charCodeAt(i + 3) === 110 &&
chunk.charCodeAt(i + 4) === 116 &&
chunk.charCodeAt(i + 5) === 58
)
}
|