FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

module: do not check circular dependencies for exported proxies by BridgeAR · Pull Request #33338 · nodejs/node · GitHub

/ node Public

module: do not check circular dependencies for exported proxies - #33338

Closed
BridgeAR wants to merge 1 commit into
nodejs:masterfrom
BridgeAR:fix-circular-modules-check-with-proxies
Closed

module: do not check circular dependencies for exported proxies#33338
BridgeAR wants to merge 1 commit into
nodejs:masterfrom
BridgeAR:fix-circular-modules-check-with-proxies

Conversation

Copy link
Copy Markdown
Member

In case the exported module is a proxy that has the getPrototypeOf
or setPrototypeOf trap, skip the circular dependencies check.
It would otherwise be triggered by the check itself.

Fixes: #33334

Signed-off-by: Ruben Bridgewater ruben@bridgewater.de

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

BridgeAR requested a review from addaleax May 10, 2020 11:56
Comment thread lib/internal/modules/cjs/loader.js Outdated
Comment thread lib/internal/modules/cjs/loader.js Outdated

ghost commented May 10, 2020
edited by ghost
Loading

Copy link
Copy Markdown

I don't really like the direction this is going. Even with these changes it still triggers some traps (get for example):

module.exports = new Proxy({}, {
  get(){
    assert.fail(); // Throws here
  }
});

But, in general, altering user's objects is really bad practice. I understand the intention is to help users resolve problems regarding circular dependencies, but it brings the cobra effect. Consider the following example:

// Script A
module.exports = someCondition ? new MyClass() : {};

// Script B
const A = require('./A');
if (Object.getPrototypeOf(A) !== Object.prototype) {
  // Here we know that `someCondition` is true
} else {
  // Here we know that `someCondition` is false
}

It does not work as expected in v14.x. May I suggest removing this entire feature, or at least adding an opt-in flag for that? Most of the users know what they are doing and altering random objects makes a lot of unexpected bugs hard to debug.

rickyes commented May 10, 2020
edited
Loading

Copy link
Copy Markdown
Contributor

I don't really like the direction this is going. Even with these changes it still triggers some traps (get for example):

module.exports = new Proxy({}, {
  get(){
    assert.fail(); // Throws here
  }
});

It does not trigger the get hook to the proxy because there is no access property operation for proxy objects inside internal.

But, in general, altering user's objects is really bad practice. I understand the intention is to help users resolve problems regarding circular dependencies, but it brings the cobra effect. Consider the following example:

// Script A
module.exports = someCondition ? new MyClass() : {};

// Script B
const A = require('./A');
if (Object.getPrototypeOf(A) !== Object.prototype) {
  // Here we know that `someCondition` is true
} else {
  // Here we know that `someCondition` is false
}

Module A is proxied on loading, but the prototype will point to global.Object.prototype, so it works fine in this case.

ghost commented May 10, 2020
edited by ghost
Loading

Copy link
Copy Markdown

It does not trigger the get hook to the proxy because there is no access property operation for proxy objects inside internal.

That is incorrect. It does trigger get trap. Please try it yourself before posting a comment:

// A.js
const assert = require('assert');
module.exports = new Proxy({}, {
  get(){
    assert.fail();
  }
});
require('./B');

// B.js
require('./A');

It triggers the get trap at module.exports.__esModule
(that is internal/modules/cjs/loader.js line 861).

Module A is proxied on loading, but the prototype will point to global.Object.prototype, so it works fine in this case.

That is incorrect. Please try it yourself before posting a comment:

// A.js
const someCondition = false;
class MyClass{}
module.exports = someCondition ? new MyClass() : {};
require('./B');

// B.js
const A = require('./A');
if (Object.getPrototypeOf(A) !== Object.prototype) {
  console.log('Oh, something went really bad :/');
} else {
  console.log('OK');
}

addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM although I’m having mixed feelings, because it seems like we’re working around people’s broken Proxy implementations here.

Comment thread lib/internal/modules/cjs/loader.js Outdated
Comment thread lib/internal/modules/cjs/loader.js Outdated

Copy link
Copy Markdown
Member

I don't really like the direction this is going. Even with these changes it still triggers some traps (get for example):

Yeah, I agree here – there’s no point in doing anything here for Proxy exports 👍

But, in general, altering user's objects is really bad practice.

So is exporting an incomplete Proxy from a module, I would say 🤷‍♀️

May I suggest removing this entire feature, or at least adding an opt-in flag for that?

I understand where you’re coming from, but the example code you posted is contrived, and there’s no reason to expect that it is a common occurrence, whereas this feature has enabled catching real-world bugs multiple times even before it was released. It’s making a trade-off, sure, but I would definitely disagree with the notion that it makes the overall situation worse. What’s more, it tends to improve the situation for people who are less familiar with Node.js, and those who do run into these edge cases with it can be assumed to be familiar enough with JS and Node.js to know how to work with them.

BridgeAR force-pushed the fix-circular-modules-check-with-proxies branch from dba07f5 to 83e5b2a Compare May 11, 2020 12:45

Copy link
Copy Markdown
Member Author

I updated the code to fully work with proxies. It will now just use the target object.

It won't "fix" the prototype example but it does seem contrived as @addaleax pointed out and I don't think we have to fix that.

BridgeAR added the module Issues and PRs related to the module subsystem. label May 11, 2020

Copy link
Copy Markdown
Collaborator

Comment thread lib/internal/modules/cjs/loader.js Outdated

This comment has been minimized.

addaleax left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I updated the code to fully work with proxies.

I would disagree with this – the current state of the PR seems worse than the previous version.

It will now just use the target object.

If the module.exports of a module is a Proxy, there is no point in applying this feature, because there is no way to tell how the Proxy interacts with the target object. Plus, modifying an object that is only reachable as a Proxy target breaks expectations about how Proxy objects` work in general.

Copy link
Copy Markdown
Member Author

I was already pondering if the argument about not telling how the Proxy would interact would be brought up 😄 I am fine with skipping proxies completely as well.

BridgeAR force-pushed the fix-circular-modules-check-with-proxies branch from 31b25e4 to ed49784 Compare May 11, 2020 18:12

Copy link
Copy Markdown
Member Author

Updated.

In case the exported module is a proxy that has the `getPrototypeOf`
or `setPrototypeOf` trap, skip the circular dependencies check.
It would otherwise be triggered by the check itself.

Fixes: nodejs#33334

Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de>
BridgeAR force-pushed the fix-circular-modules-check-with-proxies branch from ed49784 to 4e7e478 Compare May 11, 2020 18:16

Copy link
Copy Markdown
Collaborator

BridgeAR added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label May 11, 2020

Copy link
Copy Markdown
Collaborator

BridgeAR added a commit to BridgeAR/node that referenced this pull request May 14, 2020
In case the exported module is a proxy that has the `getPrototypeOf`
or `setPrototypeOf` trap, skip the circular dependencies check.
It would otherwise be triggered by the check itself.

Fixes: nodejs#33334

Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de>

PR-URL: nodejs#33338
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>

Copy link
Copy Markdown
Member Author

Landed in 24bf1ad

BridgeAR closed this May 14, 2020
codebytere pushed a commit that referenced this pull request May 16, 2020
In case the exported module is a proxy that has the `getPrototypeOf`
or `setPrototypeOf` trap, skip the circular dependencies check.
It would otherwise be triggered by the check itself.

Fixes: #33334

Signed-off-by: Ruben Bridgewater <ruben@bridgewater.de>

PR-URL: #33338
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Zeyu Yang <himself65@outlook.com>
codebytere mentioned this pull request May 18, 2020

Copy link
Copy Markdown
Member

@BridgeAR should this go back to 12, and if yes, could you please open a manual backport for it? There are a host of conflicts.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. module Issues and PRs related to the module subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Assertion error starting from v14.0.0

9 participants


Back | FazBrowse Home | New Git URL