Skip to content
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

Jump to bottom

src: don't overwrite environment from .env file #49424

Merged
merged 8 commits into from
Sep 8, 2023
Merged

src: don't overwrite environment from .env file #49424

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
edaa662
src: don't overwrite environment from .env file
philnash Sep 1, 2023
271bebd
src: .env file can override NODE_OPTIONS
philnash Sep 3, 2023
f673db5
Revert "src: .env file can override NODE_OPTIONS"
philnash Sep 4, 2023
005da17
src: extra test for environment variables and .env
philnash Sep 4, 2023
22dbae2
src: env file exists in test locations and overrides result
philnash Sep 6, 2023
e9371df
src: combine tests for overriding environment vars
philnash Sep 7, 2023
d91ebce
src: don't fully override environment in tests
philnash Sep 7, 2023
56f0868
src: fix env var TZ test
philnash Sep 8, 2023
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
21 changes: 13 additions & 8 deletions src/node_dotenv.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,19 @@ void Dotenv::SetEnvironment(node::Environment* env) {
for (const auto& entry : store_) {
auto key = entry.first;
auto value = entry.second;
env->env_vars()->Set(
isolate,
v8::String::NewFromUtf8(
isolate, key.data(), NewStringType::kNormal, key.size())
.ToLocalChecked(),
v8::String::NewFromUtf8(
isolate, value.data(), NewStringType::kNormal, value.size())
.ToLocalChecked());

auto existing = env->env_vars()->Get(key.data());

if (existing.IsNothing() || strcmp(key.data(), "NODE_OPTIONS") == 0) {
env->env_vars()->Set(
isolate,
v8::String::NewFromUtf8(
isolate, key.data(), NewStringType::kNormal, key.size())
.ToLocalChecked(),
v8::String::NewFromUtf8(
isolate, value.data(), NewStringType::kNormal, value.size())
.ToLocalChecked());
}
}
}

Expand Down
25 changes: 25 additions & 0 deletions test/parallel/test-dotenv-edge-cases.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,29 @@ describe('.env supports edge cases', () => {
assert.strictEqual(child.code, 0);
});

it('should not override existing environment variables', async () => {
const code = `
require('assert').strictEqual(process.env.BASIC, 'existing');
`.trim();
const child = await common.spawnPromisified(
process.execPath,
[ `--env-file=${validEnvFilePath}`, '--eval', code ],
{ cwd: __dirname, env: { BASIC: 'existing' } },
);
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
});
GeoffreyBooth marked this conversation as resolved.
Show resolved Hide resolved

it('should override NODE_OPTIONS', async () => {
Copy link
Member

Choose a reason for hiding this comment

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

No, I don't think it should.

Copy link
Member

Choose a reason for hiding this comment

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

Can you please explain why?

Copy link
Member

Choose a reason for hiding this comment

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

Because all environment variables should be treated the same way. The docs don't mention treating any as an exception. I don't know why we should.

const code = `
require('assert').strictEqual(process.env.NODE_OPTIONS, '--experimental-permission --allow-fs-read=*');
`.trim();
const child = await common.spawnPromisified(
process.execPath,
[ `--env-file=${relativePath}`, '--eval', code ],
{ cwd: __dirname, env: { NODE_OPTIONS: '--experimental-permission --allow-worker' } },
);
assert.strictEqual(child.stderr, '');
assert.strictEqual(child.code, 0);
});
});