Fix --require scripts missing env vars in cluster mode#6121
Open
tlhunter wants to merge 1 commit into
Open
Conversation
In cluster mode, PM2 serialises the configured environment into a JSON string passed as process.env.pm2_env, which ProcessContainer.js unpacks at startup. Node.js processes execArgv (including --require flags) before the entry script runs, so any library loaded via --require saw the raw JSON blob rather than the individual env vars. Adds ProcessContainerClusterInitEnv.js, a tiny --require script that expands pm2_env JSON into process.env. ClusterMode.js now prepends --require <this script> at the front of execArgv so the env is fully expanded before any user-specified --require modules run. Adds programmatic tests verifying that a --require script can read a PM2-configured env var in both cluster mode (the regression) and fork mode. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This allows scripts that run via
--requireto access the intended ENV vars supplied by PM2.We had a user-submitted issue that the Datadog tracer wouldn't properly read ENV var configuration when used with PM2. While we can fix this by having Datadog do the pm2_env parsing, it does seem like similar functionality would need to land in other libraries as well. For that reason it seems better to try and solve it inside of pm2.