module: add dynamic file-specific ESM warnings

src/node_contextify.cc

@@ -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,
@@ -1780,8 +1786,9 @@ 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.
+        std::string warning_message = GetRequireEsmWarning(filename);
         should_throw =
-            ProcessEmitWarningSync(env, require_esm_warning).IsJust();
+            ProcessEmitWarningSync(env, warning_message.c_str()).IsJust();
       }
       if (should_throw) {
         isolate->ThrowException(cjs_exception);

src/node_process_events.cc

@@ -21,7 +21,12 @@ 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);
+  v8::Local<v8::String> message_string =
+      v8::String::NewFromUtf8(isolate,
+                              message.data(),
+                              v8::NewStringType::kNormal,
+                              static_cast<int>(message.size()))
+          .ToLocalChecked();
 
   Local<Value> argv[] = {message_string};
   Local<Function> emit_function = env->process_emit_warning_sync();

test/es-module/test-esm-cjs-load-error-note.mjs

@@ -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}`,

test/es-module/test-typescript-commonjs.mjs

@@ -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 * as assert from 'node:assert';
 import { test } from 'node:test';
 
 if (!process.config.variables.node_use_amaro) skip('Requires Amaro');
@@ -14,9 +14,9 @@ test('require a .ts file with explicit extension succeeds', async () => {
     cwd: fixtures.path('typescript/ts'),
   });
 
-  strictEqual(result.stderr, '');
-  strictEqual(result.stdout, 'Hello, TypeScript!\n');
-  strictEqual(result.code, 0);
+  assert.strictEqual(result.stderr, '');
+  assert.strictEqual(result.stdout, 'Hello, TypeScript!\n');
+  assert.strictEqual(result.code, 0);
 });
 
 test('eval require a .ts file with implicit extension fails', async () => {
@@ -28,9 +28,9 @@ test('eval require a .ts file with implicit extension fails', async () => {
     cwd: fixtures.path('typescript/ts'),
   });
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /Error: Cannot find module/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /Error: Cannot find module/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('eval require a .cts file with implicit extension fails', async () => {
@@ -42,9 +42,9 @@ test('eval require a .cts file with implicit extension fails', async () => {
     cwd: fixtures.path('typescript/ts'),
   });
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /Error: Cannot find module/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /Error: Cannot find module/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('require a .ts file with implicit extension fails', async () => {
@@ -53,19 +53,31 @@ test('require a .ts file with implicit extension fails', async () => {
     fixtures.path('typescript/cts/test-extensionless-require.ts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /Error: Cannot find module/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /Error: Cannot find module/);
+  assert.strictEqual(result.code, 1);
 });
 
 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');
+  } 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);
+  assert.strictEqual(result.code, 1);
 });
 
 test('execute a .cts file importing a .cts file', async () => {
@@ -74,9 +86,9 @@ test('execute a .cts file importing a .cts file', async () => {
     fixtures.path('typescript/cts/test-require-commonjs.cts'),
   ]);
 
-  strictEqual(result.stderr, '');
-  match(result.stdout, /Hello, TypeScript!/);
-  strictEqual(result.code, 0);
+  assert.strictEqual(result.stderr, '');
+  assert.match(result.stdout, /Hello, TypeScript!/);
+  assert.strictEqual(result.code, 0);
 });
 
 test('execute a .cts file importing a .ts file export', async () => {
@@ -85,9 +97,9 @@ test('execute a .cts file importing a .ts file export', async () => {
     fixtures.path('typescript/cts/test-require-ts-file.cts'),
   ]);
 
-  strictEqual(result.stderr, '');
-  match(result.stdout, /Hello, TypeScript!/);
-  strictEqual(result.code, 0);
+  assert.strictEqual(result.stderr, '');
+  assert.match(result.stdout, /Hello, TypeScript!/);
+  assert.strictEqual(result.code, 0);
 });
 
 test('execute a .cts file importing a .mts file export', async () => {
@@ -96,9 +108,9 @@ test('execute a .cts file importing a .mts file export', async () => {
     fixtures.path('typescript/cts/test-require-mts-module.cts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /Error \[ERR_REQUIRE_ESM\]: require\(\) of ES Module/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /Error \[ERR_REQUIRE_ESM\]: require\(\) of ES Module/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('execute a .cts file importing a .mts file export', async () => {
@@ -107,28 +119,28 @@ test('execute a .cts file importing a .mts file export', async () => {
     fixtures.path('typescript/cts/test-require-mts-module.cts'),
   ]);
 
-  match(result.stdout, /Hello, TypeScript!/);
-  strictEqual(result.code, 0);
+  assert.match(result.stdout, /Hello, TypeScript!/);
+  assert.strictEqual(result.code, 0);
 });
 
 test('expect failure of a .cts file in node_modules', async () => {
   const result = await spawnPromisified(process.execPath, [
     fixtures.path('typescript/cts/test-cts-node_modules.cts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('expect failure of a .ts file in node_modules', async () => {
   const result = await spawnPromisified(process.execPath, [
     fixtures.path('typescript/cts/test-ts-node_modules.cts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('expect failure of a .cts requiring esm without default type module', async () => {
@@ -137,9 +149,9 @@ test('expect failure of a .cts requiring esm without default type module', async
     fixtures.path('typescript/cts/test-mts-node_modules.cts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /ERR_REQUIRE_ESM/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /ERR_REQUIRE_ESM/);
+  assert.strictEqual(result.code, 1);
 });
 
 test('expect failure of a .cts file requiring esm in node_modules', async () => {
@@ -148,7 +160,7 @@ test('expect failure of a .cts file requiring esm in node_modules', async () =>
     fixtures.path('typescript/cts/test-mts-node_modules.cts'),
   ]);
 
-  strictEqual(result.stdout, '');
-  match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
-  strictEqual(result.code, 1);
+  assert.strictEqual(result.stdout, '');
+  assert.match(result.stderr, /ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING/);
+  assert.strictEqual(result.code, 1);
 });