Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(log): line key does not necessarily exist #5588

Merged
merged 2 commits into from Nov 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/lucky-eyes-double.md
@@ -0,0 +1,6 @@
---
"@pnpm/default-reporter": patch
"pnpm": patch
---

The reporter should not crash when the CLI process is kill during lifecycle scripts execution [#5588](https://github.com/pnpm/pnpm/pull/5588).
5 changes: 5 additions & 0 deletions .changeset/moody-weeks-reply.md
@@ -0,0 +1,5 @@
---
"@pnpm/lifecycle": patch
---

Never log a lifecycle exit debug log without an exit code [#5588](https://github.com/pnpm/pnpm/pull/5588).
Expand Up @@ -266,6 +266,7 @@ function formatLine (maxWidth: number, logObj: LifecycleLog) {
}

function cutLine (line: string, maxLength: number) {
if (!line) return '' // This actually should never happen but it is better to be safe
return stripAnsi(line).slice(0, maxLength)
}

Expand Down
46 changes: 46 additions & 0 deletions packages/default-reporter/test/reportingLifecycleScripts.ts
Expand Up @@ -739,6 +739,52 @@ ${STATUS_INDENTATION} ${STATUS_FAILED}`)
})
})

test('do not fail if the debug log has no output', (done) => {
const output$ = toOutput$({
context: { argv: ['install'] },
reportingOptions: { outputMaxWidth: 79 },
streamParser: createStreamParser(),
})

const wd = path.resolve(process.cwd(), 'node_modules', '.registry.npmjs.org', 'foo', '1.0.0', 'node_modules', 'foo')

lifecycleLogger.debug({
depPath: 'registry.npmjs.org/foo/1.0.0',
optional: false,
script: 'node foo',
stage: 'install',
wd,
})
lifecycleLogger.debug({
depPath: 'registry.npmjs.org/foo/1.0.0',
line: undefined as any, // eslint-disable-line @typescript-eslint/no-explicit-any
stage: 'install',
stdio: 'stdout',
wd,
})
lifecycleLogger.debug({
depPath: 'registry.npmjs.org/foo/1.0.0',
exitCode: 1,
optional: false,
stage: 'install',
wd,
})

expect.assertions(1)

output$.pipe(skip(1), take(1), map(normalizeNewline)).subscribe({
complete: () => done(),
error: done,
next: (output: string) => {
expect(replaceTimeWith1Sec(output)).toBe(`\
${chalk.gray('node_modules/.registry.npmjs.org/foo/1.0.0/node_modules/')}foo: Running install script, failed in 1s
.../foo/1.0.0/node_modules/foo ${INSTALL}$ node foo
${OUTPUT_INDENTATION}
${STATUS_INDENTATION} ${STATUS_FAILED}`)
},
})
})

// Many libs use stderr for logging, so showing all stderr adds not much value
test['skip']('prints lifecycle progress', (done) => {
const output$ = toOutput$({
Expand Down
2 changes: 1 addition & 1 deletion packages/lifecycle/src/runLifecycleHook.ts
Expand Up @@ -100,7 +100,7 @@ export async function runLifecycleHook (
// Preventing the pnpm reporter from overriding the project's script output
return
}
const code = arguments[3]
const code = arguments[3] ?? 1
lifecycleLogger.debug({
depPath: opts.depPath,
exitCode: code,
Expand Down