Why are stack traces enabled in CI (GitHub Actions)?

[jasonkuhrt]

I've been debugging without success why OClif is showing stack traces for errors in our CI pipeline. It breaks our snapshot tests that do not expect stack traces to be displayed.

I'm resorting to using pnpm patch with added internal logging to figure this out. My presumption is that the logging comes from the handle function https://github.com/oclif/core/blob/main/src/errors/handle.ts#L30. Perhaps the debug property is true, but if so, I don't know why it would be.

Here's an example test failure from a recent run:

[jasonkuhrt]

Turns out debug is true, now trying to understand why that is.

[mdonnalley]

The debug setting is set here: https://github.com/oclif/core/blob/main/src/execute.ts#L58-L62

[jasonkuhrt]

Thanks, I'm aware. I've narrowed down my problem to around here:

It seems the code in the repo has changed since, not seeing _debug there https://github.com/oclif/core/blob/db95c989e9c5c3101c70c043efd8fcc99cc67b9f/src/config/config.ts.

[jasonkuhrt]

So, OClif sets debug true if <BIN_NAME>_DEBUG=true is in the environment. This was not clear to me. If that's documented, I missed it. Is it?

[mdonnalley]

What version of oclif/core are you using? The latest version no longer has that _debug method on Config

[jasonkuhrt]

We're currently on @oclif/core@3.26.6.

Does the new version not have the behaviour I discovered above?

[mdonnalley]

I think it's showing stack traces because of something on your end. How are you executing your CLI?

With a newly generated CLI, you can see that the stack trace only shows up if you use bin/dev.js

~/code/gh-discussion-1277 via ⬢ v20.17.0
❯ bin/run.js hello INVALID
 ›   Error: The following error occurred:
 ›     Missing required flag from
 ›   See more help with --help

~/code/gh-discussion-1277 via ⬢ v20.17.0
❯ bin/dev.js hello INVALID
Error: The following error occurred:
  Missing required flag from
See more help with --help
    at validateFlags (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/parser/validate.js:77:19)
    at async Object.parse (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/parser/index.js:20:5)
    at async Hello.parse (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/command.js:254:25)
    at async Hello.run (file:///Users/mdonnalley/code/gh-discussion-1277/src/commands/hello/index.ts:16:33)
    at async Hello._run (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/command.js:312:22)
    at async Config.runCommand (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/config/config.js:435:25)
    at async run (/Users/mdonnalley/code/gh-discussion-1277/node_modules/@oclif/core/lib/main.js:96:16)
    at async file:///Users/mdonnalley/code/gh-discussion-1277/bin/dev.js:6:1

If you remove the settings.debug = true line that happens inside of the execute function, then the stack trace isn't printed. So that tells me that you're likely using the dev script for your snapshot tests

[jasonkuhrt]

We're not using dev. But we did have HIVE_DEBUG envar set which I had not noticed.