fix: the dlx, create, and exec commands should set npm_config_user_agent

close #3985
pnpm · Feb 10, 2022 · 804a35b · 804a35b
1 parent fe1ff2f
commit 804a35b
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 22 deletions.
diff --git a/.changeset/thirty-owls-fix.md b/.changeset/thirty-owls-fix.md
@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-script-runners": patch
+"pnpm": patch
+---
+
+The `dlx`, `create`, and `exec` commands should set the `npm_config_user_agent` env variable.
diff --git a/packages/plugin-commands-script-runners/src/dlx.ts b/packages/plugin-commands-script-runners/src/dlx.ts
@@ -6,8 +6,8 @@ import { OUTPUT_OPTIONS } from '@pnpm/common-cli-options-help'
 import { Config } from '@pnpm/config'
 import rimraf from '@zkochan/rimraf'
 import execa from 'execa'
-import PATH from 'path-name'
 import renderHelp from 'render-help'
+import { makeEnv } from './makeEnv'
 
 export const commandNames = ['dlx']
 
@@ -43,7 +43,7 @@ export function help () {
 export async function handler (
   opts: {
     package?: string[]
-  } & Pick<Config, 'reporter'>,
+  } & Pick<Config, 'reporter' | 'userAgent'>,
   params: string[]
 ) {
   const prefix = path.join(fs.realpathSync(os.tmpdir()), `dlx-${process.pid.toString()}`)
@@ -69,13 +69,7 @@ export async function handler (
     stdio: 'inherit',
   })
   await execa(versionless(scopeless(params[0])), params.slice(1), {
-    env: {
-      ...process.env,
-      [PATH]: [
-        bins,
-        process.env[PATH],
-      ].join(path.delimiter),
-    },
+    env: makeEnv({ userAgent: opts.userAgent, prependPaths: [bins] }),
     stdio: 'inherit',
   })
 }

diff --git a/packages/plugin-commands-script-runners/src/exec.ts b/packages/plugin-commands-script-runners/src/exec.ts
@@ -8,10 +8,10 @@ import sortPackages from '@pnpm/sort-packages'
 import { Project } from '@pnpm/types'
 import execa from 'execa'
 import pLimit from 'p-limit'
-import PATH from 'path-name'
 import pick from 'ramda/src/pick'
 import renderHelp from 'render-help'
 import existsInDir from './existsInDir'
+import { makeEnv } from './makeEnv'
 import {
   PARALLEL_OPTION_HELP,
   shorthands as runShorthands,
@@ -70,7 +70,7 @@ export async function handler (
     reverse?: boolean
     sort?: boolean
     workspaceConcurrency?: number
-  } & Pick<Config, 'extraBinPaths' | 'lockfileDir' | 'dir' | 'recursive' | 'workspaceDir'>,
+  } & Pick<Config, 'extraBinPaths' | 'lockfileDir' | 'dir' | 'userAgent' | 'recursive' | 'workspaceDir'>,
   params: string[]
 ) {
   // For backward compatibility
@@ -121,16 +121,17 @@ export async function handler (
             : {}
           await execa(params[0], params.slice(1), {
             cwd: prefix,
-            env: {
-              ...process.env,
-              ...extraEnv,
-              [PATH]: [
+            env: makeEnv({
+              extraEnv: {
+                ...extraEnv,
+                PNPM_PACKAGE_NAME: opts.selectedProjectsGraph?.[prefix]?.package.manifest.name,
+              },
+              prependPaths: [
                 path.join(opts.dir, 'node_modules/.bin'),
                 ...opts.extraBinPaths,
-                process.env[PATH],
-              ].join(path.delimiter),
-              PNPM_PACKAGE_NAME: opts.selectedProjectsGraph?.[prefix]?.package.manifest.name,
-            },
+              ],
+              userAgent: opts.userAgent,
+            }),
             stdio: 'inherit',
           })
           result.passes++

diff --git a/packages/plugin-commands-script-runners/src/makeEnv.ts b/packages/plugin-commands-script-runners/src/makeEnv.ts
@@ -0,0 +1,20 @@
+import path from 'path'
+import PATH from 'path-name'
+
+export function makeEnv (
+  opts: {
+    extraEnv?: NodeJS.ProcessEnv
+    userAgent?: string
+    prependPaths: string[]
+  }
+) {
+  return {
+    ...process.env,
+    ...opts.extraEnv,
+    npm_config_user_agent: opts.userAgent ?? 'pnpm',
+    [PATH]: [
+      ...opts.prependPaths,
+      process.env[PATH],
+    ].join(path.delimiter),
+  }
+}
diff --git a/packages/plugin-commands-script-runners/src/run.ts b/packages/plugin-commands-script-runners/src/run.ts
@@ -114,7 +114,7 @@ For options that may be used with `-r`, see "pnpm help recursive"',
 export type RunOpts =
   & Omit<RecursiveRunOpts, 'allProjects' | 'selectedProjectsGraph' | 'workspaceDir'>
   & { recursive?: boolean }
-  & Pick<Config, 'dir' | 'engineStrict' | 'extraBinPaths' | 'reporter' | 'scriptsPrependNodePath' | 'scriptShell' | 'shellEmulator' | 'enablePrePostScripts'>
+  & Pick<Config, 'dir' | 'engineStrict' | 'extraBinPaths' | 'reporter' | 'scriptsPrependNodePath' | 'scriptShell' | 'shellEmulator' | 'enablePrePostScripts' | 'userAgent'>
   & (
     & { recursive?: false }
     & Partial<Pick<Config, 'allProjects' | 'selectedProjectsGraph' | 'workspaceDir'>>

diff --git a/packages/plugin-commands-script-runners/test/dlx.ts b/packages/plugin-commands-script-runners/test/dlx.ts
@@ -8,10 +8,15 @@ beforeEach((execa as jest.Mock).mockClear)
 
 test('dlx should work with scoped packages', async () => {
   prepareEmpty()
+  const userAgent = 'pnpm/0.0.0'
 
-  await dlx.handler({}, ['@foo/bar'])
+  await dlx.handler({ userAgent }, ['@foo/bar'])
 
-  expect(execa).toBeCalledWith('bar', [], expect.anything())
+  expect(execa).toBeCalledWith('bar', [], expect.objectContaining({
+    env: expect.objectContaining({
+      npm_config_user_agent: userAgent,
+    }),
+  }))
 })
 
 test('dlx should work with versioned packages', async () => {