-
Notifications
You must be signed in to change notification settings - Fork 29.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
esm: Add support for pjson cache and main without extensions #18728
Conversation
9b71cb0
to
319a22d
Compare
This adds support for ensuring that the top-level main into Node is supported loading when it has no extension for backwards-compat with NodeJS bin workflows. In addition package.json caching is implemented in the module lookup process.
319a22d
to
f14420e
Compare
@nodejs/modules , also I missed you joining the collaborator ranks - so here's a late welcome :) |
Any obvious reason this isn't two PRs (one for the main without extensions, one for the cache) by the way? |
This could just as well be two separate PRs, although there is some minor general refactoring here as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, would love adding some tests (not sure how to test the caching behavior though)
url.search = old.search; | ||
url.hash = old.hash; | ||
} | ||
|
||
const ext = extname(url.pathname); | ||
return { url: `${url}`, format: extensionFormatMap[ext] || ext }; | ||
|
||
const format = extensionFormatMap[ext] || parentURL === undefined && 'cjs'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is confusing IMO, I'd write it as either an if/else or at least use parenthesis.
if (!format) | ||
throw new errors.Error('ERR_UNKNOWN_FILE_EXTENSION', url.pathname); | ||
|
||
return { url: `${url}`, format }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just wondering, why is this wrapping of ${url}
required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a URL -> string serialization convention in this code.
lib/internal/loader/Loader.js
Outdated
async resolve(specifier, parentURL = this.base) { | ||
if (typeof parentURL !== 'string') | ||
async resolve(specifier, parentURL) { | ||
if (parentURL !== undefined && typeof parentURL !== 'string') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure I like the new logic (of using parentURL !== undefined
instead of an explicit check) - If possible I'd at least make the check a getter or a function and call that instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Loaders exist in their own context, without even a this
reference currently, so the alternative channel would be arguments. So the idea of parentURL === undefined
is that it avoids the need for a breaking change in the arguments when we already have it, and it makes logical API sense in terms of the tree structure of modules.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, all I'm saying is that I'd likely put a function called isMain
and pass parentURL
to it to make it explicit - without the context of this PR it wouldn't be immediately obvious to me what it does
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might want to be a bit careful about over abstracting here if we ever want to support a --require
like flag for ESM, which I presume also would not have a parentURL
, but wouldn't be a "main"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, we could assign to isMain
first to make this clearer.
lib/internal/process/modules.js
Outdated
function initializeImportMetaObject(wrap, meta) { | ||
meta.url = wrap.url; | ||
} | ||
|
||
function setupModules() { | ||
setInitializeImportMetaObjectCallback(initializeImportMetaObject); | ||
|
||
let ESMLoader = new Loader(); | ||
const loaderPromise = (async () => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't a great pattern and errors here are suppressed unless explicitly asked for
lib/internal/process/modules.js
Outdated
}; | ||
exports.setup = setupModules; | ||
exports.ESMLoader = undefined; | ||
exports.loaderPromise = undefined; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we want to start this as undefined
, maybe set to a promise that we'd resolve with the "new" loaderPromise
data?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure I'll switch around some of the async logic.
await ESMLoader.import(getURLFromFilePath(request).pathname); | ||
})() | ||
if (experimentalModules && isMain) { | ||
internalESModule.loaderPromise.then((loader) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not a fan of our error handling logic here of console.error(e); process.exit(1)
but that's unrelated to this PR. I might raise it at the team meeting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@benjamingr that was done because unhandled rejection gave even worse error messages to the user.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bmeck then we should either fix the unhandled rejection error messages or throw
here in nextTick
so that people with uncaughtException
checks can intercept it if they can for synchronous loading?
If you can point me towards related reading I promise to read it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
related reading??
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For adding the behavior for error messages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
src/module_wrap.cc
Outdated
@@ -494,23 +493,73 @@ Maybe<uv_file> CheckFile(const URL& search, | |||
return Just(fd); | |||
} | |||
|
|||
PackageConfig emptyPackage = { false, false, "" }; | |||
std::unordered_map<std::string, PackageConfig> pjson_cache_; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we OK with keeping this in memory for all time? (I think so, just checking, since this means more memory that's always alive in the process)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it's a cache for the lifetime of the process and we're not maintaining the full contents just the main string.
src/module_wrap.cc
Outdated
} | ||
Maybe<uv_file> check = CheckFile(path, LEAVE_OPEN_AFTER_CHECK); | ||
if (check.IsNothing()) { | ||
return pjson_cache_[path] = emptyPackage; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd personally prefer it if this was split into two lines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto for other usages of this pattern
src/module_wrap.cc
Outdated
enum ResolveExtensionsOptions { | ||
TRY_EXACT_NAME, | ||
ONLY_VIA_EXTENSIONS | ||
}; | ||
|
||
template<ResolveExtensionsOptions options> | ||
Maybe<URL> ResolveExtensions(const URL& search) { | ||
Maybe<URL> ResolveExtensions(Environment* env, const URL& search) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you add env
here? Is it used somewhere and I missed it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, yes this is unused.
src/module_wrap.cc
Outdated
if (!ShouldBeTreatedAsRelativeOrAbsolutePath(main_std)) { | ||
main_std.insert(0, "./"); | ||
if (!ShouldBeTreatedAsRelativeOrAbsolutePath(pjson.main)) { | ||
return Resolve(env, "./" + pjson.main, search); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RESOLVED: DELEGATE TO SEPARATE PR
Does this get weird with a leading /
? I'm not entirely sure what this is trying to do versus below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just a rewriting of the original:
if (!ShouldBeTreatedAsRelativeOrAbsolutePath(main_std)) {
main_std.insert(0, "./");
}
return Resolve(env, main_std, search);
into:
if (!ShouldBeTreatedAsRelativeOrAbsolutePath(main_std)) {
return Resolve(env, "./" + pjson.main, search);
}
return Resolve(env, main_std, search);
which I believe is invariant. But happy to revert otherwise too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this looks like a breaking bug that I introduced a long time ago from CJS when I dug up git blame. I'll deal with this in a separate PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Glad to have helped surface. Ideally I think the pjson.main
should be pre-sanitized at the cache phase, so that that can already be handled by the time the code gets here.
@benjamingr thanks for the review. The test at https://github.com/nodejs/node/pull/18728/files#diff-d3da74a6bdb693be276bdef1df06123fL7 catches the main extension case, while the rest of the module tests will all use the cache (there are repeat loads of the same package already that would apply here). |
Yeah, though technically they're not testing that code - as in: the code could cache or not cache and the tests wouldn't wouldn't fail. Although I'm not sure how to test it or even if we should. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Second round
doc/api/esm.md
Outdated
|
||
export async function resolve(specifier, parentModuleURL, defaultResolver) { | ||
return { | ||
url: new URL(specifier, parentModuleURL).href, | ||
url: new URL(specifier, parentModuleURL || baseURL).href, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given we use the pattern parentModuleURL = baseURL
below for the default argument value - it's probably a good idea to stay consistent in the docs here and use it too.
doc/api/esm.md
Outdated
format: 'esm' | ||
}; | ||
} | ||
``` | ||
|
||
The parentURL is provided as `undefined` when performing main NodeJS load itself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: NodeJS -> Node.js
inspectBrk = true; | ||
} | ||
this.isMain = false; | ||
if (process._breakFirstLine) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reading this again, can you explain why removing the if (this.main)
without if (parentURL)
is valid?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because we clear _breakFirstLine
it's guaranteed to only trigger for the first module loaded.
lib/internal/process/modules.js
Outdated
setInitializeImportMetaObjectCallback(initializeImportMetaObject); | ||
} | ||
exports.loaderPromise = new Promise((resolve, reject) => { | ||
exports.setup = function() { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This works (defining setup
inside the promise) but has some side effects - for example synchronous throws from setup
will now be converted to loaderPromise
errors.
I'd do something like:
let loaderPromiseResolve;
exports.loaderPromise = new Promise(resolve => {
loaderPromiseResolve = resolve;
});
And then define loaderPromise
as resolve, and use loaderPromiseResolve
on the new loaderPromise
(since you can pass a rejected promise to it and it'll reject the original promise).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few more nits about the promises - overall lgtm
lib/internal/process/modules.js
Outdated
function initializeImportMetaObject(wrap, meta) { | ||
meta.url = wrap.url; | ||
} | ||
|
||
function setupModules() { | ||
let loaderResolve, loaderReject; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, elaborating on what I wrote before:
let aResolve, aReject;
exports.loaderPromise = new Promise((resolve, reject) => {
aResolve = resolve;
aReject = reject;
});
trackedPromise.then(aResolve, aReject);
Can be written as:
let aResolve;
exports.loaderPromise = new Promise((resolve, reject) => {
aResolve = resolve;
});
aResolve(trackedPromise);
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could also just use createPromise/promiseReject/promiseResolve, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@devsnek that's technically true but I'm not sure it would help clean the code and that's an internal API - I doubt the cost of the extra closure here is worth it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't looked through this code at all, so take this with a grain of salt, but I recently did a lot of benchmarking on using the Promise constructor vs the internal createPromise/promiseReject/promiseResolve and the latter is definitely quite a bit faster.
But again, I don't know about the usage here, whether this is performance sensitive code, if these functions end up being user-land exposed, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i just meant for readability heh, i was actually under the impression that the api was slower than the promise constructor
const loaderPromise = exports.loaderPromise = createPromise();
...
promiseResolve(loaderPromise, ESMLoader);
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@devsnek @apapirovski not allocating a closure and it being faster is actually why we have this API to begin with (as well as util.promisify
). There's a bit of history involved but if it wasn't faster I'd be surprised. That said - this code does I/O and the impact of an extra closure isn't something we should optimize for.
@devsnek I think it makes the code easier for people more familiar with promises in core to read but overall I personally prefer standard to nonstandard when we have the choice.
Namely, there are subtle differences between promiseResolve
and resolve
in the promise constructor which I'd rather avoid in areas that are not performance sensitive. I don't feel strongly about it though.
await ESMLoader.import(getURLFromFilePath(request).pathname); | ||
})() | ||
if (experimentalModules && isMain) { | ||
internalESModule.loaderPromise.then((loader) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bmeck then we should either fix the unhandled rejection error messages or throw
here in nextTick
so that people with uncaughtException
checks can intercept it if they can for synchronous loading?
If you can point me towards related reading I promise to read it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, would love it if more people gave this a look and made sure this behaves as expected and there are no subtle C++ issues I missed
src/module_wrap.cc
Outdated
@@ -494,6 +493,59 @@ Maybe<uv_file> CheckFile(const URL& search, | |||
return Just(fd); | |||
} | |||
|
|||
PackageConfig emptyPackage = { false, false, "" }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
static const PackageConfig kEmptyPackage = ...
and since it's only used in GetPackageConfig() move it into that function.
src/module_wrap.cc
Outdated
@@ -494,6 +493,59 @@ Maybe<uv_file> CheckFile(const URL& search, | |||
return Just(fd); | |||
} | |||
|
|||
PackageConfig emptyPackage = { false, false, "" }; | |||
std::unordered_map<std::string, PackageConfig> pjson_cache_; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style: pjson_cache
, no trailing underscore. package_json_cache
is a better name, IMO.
Substance: should be a member of Environment
.
src/module_wrap.cc
Outdated
Maybe<uv_file> check = CheckFile(path, LEAVE_OPEN_AFTER_CHECK); | ||
if (check.IsNothing()) { | ||
return pjson_cache_[path] = | ||
emptyPackage; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No linebreak, fits on one line. Likewise below.
src/module_wrap.cc
Outdated
} | ||
|
||
Isolate* isolate = env->isolate(); | ||
Local<Context> context = isolate->GetCurrentContext(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
env->context()
? You should probably create a v8::HandleScope handle_scope(isolate)
first since you're creating JS handles.
src/module_wrap.cc
Outdated
Local<Context> context = isolate->GetCurrentContext(); | ||
std::string pkg_src = ReadFile(check.FromJust()); | ||
uv_fs_t fs_req; | ||
uv_fs_close(nullptr, &fs_req, check.FromJust(), nullptr); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check the return value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is actually the same code we have got currently just moved around a bit.
I think to properly do this would involve improving the error handling here, which I may not be the best person for as I'm not sure what mechanisms would be best here without further pointers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since I wouldn't expect it to fail, a simple CHECK should suffice:
CHECK_EQ(0, uv_fs_close(nullptr, &fs_req, check.FromJust(), nullptr));
src/module_wrap.cc
Outdated
} | ||
|
||
Local<Value> pkg_json; | ||
if (!JSON::Parse(context, src).ToLocal(&pkg_json) || !pkg_json->IsObject()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you use the ToObject() overload that takes a Context?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm' not sure I follow exactly what is intended here. Do you mean something like:
Local<Value> pkg_json = JSON::Parse(context, src).ToLocalChecked();
MaybeLocal<Object> pkg_json_obj = pkg_json->ToObject(context);
if (pkg_json_obj.isEmpty())
// ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You probably don't want to use .ToLocalChecked()
on the return value of JSON::Parse()
because that will abort node when the JSON is malformed without a clear error message (aside: that's also an argument for removing the TryCatch; the exception should bubble up.)
Essentially, you'd do something like this:
Local<Value> package_json_v;
Local<Object> package_json;
if (!JSON::Parse(context, src).ToLocal(&package_json_v)) return; // Exception pending.
if (!package_json_v->ToObject(context).ToLocal(&package_json)) return; // Exception pending.
// |package_json| points to a valid JS object now.
src/module_wrap.cc
Outdated
@@ -594,8 +618,8 @@ Maybe<URL> ResolveModule(Environment* env, | |||
|
|||
Maybe<URL> ResolveDirectory(Environment* env, | |||
const URL& search, | |||
bool read_pkg_json) { | |||
if (read_pkg_json) { | |||
bool check_pjson_main) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally, use an enum, not a bool; easier to read at call sites.
src/module_wrap.h
Outdated
struct PackageConfig { | ||
bool exists; | ||
bool has_main; | ||
std::string main; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make these const if at all possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't get this to work unfortunately - seems to be a result of PackageConfig
not being a pointer on the map itself in the assignment operator.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was the error you got?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two:
error: use of deleted function ‘node::Environment::PackageConfig& node::Environment::PackageConfig::operator=(const node::Environment::PackageConfig&)’
error: non-static const member ‘const bool node::Environment::PackageConfig::exists’, can’t use default assignment operator
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@guybedford that's just because since it's const it must be fully intiialized - when you do myMap['foo'] = bar
that potentially creates an empty object and then assigns bar
to it.
You can use emplace
to construct the object inside the map to overcome it.
src/module_wrap.cc
Outdated
PackageConfig pjson = { true, has_main, main_std }; | ||
return pjson_cache_[path] = | ||
pjson; | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Return either a const PackageConfig&
or a PackageConfig*
. Mutable references are tricky because it's not always clear at the call site if you're manipulating the original or a copy.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not shown here, but this issue is addressed and const PackageConfig& is returned.
d007ba1
to
2d6d4e6
Compare
@bnoordhuis thanks for the feedback, I've included the points as mentioned, perhaps just check I've got these along the right lines. |
7330c86
to
717d4ca
Compare
717d4ca
to
081aab4
Compare
src/env.h
Outdated
bool exists; | ||
bool has_main; | ||
std::string main; | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PackageConfig should probably live in the node::loader
namespace, like ModuleWrap.
src/module_wrap.cc
Outdated
return kEmptyPackage; | ||
|
||
Isolate* isolate = env->isolate(); | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Teeniest of style nits: can you drop the blank line?
src/module_wrap.cc
Outdated
|
||
// It's not okay for the called of this method to not be able to tell | ||
// whether an exception is pending or not. | ||
TryCatch try_catch(isolate); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The TryCatch means exceptions from the code below won't propagate. Either remove this (I think you should) or drop the 'exception pending' comments below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So what we'd actually want is to throw a JS error for JSON parsing failure. But if the above is definitely not going to help with that sure, it can be removed.
src/module_wrap.cc
Outdated
|
||
if (!JSON::Parse(env->context(), src).ToLocal(&pkg_json_v) || | ||
!pkg_json_v->ToObject(env->context()).ToLocal(&pkg_json)) | ||
return kEmptyPackage; // Exception pending. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you put braces around the consequent?
src/module_wrap.cc
Outdated
if (pkg_json->Get(env->context(), env->main_string()) | ||
.ToLocal(&pkg_main) && pkg_main->IsString()) { | ||
has_main = true; | ||
Utf8Value main_utf8(isolate, pkg_main.As<String>()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.As<String>()
isn't necessary. You don't per se need the IsString() check either, Utf8Value will coerce the value to string.
src/module_wrap.cc
Outdated
.ToLocal(&pkg_main) && pkg_main->IsString()) { | ||
has_main = true; | ||
Utf8Value main_utf8(isolate, pkg_main.As<String>()); | ||
main_std = std::string(*main_utf8, main_utf8.length()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe use main_std.assign()
here. The compiler will probably elide the temporary but .assign()
will for sure.
src/module_wrap.h
Outdated
@@ -12,10 +12,15 @@ | |||
namespace node { | |||
namespace loader { | |||
|
|||
enum package_main_check : bool { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style: should be something like PackageMainCheck
or CheckPackageMain
.
src/env.h
Outdated
bool is_valid; | ||
bool has_main; | ||
std::string main; | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would still be nice if these were const.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell getting this to work would mean inlining the kEmptyPackage
constructor at each place it is assigned through an emplace call, which doesn't seem very nice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(as in kEmptyPackage
would be replaced by these inline constructors?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
map.emplace(std::make_pair(key, kEmptyPackage))
should work, I think. If it doesn't, you could add a PackageConfig() = default
constructor and emplace PackageConfig()
instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first case didn't work unfortunately. In the second case it would need to be a PackageConfig(true)
and a PackageConfig(false)
to avoid a full expansion of arguments. But = default
doesn't seem to be compatible with default constructor arguments as far as I can tell?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I managed to get the const
s to work out, but it's pretty awful code to look at.
PR-URL: nodejs#18788 Refs: nodejs#18728 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
It would be nice to get it in, as backwards compatibility for Node bins is an important use case I feel. Will work on the backport here first thing tomorrow. |
Created #18923 for the backport. |
(To note the backport issue - this should land after #18368) |
This adds support for ensuring that the top-level main into Node is supported loading when it has no extension for backwards-compat with NodeJS bin workflows. In addition package.json caching is implemented in the module lookup process. PR-URL: nodejs#18728 Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: nodejs#18788 Refs: nodejs#18728 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
This adds support for ensuring that the top-level main into Node is supported loading when it has no extension for backwards-compat with NodeJS bin workflows. In addition package.json caching is implemented in the module lookup process. Backport-PR-URL: #18923 PR-URL: #18728 Reviewed-By: Benjamin Gruenbaum <[email protected]>
Backport-PR-URL: #18923 PR-URL: #18788 Refs: #18728 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
This adds support for ensuring that the top-level main into Node is supported loading when it has no extension for backwards-compat with NodeJS bin workflows. In addition package.json caching is implemented in the module lookup process. PR-URL: nodejs#18728 Reviewed-By: Benjamin Gruenbaum <[email protected]>
PR-URL: nodejs#18788 Refs: nodejs#18728 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]>
Should this be backported to |
needs to come with #18788 if backported |
@MylesBorins for #18788, can you try pulling through #18923? Or should I make this up again against v8.x? |
@guybedford that one doesn't land cleanly either... we may need a bit of a sprint to catch the esm implementation in 8.x caught up |
@MylesBorins sure will aim to get to this when I have some time. |
I've pulled out the refactorings from #18392 that aren't directly related to the package.json flag, in particular two features:
node --experimental-modules module-without-an-extension
works as a special case. This is necessary for ensuring backwards-compatibility with NodeJS bin workflows. But extensions are still not permitted in dependencies.Review much appreciated especially with the C++ code.
Hopefully this shouldn't be too controversial allowing these useful features to not be blocked by progress on #18392.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesAffected core subsystem(s)
esmodules