modules: add setter for module.parent #35522

aduh95 · 2020-10-06T15:57:59Z

module.parent breaks the ecosystem when read-only (see #32217 (comment)). This PR adds a setter to allow user to change its value instead of throwing.

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

nodejs-github-bot · 2020-10-06T15:58:03Z

Review requested:

@nodejs/modules

richardlau · 2020-10-06T16:03:33Z

CITGM: https://ci.nodejs.org/job/citgm-smoker/2498/

bmeck

LGTM pending lint

richardlau

From the CITGM results that have completed this has fixed the node-gyp test suite, thanks.

richardlau · 2020-10-06T17:55:18Z

Can we fast track? Would be good to get this in the next 14.x release

14.x isn't affected. #33533 didn't backport the breaking parts of #32217.

nodejs-github-bot · 2020-10-06T17:56:40Z

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

aduh95 · 2020-10-06T17:56:51Z

BTW, this should have the label dont-land-on-v14.x and dont-land-on-v12.x.

ExE-Boss · 2020-10-07T18:06:32Z

My only issue with converting module.parent into an accessor on the prototype is that delete module.parent no longer works (unless module is converted into a Proxy) and module.parent = undefined triggers the deprecation warning.

bmeck · 2020-10-08T14:35:14Z

lib/internal/modules/cjs/loader.js

+    'module.parent is deprecated due to accuracy issues. Please use ' +
+      'require.main to find program entry point instead.',
+    'DEP0144'
+  ) : setModuleParent,


Make delete work:

Suggested change

) : setModuleParent,

) : setModuleParent,

configurable: true,

bmeck · 2020-10-08T14:35:35Z

@ExE-Boss making the property configurable should make delete work.

bmeck · 2020-10-08T14:40:24Z

test/parallel/test-module-parent-setter-deprecation.js

+  'DEP0144'
+);
+
+module.parent = undefined;


Suggested change

module.parent = undefined;

module.parent = undefined;

delete module.parent;

assert.strictEqual('parent' in module, false);

bmeck · 2020-10-08T14:40:42Z

test/parallel/test-module-parent-setter-deprecation.js

+// Flags: --pending-deprecation
+
+'use strict';
+const common = require('../common');


Suggested change

const common = require('../common');

const common = require('../common');

const assert = require('assert');

bmeck · 2020-10-08T14:41:34Z

lib/internal/modules/cjs/loader.js

+function setModuleParent(value) {
+  moduleParentCache.set(this, value);
+}
+
 ObjectDefineProperty(Module.prototype, 'parent', {


moving this to be on the module itself is needed to make delete work

Wouldn't that trigger a new deprecation warning for each Module instance?

module.parent; // triggers one warning module.parent?.parent; // triggers another warning?

No, because the deprecation uses a deprecation code:

node/lib/internal/util.js

Lines 77 to 82 in ce84bac

if (code !== undefined) {

if (!codesWarned.has(code)) {

process.emitWarning(msg, 'DeprecationWarning', code, deprecated);

codesWarned.add(code);

}

} else {

aduh95 · 2020-10-13T13:36:55Z

@ExE-Boss Would it be fine for you if we land this PR as is, and then someone else (maybe you?) opens another PR with the changes you're suggesting? I'm afraid I don't have the bandwidth to work on this currently, and I wouldn't want it to miss the v15.x release.

ExE-Boss · 2020-10-13T18:11:04Z

@aduh95 I don’t mind either way.

PR-URL: nodejs#35522 Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

aduh95 · 2020-10-16T22:51:23Z

Landed in aaf225a

jkrems approved these changes Oct 6, 2020

View reviewed changes

bmeck approved these changes Oct 6, 2020

View reviewed changes

richardlau approved these changes Oct 6, 2020

View reviewed changes

aduh95 force-pushed the module-parent-setter branch from 137222b to 80384e8 Compare October 6, 2020 17:08

richardlau added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2020

This comment has been minimized.

Sign in to view

MylesBorins added the fast-track PRs that do not need to wait for 48 hours to land. label Oct 6, 2020

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2020

richardlau added dont-land-on-v12.x labels Oct 6, 2020

MylesBorins removed the fast-track PRs that do not need to wait for 48 hours to land. label Oct 6, 2020

This comment has been minimized.

Sign in to view

ryzokuken approved these changes Oct 6, 2020

View reviewed changes

benjamingr approved these changes Oct 6, 2020

View reviewed changes

addaleax approved these changes Oct 7, 2020

View reviewed changes

bmeck reviewed Oct 8, 2020

View reviewed changes

aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 14, 2020

aduh95 force-pushed the module-parent-setter branch from 80384e8 to aaf225a Compare October 16, 2020 22:51

aduh95 merged commit aaf225a into nodejs:master Oct 16, 2020

aduh95 deleted the module-parent-setter branch October 16, 2020 22:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

modules: add setter for module.parent #35522

modules: add setter for module.parent #35522

aduh95 commented Oct 6, 2020

nodejs-github-bot commented Oct 6, 2020

richardlau commented Oct 6, 2020

bmeck left a comment

richardlau left a comment

This comment has been minimized.

richardlau commented Oct 6, 2020

nodejs-github-bot commented Oct 6, 2020

aduh95 commented Oct 6, 2020 •

edited

Loading

This comment has been minimized.

ExE-Boss commented Oct 7, 2020 •

edited

Loading

bmeck Oct 8, 2020

bmeck commented Oct 8, 2020

bmeck Oct 8, 2020

bmeck Oct 8, 2020

bmeck Oct 8, 2020

aduh95 Oct 8, 2020

ExE-Boss Oct 8, 2020

aduh95 commented Oct 13, 2020

ExE-Boss commented Oct 13, 2020

aduh95 commented Oct 16, 2020

	const common = require('../common');
	const common = require('../common');
	const assert = require('assert');

	if (code !== undefined) {
	if (!codesWarned.has(code)) {
	process.emitWarning(msg, 'DeprecationWarning', code, deprecated);
	codesWarned.add(code);
	}
	} else {

modules: add setter for module.parent #35522

modules: add setter for module.parent #35522

Conversation

aduh95 commented Oct 6, 2020

Checklist

nodejs-github-bot commented Oct 6, 2020

richardlau commented Oct 6, 2020

bmeck left a comment

Choose a reason for hiding this comment

richardlau left a comment

Choose a reason for hiding this comment

This comment has been minimized.

richardlau commented Oct 6, 2020

nodejs-github-bot commented Oct 6, 2020

aduh95 commented Oct 6, 2020 • edited Loading

This comment has been minimized.

ExE-Boss commented Oct 7, 2020 • edited Loading

bmeck Oct 8, 2020

Choose a reason for hiding this comment

bmeck commented Oct 8, 2020

bmeck Oct 8, 2020

Choose a reason for hiding this comment

bmeck Oct 8, 2020

Choose a reason for hiding this comment

bmeck Oct 8, 2020

Choose a reason for hiding this comment

aduh95 Oct 8, 2020

Choose a reason for hiding this comment

ExE-Boss Oct 8, 2020

Choose a reason for hiding this comment

aduh95 commented Oct 13, 2020

ExE-Boss commented Oct 13, 2020

aduh95 commented Oct 16, 2020

aduh95 commented Oct 6, 2020 •

edited

Loading

ExE-Boss commented Oct 7, 2020 •

edited

Loading