test_runner: use module.registerHooks in module mocks

Migrate away from module.register(). This no longer needs to deal with the worker synchronization. PR-URL: #60326 Reviewed-By: Marco Ippolito <[email protected]> Reviewed-By: Chemi Atlow <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]>

Author: joyeecheung

lib/internal/test_runner/coverage.js

@@ -37,7 +37,7 @@ const{
 },
 }=require('internal/errors');
 const{ matchGlobPattern }=require('internal/fs/glob');
-const{ kMockSearchParam }=require('internal/test_runner/mock/mock');
+const{constants: {kMockSearchParam }}=require('internal/test_runner/mock/loader');
 
 constkCoverageFileRegex=/^coverage-(\d+)-(\d{13})-(\d+)\.json$/;
 constkIgnoreRegex=/\/\*node:coverageignorenext(?<count>\d+)?\*\//;

lib/internal/test_runner/mock/loader.js

@@ -1,77 +1,24 @@
 'use strict';
 const{
- AtomicsNotify,
- AtomicsStore,
  JSONStringify,
  SafeMap,
 }=primordials;
-const{
- kBadExportsMessage,
- kMockSearchParam,
- kMockSuccess,
- kMockExists,
- kMockUnknownMessage,
-}=require('internal/test_runner/mock/mock');
+
+constkMockSearchParam='node-test-mock';
+constkBadExportsMessage='Cannot create mock because named exports '+
+'cannot be applied to the provided default export.';
+
 const{URL, URLParse }=require('internal/url');
 letdebug=require('internal/util/debuglog').debuglog('test_runner',(fn)=>{
 debug=fn;
 });
 
-// TODO(cjihrig): The mocks need to be thread aware because the exports are
-// evaluated on the thread that creates the mock. Before marking this API as
-// stable, one of the following issues needs to be implemented:
-// https://github.com/nodejs/node/issues/49472
-// or https://github.com/nodejs/node/issues/52219
-
 constmocks=newSafeMap();
 
-asyncfunctioninitialize(data){
-data?.port.on('message',({ type, payload })=>{
-debug('mock loader received message type "%s" with payload %o',type,payload);
-
-if(type==='node:test:register'){
-const{ baseURL }=payload;
-constmock=mocks.get(baseURL);
-
-if(mock?.active){
-debug('already mocking "%s"',baseURL);
-sendAck(payload.ack,kMockExists);
-return;
-}
-
-constlocalVersion=mock?.localVersion??0;
-
-debug('new mock version %d for "%s"',localVersion,baseURL);
-mocks.set(baseURL,{
-__proto__: null,
-active: true,
-cache: payload.cache,
-exportNames: payload.exportNames,
-format: payload.format,
-hasDefaultExport: payload.hasDefaultExport,
- localVersion,
-url: baseURL,
-});
-sendAck(payload.ack);
-}elseif(type==='node:test:unregister'){
-constmock=mocks.get(payload.baseURL);
-
-if(mock!==undefined){
-mock.active=false;
-mock.localVersion++;
-}
-
-sendAck(payload.ack);
-}else{
-sendAck(payload.ack,kMockUnknownMessage);
-}
-});
-}
-
-asyncfunctionresolve(specifier,context,nextResolve){
+functionresolve(specifier,context,nextResolve){
 debug('resolve hook entry, specifier = "%s", context = %o',specifier,context);
 
-constnextResolveResult=awaitnextResolve(specifier,context);
+constnextResolveResult=nextResolve(specifier,context);
 constmockSpecifier=nextResolveResult.url;
 
 constmock=mocks.get(mockSpecifier);
@@ -95,7 +42,7 @@ async function resolve(specifier, context, nextResolve){
 return{__proto__: null,url: href,format: nextResolveResult.format};
 }
 
-asyncfunctionload(url,context,nextLoad){
+functionload(url,context,nextLoad){
 debug('load hook entry, url = "%s", context = %o',url,context);
 constparsedURL=URLParse(url);
 if(parsedURL){
@@ -105,7 +52,7 @@ async function load(url, context, nextLoad){
 constbaseURL=parsedURL ? parsedURL.href : url;
 constmock=mocks.get(baseURL);
 
-constoriginal=awaitnextLoad(url,context);
+constoriginal=nextLoad(url,context);
 debug('load hook, mock = %o',mock);
 if(mock?.active!==true){
 returnoriginal;
@@ -130,14 +77,14 @@ async function load(url, context, nextLoad){
 __proto__: null,
  format,
 shortCircuit: true,
-source: awaitcreateSourceFromMock(mock,format),
+source: createSourceFromMock(mock,format),
 };
 
 debug('load hook finished, result = %o',result);
 returnresult;
 }
 
-asyncfunctioncreateSourceFromMock(mock,format){
+functioncreateSourceFromMock(mock,format){
 // Create mock implementation from provided exports.
 const{ exportNames, hasDefaultExport, url }=mock;
 constuseESM=format==='module'||format==='module-typescript';
@@ -196,9 +143,12 @@ if (module.exports === null || typeof module.exports !== 'object'){
 returnsource;
 }
 
-functionsendAck(buf,status=kMockSuccess){
-AtomicsStore(buf,0,status);
-AtomicsNotify(buf,0);
-}
-
-module.exports={ initialize, load, resolve };
+module.exports={
+hooks: {__proto__: null, load, resolve },
+ mocks,
+constants: {
+__proto__: null,
+ kBadExportsMessage,
+ kMockSearchParam,
+},
+};

lib/internal/test_runner/mock/mock.js

@@ -2,12 +2,9 @@
 const{
  ArrayPrototypePush,
  ArrayPrototypeSlice,
- AtomicsStore,
- AtomicsWait,
  Error,
  FunctionPrototypeBind,
  FunctionPrototypeCall,
- Int32Array,
  ObjectDefineProperty,
  ObjectGetOwnPropertyDescriptor,
  ObjectGetPrototypeOf,
@@ -19,9 +16,6 @@ const{
  SafeMap,
  StringPrototypeSlice,
  StringPrototypeStartsWith,
-globalThis: {
- SharedArrayBuffer,
-},
 }=primordials;
 const{
 codes: {
@@ -54,19 +48,10 @@ const{
  validateOneOf,
 }=require('internal/validators');
 const{ MockTimers }=require('internal/test_runner/mock/mock_timers');
-const{ strictEqual, notStrictEqual }=require('assert');
 const{ Module }=require('internal/modules/cjs/loader');
-const{ MessageChannel }=require('worker_threads');
 const{ _load, _nodeModulePaths, _resolveFilename, isBuiltin }=Module;
 functionkDefaultFunction(){}
 constenableModuleMocking=getOptionValue('--experimental-test-module-mocks');
-constkMockSearchParam='node-test-mock';
-constkMockSuccess=1;
-constkMockExists=2;
-constkMockUnknownMessage=3;
-constkWaitTimeout=5_000;
-constkBadExportsMessage='Cannot create mock because named exports '+
-'cannot be applied to the provided default export.';
 constkSupportedFormats=[
 'builtin',
 'commonjs-typescript',
@@ -76,6 +61,11 @@ const kSupportedFormats = [
 'module',
 ];
 letsharedModuleState;
+const{
+hooks: mockHooks,
+ mocks,
+constants: { kBadExportsMessage, kMockSearchParam },
+}=require('internal/test_runner/mock/loader');
 
 classMockFunctionContext{
  #calls;
@@ -201,8 +191,8 @@ class MockModuleContext{
  hasDefaultExport,
  namedExports,
  sharedState,
+ specifier,
 }){
-constack=newInt32Array(newSharedArrayBuffer(4));
 constconfig={
 __proto__: null,
  cache,
@@ -218,28 +208,36 @@ class MockModuleContext{
 this.#sharedState =sharedState;
 this.#restore ={
 __proto__: null,
- ack,
  baseURL,
 cached: fullPathinModule._cache,
  format,
  fullPath,
 value: Module._cache[fullPath],
 };
 
-sharedState.loaderPort.postMessage({
-__proto__: null,
-type: 'node:test:register',
-payload: {
+constmock=mocks.get(baseURL);
+
+if(mock?.active){
+debug('already mocking "%s"',baseURL);
+thrownewERR_INVALID_STATE(
+`Cannot mock '${specifier}'. The module is already mocked.`,
+);
+}else{
+constlocalVersion=mock?.localVersion??0;
+
+debug('new mock version %d for "%s"',localVersion,baseURL);
+mocks.set(baseURL,{
 __proto__: null,
- ack,
- baseURL,
+url: baseURL,
  cache,
 exportNames: ObjectKeys(namedExports),
  hasDefaultExport,
  format,
-},
-});
-waitForAck(ack);
+ localVersion,
+active: true,
+});
+}
+
 deleteModule._cache[fullPath];
 sharedState.mockExports.set(baseURL,{
 __proto__: null,
@@ -261,17 +259,12 @@ class MockModuleContext{
 Module._cache[this.#restore.fullPath]=this.#restore.value;
 }
 
-AtomicsStore(this.#restore.ack,0,0);
-this.#sharedState.loaderPort.postMessage({
-__proto__: null,
-type: 'node:test:unregister',
-payload: {
-__proto__: null,
-ack: this.#restore.ack,
-baseURL: this.#restore.baseURL,
-},
-});
-waitForAck(this.#restore.ack);
+constmock=mocks.get(this.#restore.baseURL);
+
+if(mock!==undefined){
+mock.active=false;
+mock.localVersion++;
+}
 
 this.#sharedState.mockMap.delete(this.#restore.baseURL);
 this.#sharedState.mockMap.delete(this.#restore.fullPath);
@@ -654,7 +647,7 @@ class MockTracker{
 consthasFileProtocol=StringPrototypeStartsWith(filename,'file://');
 constcaller=hasFileProtocol ? filename : pathToFileURL(filename).href;
 const{ format, url }=sharedState.moduleLoader.resolveSync(
-mockSpecifier,caller,null,
+mockSpecifier,caller,kEmptyObject,
 );
 debug('module mock, url = "%s", format = "%s", caller = "%s"',url,format,caller);
 if(format){// Format is not yet known for ambiguous files when detection is enabled.
@@ -828,20 +821,13 @@ function setupSharedModuleState(){
 if(sharedModuleState===undefined){
 const{ mock }=require('test');
 constmockExports=newSafeMap();
-const{port1, port2 }=newMessageChannel();
+const{registerHooks }=require('internal/modules/customization_hooks');
 constmoduleLoader=esmLoader.getOrInitializeCascadedLoader();
 
-moduleLoader.register(
-'internal/test_runner/mock/loader',
-'node:',
-{__proto__: null,port: port2},
-[port2],
-true,
-);
+registerHooks(mockHooks);
 
 sharedModuleState={
 __proto__: null,
-loaderPort: port1,
  mockExports,
 mockMap: newSafeMap(),
  moduleLoader,
@@ -941,13 +927,6 @@ function findMethodOnPrototypeChain(instance, methodName){
 returndescriptor;
 }
 
-functionwaitForAck(buf){
-constresult=AtomicsWait(buf,0,0,kWaitTimeout);
-
-notStrictEqual(result,'timed-out','test mocking synchronization failed');
-strictEqual(buf[0],kMockSuccess);
-}
-
 functionensureNodeScheme(specifier){
 if(!StringPrototypeStartsWith(specifier,'node:')){
 return`node:${specifier}`;
@@ -962,10 +941,5 @@ if (!enableModuleMocking){
 
 module.exports={
  ensureNodeScheme,
- kBadExportsMessage,
- kMockSearchParam,
- kMockSuccess,
- kMockExists,
- kMockUnknownMessage,
  MockTracker,
 };