Move user-agent template populating into userAgent flattener

npm · Mar 16, 2021 · 300ff77 · 300ff77
1 parent 3122142
commit 300ff77
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 28 deletions.
diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
@@ -142,6 +142,7 @@ define('all', {
     all outdated or installed packages, rather than only those directly
     depended upon by the current project.
   `,
+  flatten,
 })
 
 define('allow-same-version', {
@@ -688,7 +689,7 @@ define('force', {
   flatten,
 })
 
-define('foreground-script', {
+define('foreground-scripts', {
   default: false,
   type: Boolean,
   description: `
@@ -1326,6 +1327,7 @@ define('parseable', {
     Output parseable results from commands that write to standard output. For
     \`npm search\`, this will be tab-separated table format.
   `,
+  flatten,
 })
 
 define('prefer-offline', {
@@ -1940,7 +1942,17 @@ define('user-agent', {
     * \`{ci}\` - The value of the \`ci-name\` config, if set, prefixed with
       \`ci/\`, or an empty string if \`ci-name\` is empty.
   `,
-  flatten,
+  flatten (key, obj, flatOptions) {
+    const value = obj[key]
+    const ciName = obj['ci-name']
+    flatOptions.userAgent =
+      value.replace(/\{node-version\}/gi, obj['node-version'])
+        .replace(/\{npm-version\}/gi, obj['npm-version'])
+        .replace(/\{platform\}/gi, process.platform)
+        .replace(/\{arch\}/gi, process.arch)
+        .replace(/\{ci\}/gi, ciName ? `ci/${ciName}` : '')
+        .trim()
+  },
 })
 
 define('userconfig', {

diff --git a/node_modules/@npmcli/config/lib/get-user-agent.js b/node_modules/@npmcli/config/lib/get-user-agent.js
diff --git a/node_modules/@npmcli/config/lib/index.js b/node_modules/@npmcli/config/lib/index.js
diff --git a/tap-snapshots/test-lib-utils-config-definitions.js-TAP.test.js b/tap-snapshots/test-lib-utils-config-definitions.js-TAP.test.js
@@ -49,7 +49,7 @@ Array [
   "fetch-retry-mintimeout",
   "fetch-timeout",
   "force",
-  "foreground-script",
+  "foreground-scripts",
   "format-package-lock",
   "fund",
   "git",

diff --git a/tap-snapshots/test-lib-utils-config-describe-all.js-TAP.test.js b/tap-snapshots/test-lib-utils-config-describe-all.js-TAP.test.js
@@ -385,7 +385,7 @@ mistakes, unnecessary performance degradation, and malicious input.
 If you don't have a clear idea of what you want to do, it is strongly
 recommended that you do not use this option!
 
-#### \`foreground-script\`
+#### \`foreground-scripts\`
 
 * Default: false
 * Type: Boolean

diff --git a/test/lib/utils/config/definitions.js b/test/lib/utils/config/definitions.js
@@ -677,3 +677,21 @@ t.test('detect CI', t => {
   t.equal(defnCIFoo['ci-name'].default, 'foo', 'name of CI when in CI')
   t.end()
 })
+
+t.test('user-agent', t => {
+  const obj = {
+    'user-agent': definitions['user-agent'].default,
+    'npm-version': '1.2.3',
+    'node-version': '9.8.7',
+  }
+  const flat = {}
+  const expectNoCI = `npm/1.2.3 node/9.8.7 ` +
+    `${process.platform} ${process.arch}`
+  definitions['user-agent'].flatten('user-agent', obj, flat)
+  t.equal(flat.userAgent, expectNoCI)
+  obj['ci-name'] = 'foo'
+  const expectCI = `${expectNoCI} ci/foo`
+  definitions['user-agent'].flatten('user-agent', obj, flat)
+  t.equal(flat.userAgent, expectCI)
+  t.end()
+})