Repository: nodejs/node
Pull request: test: only show overridden env in child process failures

Previously when the child process helpers are used to print information about the failed expectations and the env of the child process was overridden, it printed the entire env object, which may be too much if the caller does something like `{ env: { ENV: 'var', ...process.env } }` (which tend to be always the case for specifying env because we need to copy the process.env for dynamic library loading in the CI). This updates it to only show the env vars that differ from process.env for a cleaner log in the case of failure.

<!--
Before submitting a pull request, please read:

- the CONTRIBUTING guide at https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md
- the commit message formatting guidelines at
  https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines

For code changes:
1. Include tests for any bug fixes or new features.
2. Update documentation if relevant.
3. Ensure that `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes.

If you believe this PR should be highlighted in the Node.js CHANGELOG
please add the `notable-change` label.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
-->


Changed files:
filename: test/common/child_process.js
patch: @@ -86,8 +86,22 @@ function expectSyncExit(caller, spawnArgs, {
     console.error(`${tag} status = ${child.status}, signal = ${child.signal}`);
 
     const error = new Error(`${failures.join('\n')}`);
-    if (spawnArgs[2]) {
-      error.options = spawnArgs[2];
+    if (typeof spawnArgs[2] === 'object' && spawnArgs[2] !== null) {
+      const envInOptions = spawnArgs[2].env;
+      // If the env is overridden in the spawn options, include it in the error
+      // object for easier debugging.
+      if (typeof envInOptions === 'object' && envInOptions !== null && envInOptions !== process.env) {
+        // Only include the environment variables that are different from
+        // the current process.env to avoid cluttering the output.
+        error.options = { ...spawnArgs[2], env: {} };
+        for (const key of Object.keys(envInOptions)) {
+          if (envInOptions[key] !== process.env[key]) {
+            error.options.env[key] = spawnArgs[2].env[key];
+          }
+        }
+      } else {
+        error.options = spawnArgs[2];
+      }
     }
     let command = spawnArgs[0];
     if (Array.isArray(spawnArgs[1])) {