Skip to content

module: warn on using unfinished circular dependency - #29935

Closed
addaleax wants to merge 3 commits into
nodejs:masterfrom
addaleax:circular-dependency-warning
Closed

addaleax wants to merge 3 commits into
nodejs:masterfrom
addaleax:circular-dependency-warning

Conversation

@addaleax

Copy link
Copy Markdown
Member

Warn when a non-existent property of an unfinished module.exports
object is being accessed, as that very often indicates the presence
of a hard-to-detect and hard-to-debug problem.

This mechanism is only used if module.exports is still a
regular object at the point at which the second, circular require()
happens.

The downside is that, temporarily, module.exports will have a
prototype other than Object.prototype, and that there may
be valid uses of accessing non-existent properties of unfinished
module.exports objects.

Performance of circular require calls in general is not
noticeably impacted.

                                           confidence improvement accuracy (*)   (**)  (***)
 module/module-loader-circular.js n=10000                 3.96 %       ±5.12% ±6.82% ±8.89%

Example:

$ cat a.js 
'use strict';
const b = require('./b.js');

exports.fn = () => {};
$ cat b.js 
'use strict';
const a = require('./a.js');

a.fn();
$ node a.js 
(node:1617) Warning: Accessing non-existent property 'fn' of module exports inside circular dependency
/tmp/b.js:4
a.fn();
  ^

TypeError: a.fn is not a function
    at Object.<anonymous> (/tmp/b.js:4:3)
    [...]
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • commit message follows commit guidelines

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. module Issues and PRs related to the module subsystem. semver-major PRs that contain breaking changes and should be released in the next major version.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants