fix(logs): clean args for failed commands

PR-URL: #3761 Credit: @wraithgar Close: #3761 Reviewed-by: @lukekarrys
npm · Sep 15, 2021 · ca792ac · ca792ac
1 parent 371655a
commit ca792ac
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 1 deletion.
diff --git a/lib/utils/error-message.js b/lib/utils/error-message.js
@@ -367,7 +367,7 @@ module.exports = (er, npm) => {
         detail.push(['signal', er.signal])
 
       if (er.cmd && Array.isArray(er.args))
-        detail.push(['command', ...[er.cmd, ...er.args]])
+        detail.push(['command', ...[er.cmd, ...er.args.map(replaceInfo)]])
 
       if (er.stdout)
         detail.push(['', er.stdout.trim()])

diff --git a/tap-snapshots/test/lib/utils/error-message.js.test.cjs b/tap-snapshots/test/lib/utils/error-message.js.test.cjs
@@ -180,6 +180,40 @@ Object {
 }
 `
 
+exports[`test/lib/utils/error-message.js TAP args are cleaned > must match snapshot 1`] = `
+Object {
+  "detail": Array [
+    Array [
+      "signal",
+      "SIGYOLO",
+    ],
+    Array [
+      "command",
+      "some command",
+      "a",
+      "r",
+      "g",
+      "s",
+      "https://evil:***@npmjs.org",
+    ],
+    Array [
+      "",
+      "stdout",
+    ],
+    Array [
+      "",
+      "stderr",
+    ],
+  ],
+  "summary": Array [
+    Array [
+      "",
+      "cmd err",
+    ],
+  ],
+}
+`
+
 exports[`test/lib/utils/error-message.js TAP bad engine with config loaded > must match snapshot 1`] = `
 Object {
   "detail": Array [

diff --git a/test/lib/utils/error-message.js b/test/lib/utils/error-message.js
@@ -201,6 +201,17 @@ t.test('default message', t => {
   t.end()
 })
 
+t.test('args are cleaned', t => {
+  t.matchSnapshot(errorMessage(Object.assign(new Error('cmd err'), {
+    cmd: 'some command',
+    signal: 'SIGYOLO',
+    args: ['a', 'r', 'g', 's', 'https://evil:password@npmjs.org'],
+    stdout: 'stdout',
+    stderr: 'stderr',
+  }), npm))
+  t.end()
+})
+
 t.test('eacces/eperm', t => {
   const runTest = (windows, loaded, cachePath, cacheDest) => t => {
     if (windows)