nodejs / node

Node.js JavaScript runtime ✨🐢🚀✨
https://nodejs.org
Other
105.32k stars 28.54k forks source link

Relative `require()` in `commonjs` source not processed by ESM Loader #53198

Open privatenumber opened 1 month ago

privatenumber commented 1 month ago

Version

v22.2.0

Platform

Darwin mac.local 23.4.0 Darwin Kernel Version 23.4.0: Fri Mar 15 00:12:49 PDT 2024; root:xnu-10063.101.17~1/RELEASE_ARM64_T6020 arm64

Subsystem

No response

What steps will reproduce the bug?

'use strict';

require('node:module').register(
  'data:text/javascript,' + `
  import assert from 'node:assert';

  export ${encodeURIComponent(
    function resolve(specifier, context, nextResolve) {
      console.log({ specifier, context });
      return nextResolve(specifier, context);
    },
  )}

  export ${encodeURIComponent(
    function load(url, context, nextLoad) {
      if (url === 'custom:cjs') {
        return {
          format: 'commonjs',
          source: 'console.log(require("./relative"))',
          shortCircuit: true,
        };
      }
      return nextLoad(url, context);
    }
  )}
  `,
);

import('custom:cjs').then(console.log, console.error);

How often does it reproduce? Is there a required condition?

Consistently

What is the expected behavior? Why is that the expected behavior?

The load hook doc says:

When a source is provided, all require calls from this module will be processed by the ESM loader with registered resolve and load hooks

https://nodejs.org/api/module.html#resolvespecifier-context-nextresolve:~:text=When%20a%20source,will%20not%20apply.

What do you see instead?

require() calls with relative path are still processed by the CommonJS loader

Error: Cannot find module './relative'
Require stack:
- custom:cjs
    at Module._resolveFilename (node:internal/modules/cjs/loader:1186:15)
    at require (node:internal/modules/esm/translators:195:30)
    at Object.<anonymous> (custom:cjs:1:13)
    at loadCJSModule (node:internal/modules/esm/translators:223:3)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:258:7)
    at ModuleJob.run (node:internal/modules/esm/module_job:262:25)
    at async ModuleLoader.import (node:internal/modules/esm/loader:475:24) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [ 'custom:cjs' ]
}

Additional information

No response

aduh95 commented 1 month ago

require() calls with relative path are still processed by the CommonJS loader

That's not correct, they are processed by your custom loader. If you tweak your resolve hook to not call the next function when it receives ./relative, you won't see the error. The reason you won't see the console.log output every time is documented here: https://github.com/nodejs/node/blob/fac55e3ef99262877b40a1df461f0e5b94069b28/doc/api/module.md#L391-L394

AFAICT, working as expected, so closing. Let me know if I missed something.

aduh95 commented 1 month ago

Actually, you were correct, the stack trace shows MODULE_NOT_FOUND, not ERR_MODULE_NOT_FOUND, which is an indication that the error is indeed returned by the CJS loader, sorry for answering too quickly.

/cc @nodejs/loaders