os: refactor structure of the os module #12654

jasnell · 2017-04-25T21:53:53Z

Refactoring the structure of the os module to use the more efficient module.exports = {} pattern.

Also adds simple Symbol.toPrimitive support for each of the os methods that return simple primitives.

Lastly, removes extraneous console output from the test-os.js

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

os

mscdex · 2017-04-25T22:03:42Z

What is the reason for the Symbol.toPrimitive changes?

jasnell · 2017-04-25T22:17:48Z

Symbol.toPrimitive is an extremely simple convenience. For instance, os.endianness() always returns a constant string value. With the Symbol.toPrimitive, we can do:

// No parens at the end
`${os.endianess}`

instead of

`${os.endianness()}`

Likewise with the other functions that always return primitives.

It's extremely minor and quite cheap for us to support.

Another, example...

 `${os.platform}-${os.release}-${os.arch}-${os.hostname}`

Instead of

 `${os.platform()}-${os.release()}-${os.arch()}-${os.hostname()}`

Trott · 2017-04-25T22:51:41Z

test/parallel/test-os.js

+/* eslint-disable no-restricted-properties */
+[
+
+  [assert.equal, `${os.freemem}`, os.freemem()],


Nit: Maybe better as

assert.strictEqual, `${os.freemem}`, `${os.freemem()}`]

Matter of style preference, I suppose.

This was intentional, recognizing that the differences in the values should still be equal.

This was intentional, recognizing that the differences in the values should still be equal.

You might be misunderstanding my suggestion. I know it's intentional. Explicitly converting the number to a string and using strictEqual() makes it more clear that it's intentional, at least in my opinion. OK by me, though, if you prefer the way it is.

Sorry, I know what you meant, just wasn't being very clear. I'm using assert.equal() intentionally because the return value of the methods themselves are numbers and I want to ensure that the conversion to string after the Symbol.toPrimitive call returns an equal (but not strict equal) result. Either way I think gets the job done but to answer the question: yes, I prefer it this way :-)

jasnell · 2017-04-27T18:55:07Z

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

jasnell · 2017-04-27T19:41:06Z

~~New CI: https://ci.nodejs.org/job/node-test-pull-request/7714/~~

jasnell · 2017-04-27T20:05:57Z

Oops, I rebased while the CI was checking things out and goofed it up.
New New CI: https://ci.nodejs.org/job/node-test-pull-request/7717/

jasnell · 2017-04-27T20:24:39Z

Once more with gusto: https://ci.nodejs.org/job/node-test-pull-request/7718/

jasnell · 2017-04-27T23:43:15Z

CI is green

jasnell · 2017-04-29T16:46:47Z

ping @nodejs/collaborators

watilde

Looks similar to #12717. LGTM.

aqrln

LGTM

aqrln · 2017-04-29T18:18:07Z

Is it really semver-minor? Even though I don't think someone really used these functions in template literals as values themselves (as it doesn't make much sense), strictly speaking, the behavior has changed.

Before:

> `${os.endianness}`
'function () { return \'LE\'; }'

After:

> `${os.endianness}`
'LE'

It might be better to make this a major change just to be safe and strictly adhering to semver, especially given the fact that v8.0 is coming soon. It might be also worth to split this into two commits (just refactoring and Symbol.toPrimitive functionality) and have only one of them landed on v7.x.

However, a huge +1 to the change itself, about a week ago I really wished these functions were getters when I used them in template literals, while this PR solves it even more elegantly :)

addaleax · 2017-04-29T18:25:29Z

CITGM for this PR: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/751/
CITGM for master to compare: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/752/

jasnell · 2017-04-29T18:28:14Z

I'm good with defensively labeling this as semver-major.

addaleax · 2017-04-29T18:32:19Z

test/parallel/test-os.js

+  [assert.strictEqual, `${os.type}`, os.type()],
+  [assert.strictEqual, `${os.endianness}`, os.endianness()]
+].forEach((set) => {
+  set[0](set[1], set[2], `${set[1]}, ${set[2]}`);


I’m not actually sure whether the extra error message argument here is helpful, and maybe I would just inline assert.strictEqual here instead of passing it as part of set. (Just a suggestion, feel free to ignore me if you disagree)

Now that they're all strictEquals.. +1 :-)

Refactor the structure of the os module to use more efficient module.exports = {} pattern. Add Symbol.toPrimitive support to os methods that return simple primitives. This is a minor tweak that makes using these slightly more friendly when doing things like: ```js var m = `${os.tmpdir}/foo` ```

jasnell · 2017-04-29T19:33:33Z

New CI: https://ci.nodejs.org/job/node-test-pull-request/7747/

Refactor the structure of the os module to use more efficient module.exports = {} pattern. Add Symbol.toPrimitive support to os methods that return simple primitives. This is a minor tweak that makes using these slightly more friendly when doing things like: ```js var m = `${os.tmpdir}/foo` ``` PR-URL: #12654 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

PR-URL: #12654 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

jasnell · 2017-05-01T18:47:38Z

Landed in 473572e and 23fc082

Refactor the structure of the os module to use more efficient module.exports = {} pattern. Add Symbol.toPrimitive support to os methods that return simple primitives. This is a minor tweak that makes using these slightly more friendly when doing things like: ```js var m = `${os.tmpdir}/foo` ``` PR-URL: nodejs#12654 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

PR-URL: nodejs#12654 Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>

Fishrock123 · 2017-06-01T20:31:48Z

As far as I can tell, adding Symbol.toPrimitive to bare Functions not a incompatible API change.

I'm bringing this up because I don't know how to possibly word this as a breaking change for the 8.0.0 breaking changes doc.

Reading function bodies in any real, dependant way is already not supported. (Obviously. This is like process.binding('natives'), and anyone possibly depending on this knows function bodies can and will change at any time.)

Adding the symbol does not alter any existing behavior of the actual documented functions, in any way (including typeof), or the module overall.

The behavior before, for coercion to "primitive", is effectively a common "misuse" error that under normal circumstances would be akin to any of our TypeErrors for invalid arguments. That is, you forgot to add the parens to call the function when you meant to.

This either: adds behavior that was "missing", or "fixes" previously "broken" behavior.

@jasnell, @addaleax, @aqrln Thoughts? Would I be ok to remove the label? (We can add dont-land-on- if ya'll want.)

addaleax · 2017-06-01T20:49:45Z

Would I be ok to remove the label?

I think so, yes. I don’t think this kind of change makes sense for LTS, so I’m adding the dont-land labels.

aqrln · 2017-06-02T01:32:37Z

@Fishrock123 yes, I'm fine with it. Thanks for bringing this up.

jasnell · 2017-06-02T02:59:51Z

In this particular case, dropping down to semver-minor is ok. We need to be careful about it in general with these kinds of changes, tho. Adding the don't land labels is ++

jasnell added dont-land-on-v4.x semver-minor PRs that contain new features and should be released in the next minor version. labels Apr 25, 2017

nodejs-github-bot added the os Issues and PRs related to the os subsystem. label Apr 25, 2017

jasnell changed the title ~~Refactor os~~ os: refactor structure of the os module Apr 25, 2017

Trott reviewed Apr 25, 2017

View reviewed changes

refack mentioned this pull request Apr 25, 2017

modules refactored to use export pattern nodejs/Release#200

Closed

jasnell force-pushed the refactor-os branch from aabe924 to e7f6d7a Compare April 27, 2017 19:39

jasnell force-pushed the refactor-os branch from e7f6d7a to 0a4ee5e Compare April 27, 2017 19:41

jasnell force-pushed the refactor-os branch from 0a4ee5e to 4593d46 Compare April 27, 2017 20:23

watilde approved these changes Apr 29, 2017

View reviewed changes

aqrln approved these changes Apr 29, 2017

View reviewed changes

jasnell added semver-major PRs that contain breaking changes and should be released in the next major version. and removed semver-minor PRs that contain new features and should be released in the next minor version. labels Apr 29, 2017

addaleax approved these changes Apr 29, 2017

View reviewed changes

jasnell force-pushed the refactor-os branch from 4593d46 to 922f10f Compare April 29, 2017 19:31

jasnell added 2 commits April 29, 2017 12:32

test: remove extra console output from test-os.js

854d7b7

jasnell force-pushed the refactor-os branch from 922f10f to 854d7b7 Compare April 29, 2017 19:32

benjamingr approved these changes Apr 29, 2017

View reviewed changes

jasnell closed this May 1, 2017

YurySolovyov mentioned this pull request May 12, 2017

Migrate squirrel-update to JS atom/atom#14385

Closed

jasnell mentioned this pull request May 11, 2017

8.0.0 Release Proposal #12220

Closed

addaleax added dont-land-on-v7.x semver-minor PRs that contain new features and should be released in the next minor version. and removed semver-major PRs that contain breaking changes and should be released in the next major version. labels Jun 1, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

os: refactor structure of the os module #12654

os: refactor structure of the os module #12654

jasnell commented Apr 25, 2017

mscdex commented Apr 25, 2017

jasnell commented Apr 25, 2017 •

edited

Loading

Trott Apr 25, 2017 •

edited

Loading

jasnell Apr 25, 2017

Trott Apr 25, 2017

jasnell Apr 25, 2017

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017 •

edited

Loading

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017

jasnell commented Apr 29, 2017

watilde left a comment

aqrln left a comment

aqrln commented Apr 29, 2017 •

edited

Loading

addaleax commented Apr 29, 2017

jasnell commented Apr 29, 2017

addaleax Apr 29, 2017

jasnell Apr 29, 2017

jasnell commented Apr 29, 2017

jasnell commented May 1, 2017

Fishrock123 commented Jun 1, 2017 •

edited

Loading

addaleax commented Jun 1, 2017

aqrln commented Jun 2, 2017

jasnell commented Jun 2, 2017

os: refactor structure of the os module #12654

os: refactor structure of the os module #12654

Conversation

jasnell commented Apr 25, 2017

Checklist

Affected core subsystem(s)

mscdex commented Apr 25, 2017

jasnell commented Apr 25, 2017 • edited Loading

Trott Apr 25, 2017 • edited Loading

Choose a reason for hiding this comment

jasnell Apr 25, 2017

Choose a reason for hiding this comment

Trott Apr 25, 2017

Choose a reason for hiding this comment

jasnell Apr 25, 2017

Choose a reason for hiding this comment

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017 • edited Loading

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017

jasnell commented Apr 27, 2017

jasnell commented Apr 29, 2017

watilde left a comment

Choose a reason for hiding this comment

aqrln left a comment

Choose a reason for hiding this comment

aqrln commented Apr 29, 2017 • edited Loading

addaleax commented Apr 29, 2017

jasnell commented Apr 29, 2017

addaleax Apr 29, 2017

Choose a reason for hiding this comment

jasnell Apr 29, 2017

Choose a reason for hiding this comment

jasnell commented Apr 29, 2017

jasnell commented May 1, 2017

Fishrock123 commented Jun 1, 2017 • edited Loading

addaleax commented Jun 1, 2017

aqrln commented Jun 2, 2017

jasnell commented Jun 2, 2017

jasnell commented Apr 25, 2017 •

edited

Loading

Trott Apr 25, 2017 •

edited

Loading

jasnell commented Apr 27, 2017 •

edited

Loading

aqrln commented Apr 29, 2017 •

edited

Loading

Fishrock123 commented Jun 1, 2017 •

edited

Loading