module: allow passing a directory to createRequireFromPath #23818

gillesdemey · 2018-10-22T18:48:40Z

I still need to update the documentation for this change, I'm not quite sure if we should update the documentation to encourage users to pass a directory or do we prefer a file path?

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

lib/internal/modules/cjs/loader.js

test/parallel/test-module-create-require-from-directory.js

Trott · 2018-11-19T00:59:38Z

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

guybedford

CI failure seems to be unrelated as far as I can tell, but perhaps someone can double check.

gillesdemey · 2018-11-20T10:35:48Z

Seems like a flaky streams test, from the CI output:

02:54:38 not ok 410 parallel/test-stream-pipeline
02:54:38   ---
02:54:38   duration_ms: 120.94
02:54:38   severity: fail
02:54:38   exitcode: 1
02:54:38   stack: |-
02:54:38     timeout
02:54:38   ...

Trott · 2018-11-23T23:34:11Z

Resume Build CI: https://ci.nodejs.org/job/node-test-pull-request/18906/

Trott · 2018-11-28T03:30:02Z

This affects CJS modules so I want to make sure it gets sufficient review, so.... @nodejs/collaborators (Maybe we should have a CJS modules team?)

test/parallel/test-module-create-require-from-directory.js

guybedford · 2018-11-28T14:37:17Z

Note it is important to merge this or the docs change as effectively the documentation is incorrect until then!

mcollina · 2018-11-28T16:45:39Z

test/parallel/test-module-create-require-from-directory.js

+assert.strictEqual(req('./baz'), 'perhaps I work');
+assert.throws(() => {
+  reqFromNotDir('./baz');
+}, { code: 'MODULE_NOT_FOUND' });


I'd expect both of this to pass. fixtures is a directory, so they should both work IMHO. This probably requires adding a round-trip to OS, but I don't think it could be avoided.

That would be a very different approach to this function, but it could work. //cc @devsnek

I'm happy to change the implementation to call stat.isDirectory() if that's the way we want to move this forward :)

If we want to get this merged, I'd suggest we stick with the current behaviour which matches the behaviour of path resolution.

+1 to sticking to behavior that matches path... we should change this behavior in the path module if we want to fix it imho

I personally think calling stat is a good idea in this case. createRequireFromPath is IMO special enough to work differently from the rest of Module.

I would like to land this to improve the behavior and introduce the stat separately in a follow up. Is that reasonable for you @BridgeAR ?

This has three different open comments at the moment (actually four but two are about using stat). I personally would not land this but I won't block it either.

@BridgeAR afaict all open comments are about stat, which I think should be an incremental improvement discussed separately.

Did I miss any other open comments?

MylesBorins

LGTM

MylesBorins · 2019-04-25T06:52:11Z

went ahead and rebased against master and added a very minor doc fix to at the very least get the docs working.

@Trott I've dropped the semver-minor label on this as I believe it should be considered a bug fix. The docs at the very least imply that being able to pass a directory to createRequireFromPath was expected behavior.

The function is not used anywhere in core so AFAIK I don't think we need to consider it a change to the way CJS modules work.

@mcollina do you have any objections to this landing?

nodejs-github-bot · 2019-04-25T06:52:42Z

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

lib/internal/modules/cjs/loader.js

BridgeAR · 2019-04-25T07:27:05Z

lib/internal/modules/cjs/loader.js

+  // Allow a directory to be passed as the filename
+  const normalized = path.win32.normalize(filename);
+  const trailingSlash = normalized.charCodeAt(normalized.length - 1) ===
+    CHAR_BACKWARD_SLASH;


Should we maybe just call stat to verify if it's a file or directory? That way it's even safer and works without a trailing slash.

I think the issue isn't being different from module it is being different from how Path works... I'm not 100% we should be adding the stat here

BridgeAR · 2019-04-25T07:30:13Z

test/parallel/test-module-create-require-from-directory.js

+assert.strictEqual(req('./baz'), 'perhaps I work');
+assert.throws(() => {
+  reqFromNotDir('./baz');
+}, { code: 'MODULE_NOT_FOUND' });


I personally think calling stat is a good idea in this case. createRequireFromPath is IMO special enough to work differently from the rest of Module.

lib/internal/modules/cjs/loader.js

MylesBorins · 2019-04-25T20:30:07Z

@targos why did you add back the semver-minor label? I don't believe this is a minor as lack of directory support is a bug, original docs implied feature was intended

targos · 2019-04-25T21:04:24Z

Sorry, I was just passing through PRs without any label. I didn't see it was added and removed.

Fixes: nodejs#23710

nodejs-github-bot · 2019-04-30T17:49:31Z

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

MylesBorins · 2019-04-30T17:50:32Z

rebased PR and added changes based on review. PTAL

MylesBorins · 2019-04-30T20:44:19Z

only failure is infra failure on AIX... will land in 24 hours if there are no objections

BridgeAR

LGTM. It would be nice to get a follow-up PR that implements the suggested stat call.

addaleax

LGTM – I don’t think a stat call necessarily makes sense, or at least I’d like to see an opt-out switch of that, because it’s only a help to avoid accidentally passing in non-directories, not something that actually influences how the feature works.

nodejs-github-bot · 2019-05-01T22:17:52Z

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

BridgeAR · 2019-05-01T22:22:18Z

@addaleax

I don’t think a stat call necessarily makes sense, or at least I’d like to see an opt-out switch of that, because it’s only a help to avoid accidentally passing in non-directories, not something that actually influences how the feature works.

I would not use an opt-out but up to two stat calls: one for the filename as it is and if that fails one for path.dirname(filename).

addaleax · 2019-05-01T22:24:56Z

@BridgeAR I think it’s a bad idea because I think the whole idea of tying the module system to the actual filesystem breaks orthogonality and is consequentially a design flaw; but that’s a bigger discussion.

MylesBorins · 2019-05-02T00:34:37Z

landed in e5c8be2

Fixes: #23710 PR-URL: #23818 Reviewed-By: Guy Bedford <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>

jdalton reviewed Oct 22, 2018

View reviewed changes

lib/internal/modules/cjs/loader.js Show resolved Hide resolved

gillesdemey commented Oct 22, 2018

View reviewed changes

test/parallel/test-module-create-require-from-directory.js Outdated Show resolved Hide resolved

guybedford approved these changes Nov 20, 2018

View reviewed changes

Trott added the semver-minor PRs that contain new features and should be released in the next minor version. label Nov 28, 2018

mcollina reviewed Nov 28, 2018

View reviewed changes

test/parallel/test-module-create-require-from-directory.js Outdated Show resolved Hide resolved

mcollina reviewed Nov 28, 2018

View reviewed changes

This was referenced Mar 11, 2019

module: createRequireFromPath documentation is incorrect #23710

Closed

doc fix: align code example for module.createRequireFromPath() with actual code behavior. #26606

Closed

MylesBorins mentioned this pull request Apr 25, 2019

Odd behaviour: createRequireFromPath('.') #27401

Closed

MylesBorins removed the semver-minor PRs that contain new features and should be released in the next minor version. label Apr 25, 2019

MylesBorins approved these changes Apr 25, 2019

View reviewed changes

MylesBorins force-pushed the fix/createRequireFromPath branch from 83f4c9b to 4c6c0d6 Compare April 25, 2019 06:44

MylesBorins self-assigned this Apr 25, 2019

This comment has been minimized.

Sign in to view

BridgeAR reviewed Apr 25, 2019

View reviewed changes

jdalton reviewed Apr 25, 2019

View reviewed changes

lib/internal/modules/cjs/loader.js Outdated Show resolved Hide resolved

targos added module Issues and PRs related to the module subsystem. semver-minor PRs that contain new features and should be released in the next minor version. labels Apr 25, 2019

targos removed the semver-minor PRs that contain new features and should be released in the next minor version. label Apr 25, 2019

gillesdemey added 2 commits April 30, 2019 10:14

module: allow passing a directory to createRequireFromPath

a734696

Fixes: nodejs#23710

module: fix windows path separators

676cc00

gillesdemey and others added 4 commits April 30, 2019 10:14

test: make test-module-create-require-from-directory pass on Windows

c2eff11

test: add a negative test to test-module-create-require-from-directory

2b1f48e

fixup: doc change

5942747

fixup: notes from review

9ec4cb8

MylesBorins force-pushed the fix/createRequireFromPath branch from d797960 to 9ec4cb8 Compare April 30, 2019 17:49

BridgeAR approved these changes May 1, 2019

View reviewed changes

addaleax approved these changes May 1, 2019

View reviewed changes

MylesBorins closed this May 2, 2019

gillesdemey deleted the fix/createRequireFromPath branch May 2, 2019 08:23

targos mentioned this pull request May 6, 2019

v12.2.0 proposal #27578

Merged

HarshithaKP mentioned this pull request Mar 31, 2020

module: createRequireFromPath missed docs #24763

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

module: allow passing a directory to createRequireFromPath #23818

module: allow passing a directory to createRequireFromPath #23818

gillesdemey commented Oct 22, 2018

Trott commented Nov 19, 2018

guybedford left a comment

gillesdemey commented Nov 20, 2018

Trott commented Nov 23, 2018

Trott commented Nov 28, 2018

guybedford commented Nov 28, 2018

mcollina Nov 28, 2018

guybedford Nov 29, 2018

gillesdemey Dec 1, 2018

guybedford Mar 11, 2019

MylesBorins Apr 25, 2019

BridgeAR Apr 25, 2019

MylesBorins Apr 30, 2019

BridgeAR Apr 30, 2019

MylesBorins May 1, 2019

MylesBorins left a comment

This comment has been minimized.

MylesBorins commented Apr 25, 2019

nodejs-github-bot commented Apr 25, 2019

BridgeAR Apr 25, 2019

MylesBorins Apr 25, 2019

BridgeAR Apr 25, 2019

MylesBorins commented Apr 25, 2019

targos commented Apr 25, 2019

nodejs-github-bot commented Apr 30, 2019

MylesBorins commented Apr 30, 2019

MylesBorins commented Apr 30, 2019

BridgeAR left a comment

addaleax left a comment

nodejs-github-bot commented May 1, 2019

BridgeAR commented May 1, 2019

addaleax commented May 1, 2019

MylesBorins commented May 2, 2019

module: allow passing a directory to createRequireFromPath #23818

module: allow passing a directory to createRequireFromPath #23818

Conversation

gillesdemey commented Oct 22, 2018

Checklist

Trott commented Nov 19, 2018

guybedford left a comment

Choose a reason for hiding this comment

gillesdemey commented Nov 20, 2018

Trott commented Nov 23, 2018

Trott commented Nov 28, 2018

guybedford commented Nov 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MylesBorins left a comment

Choose a reason for hiding this comment

This comment has been minimized.

MylesBorins commented Apr 25, 2019

nodejs-github-bot commented Apr 25, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MylesBorins commented Apr 25, 2019

targos commented Apr 25, 2019

nodejs-github-bot commented Apr 30, 2019

MylesBorins commented Apr 30, 2019

MylesBorins commented Apr 30, 2019

BridgeAR left a comment

Choose a reason for hiding this comment

addaleax left a comment

Choose a reason for hiding this comment

nodejs-github-bot commented May 1, 2019

BridgeAR commented May 1, 2019

addaleax commented May 1, 2019

MylesBorins commented May 2, 2019