Send current project scope & CI status headers on request #14129

iarna · 2016-09-29T22:22:27Z

TODO:

Document CI header behavior
Document Scope header behavior
Swap out WIP npm-registry-client with a release that has these patches merged.

othiym23

Looks good so far!

othiym23 · 2016-09-30T01:53:43Z

test/tap/ci-header.js

+var filteredEnv = extend({}, process.env)
+ciKeys.forEach(function (key) { delete filteredEnv[key] })
+
+var conf = function (extraEnv) {


This is really something – might this be something that can be abstracted out into common for use elsewhere? It seems pretty useful.

othiym23 · 2016-09-30T01:55:02Z

lib/npm.js

+        if (config.get('scope') === '') {
+          config.set('scope', getProjectScope(npm.prefix))
+        }
+        if (config.get('scope') !== '' && config.get('scope')[0] !== '@') {


Good call on moving this here.

ashleygwilliams · 2016-10-07T23:15:10Z

doc/misc/npm-registry.md

@@ -21,6 +21,21 @@ The registry URL used is determined by the scope of the package (see
 supplied by the `registry` config parameter.  See `npm-config(1)`,
 `npmrc(5)`, and `npm-config(7)` for more on managing npm's configuration.

+## Does npm send any information about me back to the registry?
+
+When making requests of the registry npm adds two headers with information


I'd start this with the word Yes.

Oh... of course! =D

ashleygwilliams · 2016-10-07T23:15:52Z

doc/misc/npm-registry.md

+  continous integration environment, "false" otherwise. This is detected by
+  looking for the following environment variables: `CI`, `TDDIUM`,
+  `JENKINS_URL`, `bamboo.buildKey`. This is used to gather better metrics on
+  how npm is used by humans, versus build farms.


might say bots instead of build farm here

Huh, I would think of bots as something entirely different than CI…

ashleygwilliams · 2016-10-07T23:18:54Z

doc/misc/npm-registry.md

@@ -21,6 +21,21 @@ The registry URL used is determined by the scope of the package (see
 supplied by the `registry` config parameter.  See `npm-config(1)`,
 `npmrc(5)`, and `npm-config(7)` for more on managing npm's configuration.

+## Does npm send any information about me back to the registry?


i'd also mention if the data sent is tied to username or package. i.e. is it "anonymized", not taken into account with any other data. also is the scope and the ci data going to be analyzed together or kept separate. people might worry about rate limiting.

I think I can kind of see where your going with this but I'm at a loss as to what to do exactly?

"data sent is tied to username or package" I don't really know what you mean by "tied"? If you're authed then your authentication info can be traced back to a username, and of course the package name you're installing is the primary bit of the request…

This seems to get into the what the registry will do with this information. (The answer right now is "ignore it".)

As for what we might do with it? What do we need to say beyond the tentative descriptions I've given below?

Something like? "We choose not to correlate the information in these headers with any authenticated accounts you're using."

yeah that last line sounds super good.

ashleygwilliams · 2016-10-07T23:20:06Z

doc/misc/npm-registry.md

+  organization.
+* `Npm-In-CI` – Set to "true" if npm believes this install is running in a
+  continous integration environment, "false" otherwise. This is detected by
+  looking for the following environment variables: `CI`, `TDDIUM`,


maybe link to the code that does this? i imagine people will want to argue technically about how this is incomplete and/or not accurate so it may be helpful to tell them where a PR would be useful.

ashleygwilliams · 2016-10-10T17:36:30Z

doc/misc/npm-registry.md

@@ -21,6 +21,21 @@ The registry URL used is determined by the scope of the package (see
 supplied by the `registry` config parameter.  See `npm-config(1)`,
 `npmrc(5)`, and `npm-config(7)` for more on managing npm's configuration.

+## Does npm send any information about me back to the registry?


yeah that last line sounds super good.

ashleygwilliams · 2016-10-10T17:36:42Z

doc/misc/npm-registry.md

+  organization.
+* `Npm-In-CI` – Set to "true" if npm believes this install is running in a
+  continous integration environment, "false" otherwise. This is detected by
+  looking for the following environment variables: `CI`, `TDDIUM`,


@iarna

Credit: @iarna PR-URL: npm/npm-registry-client#129 PR-URL: npm/npm-registry-client#145

@iarna

Npm-Scope is set to the scope of the current top level project. Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

@iarna

Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

@iarna

Credit: @iarna PR-URL: #14129 Reviewed-By: @ashleygwilliams

@iarna

Npm-Scope is set to the scope of the current top level project. Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

@iarna

Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

@iarna

Credit: @iarna PR-URL: #14129 Reviewed-By: @ashleygwilliams

iarna · 2016-10-20T10:43:37Z

This has been merged into release-next.

iarna added the target-latest label Sep 29, 2016

iarna force-pushed the iarna/scope-header branch 2 times, most recently from d17d942 to b53f7fa Compare September 29, 2016 23:59

othiym23 reviewed Sep 30, 2016

View reviewed changes

iarna force-pushed the release-next branch 15 times, most recently from 040beea to 5b4e3f3 Compare October 7, 2016 02:55

iarna force-pushed the iarna/scope-header branch 2 times, most recently from b960147 to 267d7ef Compare October 7, 2016 23:11

ashleygwilliams reviewed Oct 7, 2016

View reviewed changes

iarna force-pushed the iarna/scope-header branch 2 times, most recently from 842df62 to df78055 Compare October 7, 2016 23:33

ashleygwilliams suggested changes Oct 10, 2016

View reviewed changes

iarna added this to the 4.x milestone Oct 17, 2016

zkat added the in-progress label Oct 19, 2016

iarna force-pushed the iarna/scope-header branch from df78055 to ac20b31 Compare October 20, 2016 09:59

iarna force-pushed the release-next branch from 61a39ae to 94255da Compare October 20, 2016 10:06

iarna added 4 commits October 20, 2016 03:19

npm-registry-client@7.3.0

af03381

Credit: @iarna PR-URL: npm/npm-registry-client#129 PR-URL: npm/npm-registry-client#145

npm: Send Npm-Scope header along with requests to registry

60a0678

Npm-Scope is set to the scope of the current top level project. Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

test: Add test to ensure CI header is being sent when env is set

87d7244

Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

doc: Document headers we add to registry requests

4420cf8

Credit: @iarna PR-URL: #14129 Reviewed-By: @ashleygwilliams

iarna force-pushed the iarna/scope-header branch from ac20b31 to 4420cf8 Compare October 20, 2016 10:19

iarna added a commit that referenced this pull request Oct 20, 2016

npm: Send Npm-Scope header along with requests to registry

6b6bb08

Npm-Scope is set to the scope of the current top level project. Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

iarna added a commit that referenced this pull request Oct 20, 2016

test: Add test to ensure CI header is being sent when env is set

506de80

Credit: @iarna PR-URL: #14129 Reviewed-By: @othiym23

iarna added a commit that referenced this pull request Oct 20, 2016

doc: Document headers we add to registry requests

c246a75

Credit: @iarna PR-URL: #14129 Reviewed-By: @ashleygwilliams

iarna removed the in-progress label Oct 20, 2016

iarna closed this Oct 20, 2016

This was referenced Oct 25, 2016

deps: upgrade npm to 4.0.1 nodejs/node#9284

Closed

Undocumented breaking change for scoped package config in npm@4 #14432

Closed

npm 4.0.1 tries to install public deps from private registry in scoped package #14412

Closed

iarna deleted the iarna/scope-header branch December 1, 2016 00:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send current project scope & CI status headers on request #14129

Send current project scope & CI status headers on request #14129

iarna commented Sep 29, 2016 •

edited

othiym23 left a comment

othiym23 Sep 30, 2016

othiym23 Sep 30, 2016

ashleygwilliams Oct 7, 2016

iarna Oct 7, 2016

ashleygwilliams Oct 7, 2016

iarna Oct 7, 2016

ashleygwilliams Oct 7, 2016

iarna Oct 7, 2016

ashleygwilliams Oct 10, 2016

ashleygwilliams Oct 7, 2016

iarna Oct 7, 2016

ashleygwilliams Oct 10, 2016

ashleygwilliams Oct 10, 2016

ashleygwilliams Oct 10, 2016

iarna commented Oct 20, 2016

Send current project scope & CI status headers on request #14129

Send current project scope & CI status headers on request #14129

Conversation

iarna commented Sep 29, 2016 • edited

othiym23 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iarna commented Oct 20, 2016

iarna commented Sep 29, 2016 •

edited