doc: mention case-insensitive env on windows #9166

oliversalzburg · 2016-10-18T16:53:50Z

Checklist

make -j8 test (UNIX), or vcbuild test nosign (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc

Description of change

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another.

Closes #9157

oliversalzburg · 2016-10-18T20:03:50Z

Building Node fails on my system, so I'm currently unable to run the tests :(

This is the output I get during the build: https://gist.github.com/oliversalzburg/592885b45dbf0a561147faef519b0b05

addaleax

Building Node fails on my system, so I'm currently unable to run the tests :(

You can just use your system node to run this particular test, like node test/parallel/test-process-env.js.

addaleax · 2016-10-18T20:04:44Z

test/parallel/test-process-env.js

+  assert.strictEqual(process.env.TEST, process.env.teST);
+} else {
+  assert.strictEqual('undefined', typeof process.env.test);
+}


I think our linter doesn’t like files that don’t end in newlines

addaleax · 2016-10-18T20:05:38Z

test/parallel/test-process-env.js

+// environment variables should be case-insensitive on Windows, and
+// case-sensitive on other platforms
+process.env.TEST = 'test';
+if (common.isWindows) {


I think you’ll need to change require('../common'); to const common = require('../common'); for this to work

oliversalzburg · 2016-10-18T20:19:34Z

@addaleax My system node says it's fine:

$ node test/parallel/test-process-env.js; echo $?
0

…unless I'm not doing it right.

addaleax · 2016-10-18T20:22:44Z

CI: https://ci.nodejs.org/job/node-test-commit/5666/

cjihrig · 2016-10-18T20:36:59Z

test/parallel/test-process-env.js

@@ -67,3 +67,12 @@ assert.equal(3, date.getUTCHours());
 assert.equal(5, date.getHours());
 */
 /* eslint-enable max-len */
+
+// environment variables should be case-insensitive on Windows, and


Can you please capitalize and punctuate the comments.

Gladly, I just wanted to conform with other comments in the file. Is there some guideline regarding capitalization here?

cjihrig · 2016-10-18T20:39:12Z

test/parallel/test-process-env.js

+// case-sensitive on other platforms
+process.env.TEST = 'test';
+if (common.isWindows) {
+  assert.strictEqual(process.env.TEST, process.env.teST);


Can you replace this with two separate assertions:

assert.strictEqual(process.env.TEST, 'test'); assert.strictEqual(process.env.teST, 'test');

cjihrig · 2016-10-18T20:39:43Z

test/parallel/test-process-env.js

+if (common.isWindows) {
+  assert.strictEqual(process.env.TEST, process.env.teST);
+} else {
+  assert.strictEqual('undefined', typeof process.env.teST);


Instead of checking the typeof, can you just directly compare against undefined.

cjihrig · 2016-10-18T20:40:05Z

test/parallel/test-process-env.js

+// case-sensitive on other platforms
+process.env.TEST = 'test';
+if (common.isWindows) {
+  assert.strictEqual(process.env.TEST, process.env.teST);


Actually, you can move the test for process.env.TEST out of the if.

I updated the assertions. Please let me know if that's in line with what you had in mind.

addaleax · 2016-10-18T21:15:51Z

This is the output I get during the build: https://gist.github.com/oliversalzburg/592885b45dbf0a561147faef519b0b05

Yeah that seems like something for @nodejs/platform-windows to look at

seishun · 2016-10-19T06:44:08Z

This is the output I get during the build: https://gist.github.com/oliversalzburg/592885b45dbf0a561147faef519b0b05

Since it doesn't pertain to the PR, I suggest moving this discussion to #node-dev.

bzoz · 2016-10-19T06:58:38Z

Tested master, it compiles fine. I would suggest git clean -fdx

lpinca · 2016-10-24T08:44:47Z

test/parallel/test-process-env.js

+  assert.strictEqual(process.env.test, 'test');
+  assert.strictEqual(process.env.teST, 'test');
+} else {
+  assert.strictEqual(undefined, process.env.test);


Nit: can you please swap the arguments? The first one is actual and second one expected.

Good call! Done.

jasnell · 2016-10-24T14:09:23Z

doc/api/process.md

@@ -708,6 +708,16 @@ console.log(process.env.TEST);
 // => undefined
 ```

+Note that, on Windows operating systems, environment variables are case-insensitive.


Minor nit: Remove the Note that, and just make it On Windows, environment variables are case-insensitive.

Should be fixed now. Thanks

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Fixes: #9157

Environment variables should be treated case-insensitive on Windows platforms and case-sensitive on UNIX platforms

benjamingr · 2016-10-25T08:28:35Z

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

If no one objects I'll land this if green.

benjamingr · 2016-10-25T09:25:04Z

FreeBSD failure unrelated (investigate flaky test-http-server-consumed-timeout on FreeBSD #9227)
Fanned arm build failure only in one case and unrelated (https://ci.nodejs.org/job/node-test-binary-arm/4476/RUN_SUBSET=addons,label=pi1-raspbian-wheezy/console) and is pretty weird to be honest it'd be great if someone from @nodejs/build could take a look.

benjamingr · 2016-10-25T09:25:41Z

Landed in 2a45616 and 0a8d0ea

Cheers.

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

Environment variables should be treated case-insensitive on Windows platforms and case-sensitive on UNIX platforms. This commit ensures this behavior persists. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

Environment variables should be treated case-insensitive on Windows platforms and case-sensitive on UNIX platforms. This commit ensures this behavior persists. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

Environment variables should be treated case-insensitive on Windows platforms and case-sensitive on UNIX platforms. This commit ensures this behavior persists. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> PR-URL: #9166 Fixes: #9157

nodejs-github-bot added doc Issues and PRs related to the documentations. process Issues and PRs related to the process subsystem. labels Oct 18, 2016

rvagg force-pushed the master branch from c133999 to 83c7a88 Compare October 18, 2016 17:02

addaleax reviewed Oct 18, 2016

View reviewed changes

addaleax added the test Issues and PRs related to the tests. label Oct 18, 2016

cjihrig reviewed Oct 18, 2016

View reviewed changes

cjihrig approved these changes Oct 18, 2016

View reviewed changes

lpinca reviewed Oct 24, 2016

View reviewed changes

lpinca approved these changes Oct 24, 2016

View reviewed changes

jasnell reviewed Oct 24, 2016

View reviewed changes

jasnell approved these changes Oct 24, 2016

View reviewed changes

oliversalzburg added 2 commits October 24, 2016 16:15

doc: mention case-insensitive env on windows

a1857ac

On Windows OS, environment variables are case-insensitive and are treated likewise in NodeJS. This can be confusing and can lead to hard-to-debug problems when moving code from one environment to another. Fixes: #9157

test: case sensitivity of env variables

b707743

Environment variables should be treated case-insensitive on Windows platforms and case-sensitive on UNIX platforms

benjamingr closed this Oct 25, 2016

oliversalzburg deleted the feature/env-case branch October 25, 2016 09:28

evanlucas mentioned this pull request Nov 3, 2016

v7.1.0 proposal - 2016-11-08 #9438

Merged

MylesBorins added dont-land-on-v4.x labels Nov 17, 2016

MylesBorins mentioned this pull request Nov 22, 2016

v6.9.2 proposal #9735

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: mention case-insensitive env on windows #9166

doc: mention case-insensitive env on windows #9166

oliversalzburg commented Oct 18, 2016 •

edited

Loading

oliversalzburg commented Oct 18, 2016 •

edited

Loading

addaleax left a comment

addaleax Oct 18, 2016

oliversalzburg Oct 18, 2016

addaleax Oct 18, 2016

oliversalzburg Oct 18, 2016

oliversalzburg commented Oct 18, 2016

addaleax commented Oct 18, 2016

cjihrig Oct 18, 2016

oliversalzburg Oct 18, 2016

cjihrig Oct 18, 2016

oliversalzburg Oct 18, 2016

cjihrig Oct 18, 2016

oliversalzburg Oct 18, 2016

cjihrig Oct 18, 2016

oliversalzburg Oct 18, 2016

addaleax commented Oct 18, 2016

seishun commented Oct 19, 2016

bzoz commented Oct 19, 2016

lpinca Oct 24, 2016

oliversalzburg Oct 24, 2016

jasnell Oct 24, 2016

oliversalzburg Oct 24, 2016

benjamingr commented Oct 25, 2016

benjamingr commented Oct 25, 2016

benjamingr commented Oct 25, 2016

doc: mention case-insensitive env on windows #9166

doc: mention case-insensitive env on windows #9166

Conversation

oliversalzburg commented Oct 18, 2016 • edited Loading

Checklist

Affected core subsystem(s)

Description of change

oliversalzburg commented Oct 18, 2016 • edited Loading

addaleax left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oliversalzburg commented Oct 18, 2016

addaleax commented Oct 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

addaleax commented Oct 18, 2016

seishun commented Oct 19, 2016

bzoz commented Oct 19, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

benjamingr commented Oct 25, 2016

benjamingr commented Oct 25, 2016

benjamingr commented Oct 25, 2016

oliversalzburg commented Oct 18, 2016 •

edited

Loading

oliversalzburg commented Oct 18, 2016 •

edited

Loading