module: add createRequire method #27405

MylesBorins · 2019-04-25T04:31:54Z

This is an abstraction on top of creatRequireFromPath that can accept
both paths, URL Strings, and URL Objects.

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 · 2019-04-25T04:31:56Z

Lite-CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3363

benjamingr

Code LGTM

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

mscdex · 2019-04-25T13:05:04Z

Is there a reason this can't be a part of createRequireFromPath() instead of creating a separate function?

lib/internal/modules/cjs/loader.js

nodejs-github-bot · 2019-04-26T18:42:32Z

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

MylesBorins · 2019-04-26T18:43:46Z

Updated code based on feedback from @devsnek. Have also added documentation to modules.md.

@mscdex I don't think this makes sense to add to createRequireFromPath as that API explicitly states it is meant for paths. I think it might make sense to deprecate createRequireFromPath and make it an internal API, as createRequire is far more useful IMHO.

jkrems

🎉

nodejs-github-bot · 2019-04-26T20:45:29Z

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

MylesBorins · 2019-04-26T23:11:01Z

CI is actually green the fail above is a lie. If there are no objections to this PR I plan to land it as is on Monday

Fishrock123

This seems fine to me... (but I am not convinced that it is an acceptable replacement of import.meta.require...)

lib/internal/modules/cjs/loader.js

doc/api/modules.md

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

MylesBorins · 2019-04-30T21:26:59Z

Changed a few things here:

createRequire now only supports absolute paths (either path or URL)
- this is because the underlying logic in Module for relative paths is undefined / confusing e.g. caching cwd(). This limitation, which we could choose to remove later, guards against unexpected behavior (which was present in our documentation)
createRequireFromPath is now docs deprecated
- please LMK if I need to do anything more, haven't deprecated before

PTAL

nodejs-github-bot · 2019-04-30T21:27:38Z

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

lib/internal/modules/cjs/loader.js

MylesBorins · 2019-05-01T07:25:54Z

One more stab at it

Differences:

now fails with non-url objects early
swallows all errors from fileURLToPath and has a single unified error
explicitly only support
- file URL objects
- file URL string
- absolute path string

I believe this has scoped the use of this API enough that it guards against most footguns PTAL

BridgeAR

If we really deprecate the other API, it'll need an entry in doc/api/deprecations.md.

doc/api/modules.md

lib/internal/modules/cjs/loader.js

benjamingr · 2019-05-02T13:01:46Z

changes still lgtm

doc/api/deprecations.md

nodejs-github-bot · 2019-05-03T06:41:41Z

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

nodejs-github-bot · 2019-05-03T18:46:30Z

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

MylesBorins · 2019-05-03T19:12:55Z

latest CI was green!

landed in 411063c

This is an abstraction on top of creatRequireFromPath that can accept both paths, URL Strings, and URL Objects. PR-URL: #27405 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jan Krems <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Notable changes: * tls: * Added an `enableTrace()` method to `TLSSocket` and an `enableTrace` option to `tls.createServer()`. When enabled, TSL packet trace information is written to `stderr`. This can be used to debug TLS connection problems. #27497 * cli: * Added a `--trace-tls` command-line flag that enables tracing of TLS connections without the need to modify existing application code. #27497 * Added a `--cpu-prof-interval` command-line flag. It can be used to specify the sampling interval for the CPU profiles generated by `--cpu-prof`. #27535 * module: * Added the `createRequire()` method. It allows to create a require function a file URL object, a file URL string or an absolute path string. The existing `createRequireFromPath()` method is now deprecated #27405. * Throw on `require('./path.mjs')`. This is technically a breaking change that should have landed with Node.js 12.0.0. It is necessary to have this to keep the possibility for a future minor version to load ES Modules with the require function. #27417 * meta: * Added Christian Clauss (https://github.com/cclauss) to collaborators. #27554 PR-URL: #27578

Notable changes: * deps: * Updated llhttp to 1.1.3. This fixes a bug that made Node.js' HTTP parser refuse any request URL that contained the "|" (vertical bar) character. #27595 * tls: * Added an `enableTrace()` method to `TLSSocket` and an `enableTrace` option to `tls.createServer()`. When enabled, TSL packet trace information is written to `stderr`. This can be used to debug TLS connection problems. #27497 #27376 * cli: * Added a `--trace-tls` command-line flag that enables tracing of TLS connections without the need to modify existing application code. #27497 * Added a `--cpu-prof-interval` command-line flag. It can be used to specify the sampling interval for the CPU profiles generated by `--cpu-prof`. #27535 * module: * Added the `createRequire()` method. It allows to create a require function from a file URL object, a file URL string or an absolute path string. The existing `createRequireFromPath()` method is now deprecated #27405. * Throw on `require('./path.mjs')`. This is technically a breaking change that should have landed with Node.js 12.0.0. It is necessary to have this to keep the possibility for a future minor version to load ES Modules with the require function. #27417 * repl: * The REPL now supports multi-line statements using `BigInt` literals as well as public and private class fields and methods. #27400 * The REPL now supports tab autocompletion of file paths with `fs` methods. #26648 * meta: * Added Christian Clauss (https://github.com/cclauss) to collaborators. #27554 PR-URL: #27578

This is an abstraction on top of creatRequireFromPath that can accept both paths, URL Strings, and URL Objects. PR-URL: nodejs/node#27405 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Jan Krems <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Rich Trott <[email protected]>

MylesBorins force-pushed the createRequire branch 2 times, most recently from a83b861 to 8c6a784 Compare April 25, 2019 06:20

benjamingr approved these changes Apr 25, 2019

View reviewed changes

benjamingr reviewed Apr 25, 2019

View reviewed changes

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

devsnek 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

jasnell approved these changes Apr 26, 2019

View reviewed changes

MylesBorins mentioned this pull request Apr 26, 2019

upstream PR for createRequire nodejs/modules#322

Closed

jkrems approved these changes Apr 26, 2019

View reviewed changes

Fishrock123 approved these changes Apr 26, 2019

View reviewed changes

guybedford reviewed Apr 27, 2019

View reviewed changes

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

bnoordhuis reviewed Apr 28, 2019

View reviewed changes

doc/api/modules.md Outdated Show resolved Hide resolved

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

MylesBorins force-pushed the createRequire branch from 7412f8a to 21a6bf5 Compare April 30, 2019 21:24

MylesBorins commented Apr 30, 2019

View reviewed changes

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

guybedford reviewed Apr 30, 2019

View reviewed changes

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

sam-github mentioned this pull request May 1, 2019

aix failing in CI nodejs/build#1796

Closed

MylesBorins force-pushed the createRequire branch from 29ca8e4 to bc5f646 Compare May 1, 2019 07:26

This comment has been minimized.

Sign in to view

BridgeAR reviewed May 1, 2019

View reviewed changes

doc/api/modules.md Outdated Show resolved Hide resolved

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

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

mscdex mentioned this pull request May 2, 2019

createRequireFromPath does not support directories with a trailing slash #27527

Closed

Trott added the notable-change PRs with changes that should be highlighted in changelogs. label May 3, 2019

Trott reviewed May 3, 2019

View reviewed changes

doc/api/deprecations.md Outdated Show resolved Hide resolved

Trott approved these changes May 3, 2019

View reviewed changes

fixup: don't number dep

e754f55

MylesBorins closed this May 3, 2019

targos mentioned this pull request May 6, 2019

v12.2.0 proposal #27578

Merged

BethGriggs added the lts-watch-v10.x label Aug 20, 2019

BethGriggs added the backport-requested-v10.x label Oct 17, 2019

Uh oh!

module: add createRequire method #27405

module: add createRequire method #27405

Uh oh!

Conversation

MylesBorins commented Apr 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

nodejs-github-bot commented Apr 25, 2019

Uh oh!

benjamingr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mscdex commented Apr 25, 2019

Uh oh!

Uh oh!

nodejs-github-bot commented Apr 26, 2019

Uh oh!

MylesBorins commented Apr 26, 2019

Uh oh!

jkrems left a comment

Choose a reason for hiding this comment

Uh oh!

nodejs-github-bot commented Apr 26, 2019

Uh oh!

MylesBorins commented Apr 26, 2019

Uh oh!

Fishrock123 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MylesBorins commented Apr 30, 2019

Uh oh!

nodejs-github-bot commented Apr 30, 2019

Uh oh!

Uh oh!

Uh oh!

MylesBorins commented May 1, 2019

Uh oh!

This comment has been minimized.

This comment has been minimized.

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benjamingr commented May 2, 2019

Uh oh!

Uh oh!

nodejs-github-bot commented May 3, 2019

Uh oh!

nodejs-github-bot commented May 3, 2019

Uh oh!

MylesBorins commented May 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

16 participants

MylesBorins commented Apr 25, 2019 •

edited

Loading