Skip to content

Update dependency eventsource to v5 - #937

Merged
mxiao-cll merged 2 commits into
mainfrom
renovate/eventsource-5.x
Nov 4, 2026
Merged

mxiao-cll merged 2 commits into
mainfrom
renovate/eventsource-5.x

Conversation

@renovate

@renovate renovate Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

This PR contains the following updates:

Package Change Age Confidence
eventsource 4.1.1 → 5.1.4 age confidence

Release Notes

EventSource/eventsource (eventsource)

v5.1.4

Compare Source

Patch Changes
  • #​372 0769591 Thanks @​edsonsims! - Copy URL objects during construction so later caller mutations do not change the exposed URL or reconnection target.

v5.1.3

Compare Source

Patch Changes
  • #​369 d3fe0d3 Thanks @​rexxars! - Accept case variations of text/event-stream and reject different MIME subtypes such as text/event-streaming.

  • #​370 02634eb Thanks @​rexxars! - Avoid double-encoding non-ASCII event IDs when reconnecting with Cloudflare Workers' native fetch.

  • #​367 fd62d79 Thanks @​OsamaAnsar! - Fixed Last-Event-ID not being sent as UTF-8 on reconnect

    The event ID was passed to fetch() as a plain string header value, but header values are byte strings. An ID containing a character above U+00FF, eg €, made fetch() throw a TypeError on every reconnect attempt, so the connection was never re-established. An ID with characters in the U+0080 to U+00FF range, eg é, was sent as a single Latin-1 byte instead of its UTF-8 encoding. The header now carries the UTF-8 bytes of the ID, as the specification requires.

v5.1.2

Compare Source

Patch Changes

v5.1.1

Compare Source

Patch Changes
  • #​358 de3c0ae Thanks @​pacocartones! - Fixed MessageEvent.lastEventId being empty when a message omits the id field

    The lastEventId attribute is the last event ID string of the event source, so an explicit id field persists until another one replaces it. Message events were dispatched with the current event's own id instead of that buffer, which left lastEventId empty on every event that omitted id, even though the buffer still held the earlier value and would have been sent as Last-Event-ID on reconnect.

  • 17a9772 Thanks @​rexxars! - Fixed ID-only event blocks not updating MessageEvent.lastEventId or Last-Event-ID on reconnect.

v5.1.0

Compare Source

Minor Changes
  • #​355 d8370e4 Thanks @​rexxars! - Typed response body chunks as buffers instead of unknown

    ReaderLike typed chunks read off the response body as unknown, but they are handed to a TextDecoder, which only accepts buffers and throws on anything else. So a reader yielding anything else was never usable, and the type said otherwise. It also hid a type error in the client itself, which only surfaces when compiling against TypeScript's dom library: the node typings resolve the chunk to any, while the dom library resolves it to {}.

    Chunks are now typed as Uint8Array | DataView | ArrayBuffer, which is what both the node and DOM typings accept, and which every fetch() implementation yields. Nothing changes at runtime.

    If you pass a custom fetch() that returns a hand-rolled body, and your reader's chunk type is wider than the above, eg unknown or any, it will no longer be assignable. Returning a real Response, or a reader that yields Uint8Array chunks, is unaffected.

  • #​355 008f07e Thanks @​rexxars! - Declared the this type for the onerror, onmessage and onopen properties

    addEventListener() already declared that listeners are called with the EventSource instance as this, but the on* properties did not, so this was an implicit any in handlers assigned to them (an error under noImplicitThis). They now match addEventListener() and the native EventSource:

    eventSource.onmessage = function (event) {
      console.log(this.url, event.data) // `this` is now typed
    }

    Handlers that declare an incompatible this, eg an unbound class method typed with this: MyClass, will now be rejected where they were previously accepted. Arrow functions and handlers that ignore this are unaffected.

  • #​355 3512add Thanks @​rexxars! - Made the exported EventSource type structural, so other implementations can satisfy it

    EventSource was exported as a class holding hard-private (#) fields, which makes TypeScript emit a #private brand into the declaration file and turns the exported type nominal. A consumer writing function connect(es: EventSource) against this package could not pass the native EventSource, a mock, or any other implementation, even when the shape matched exactly.

    The implementation class is now internal, and EventSource is exported as an interface plus a const holding the constructor. As a result:

    • The native EventSource, along with mocks and stubs, is assignable to the exported EventSource type
    • The exported value and globalThis.EventSource are interchangeable in both directions, which helps libraries that accept an EventSource implementation to construct
    • A new EventSourceConstructor type is exported for that case

    Nothing changes at runtime: new EventSource(...), instanceof, subclassing, the readyState statics, EventSource.name, inspected output and the eventsource.supports-fetch-override symbol all behave as before, and the internal state is still held in real #private fields.

Patch Changes
  • #​357 8e5c691 Thanks @​rexxars! - Fixed origin and lastEventId being empty on Cloudflare Workers

    workerd accepts data from the MessageEvent constructor's init dictionary but silently drops origin and lastEventId, so message events dispatched on Cloudflare Workers arrived with origin set to null and lastEventId to an empty string. Both are now assigned explicitly when the constructor did not take them, which leaves every other runtime untouched.

v5.0.0

Compare Source

Major Changes
  • #​349 b195e70 Thanks @​rexxars! - - BREAKING CHANGE: The client now fails the connection, emitting an error without reconnecting, if the parser buffers 100 MB without receiving a valid, complete EventSource line. Configure a different limit with maxBufferSize; ideally, servers should emit smaller chunks or newlines more frequently.
    • BREAKING CHANGE: Node.js 22.12 or later is now required. Older Node.js versions may still work, but are not supported or guaranteed going forward because Node.js 20 is out of LTS.
    • BREAKING CHANGE: The separate CommonJS variant is no longer published. Node.js 22.12 and later transparently supports require() of ESM, so most CommonJS consumers should continue to work. This removes the dual-package hazard.
    • BREAKING CHANGE: Chrome versions before 84, Safari before 15, Firefox before 105, Edge before 84, and JavaScript environments without private fields, methods, and accessors are no longer supported.
    • BREAKING CHANGE: When both an on* property handler and an addEventListener() listener are registered for the same event, they now run in registration order instead of always running the on* handler first. Code that relied on the old order can observe a different callback sequence.
    • Unref reconnection timers where the runtime supports it, so pending reconnects do not keep the process alive.

Configuration

📅 Schedule: (UTC)

  • Branch creation
    • Only on Sunday and Saturday (* * * * 0,6)
  • Automerge
    • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate
renovate Bot requested a review from a team as a code owner November 1, 2026 12:55
@github-actions

github-actions Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

NPM Publishing labels 🏷️

🛑 This PR needs labels to indicate how to increase the current package version in the automated workflows. Please add one of the following labels: none, patch, minor, or major.

@renovate
renovate Bot force-pushed the renovate/eventsource-5.x branch 2 times, most recently from 36781f9 to 8bf299e Compare November 2, 2026 13:57
@renovate
renovate Bot force-pushed the renovate/eventsource-5.x branch from c9a7952 to dd51c75 Compare November 2, 2026 14:03
@renovate

renovate Bot commented Nov 2, 2026

Copy link
Copy Markdown
Contributor Author

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

@mxiao-cll
mxiao-cll merged commit a2fd45b into main Nov 4, 2026
15 checks passed
@mxiao-cll
mxiao-cll deleted the renovate/eventsource-5.x branch November 4, 2026 19:31
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

❌ failed to run preflight checks
Failure message: No labels present on the PR, expected version bump label (one of 'major', 'minor', 'patch', or 'none')
Failed job: preflight

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants