feat(jest-resolve): detect node:-prefixed built-in modules

[antongolub]

Problem

 ● Test suite failed to run

    ENOENT: no such file or directory, open 'node:util'

      at Runtime.readFile (node_modules/jest/node_modules/jest-runtime/build/index.js:2117:21)
      at Object.<anonymous> (node_modules/globby/gitignore.js:8:17)

Summary

https://nodejs.org/api/modules.html#modules_core_modules

Core modules can also be identified using the node: prefix, for instance, require('node:http').

Fix

export default function isBuiltinModule(module: string): boolean {
  // https://nodejs.org/api/modules.html#modules_core_modules
  // Core modules can also be identified using the node: prefix, for instance, require('node:http')
  return BUILTIN_MODULES.has(
    module.startsWith('node:') ? module.slice(5) : module,
  );
}

Test plan

jest /Users/a.golub/projects/gh/jest/packages/jest-resolve/src/__tests__/isBuiltinModule.test.ts

  it('should return true for the `node:http` module', () => {
    expect(isBuiltinModule('node:http')).toBe(true);
  });

[codecov-commenter]

Codecov Report

Merging #11686 (511220a) into master (fdc74af) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master   #11686   +/-   ##
=======================================
  Coverage   69.01%   69.01%           
=======================================
  Files         312      312           
  Lines       16335    16336    +1     
  Branches     4734     4735    +1     
=======================================
+ Hits        11273    11274    +1     
  Misses       5034     5034           
  Partials       28       28           

Impacted Files	Coverage Δ
packages/jest-resolve/src/isBuiltinModule.ts	66.66% <100.00%> (+4.16%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fdc74af...511220a. Read the comment docs.

[antongolub]

@SimenB,

Could you rerun Node CI / Node v12.x on windows-latest job?

[theoludwig]

Hey! 👋
There is already an open PR to fix that: #11638
And there is an open issue too: #11637

Concerning the implementation itself, I think that isBuiltinModule should returns true or false if the actual module name is a builtin module, whatever the path is.
Whereas isCoreModule also take care to check the path so, we should probably fix this in the ìsCoreModule function I edited in my PR.
I might be mistaken but it is what I think.

Also you forgot to update CHANGELOG.md. 😄

[theoludwig]

We should probably also test that node:not-a-code-module returns false.

[antongolub]

Reasonable. I'll add this case, thanks.

[antongolub]

Hmm... isBuiltinModule lays deeper than isCoreModule, and imho the fix should be applied as much closer to the point where the issue raises. Anyway, I'd be happy if any of our PRs would have merged as soon as possible.

[theoludwig]

Anyway, I'd be happy if any of our PRs would have merged as soon as possible.

Yes, hopefully, one of our PR will get merged soon.

[theoludwig]

Here we can avoid the ternary operator, and do it with Regex:

export default function isBuiltinModule(module: string): boolean {
  module = module.replace(/^node:/, '');
  return BUILTIN_MODULES.has(module);
}

See discussion: #11638 (comment)

[antongolub]

Hey @divlo,

1. Just thought, that regex might be slower.
2. Argument mutation is not "the best practice".

var Benchmark = require('benchmark')
var suite = new Benchmark.Suite;

const moduleName = 'node:foobar'
suite
  .add('String#replace', function() {
    moduleName.replace(/^node:/, '');
  })
  .add('String#startsWith', function() {
    moduleName.startsWith('node:') ? moduleName.slice(5) : moduleName;
  })
  .on('cycle', function(event) {
    console.log(String(event.target));
  })
  .on('complete', function() {
    console.log('Fastest is ' + this.filter('fastest').map('name'));
  })
  .run({ 'async': true });

 node bench.js
String#replace x 17,913,326 ops/sec ±1.19% (87 runs sampled)
String#startsWith x 57,254,145 ops/sec ±0.73% (88 runs sampled)

[theoludwig]

Indeed! 👍
I also ran it on my laptop :

String#replace x 25,474,843 ops/sec ±0.37% (96 runs sampled)
String#startsWith x 86,410,568 ops/sec ±0.21% (98 runs sampled)
Fastest is String#startsWith

Great one, will also change this in my PR.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.