module: cache nearest parent package.json per directory

getNearestParentPackageJSON() memoized its answer per file, so every
module loaded still made one native call, and TraverseParent() builds
several std::filesystem::path temporaries per directory level and
serializes the whole package.json, which the JS side then usually
discarded because it already had that package.json deserialized.
The native traversal starts at the directory of the given path, so the
answer only depends on that directory: key the memo by it (following
NormalizePath()'s trailing-separator rule), so that all modules in a
directory share one native call. When the permission model is enabled
the traversal also depends on the read permissions in effect at call
time, so that configuration keeps the per-file cache.
Loading a 1000-module tree spread over ~240 directories goes from 1000
to 236 native calls.
Signed-off-by: Shelley Vohr <shelley.vohr@gmail.com>
PR-URL: #65326
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jordan Harband <ljharb@gmail.com>

Author: codebytere

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;

lib/internal/modules/package_json_reader.js

@@ -23,7 +23,8 @@ const {
 ERR_MODULE_NOT_FOUND,
 },
 }=require('internal/errors');
-const{ kEmptyObject }=require('internal/util');
+const{ kEmptyObject, isWindows }=require('internal/util');
+constpermission=require('internal/process/permission');
 constmodulesBinding=internalBinding('modules');
 constpath=require('path');
 const{ validateString }=require('internal/validators');
@@ -140,10 +141,18 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
 }
 
 /**
- * A cache mapping a module's path to its parent `package.json` file's path.
- * This is used in concert with `deserializedPackageJSONCache` to improve
- * the performance of `getNearestParentPackageJSON` when called repeatedly
- * on the same module paths.
+ * A cache mapping a directory to the path of the nearest `package.json` at or
+ * above it (`null` when there is none). The native traversal for a module
+ * starts at the module's directory, so every module in a directory shares one
+ * entry and one native call. Used in concert with
+ * `deserializedPackageJSONCache`.
+ */
+constdirectoryToParentPackageJSONPathCache=newSafeMap();
+
+/**
+ * When the permission model is enabled the native traversal also depends on
+ * the read permissions in effect at the time of the call, so results are only
+ * remembered per exact module path, as before.
  */
 constmoduleToParentPackageJSONCache=newSafeMap();
 
@@ -158,30 +167,51 @@ const moduleToParentPackageJSONCache = new SafeMap();
  */
 constdeserializedPackageJSONCache=newSafeMap();
 
+/**
+ * The directory the native nearest-parent traversal starts from for `checkPath`
+ * (see BindingData::NormalizePath/TraverseParent): the path itself when it has
+ * a trailing separator, its dirname otherwise.
+ * @param {string} checkPath
+ * @returns {string}
+ */
+functiongetTraversalStartDirectory(checkPath){
+constlast=checkPath[checkPath.length-1];
+if(last==='/'||(isWindows&&last==='\\')){
+returnStringPrototypeSlice(checkPath,0,-1);
+}
+returnpath.dirname(checkPath);
+}
+
 /**
  * Get the nearest parent package.json file from a given path.
  * Return the package.json data and the path to the package.json file, or undefined.
  * @param {string} checkPath The path to start searching from.
  * @returns {undefined | DeserializedPackageConfig}
  */
 functiongetNearestParentPackageJSON(checkPath){
-constparentPackageJSONPath=moduleToParentPackageJSONCache.get(checkPath);
-if(parentPackageJSONPath!==undefined){
-returndeserializedPackageJSONCache.get(parentPackageJSONPath);
+constpermissionEnabled=permission.isEnabled();
+constcache=permissionEnabled ? moduleToParentPackageJSONCache : directoryToParentPackageJSONPathCache;
+constkey=permissionEnabled ? checkPath : getTraversalStartDirectory(checkPath);
+letparentPackageJSONPath=cache.get(key);
+if(parentPackageJSONPath===undefined){
+constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
+if(result===undefined){
+parentPackageJSONPath=null;
+}else{
+constpackageConfig=deserializePackageJSON(checkPath,result);
+parentPackageJSONPath=packageConfig.path;
+if(!deserializedPackageJSONCache.has(parentPackageJSONPath)){
+deserializedPackageJSONCache.set(parentPackageJSONPath,packageConfig);
+}
+}
+cache.set(key,parentPackageJSONPath);
 }
 
-constresult=modulesBinding.getNearestParentPackageJSON(checkPath);
-constpackageConfig=deserializePackageJSON(checkPath,result);
-
-moduleToParentPackageJSONCache.set(checkPath,packageConfig.path);
-
-constmaybeCachedPackageConfig=deserializedPackageJSONCache.get(packageConfig.path);
-if(maybeCachedPackageConfig!==undefined){
-returnmaybeCachedPackageConfig;
+if(parentPackageJSONPath===null){
+// No package.json above this path: same shape as before, carrying the queried path.
+returndeserializePackageJSON(checkPath,undefined);
 }
-
-deserializedPackageJSONCache.set(packageConfig.path,packageConfig);
-returnpackageConfig;
+returndeserializedPackageJSONCache.get(parentPackageJSONPath);
 }
 
 /**

test/parallel/test-module-nearest-parent-package-json-cache.js

@@ -0,0 +1,57 @@
+'use strict';
+// Flags: --expose-internals
+// The nearest parent package.json lookup that every CommonJS module load
+// performs is answered once per directory, not once per file.
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+const{ internalBinding }=require('internal/test/binding');
+constpackageJsonReader=require('internal/modules/package_json_reader');
+
+tmpdir.refresh();
+constroot=tmpdir.resolve('pkg');
+constsub=path.join(root,'lib','sub');
+fs.mkdirSync(sub,{recursive: true});
+fs.writeFileSync(path.join(root,'package.json'),JSON.stringify({name: 'pkg',type: 'commonjs'}));
+constfiles=[];
+for(constdirof[path.join(root,'lib'),sub]){
+for(leti=0;i<5;i++){
+constfile=path.join(dir,`m${i}.js`);
+fs.writeFileSync(file,'module.exports = __filename;');
+files.push(file);
+}
+}
+
+constmodulesBinding=internalBinding('modules');
+constoriginal=modulesBinding.getNearestParentPackageJSON;
+constcalls=[];
+modulesBinding.getNearestParentPackageJSON=common.mustCallAtLeast((checkPath)=>{
+calls.push(checkPath);
+returnoriginal(checkPath);
+},1);
+
+for(constfileoffiles){
+assert.strictEqual(require(file),file);
+}
+// Ten modules in two directories: two lookups reach the binding.
+assert.strictEqual(calls.length,2,`binding called for: ${calls.join(', ')}`);
+
+// Same answer (and the same object) for every file of a directory, and for
+// the directory itself when asked with a trailing separator.
+constviaFile=packageJsonReader.getNearestParentPackageJSON(files[0]);
+assert.strictEqual(viaFile.data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(files[1]),viaFile);
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(root,'lib')+path.sep),viaFile);
+assert.strictEqual(calls.length,2);
+
+// A directory that has not been seen yet is looked up once more.
+constother=path.join(root,'other');
+fs.mkdirSync(other);
+fs.writeFileSync(path.join(other,'x.js'),'');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'x.js')).data.name,'pkg');
+assert.strictEqual(packageJsonReader.getNearestParentPackageJSON(path.join(other,'y.js')).data.name,'pkg');
+assert.strictEqual(calls.length,3);
+
+modulesBinding.getNearestParentPackageJSON=original;