From 6734ba36dd6e07a859ab4d6eb4f264d2c0022276 Mon Sep 17 00:00:00 2001
From: Luke Karrys <luke@lukekarrys.com>
Date: Sat, 27 Nov 2021 08:08:06 -0700
Subject: feat: streaming debug logfile

This decouples the log file writing from the terminal logging. We now
open an append only file at the start of the process and stream logs to
it. We still only display the log file message in timing mode or if
there is an error, but the file is still written regardless.

All logging now goes through `proc-log` and this is the first step to
removing `npmlog`. For now `npmlog` is still used for the terminal
logging but with a shim in front of it to make it easier to test and
use in conjunction with `proc-log`. Ref: npm/statusboard#366

This also refactors many of the tests to always use an explicit
`t.testdir` for their cache since the file is opened on each `new Npm()`.
Tests are also refactored to use more of `MockNpm` with behavior to
add config items and load `npm` if necessary. A new fixture `mockGlobals`
was also added to make much of this more ergonomic. Ref: npm/statusboard#410

Closes npm/statusboard#411
Closes npm/statusboard#367

PR-URL: https://github.com/npm/cli/pull/4062
Credit: @lukekarrys
Close: #4062
Reviewed-by: @wraithgar
---
 test/lib/commands/doctor.js | 83 ++++++++++++++++++++++-----------------------
 1 file changed, 40 insertions(+), 43 deletions(-)

(limited to 'test/lib/commands/doctor.js')

diff --git a/test/lib/commands/doctor.js b/test/lib/commands/doctor.js
index e3ad5cc72..51b6111a0 100644
--- a/test/lib/commands/doctor.js
+++ b/test/lib/commands/doctor.js
@@ -50,13 +50,13 @@ const logs = {
   info: [],
 }
 
-const clearLogs = (obj = logs) => {
+const clearLogs = () => {
   output.length = 0
-  for (const key in obj) {
-    if (Array.isArray(obj[key])) {
-      obj[key].length = 0
+  for (const key in logs) {
+    if (Array.isArray(logs[key])) {
+      logs[key].length = 0
     } else {
-      delete obj[key]
+      delete logs[key]
     }
   }
 }
@@ -65,13 +65,41 @@ const npm = {
   flatOptions: {
     registry: 'https://registry.npmjs.org/',
   },
-  log: {
+  version: '7.1.0',
+  output: data => {
+    output.push(data)
+  },
+}
+
+let latestNpm = npm.version
+const pacote = {
+  manifest: async () => {
+    return { version: latestNpm }
+  },
+}
+
+let verifyResponse = { verifiedCount: 1, verifiedContent: 1 }
+const cacache = {
+  verify: async () => {
+    return verifyResponse
+  },
+}
+
+const mocks = {
+  '../../../lib/utils/is-windows.js': false,
+  '../../../lib/utils/ping.js': ping,
+  cacache,
+  pacote,
+  'make-fetch-happen': fetch,
+  which,
+  'proc-log': {
     info: msg => {
       logs.info.push(msg)
     },
+  },
+  npmlog: {
     newItem: name => {
       logs[name] = {}
-
       return {
         info: (_, msg) => {
           if (!logs[name].info) {
@@ -109,33 +137,11 @@ const npm = {
       error: 0,
     },
   },
-  version: '7.1.0',
-  output: data => {
-    output.push(data)
-  },
-}
 
-let latestNpm = npm.version
-const pacote = {
-  manifest: async () => {
-    return { version: latestNpm }
-  },
-}
-
-let verifyResponse = { verifiedCount: 1, verifiedContent: 1 }
-const cacache = {
-  verify: async () => {
-    return verifyResponse
-  },
 }
 
 const Doctor = t.mock('../../../lib/commands/doctor.js', {
-  '../../../lib/utils/is-windows.js': false,
-  '../../../lib/utils/ping.js': ping,
-  cacache,
-  pacote,
-  'make-fetch-happen': fetch,
-  which,
+  ...mocks,
 })
 const doctor = new Doctor(npm)
 
@@ -205,7 +211,7 @@ t.test('node versions', t => {
         npm.globalDir = dir
         npm.localBin = dir
         npm.globalBin = dir
-        npm.log.level = 'info'
+        mocks.npmlog.level = 'info'
 
         st.teardown(() => {
           delete npm.cache
@@ -214,7 +220,7 @@ t.test('node versions', t => {
           delete npm.globalDir
           delete npm.localBin
           delete npm.globalBin
-          npm.log.level = 'error'
+          mocks.npmlog.level = 'error'
           clearLogs()
         })
 
@@ -293,12 +299,8 @@ t.test('node versions', t => {
 
       vt.test('npm doctor skips some tests in windows', async st => {
         const WinDoctor = t.mock('../../../lib/commands/doctor.js', {
+          ...mocks,
           '../../../lib/utils/is-windows.js': true,
-          '../../../lib/utils/ping.js': ping,
-          cacache,
-          pacote,
-          'make-fetch-happen': fetch,
-          which,
         })
         const winDoctor = new WinDoctor(npm)
 
@@ -592,12 +594,7 @@ t.test('node versions', t => {
         }
 
         const Doctor = t.mock('../../../lib/commands/doctor.js', {
-          '../../../lib/utils/is-windows.js': false,
-          '../../../lib/utils/ping.js': ping,
-          cacache,
-          pacote,
-          'make-fetch-happen': fetch,
-          which,
+          ...mocks,
           fs,
         })
         const doctor = new Doctor(npm)
-- 
cgit v1.2.3