lib: add `navigator.userAgent` #50200

anonrig · 2023-10-16T17:32:11Z

Follow-up for #47769

cc @nodejs/tsc

github-actions · 2023-10-16T17:33:18Z

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @anonrig.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment.

aduh95 · 2023-10-16T17:49:48Z

Two questions:

Why is that semver-major?
How is it relevant for Node.js?

test/parallel/test-navigator.js

anonrig · 2023-10-16T17:51:34Z

Two questions:

Why is that semver-major?

Some packages might depend on navigator.userAgent to detect if it's not Node.js or not. I don't want to introduce breaking change.

How is it relevant for Node.js?

navigator.userAgent is included in WINTERCG Minimum Common Web Platform API - https://common-min-api.proposal.wintercg.org

meyfa · 2023-10-16T18:10:49Z

The default value contained in this PR is currently different from the value used in native fetch, see: nodejs/undici#2306

There is also some discussion about not including the version number that may be of relevance here.

I think if Node.js exposes a user agent in multiple places, it needs to be the same everywhere.

KhafraDev · 2023-10-16T18:18:49Z

the version should be removed, so either "node.js" or "node". Undici uses "node" so that would make our lives easier (the fetch user-agent and navigator user-agent seem like they should be equal, although I'm not entirely sure).

anonrig · 2023-10-16T18:45:54Z

the version should be removed, so either "node.js" or "node". Undici uses "node" so that would make our lives easier (the fetch user-agent and navigator user-agent seem like they should be equal, although I'm not entirely sure).

Referencing WINTERCG, it's recommended to have a product version with the user agent. I'm more in favor of having the version:

User-Agent      = product *( RWS ( product / comment ) )
product         = token ["/" product-version]
product-version = token

KhafraDev · 2023-10-16T19:08:34Z

There are legitimate security concerns by adding the node version, maybe something like what Chrome is doing would be acceptable? If you don't want to click that they're replacing minor version numbers with zeros (ie. v20.1.1 -> v20.0.0). Is there any discussion about why a version number is required?

doc/api/globals.md

Uzlopak · 2023-10-19T23:52:39Z

I thought about the version.

I am +1 for adding the version.

First of all, the userAgent is in browsers used for requests. We dont expose the version via a http request nor via a http response. Browsers expose this information with their version via request and they dont consider it as a security issue. If it would be a security issue chrome, safari and co would have removed the version information long time ago.

Also comparing to deno and bun, they also expose the version.

So I am 100% hoping that the version gets exposed.

GeoffreyBooth · 2023-10-20T00:08:17Z

Browsers expose this information with their version via request and they dont consider it as a security issue.

Actually Chrome only exposes the major version; they consider exposing the minor/patch versions to be a security concern. See the Chrome/118.0.0.0 in the example above. All of the Chrome 118.x versions return 118.0.0.0 as the version.

But we can do the same, it’s better than not including a version.

KhafraDev · 2023-10-20T00:09:14Z

Chrome did limit it, from the link I posted above:

From Chrome 101 we replaced the minor version number with zeros, e.g. Chrome/101.3.2.1 became Chrome/101.0.0.0.

Firefox also limits some information (windows & macOS versions are capped at 10 and 10.15 respectively, and some architectures don't include any information in their user-agent header). (Source) I'd assume they have plans to limit it further.

KhafraDev · 2023-10-20T00:10:02Z

But we can do the same, it’s better than not including a version.

Yep, this was my proposed alternative.

anonrig · 2023-10-20T00:13:31Z

I'll update the PR with the proposed change.

GeoffreyBooth · 2023-10-20T15:39:06Z

This isn’t semver-major, the semver-major change was adding navigator in the first place. Now that navigator exists we should add all the properties people expect on it.

lib/internal/navigator.js

nodejs-github-bot · 2023-10-20T16:01:41Z

CI: https://ci.nodejs.org/job/node-test-pull-request/55058/

Uzlopak

RSLGTM

styfle · 2023-10-20T17:15:07Z

the fetch user-agent and navigator user-agent seem like they should be equal

💯 agree!

Also something to consider: it looks like there is existing code out there that looks for Node.js string matching.

For example:

consider userAgent missing flexdinesh/browser-or-node#25

mcollina

lgtm

nodejs-github-bot · 2023-10-20T20:22:50Z

Landed in 05a7810

Ethan-Arrowood · 2023-10-20T22:39:34Z

I really think the user-agent keys should match #50200 (comment)

Can we update it ?

KhafraDev · 2023-10-20T23:24:18Z

honestly i'm starting to question the benefit of having navigator whatsoever. I think there should be an agreement on if node should even have it before it's changed again.

PR-URL: #50200 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Matthew Aitken <maitken033380023@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>

Notable changes: doc: * add H4ad to collaborators (Vinícius Lourenço) #50217 esm: * (SEMVER-MINOR) detect ESM syntax in ambiguous JavaScript (Geoffrey Booth) #50096 fs: * (SEMVER-MINOR) add flush option to appendFile() functions (Colin Ihrig) #50095 lib: * (SEMVER-MINOR) add `navigator.userAgent` (Yagiz Nizipli) #50200 stream: * (SEMVER-MINOR) allow pass stream class to `stream.compose` (Alex Yang) #50187 * call helper function from push and unshift (Raz Luvaton) #50173 PR-URL: #50335

PR-URL: nodejs#50200 Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com> Reviewed-By: Matthew Aitken <maitken033380023@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br>

Notable changes: doc: * add H4ad to collaborators (Vinícius Lourenço) nodejs#50217 esm: * (SEMVER-MINOR) detect ESM syntax in ambiguous JavaScript (Geoffrey Booth) nodejs#50096 fs: * (SEMVER-MINOR) add flush option to appendFile() functions (Colin Ihrig) nodejs#50095 lib: * (SEMVER-MINOR) add `navigator.userAgent` (Yagiz Nizipli) nodejs#50200 stream: * (SEMVER-MINOR) allow pass stream class to `stream.compose` (Alex Yang) nodejs#50187 * call helper function from push and unshift (Raz Luvaton) nodejs#50173 PR-URL: nodejs#50335

anonrig force-pushed the add-navigator-useragent branch from 1704a23 to 218c1a1 Compare October 16, 2023 17:32

nodejs-github-bot added the needs-ci PRs that need a full CI run. label Oct 16, 2023

aduh95 reviewed Oct 16, 2023

View reviewed changes

test/parallel/test-navigator.js Show resolved Hide resolved

anonrig force-pushed the add-navigator-useragent branch from 218c1a1 to b92833e Compare October 16, 2023 18:49

anonrig force-pushed the add-navigator-useragent branch from b92833e to 6b9fd6e Compare October 17, 2023 17:53

anonrig added the dont-land-on-v21.x label Oct 17, 2023

GeoffreyBooth reviewed Oct 17, 2023

View reviewed changes

doc/api/globals.md Show resolved Hide resolved

doc/api/globals.md Show resolved Hide resolved

Uzlopak mentioned this pull request Oct 17, 2023

lib: add navigator.onLine #50224

Open

tniessen added the experimental Issues and PRs related to experimental features. label Oct 19, 2023

GeoffreyBooth mentioned this pull request Oct 20, 2023

navigator object breaks projects in v21.0.0 #50269

Closed

GeoffreyBooth added semver-minor PRs that contain new features and should be released in the next minor version. and removed semver-major PRs that contain breaking changes and should be released in the next major version. dont-land-on-v21.x labels Oct 20, 2023

GeoffreyBooth approved these changes Oct 20, 2023

View reviewed changes

anonrig added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 20, 2023

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 20, 2023

Uzlopak reviewed Oct 20, 2023

View reviewed changes

lib/internal/navigator.js Show resolved Hide resolved

Uzlopak approved these changes Oct 20, 2023

View reviewed changes

KhafraDev approved these changes Oct 20, 2023

View reviewed changes

mcollina approved these changes Oct 20, 2023

View reviewed changes

H4ad approved these changes Oct 20, 2023

View reviewed changes

GeoffreyBooth added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Oct 20, 2023

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 20, 2023

nodejs-github-bot merged commit 05a7810 into nodejs:main Oct 20, 2023
56 checks passed

hex2dec mentioned this pull request Oct 22, 2023

docs: fix webpack repo links that use legacy branch name webpack/webpack.js.org#7036

Merged

targos mentioned this pull request Oct 23, 2023

v21.1.0 release proposal #50335

Merged

meabed mentioned this pull request Oct 25, 2023

[BUG] Node 21 now has a "navigator" object defined on global scope. framer/motion#2376

Closed

davidfiala mentioned this pull request Oct 30, 2023

node v21.0.0 breaks with xterm: Cannot read properties of undefined (reading 'includes') xtermjs/xterm.js#4850

Closed

plainheart mentioned this pull request Nov 2, 2023

fix(env): fix env detection compatibility in node v21.1.0 ecomfe/zrender#1036

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lib: add `navigator.userAgent` #50200

lib: add `navigator.userAgent` #50200

anonrig commented Oct 16, 2023 •

edited

Loading

github-actions bot commented Oct 16, 2023

aduh95 commented Oct 16, 2023

anonrig commented Oct 16, 2023

meyfa commented Oct 16, 2023

KhafraDev commented Oct 16, 2023

anonrig commented Oct 16, 2023

KhafraDev commented Oct 16, 2023

Uzlopak commented Oct 19, 2023

GeoffreyBooth commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

anonrig commented Oct 20, 2023

GeoffreyBooth commented Oct 20, 2023

nodejs-github-bot commented Oct 20, 2023

Uzlopak left a comment

styfle commented Oct 20, 2023

mcollina left a comment

nodejs-github-bot commented Oct 20, 2023

Ethan-Arrowood commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

lib: add navigator.userAgent #50200

lib: add navigator.userAgent #50200

Conversation

anonrig commented Oct 16, 2023 • edited Loading

github-actions bot commented Oct 16, 2023

aduh95 commented Oct 16, 2023

anonrig commented Oct 16, 2023

meyfa commented Oct 16, 2023

KhafraDev commented Oct 16, 2023

anonrig commented Oct 16, 2023

KhafraDev commented Oct 16, 2023

Uzlopak commented Oct 19, 2023

GeoffreyBooth commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

anonrig commented Oct 20, 2023

GeoffreyBooth commented Oct 20, 2023

nodejs-github-bot commented Oct 20, 2023

Uzlopak left a comment

Choose a reason for hiding this comment

styfle commented Oct 20, 2023

mcollina left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented Oct 20, 2023

Ethan-Arrowood commented Oct 20, 2023

KhafraDev commented Oct 20, 2023

lib: add `navigator.userAgent` #50200

lib: add `navigator.userAgent` #50200

anonrig commented Oct 16, 2023 •

edited

Loading