Skip to content

lib: brand-check Navigator getters to throw ERR_INVALID_THIS #63601

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

Merged
aduh95 merged 5 commits into from
Jun 2, 2026
+22 −1
Merged

lib: brand-check Navigator getters to throw ERR_INVALID_THIS #63601

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a8d88e8
lib: brand-check Navigator getters to throw ERR_INVALID_THIS
May 27, 2026
57fda3b
fix: iterate Navigator.prototype instead of lists
May 28, 2026
a35e81b
fix: keep explicit brand check and rely on private field throw
May 31, 2026
d0a014b
fix: depend on this.#attribute throw on navigator
Jun 1, 2026
19c4154
fix: unused ERR_INVALID_THIS import
Jun 1, 2026
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
8 changes: 7 additions & 1 deletion lib/internal/navigator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const {

const {
ERR_ILLEGAL_CONSTRUCTOR,
ERR_INVALID_THIS,
} = require('internal/errors').codes;

const {
Expand Down Expand Up @@ -79,7 +80,8 @@ function getNavigatorPlatform(arch, platform) {
}

class Navigator {
// Private properties are used to avoid brand validations.
// Private properties are used to avoid brand validations: reading a private
// field from a non-Navigator receiver throws a TypeError on its own.
#availableParallelism;
#locks;
#userAgent;
Expand Down Expand Up @@ -113,6 +115,10 @@ class Navigator {
* @returns {string}
*/
get language() {
// `language` does not read a private field, so brand-check explicitly
// to keep parity with the other getters when called on a non-Navigator
// receiver (e.g. `Navigator.prototype.language`).
if (!(#languages in this)) throw new ERR_INVALID_THIS('Navigator');
Copy link
Copy Markdown
Member

@anonrig anonrig Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We shouldn't do this. We explicitly avoided doing this because of performance in the past. We went through deprecation cycles multiple times because of this.

Copy link
Copy Markdown
Member

@LiviaMedeiros LiviaMedeiros Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't not throwing here go against the specs?

Copy link
Copy Markdown
Member

@anonrig anonrig Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accessing this.#attribute already throws

Copy link
Copy Markdown
Member

@LiviaMedeiros LiviaMedeiros Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This particular getter doesn't use private field anymore so currently it doesn't throw at all.

Copy link
Copy Markdown
Contributor

@aduh95 aduh95 Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anonrig you can try it yourself: node -p Navigator.prototype.language exits with code 0 (while accessing the other properties e.g. node -p Navigator.prototype.languages has the expected TypeError)

Copy link
Copy Markdown
Contributor

@aduh95 aduh95 Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (!(#languages in this)) throw new ERR_INVALID_THIS('Navigator');
this.#languages; // eslint-disable-line no-unused-expressions

Copy link
Copy Markdown
Member

@anonrig anonrig Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aduh95 your suggestion is the correct approach

// The default locale might be changed dynamically, so always invoke the
// binding.
return getDefaultLocale() || 'en-US';
Expand Down
16 changes: 16 additions & 0 deletions test/parallel/test-navigator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,19 @@ Object.defineProperty(navigator, 'language', { value: 'for-testing' });
assert.strictEqual(navigator.language, 'for-testing');
assert.strictEqual(navigator.languages.length, 1);
assert.strictEqual(navigator.languages[0] !== 'for-testing', true);

{
const { Navigator } = globalThis;
for (const name of Object.keys(Navigator.prototype)) {
assert.throws(
() => Navigator.prototype[name],
{ name: 'TypeError' },
`expected TypeError when reading ${name} on Navigator.prototype`,
);
assert.throws(
() => Reflect.get(Navigator.prototype, name, {}),
{ name: 'TypeError' },
`expected TypeError when reading ${name} on a plain object`,
);
}
}
Loading