Skip to content

loader, docs, test: named exports from commonjs modules #16675

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.

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
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
26 changes: 22 additions & 4 deletions doc/api/esm.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,21 @@ All CommonJS, JSON, and C++ modules can be used with `import`.
Modules loaded this way will only be loaded once, even if their query
or fragment string differs between `import` statements.

When loaded via `import` these modules will provide a single `default` export
representing the value of `module.exports` at the time they finished evaluating.
CommonJS modules, when imported, will be handled in one of two ways. By default
they will provide a single `default` export representing the value of
`module.exports` at the time they finish evaluating. However, they may also
provide `__esModule` as per
[babel spec](https://babeljs.io/docs/plugins/transform-es2015-modules-commonjs)
to use named exports, representing each enumerable key of `module.exports` at
the time they finish evaluating.
In both cases, this should be thought of like a "snapshot" of the exports at
Copy link
Member

Choose a reason for hiding this comment

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

Is this a snapshot of the values, or just a snapshot of the names?

The latter is necessary, but the former may not be.

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought just saying exports was ok since its both the names and the values

Copy link
Member

Choose a reason for hiding this comment

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

Right - I’m saying that there’s no need for the values to be snapshotted; just the names.

Copy link
Member Author

Choose a reason for hiding this comment

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

technically it isn't a snapshot, it's just a useful term to describe how it becomes static when assigned in reflection with es imports.

Copy link
Member

Choose a reason for hiding this comment

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

It’s pretty important to be precise here :-) i think “a snapshot of the names of the exports”, and indicating that if the values are updated, the resulting imports will update as well (a requirement for APM-like use cases, i understand)

the time of importing; asynchronously modifying `module.exports` will not
affect the values of the exports. Builtin libraries such as `fs` are provided
with named exports as if they were using `__esModule`

```js
import fs from 'fs';
fs.readFile('./foo.txt', (err, body) => {
import { readFile } from 'fs';
readFile('./foo.txt', (err, body) => {
if (err) {
console.error(err);
} else {
Expand All @@ -97,6 +106,15 @@ fs.readFile('./foo.txt', (err, body) => {
});
```

```js
// main.mjs
import { part } from './other.js';

// other.js
exports.part = () => {};
exports.__esModule = true;
```

## Loader hooks

<!-- type=misc -->
Expand Down
28 changes: 20 additions & 8 deletions lib/internal/loader/ModuleRequest.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,22 +35,34 @@ loaders.set('esm', async (url) => {
});

// Strategy for loading a node-style CommonJS module
// Uses babel and typescript style __esModule property for
// attaching named imports due to the possiblity of `module.exports.default`
loaders.set('cjs', async (url) => {
return createDynamicModule(['default'], url, (reflect) => {
debug(`Loading CJSModule ${url}`);
const CJSModule = require('module');
const pathname = internalURLModule.getPathFromURL(new URL(url));
CJSModule._load(pathname);
debug(`Loading CJSModule ${url}`);
const CJSModule = require('module');
const pathname = internalURLModule.getPathFromURL(new URL(url));
const exports = CJSModule._load(pathname);
Copy link
Member

Choose a reason for hiding this comment

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

This changes CJS to always evaluate prior to linking ESM which reorders imports in odd ways

const es = !!exports.__esModule;
Copy link
Member

Choose a reason for hiding this comment

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

I think we should promote the use of a Symbol instead. Adding a property might not be feasible for a lot of modules. We should also support __esModule for backward compat with babel.

Copy link
Member Author

Choose a reason for hiding this comment

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

thats a fantastic idea, would attaching it to the module module, perhaps as Module.esModule be good?

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps something in the name to indicate it is a symbol for CommonJS interop cases? esModuleInterop?

Copy link
Member

Choose a reason for hiding this comment

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

I'm fine with making it as long as we want. I would use Symbol.for() so it can be backward-compatibile with older versions of node that do not have the symbol, plus other tools that might want to process it.

const keys = es ? Object.keys(exports) : ['default'];
Copy link
Member

Choose a reason for hiding this comment

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

Would Object.getOwnPropertyNames(exports) make more sense?

Copy link
Member Author

Choose a reason for hiding this comment

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

i chose to use Object.keys so that it only exports enumerable properties. (it says so in the esm doc)

return createDynamicModule(keys, url, (reflect) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like createDynamicModule would throw if one of the exports was named executor because there would be duplicated exports? Seems like ideally it would generate an executor name that wouldn't conflict, or at least make it less likely to conflict.

Copy link
Member

Choose a reason for hiding this comment

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

It maps names to safeguard against this already:

${ArrayJoin(ArrayMap(names, (name) => `export let $${name};`), '\n')}

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah so it does, my mistake. Missed the $ on there.

if (es) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Is branching like this faster? Otherwise seems like the else branch does exactly what the if branch does, just more generally.

Copy link
Member Author

@devsnek devsnek Nov 7, 2017

Choose a reason for hiding this comment

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

i don't understand what you mean, those two blocks do different things

Copy link
Contributor

Choose a reason for hiding this comment

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

Sign, nevermind, just another case of misreading.

for (const key of keys)
Copy link
Member

Choose a reason for hiding this comment

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

There might be some edge cases where module.exports is a proxy, can you please check if that would cause problems?

Copy link
Member

Choose a reason for hiding this comment

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

I think we should use a for(;;) loop here. They are faster.

reflect.exports[key].set(exports[key]);
} else {
reflect.exports.default.set(exports);
}
});
});

// Strategy for loading a node builtin CommonJS module that isn't
// through normal resolution
loaders.set('builtin', async (url) => {
return createDynamicModule(['default'], url, (reflect) => {
debug(`Loading BuiltinModule ${url}`);
const exports = NativeModule.require(url.substr(5));
debug(`Loading BuiltinModule ${url}`);
const exports = NativeModule.require(url.substr(5));
const keys = Object.keys(exports);
return createDynamicModule(['default', ...keys], url, (reflect) => {
Copy link
Member

Choose a reason for hiding this comment

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

It's not documented that builtin modules still have a default export.

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps for these native module keys we should add a filter - Object.keys(exports).filter(name => name.startsWith('_') === false)? This would avoid private keys such as import { _makeLong } from 'path' being on the public API that will end up in the list for type hinting systems such as TypeScript.

Copy link
Member

Choose a reason for hiding this comment

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

Please do not; _ may be used to convey hopeful privacy, but it’s always fully public.

reflect.exports.default.set(exports);
for (const key of keys) reflect.exports[key].set(exports[key]);
});
});

Expand Down
11 changes: 9 additions & 2 deletions test/es-module/test-esm-namespace.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
// Flags: --experimental-modules
/* eslint-disable required-modules */

import * as fs from 'fs';
import assert from 'assert';
import fs, { readFile } from 'fs';
import main, { named } from
'../fixtures/es-module-loaders/cjs-to-es-namespace.js';

assert.deepStrictEqual(Object.keys(fs), ['default']);
assert(fs);
assert(fs.readFile);
assert.strictEqual(fs.readFile, readFile);

assert.strictEqual(main, 1);
assert.strictEqual(named, true);
8 changes: 8 additions & 0 deletions test/es-module/test-reserved-keywords.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Flags: --experimental-modules
/* eslint-disable required-modules */

import assert from 'assert';
import { enum as e } from
'../fixtures/es-module-loaders/reserved-keywords.js';

assert(e);
4 changes: 4 additions & 0 deletions test/fixtures/es-module-loaders/cjs-to-es-namespace.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
exports.named = true;
exports.default= 1;

Object.defineProperty(exports, '__esModule', { value: true });
6 changes: 6 additions & 0 deletions test/fixtures/es-module-loaders/reserved-keywords.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
enum: 'enum',
class: 'class',
delete: 'delete',
__esModule: true,
};