Skip to content

Fix environment variables casing bug #604

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

Merged
merged 5 commits into from
Jul 7, 2022
Merged

Fix environment variables casing bug #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7ed003
fix env var casing bug
hossam-nasr Jun 28, 2022
05c6ce6
localize testing of casing to Windows
hossam-nasr Jun 28, 2022
fb1665b
update test
hossam-nasr Jul 6, 2022
85632c0
Merge branch 'v3.x' into hossamnasr/env-var-casing
hossam-nasr Jul 6, 2022
ff321e6
update startApp tests too
hossam-nasr Jul 6, 2022
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
5 changes: 4 additions & 1 deletion src/eventHandlers/FunctionEnvironmentReloadHandler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@ export class FunctionEnvironmentReloadHandler extends EventHandler<
logCategory: LogCategory.System,
});

process.env = Object.assign({}, msg.environmentVariables);
// reset existing env vars
Object.keys(process.env).map((key) => delete process.env[key]);
// set new env vars
Object.assign(process.env, msg.environmentVariables);

// Change current working directory
if (msg.functionAppDirectory) {
Expand Down
30 changes: 28 additions & 2 deletions test/eventHandlers/FunctionEnvironmentReloadHandler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,14 +74,14 @@ describe('FunctionEnvironmentReloadHandler', () => {
let originalEnv: NodeJS.ProcessEnv;
let originalCwd: string;
before(() => {
originalEnv = { ...process.env };
originalCwd = process.cwd();
originalEnv = process.env;
({ stream, channel } = beforeEventHandlerSuite());
channel.hostVersion = '2.7.0';
});

after(() => {
process.env = originalEnv;
Object.assign(process.env, originalEnv);
});

afterEach(async () => {
Expand All @@ -108,6 +108,32 @@ describe('FunctionEnvironmentReloadHandler', () => {
expect(process.env.PlaceholderVariable).to.be.undefined;
});

it('preserves OS-specific casing behavior of environment variables', async () => {
process.env.PlaceholderVariable = 'TRUE';
stream.addTestMessage({
requestId: 'id',
functionEnvironmentReloadRequest: {
environmentVariables: {
hello: 'world',
SystemDrive: 'Q:',
},
functionAppDirectory: null,
},
});
await stream.assertCalledWith(Msg.reloadEnvVarsLog(2), Msg.reloadSuccess);
expect(process.env.hello).to.equal('world');
expect(process.env.SystemDrive).to.equal('Q:');
expect(process.env.PlaceholderVariable).to.be.undefined;
expect(process.env.placeholdervariable).to.be.undefined;
if (process.platform === 'win32') {
expect(process.env.HeLlO).to.equal('world');
expect(process.env.systemdrive).to.equal('Q:');
} else {
expect(process.env.HeLlO).to.be.undefined;
expect(process.env.systemdrive).to.be.undefined;
}
});

it('reloading environment variables removes existing environment variables', async () => {
process.env.PlaceholderVariable = 'TRUE';
process.env.NODE_ENV = 'Debug';
Expand Down
4 changes: 2 additions & 2 deletions test/startApp.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ describe('startApp', () => {

before(async () => {
originalCwd = process.cwd();
originalEnv = process.env;
originalEnv = { ...process.env };
({ stream, channel } = beforeEventHandlerSuite());
coreApi = await import('@azure/functions-core');
});

after(() => {
process.env = originalEnv;
Object.assign(process.env, originalEnv);
});

afterEach(async () => {
Expand Down