Skip to content

module: improve error message for top-level await in CommonJS #55874

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.

Sign up for GitHub

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

Merged
nodejs-github-bot merged 14 commits into from
Jun 24, 2025
Merged

module: improve error message for top-level await in CommonJS #55874

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
77c3d19
module: update tests for combined ambiguous module syntax error
mertcanaltin May 31, 2025
10e5620
lint
mertcanaltin May 31, 2025
b0d51ac
revert regex edit
mertcanaltin Jun 2, 2025
ab7ee6e
repair error message
mertcanaltin Jun 2, 2025
5725135
refactored ERR_AMBIGUOUS_MODULE_SYNTAX error
mertcanaltin Jun 3, 2025
f9bd373
repair hasTopLevelAwait & tests
mertcanaltin Jun 3, 2025
aab10e5
lint
mertcanaltin Jun 3, 2025
d756f7f
revert old change
mertcanaltin Jun 3, 2025
a2a9302
test repair
mertcanaltin Jun 3, 2025
53b03da
repair e.message
mertcanaltin Jun 3, 2025
32247d1
register HasTopLevelAwait method in cpp api
mertcanaltin Jun 3, 2025
811e9c5
lint
mertcanaltin Jun 3, 2025
0f126d0
update error message expectation for module syntax
mertcanaltin Jun 24, 2025
ad40103
lint
mertcanaltin Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
register HasTopLevelAwait method in cpp api
  • Loading branch information
@mertcanaltin
mertcanaltin committed Jun 3, 2025
commit 32247d10c9be251a17bdeddeb658e10f7cf361d1
23 changes: 23 additions & 0 deletions src/module_wrap.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,27 @@ void ModuleWrap::IsGraphAsync(const FunctionCallbackInfo<Value>& args) {
args.GetReturnValue().Set(module->IsGraphAsync());
}

void ModuleWrap::HasTopLevelAwait(const FunctionCallbackInfo<Value>& args) {
Isolate* isolate = args.GetIsolate();
ModuleWrap* obj;
ASSIGN_OR_RETURN_UNWRAP(&obj, args.This());

Local<Module> module = obj->module_.Get(isolate);

// Check if module is valid
if (module.IsEmpty()) {
args.GetReturnValue().Set(false);
return;
}

// For source text modules, check if the graph is async
// For synthetic modules, it's always false
bool has_top_level_await = module->IsSourceTextModule() &&
module->IsGraphAsync();

args.GetReturnValue().Set(has_top_level_await);
}

void ModuleWrap::GetError(const FunctionCallbackInfo<Value>& args) {
Isolate* isolate = args.GetIsolate();
ModuleWrap* obj;
Expand Down Expand Up @@ -1305,6 +1326,7 @@ void ModuleWrap::CreatePerIsolateProperties(IsolateData* isolate_data,
SetProtoMethodNoSideEffect(isolate, tpl, "getNamespace", GetNamespace);
SetProtoMethodNoSideEffect(isolate, tpl, "getStatus", GetStatus);
SetProtoMethodNoSideEffect(isolate, tpl, "isGraphAsync", IsGraphAsync);
SetProtoMethodNoSideEffect(isolate, tpl, "hasTopLevelAwait", HasTopLevelAwait);
SetProtoMethodNoSideEffect(isolate, tpl, "getError", GetError);
SetConstructorFunction(isolate, target, "ModuleWrap", tpl);
isolate_data->set_module_wrap_constructor_template(tpl);
Expand Down Expand Up @@ -1367,6 +1389,7 @@ void ModuleWrap::RegisterExternalReferences(
registry->Register(GetStatus);
registry->Register(GetError);
registry->Register(IsGraphAsync);
registry->Register(HasTopLevelAwait);

registry->Register(CreateRequiredModuleFacade);

Expand Down
1 change: 1 addition & 0 deletions src/module_wrap.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ class ModuleWrap : public BaseObject {
void MemoryInfo(MemoryTracker* tracker) const override {
tracker->TrackField("resolve_cache", resolve_cache_);
}
static void HasTopLevelAwait(const v8::FunctionCallbackInfo<v8::Value>& args);

v8::Local<v8::Context> context() const;
v8::Maybe<bool> CheckUnsettledTopLevelAwait();
Expand Down
17 changes: 9 additions & 8 deletions test/es-module/test-esm-detect-ambiguous.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,10 @@ describe('Module syntax detection', { concurrency: !process.env.TEST_PARALLEL },
'const fs = require("node:fs"); await Promise.resolve();',
]);

match(stderr, /ReferenceError: require is not defined in ES module scope/);
match(
stderr,
/ERR_AMBIGUOUS_MODULE_SYNTAX: This file cannot be parsed as either CommonJS or ES Module\. CommonJS error: await is only valid in async functions\. ES Module error: require is not defined in ES module scope\. If you meant to use CommonJS, wrap top-level await in async function\. If you meant to use ESM, do not use require\(\)\./
);
Comment thread
mertcanaltin marked this conversation as resolved.
strictEqual(stdout, '');
strictEqual(code, 1);
strictEqual(signal, null);
Expand Down Expand Up @@ -431,16 +434,14 @@ describe('cjs & esm ambiguous syntax case', () => {
[
'--input-type=module',
'--eval',
`await 1; const fs = require('fs');`,
`await 1;\nconst fs = require('fs');`,
]
);

match(stderr, /ERR_AMBIGUOUS_MODULE_SYNTAX/);
match(stderr, /This file cannot be parsed as either CommonJS or ES Module/);
match(stderr, /await is only valid in async functions/);
match(stderr, /require is not defined in ES module scope/);
match(stderr, /If you meant to use CommonJS/);
match(stderr, /If you meant to use ESM/);
match(
stderr,
/ERR_AMBIGUOUS_MODULE_SYNTAX: This file cannot be parsed as either CommonJS or ES Module\. CommonJS error: await is only valid in async functions\. ES Module error: require is not defined in ES module scope\. If you meant to use CommonJS, wrap top-level await in async function\. If you meant to use ESM, do not use require\(\)\./
);

strictEqual(code, 1);
strictEqual(signal, null);
Expand Down