Skip to content

watch: watch env files in --watch mode #54033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HBSPS wants to merge 3 commits into from
Closed

watch: watch env files in --watch mode #54033

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6a5b702
watch: watch env files in `--watch` mode
HBSPS Jul 25, 2024
45539cd
fix: fix for loop to use `for...of` instead of index
HBSPS Jul 25, 2024
b14e1d4
fix: apply lint
HBSPS Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion lib/internal/main/watch_mode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const {
ArrayPrototypePush,
ArrayPrototypePushApply,
ArrayPrototypeSlice,
StringPrototypeSplit,
StringPrototypeStartsWith,
} = primordials;

Expand All @@ -22,10 +23,11 @@ const { FilesWatcher } = require('internal/watch_mode/files_watcher');
const { green, blue, red, white, clear } = require('internal/util/colors');

const { spawn } = require('child_process');
const { inspect } = require('util');
const { inspect, parseEnv } = require('util');
const { setTimeout, clearTimeout } = require('timers');
const { resolve } = require('path');
const { once } = require('events');
const { readFileSync } = require('fs');

prepareMainThreadExecution(false, false);
markBootstrapComplete();
Expand Down Expand Up @@ -64,11 +66,23 @@ let exited;

function start() {
exited = false;

let kEnv = {};
for (const arg of process.execArgv) {
if (StringPrototypeStartsWith(arg, '--env-file')) {
Copy link
Member

@MoLow MoLow Jul 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use getOptionValue instead of iterating over all of process.execArgv

Copy link
Member Author

@HBSPS HBSPS Jul 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In fact, I've already applied getOptionValue, but when I used getOptionValue('--env-file') with multiple --env-file options set, I had a problem that I could only get the last --env-file information. Not an array of --env-file information.

const envFile = resolve(StringPrototypeSplit(arg, '=')[1]);
watcher.filterFile(envFile, null);
const envContent = parseEnv(readFileSync(envFile, 'utf8'));
kEnv = { ...kEnv, ...envContent };
Comment on lines +75 to +76
Copy link
Member

@MoLow MoLow Jul 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const envContent = parseEnv(readFileSync(envFile, 'utf8'));
kEnv = { ...kEnv, ...envContent };

I am pretty sure that watcher.filterFile is enough since the spawned process should handle --env-file by its own
this is also missing error handling (what happens if env file is renamed/deleted)?

Copy link
Member Author

@HBSPS HBSPS Jul 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am pretty sure that watcher.filterFile is enough since the spawned process should handle --env-file by its own

I've tested it many times, but when the child is spwan, it inherits the parent's process.env. If I only use the watcher.filterFile, if the env file is modified, it triggers a restart of the child process, but the information from the modified env doesn't seem to go to the child.

This is why I used parseEnv and readFileSync.

Refs: #54001 (comment)

this is also missing error handling (what happens if env file is renamed/deleted)?

Oh, this is my mistake.

If I can't find the --env-file I set when I started watch mode (because it's renamed or deleted), is it a good way to print ${envFile}: not found like when I first start watch mode?

}
}

const stdio = kShouldFilterModules ? ['inherit', 'inherit', 'inherit', 'ipc'] : 'inherit';
child = spawn(process.execPath, argsWithoutWatchOptions, {
stdio,
env: {
...process.env,
...kEnv,
WATCH_REPORT_DEPENDENCIES: '1',
},
});
Expand Down