Fix jsdom 28 WebSocket cross-realm Event incompatibility#1161
Open
Copilot wants to merge 8 commits intodependabot/npm_and_yarn/jsdom-28.1.0from
Open
Fix jsdom 28 WebSocket cross-realm Event incompatibility#1161Copilot wants to merge 8 commits intodependabot/npm_and_yarn/jsdom-28.1.0from
Copilot wants to merge 8 commits intodependabot/npm_and_yarn/jsdom-28.1.0from
Conversation
Bumps [jsdom](https://github.com/jsdom/jsdom) from 27.4.0 to 28.1.0. - [Release notes](https://github.com/jsdom/jsdom/releases) - [Changelog](https://github.com/jsdom/jsdom/blob/main/Changelog.md) - [Commits](jsdom/jsdom@27.4.0...28.1.0) --- updated-dependencies: - dependency-name: jsdom dependency-version: 28.1.0 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: MatthijsBurgh <18014833+MatthijsBurgh@users.noreply.github.com>
Add detection for jsdom environment in WebSocketTransportFactory to prevent using jsdom's native WebSocket which has cross-realm Event issues. This forces the use of the ws package in jsdom environments, avoiding the ERR_INVALID_ARG_TYPE error when dispatching events. Co-authored-by: MatthijsBurgh <18014833+MatthijsBurgh@users.noreply.github.com>
Update transport test to expect WsWebSocketTransport in jsdom environments, as the fix intentionally uses ws package instead of native WebSocket to avoid cross-realm Event issues. Co-authored-by: MatthijsBurgh <18014833+MatthijsBurgh@users.noreply.github.com>
Enhanced jsdom environment detection with multiple checks: - Try-catch for navigator.userAgent check (avoids circular lint rules) - Window constructor name check - jsdom-specific Symbol check in globalThis Also simplified test name per code review feedback. Co-authored-by: MatthijsBurgh <18014833+MatthijsBurgh@users.noreply.github.com>
Author
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Copilot
AI
changed the title
[WIP] Bump jsdom from 27.4.0 to 28.1.0
Fix jsdom 28 WebSocket cross-realm Event incompatibility
Feb 23, 2026
dependabot
bot
force-pushed
the
dependabot/npm_and_yarn/jsdom-28.1.0
branch
from
a3cbcfc to
7497fc2
Compare
Comment on lines
+21
to
+22
| windowConstructorName === "jsdom" || | ||
| windowConstructorName === "JSDOM" |
Convert windowConstructorName to lowercase before comparison, simplifying the check from two comparisons to one. Co-authored-by: MatthijsBurgh <18014833+MatthijsBurgh@users.noreply.github.com>
EzraBrooks
reviewed
Mar 2, 2026
Comment on lines
+3
to
+37
| /** | ||
| * Detect if we're running in a jsdom environment. | ||
| * jsdom provides WebSocket but has cross-realm issues with Event objects. | ||
| */ | ||
| function isJsdomEnvironment(): boolean { | ||
| // Check for jsdom-specific navigator.userAgent | ||
| try { | ||
| if (navigator.userAgent.includes("jsdom")) { | ||
| return true; | ||
| } | ||
| } catch { | ||
| // navigator not available | ||
| } | ||
|
|
||
| // Check for jsdom-specific window constructor name | ||
| if (typeof window !== "undefined") { | ||
| const windowConstructorName = window.constructor.name.toLowerCase(); | ||
| if (windowConstructorName === "jsdom") { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| // Check for jsdom-specific globals that aren't present in real browsers | ||
| if (typeof globalThis !== "undefined") { | ||
| // jsdom creates a special Symbol for internal use | ||
| const hasJsdomSymbol = Object.getOwnPropertySymbols(globalThis).some( | ||
| (sym) => sym.toString().includes("jsdom"), | ||
| ); | ||
| if (hasJsdomSymbol) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } |
Contributor
There was a problem hiding this comment.
I don't like having test code in application code. Did you try deleting window.WebSocket during test suite setup as an alternative workaround?
Contributor
There was a problem hiding this comment.
Ah, wait, this issue clearly would impact downstream tests as well, from our consumers.
I think that first navigator.userAgent.includes("jsdom") should be sufficient, shouldn't it?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.