feat: streaming debug logfile #4062

lukekarrys · 2021-11-18T17:51:57Z

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

lib/commands/exec.js

lib/commands/init.js

lib/npm.js

lib/utils/display.js

tap-snapshots/test/lib/utils/error-message.js.test.cjs

@lukekarrys

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: #4062 Credit: @lukekarrys Close: #4062 Reviewed-by: @wraithgar

lukekarrys changed the base branch from latest to release-next November 18, 2021 17:52

lukekarrys force-pushed the lk/stream-log-file branch 16 times, most recently from 4394532 to 64e70ba Compare November 30, 2021 01:09

lukekarrys marked this pull request as ready for review November 30, 2021 01:18

lukekarrys requested a review from a team as a code owner November 30, 2021 01:18

darcyclarke added semver:minor new backwards-compatible feature Release 8.x work is associated with a specific npm 8 release labels Nov 30, 2021

lukekarrys force-pushed the lk/stream-log-file branch from 64e70ba to b9c3857 Compare November 30, 2021 17:19

lukekarrys changed the title ~~Log file~~ feat: streaming debug logfile Nov 30, 2021