Skip to content
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

module: add dynamic file-specific ESM warnings #56628

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 18 commits
Commits
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
22 changes: 14 additions & 8 deletions src/node_contextify.cc
Original file line number Diff line number Diff line change
Expand Up @@ -1688,13 +1688,19 @@ static MaybeLocal<Function> CompileFunctionForCJSLoader(
return scope.Escape(fn);
}

static std::string GetRequireEsmWarning(Local<String> filename) {
Isolate* isolate = Isolate::GetCurrent();
Utf8Value filename_utf8(isolate, filename);

std::string warning_message =
"Failed to load the ES module: " + filename_utf8.ToString() +
". Make sure to set \"type\": \"module\" in the nearest package.json "
"file "
"or use the .mjs extension.";
return warning_message;
}

static bool warned_about_require_esm = false;
// TODO(joyeecheung): this was copied from the warning previously emitted in the
// JS land, but it's not very helpful. There should be specific information
// about which file or which package.json to update.
const char* require_esm_warning =
"To load an ES module, set \"type\": \"module\" in the package.json or use "
"the .mjs extension.";

static bool ShouldRetryAsESM(Realm* realm,
Local<String> message,
Expand Down Expand Up @@ -1780,8 +1786,8 @@ static void CompileFunctionForCJSLoader(
// This needs to call process.emit('warning') in JS which can throw if
// the user listener throws. In that case, don't try to throw the syntax
// error.
should_throw =
ProcessEmitWarningSync(env, require_esm_warning).IsJust();
std::string warning_message = GetRequireEsmWarning(filename);
should_throw = ProcessEmitWarningSync(env, warning_message).IsJust();
}
if (should_throw) {
isolate->ThrowException(cjs_exception);
Expand Down
10 changes: 9 additions & 1 deletion src/node_process_events.cc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ using v8::Just;
using v8::Local;
using v8::Maybe;
using v8::MaybeLocal;
using v8::NewStringType;
using v8::Nothing;
using v8::Object;
using v8::String;
Expand All @@ -21,7 +22,14 @@ using v8::Value;
Maybe<bool> ProcessEmitWarningSync(Environment* env, std::string_view message) {
Isolate* isolate = env->isolate();
Local<Context> context = env->context();
Local<String> message_string = OneByteString(isolate, message);
Local<String> message_string;
if (!String::NewFromUtf8(isolate,
message.data(),
NewStringType::kNormal,
static_cast<int>(message.size()))
.ToLocal(&message_string)) {
return Nothing<bool>();
}

Local<Value> argv[] = {message_string};
Local<Function> emit_function = env->process_emit_warning_sync();
Expand Down
3 changes: 1 addition & 2 deletions test/es-module/test-esm-cjs-load-error-note.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,10 @@ import assert from 'node:assert';
import { execPath } from 'node:process';
import { describe, it } from 'node:test';


// Expect note to be included in the error output
// Don't match the following sentence because it can change as features are
// added.
const expectedNote = 'Warning: To load an ES module';
const expectedNote = 'Failed to load the ES module';

const mustIncludeMessage = {
getMessage: (stderr) => `${expectedNote} not found in ${stderr}`,
Expand Down
2 changes: 1 addition & 1 deletion test/es-module/test-esm-long-path-win.js
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ describe('long path on Windows', () => {
fs.writeFileSync(cjsIndexJSPath, 'import fs from "node:fs/promises";');
const { code, signal, stderr } = await spawnPromisified(execPath, [cjsIndexJSPath]);

assert.ok(stderr.includes('Warning: To load an ES module'));
assert.ok(stderr.includes('Failed to load the ES module'));
assert.strictEqual(code, 1);
assert.strictEqual(signal, null);
});
Expand Down
24 changes: 18 additions & 6 deletions test/es-module/test-typescript-commonjs.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { skip, spawnPromisified } from '../common/index.mjs';
import * as fixtures from '../common/fixtures.mjs';
import { match, strictEqual } from 'node:assert';
import assert, { match, strictEqual } from 'node:assert';
import { test } from 'node:test';

if (!process.config.variables.node_use_amaro) skip('Requires Amaro');
Expand Down Expand Up @@ -59,12 +59,24 @@ test('require a .ts file with implicit extension fails', async () => {
});

test('expect failure of an .mts file with CommonJS syntax', async () => {
const result = await spawnPromisified(process.execPath, [
fixtures.path('typescript/cts/test-cts-but-module-syntax.cts'),
]);
const testFilePath = fixtures.path('typescript/cts/test-cts-but-module-syntax.cts');
const result = await spawnPromisified(process.execPath, [testFilePath]);

assert.strictEqual(result.stdout, '');

const expectedWarning = `Failed to load the ES module: ${testFilePath}. Make sure to set "type": "module" in the nearest package.json file or use the .mjs extension.`;
try {

assert.ok(result.stderr.includes(expectedWarning), `stderr does not contain the expected warning. Actual stderr: ${result.stderr}`);
} catch (e) {
if (e?.code === 'ERR_ASSERTION') {
e.expected = expectedWarning;
e.actual = result.stderr;
e.operator = 'includes';
}
throw e;
}

strictEqual(result.stdout, '');
match(result.stderr, /To load an ES module, set "type": "module" in the package\.json or use the \.mjs extension\./);
strictEqual(result.code, 1);
});

Expand Down
Loading