cli: implement --trace-env and --trace-env-[js|native]-stack #55604

joyeecheung · 2024-10-30T15:44:24Z

This implements --trace-env, --trace-env-js-stack and --trace-env-native-stack CLI options that print information about any access to environment variables done in the current Node.js instance to stderr, including:

The environment variable reads that Node.js does internally.
Writes in the form of process.env.KEY = "SOME VALUE".
Reads in the form of process.env.KEY.
Definitions in the form of Object.defineProperty(process.env, 'KEY', {...}).
Queries in the form of Object.hasOwn(process.env, 'KEY'),
process.env.hasOwnProperty('KEY') or 'KEY' in process.env.
Deletions in the form of delete process.env.KEY.
Enumerations inf the form of ...process.env or Object.keys(process.env).

Only the names of the environment variables being accessed are printed. The values are not printed. To print the stack trace of the access, use --trace-env-js-stack and/or --trace-env-native-stack.

$ cat env.js
const foo = process.env.FOO;
process.env.FOO = foo + "foo";

$ out/Release/node --trace-env env.js
[--trace-env] get environment variable "NODE_ICU_DATA"
[--trace-env] get environment variable "OPENSSL_CONF"
[--trace-env] get environment variable "NODE_EXTRA_CA_CERTS"
[--trace-env] get environment variable "NODE_DEBUG_NATIVE"
[--trace-env] get environment variable "NODE_COMPILE_CACHE"
[--trace-env] get environment variable "NODE_NO_WARNINGS"
[--trace-env] get environment variable "NODE_V8_COVERAGE"
[--trace-env] get environment variable "NODE_DEBUG"
[--trace-env] get environment variable "NODE_CHANNEL_FD"
[--trace-env] get environment variable "NODE_UNIQUE_ID"
[--trace-env] get environment variable "HOME"
[--trace-env] get environment variable "NODE_PATH"
[--trace-env] get environment variable "WATCH_REPORT_DEPENDENCIES"
[--trace-env] get environment variable "FOO"
[--trace-env] set environment variable "FOO"

See output of `--trace-env-js-stack`

out/Release/node --trace-env-js-stack env.js
[--trace-env] get environment variable "NODE_ICU_DATA"
[--trace-env] get environment variable "OPENSSL_CONF"
[--trace-env] get environment variable "NODE_EXTRA_CA_CERTS"
[--trace-env] get environment variable "NODE_DEBUG_NATIVE"
[--trace-env] get environment variable "NODE_COMPILE_CACHE"
[--trace-env] get environment variable "NODE_NO_WARNINGS"

----- JavaScript stack trace -----

1: setupWarningHandler (node:internal/process/pre_execution:263:17)
2: prepareExecution (node:internal/process/pre_execution:102:3)
3: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
4: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "NODE_V8_COVERAGE"

----- JavaScript stack trace -----

1: setupCodeCoverage (node:internal/process/pre_execution:333:19)
2: prepareExecution (node:internal/process/pre_execution:107:3)
3: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
4: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "NODE_DEBUG"

----- JavaScript stack trace -----

1: setupDebugEnv (node:internal/process/pre_execution:363:68)
2: prepareExecution (node:internal/process/pre_execution:108:3)
3: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
4: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "NODE_CHANNEL_FD"

----- JavaScript stack trace -----

1: setupChildProcessIpcChannel (node:internal/process/pre_execution:497:19)
2: prepareExecution (node:internal/process/pre_execution:133:5)
3: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
4: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "NODE_UNIQUE_ID"

----- JavaScript stack trace -----

1: initializeClusterIPC (node:internal/process/pre_execution:514:38)
2: prepareExecution (node:internal/process/pre_execution:137:5)
3: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
4: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "HOME"

----- JavaScript stack trace -----

1: node:internal/modules/cjs/loader:1782:57
2: initializeCJS (node:internal/modules/cjs/loader:427:12)
3: initializeCJSLoader (node:internal/process/pre_execution:590:3)
4: setupUserModules (node:internal/process/pre_execution:155:3)
5: prepareExecution (node:internal/process/pre_execution:148:5)
6: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
7: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "NODE_PATH"

----- JavaScript stack trace -----

1: node:internal/modules/cjs/loader:1783:56
2: initializeCJS (node:internal/modules/cjs/loader:427:12)
3: initializeCJSLoader (node:internal/process/pre_execution:590:3)
4: setupUserModules (node:internal/process/pre_execution:155:3)
5: prepareExecution (node:internal/process/pre_execution:148:5)
6: prepareMainThreadExecution (node:internal/process/pre_execution:47:10)
7: node:internal/main/run_main_module:15:19


[--trace-env] get environment variable "WATCH_REPORT_DEPENDENCIES"

----- JavaScript stack trace -----

1: node:internal/modules/cjs/loader:161:63
2: node:internal/util:809:15
3: reportModuleToWatchMode (node:internal/modules/cjs/loader:276:7)
4: node:internal/modules/cjs/loader:1106:5
5: traceSync (node:diagnostics_channel:322:14)
6: wrapModuleLoad (node:internal/modules/cjs/loader:218:24)
7: executeUserEntryPoint (node:internal/modules/run_main:170:5)
8: node:internal/main/run_main_module:36:49


[--trace-env] get environment variable "FOO"

----- JavaScript stack trace -----

1: /Users/joyee/projects/node/env.js:1:25
2: node:internal/modules/cjs/loader:1546:14
3: node:internal/modules/cjs/loader:1698:10
4: node:internal/modules/cjs/loader:1303:32
5: node:internal/modules/cjs/loader:1117:12
6: traceSync (node:diagnostics_channel:322:14)
7: wrapModuleLoad (node:internal/modules/cjs/loader:218:24)
8: executeUserEntryPoint (node:internal/modules/run_main:170:5)
9: node:internal/main/run_main_module:36:49


[--trace-env] set environment variable "FOO"

----- JavaScript stack trace -----

1: /Users/joyee/projects/node/env.js:2:17
2: node:internal/modules/cjs/loader:1546:14
3: node:internal/modules/cjs/loader:1698:10
4: node:internal/modules/cjs/loader:1303:32
5: node:internal/modules/cjs/loader:1117:12
6: traceSync (node:diagnostics_channel:322:14)
7: wrapModuleLoad (node:internal/modules/cjs/loader:218:24)
8: executeUserEntryPoint (node:internal/modules/run_main:170:5)
9: node:internal/main/run_main_module:36:49

nodejs-github-bot · 2024-10-30T15:44:29Z

Review requested:

@nodejs/startup

codecov · 2024-10-30T16:57:52Z

Codecov Report

Attention: Patch coverage is 98.75000% with 1 line in your changes missing coverage. Please review.

Project coverage is 87.95%. Comparing base (1d01ad6) to head (81713b5).
Report is 52 commits behind head on main.

Files with missing lines	Patch %	Lines
src/env.cc	66.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #55604      +/-   ##
==========================================
- Coverage   88.01%   87.95%   -0.06%     
==========================================
  Files         653      656       +3     
  Lines      187735   188372     +637     
  Branches    35874    35980     +106     
==========================================
+ Hits       165229   165687     +458     
- Misses      15693    15845     +152     
- Partials     6813     6840      +27

Files with missing lines	Coverage Δ
src/debug_utils.cc	`60.90% <100.00%> (+1.50%)`	⬆️
src/debug_utils.h	`80.00% <ø> (ø)`
src/node.cc	`73.60% <100.00%> (-0.15%)`	⬇️
src/node_credentials.cc	`69.28% <100.00%> (+1.13%)`	⬆️
src/node_env_var.cc	`87.02% <100.00%> (+2.21%)`	⬆️
src/node_internals.h	`81.03% <ø> (ø)`
src/node_options.cc	`87.55% <100.00%> (+0.08%)`	⬆️
src/node_options.h	`98.29% <100.00%> (+0.01%)`	⬆️
src/path.cc	`69.04% <ø> (ø)`
src/env.cc	`85.49% <66.66%> (-0.19%)`	⬇️

... and 42 files with indirect coverage changes

src/node_credentials.cc

joyeecheung · 2024-11-12T02:23:12Z

Updated this a bit and added tracing for enumeration. I figured it would also be useful to see where e.g. the ...process.env accesses are coming from.

github-actions · 2024-11-12T02:36:36Z

Failed to start CI

   ⚠  No approving reviews found
   ✘  Refusing to run CI on potentially unsafe PR

https://github.com/nodejs/node/actions/runs/11789675299

targos · 2024-11-12T09:13:02Z

Shouldn't collaborators be allowed to start CI without approving reviews?

legendecas · 2024-11-12T10:30:16Z

Shouldn't collaborators be allowed to start CI without approving reviews?

There was an update on the PR after the request-ci Add this label to start a Jenkins CI on a PR. was added, which failed the check here.

nodejs-github-bot · 2024-11-19T13:58:54Z

CI: https://ci.nodejs.org/job/node-test-pull-request/63631/

This implements --trace-env, --trace-env-js-stack and --trace-env-native-stack CLI options which can be used to find out what environment variables are accessed and where they are accessed.

joyeecheung · 2024-11-19T18:13:14Z

Fixed test to accomondate different builds.

nodejs-github-bot · 2024-11-19T18:25:31Z

CI: https://ci.nodejs.org/job/node-test-pull-request/63636/

…stack

doc/api/cli.md

StefanStojanovic · 2024-11-25T10:48:05Z

Not sure why coverage-windows is failing but that seems to predate this PR: https://github.com/nodejs/node/actions/workflows/coverage-windows.yml

This is the reason nodejs/build#3963. The mentioned should now be disabled as said in #55929.

…ative]-stack

…v-[js|native]-stack

joyeecheung · 2024-11-26T14:47:35Z

Updated to not printing values. Can you take a look again? @legendecas @jasnell

nodejs-github-bot · 2024-11-26T14:51:14Z

CI: https://ci.nodejs.org/job/node-test-pull-request/63712/

nodejs-github-bot · 2024-11-27T09:44:17Z

Landed in 9029aec

github-actions · 2024-11-27T10:47:22Z

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @joyeecheung.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

This implements --trace-env, --trace-env-js-stack and --trace-env-native-stack CLI options which can be used to find out what environment variables are accessed and where they are accessed. PR-URL: #55604 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: TODO

Notable changes: assert: * (SEMVER-MINOR) add partialDeepStrictEqual (Giovanni Bucci) #54630 cli: * (SEMVER-MINOR) implement --trace-env and --trace-env-[js|native]-stack (Joyee Cheung) #55604 doc,lib,src,test: * (SEMVER-MINOR) unflag sqlite module (Colin Ihrig) #55890 net: * (SEMVER-MINOR) support blocklist for net.Server (theanarkh) #56079 process: * (SEMVER-MINOR) deprecate `features.{ipv6,uv}` and `features.tls_*` (René) #55545 sqlite: * (SEMVER-MINOR) add `StatementSync.prototype.iterate` method (tpoisseau) #54213 PR-URL: #56119

This implements --trace-env, --trace-env-js-stack and --trace-env-native-stack CLI options which can be used to find out what environment variables are accessed and where they are accessed. PR-URL: nodejs#55604 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Oct 30, 2024

joyeecheung mentioned this pull request Oct 30, 2024

Environment variable and CLI argument handling in user-land startup snapshots #55603

Open

richardlau added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 30, 2024

legendecas reviewed Nov 1, 2024

View reviewed changes

src/node_credentials.cc Outdated Show resolved Hide resolved

joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 12, 2024

joyeecheung force-pushed the trace-env branch from 59ad62e to 8d5d797 Compare November 12, 2024 02:25

github-actions bot added request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. and removed request-ci Add this label to start a Jenkins CI on a PR. labels Nov 12, 2024

legendecas mentioned this pull request Nov 12, 2024

fix: add logs for outdated request-ci nodejs/node-core-utils#867

Open

joyeecheung added request-ci Add this label to start a Jenkins CI on a PR. and removed request-ci-failed An error occurred while starting CI via request-ci label, and manual interventon is needed. labels Nov 19, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 19, 2024

joyeecheung added 2 commits November 19, 2024 18:54

cli: implement --trace-env and --trace-env-[js|native]-stack

8a50cef

This implements --trace-env, --trace-env-js-stack and --trace-env-native-stack CLI options which can be used to find out what environment variables are accessed and where they are accessed.

fixup! cli: implement --trace-env and --trace-env-[js|native]-stack

2553316

joyeecheung force-pushed the trace-env branch from 8d5d797 to 2553316 Compare November 19, 2024 18:12

joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 19, 2024

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 19, 2024

fixup! fixup! cli: implement --trace-env and --trace-env-[js|native]-…

418bb0a

…stack

joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 21, 2024

legendecas reviewed Nov 23, 2024

View reviewed changes

doc/api/cli.md Show resolved Hide resolved

joyeecheung added 2 commits November 26, 2024 15:42

fixup! fixup! fixup! cli: implement --trace-env and --trace-env-[js|n…

8c1ff6b

…ative]-stack

fixup! fixup! fixup! fixup! cli: implement --trace-env and --trace-en…

81713b5

…v-[js|native]-stack

joyeecheung added the request-ci Add this label to start a Jenkins CI on a PR. label Nov 26, 2024

legendecas approved these changes Nov 26, 2024

View reviewed changes

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Nov 26, 2024

jasnell approved these changes Nov 26, 2024

View reviewed changes

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 27, 2024

nodejs-github-bot merged commit 9029aec into nodejs:main Nov 27, 2024
67 checks passed

joyeecheung added the notable-change PRs with changes that should be highlighted in changelogs. label Nov 27, 2024

nodejs-github-bot mentioned this pull request Dec 3, 2024

2024-12-04, Version 23.4.0 (Current), @targos #56119

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cli: implement --trace-env and --trace-env-[js|native]-stack #55604

cli: implement --trace-env and --trace-env-[js|native]-stack #55604

joyeecheung commented Oct 30, 2024 •

edited

Loading

nodejs-github-bot commented Oct 30, 2024

codecov bot commented Oct 30, 2024 •

edited

Loading

joyeecheung commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

targos commented Nov 12, 2024

legendecas commented Nov 12, 2024

nodejs-github-bot commented Nov 19, 2024

joyeecheung commented Nov 19, 2024

nodejs-github-bot commented Nov 19, 2024

StefanStojanovic commented Nov 25, 2024

joyeecheung commented Nov 26, 2024

nodejs-github-bot commented Nov 26, 2024

nodejs-github-bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

cli: implement --trace-env and --trace-env-[js|native]-stack #55604

cli: implement --trace-env and --trace-env-[js|native]-stack #55604

Conversation

joyeecheung commented Oct 30, 2024 • edited Loading

nodejs-github-bot commented Oct 30, 2024

codecov bot commented Oct 30, 2024 • edited Loading

Codecov Report

joyeecheung commented Nov 12, 2024

github-actions bot commented Nov 12, 2024

targos commented Nov 12, 2024

legendecas commented Nov 12, 2024

nodejs-github-bot commented Nov 19, 2024

joyeecheung commented Nov 19, 2024

nodejs-github-bot commented Nov 19, 2024

StefanStojanovic commented Nov 25, 2024

joyeecheung commented Nov 26, 2024

nodejs-github-bot commented Nov 26, 2024

nodejs-github-bot commented Nov 27, 2024

github-actions bot commented Nov 27, 2024

joyeecheung commented Oct 30, 2024 •

edited

Loading

codecov bot commented Oct 30, 2024 •

edited

Loading