List of tests where console.log|error can be replaced with debug

[HarshithaKP]

This issue is to track all the test files that have console.log|error that can be replaced with debug statements. The consideration is that only informative messages can be replaced, not the one that influence the test logic itself.
A good candidate for a future code & learn. Recommend one per person, doing more does not add value.
Refs: #32588 (comment)

Checklist for reference

test/parallel

• test-cluster-setup-master-cumulative.js
• test-cluster-setup-master-multiple.js
• test-cluster-worker-wait-server-close.js
• test-code-cache.js
• test-crypto.js
• test-dgram-close.js
• test-domain-http-server.js
• test-domain-stack.js
• test-event-emitter-listeners-side-effects.js
• test-event-emitter-subclass.js
• test-exception-handler2.js

[I am still building the list]

[HarshithaKP]

Can someone label this as "good-first-issue"?

[gireeshpunathil]

/cc @nodejs/testing

[himself65]

I think const debug = require('util').debuglog('test') can be extracted to the `common' module if we really do this

using

const common = require('common')

common.debug('xxx')

[Trott]

The console.log() statements in test-cli-eval.js are part of the test and changing them to debug will make the test fail, as it should. Those statement should be left alone. That test should not be on the list, I don't think.

[Trott]

Same for test-cli-node-options.js. Shouldn't be changed.

[Trott]

By the way, there are (at the time of this writing) still 8 open code-and-learn PRs that can be helped to a conclusion.

[daemon1024]

Can I work on this issue ?

From what I understand, I just need to replace console.log/error(message) with debug(message) across the listed tests.

[HarshithaKP]

@daemon1024, yes please; but would suggest to pick up only (any) one item.

[agustindaguerre]

I would like to work on this issue as well, may I take test-cluster-setup-master-multiple.js ?

[daemon1024]

@daemon1024, yes please;

Great @HarshithaKP

but would suggest to pick up only (any) one item.

Sure. I will start with working on test-domain-http-server.js

[addaleax]

Not to bring anybody down, but … can we spell out what the motivation for this is? All I can see coming out as a result of this is that some tests become harder to debug when they fail in CI.

[daemon1024]

can we spell out what the motivation for this is? All I can see coming out as a result of this is that some tests become harder to debug when they fail in CI.

@addaleax as mentioned in the reference comment .

The idea is to separate output that is considered part of the test itself from informational/debug output. The rationale is to make the intent of the output clear and to avoid cases where the debug output itself may alter the outcome of the test

Should clarify things up.

[Trott]

The idea is to separate output that is considered part of the test itself from informational/debug output. The rationale is to make the intent of the output clear and to avoid cases where the debug output itself may alter the outcome of the test

Should clarify things up.

Yeah, here's the thing. That's a problem that comes up infrequently. It happens. I've been bit by it. But the problem of a test intermittently timing out in CI and there not being enough information to figure out what's going on? Happens a lot. Way more often than console.log() messing up a test with timing, and so on. And it often happens that the test only times out once in 100 runs or 1000 runs. And often the stress test job can't reproduce it because it only happens under certain conditions on a certain machine, but that's not obvious at the outset.

I will take some extra information that confuses me a little bit once in a long while over spending hours trying to reproduce a test failure so I can debug it.

I'm not opposed to this. I'm not going to block it. But I am, sorry to say, unenthusiastic.