Skip to content

Commit d4e2a4e

Browse files
anonriganonrig
committed
lib: merge cjs and esm package json reader caches
1 parent a509753 commit d4e2a4e

File tree

7 files changed

+125
-217
lines changed

7 files changed

+125
-217
lines changed

‎lib/internal/modules/cjs/loader.js‎

Lines changed: 15 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,6 @@ const {
8282
pendingDeprecate,
8383
emitExperimentalWarning,
8484
kEmptyObject,
85-
filterOwnProperties,
8685
setOwnProperty,
8786
getLazy,
8887
} = require('internal/util');
@@ -355,36 +354,12 @@ function initializeCJS() {
355354
// -> a.<ext>
356355
// -> a/index.<ext>
357356

358-
const packageJsonCache = new SafeMap();
359-
357+
/**
358+
* @param {string} requestPath
359+
* @return {PackageConfig}
360+
*/
360361
function readPackage(requestPath) {
361-
const jsonPath = path.resolve(requestPath, 'package.json');
362-
363-
const existing = packageJsonCache.get(jsonPath);
364-
if (existing !== undefined) return existing;
365-
366-
const result = packageJsonReader.read(jsonPath);
367-
const json = result.containsKeys === false ? '{}' : result.string;
368-
if (json === undefined) {
369-
packageJsonCache.set(jsonPath, false);
370-
return false;
371-
}
372-
373-
try {
374-
const filtered = filterOwnProperties(JSONParse(json), [
375-
'name',
376-
'main',
377-
'exports',
378-
'imports',
379-
'type',
380-
]);
381-
packageJsonCache.set(jsonPath, filtered);
382-
return filtered;
383-
} catch (e) {
384-
e.path = jsonPath;
385-
e.message = 'Error parsing ' + jsonPath + ': ' + e.message;
386-
throw e;
387-
}
362+
return packageJsonReader.read(path.resolve(requestPath, 'package.json'));
388363
}
389364

390365
let _readPackage = readPackage;
@@ -414,7 +389,7 @@ function readPackageScope(checkPath) {
414389
if (StringPrototypeEndsWith(checkPath, sep + 'node_modules'))
415390
return false;
416391
const pjson = _readPackage(checkPath + sep);
417-
if (pjson) return {
392+
if (pjson.exists) return {
418393
data: pjson,
419394
path: checkPath,
420395
};
@@ -423,7 +398,7 @@ function readPackageScope(checkPath) {
423398
}
424399

425400
function tryPackage(requestPath, exts, isMain, originalPath) {
426-
const pkg = _readPackage(requestPath)?.main;
401+
const pkg = _readPackage(requestPath).main;
427402

428403
if (!pkg) {
429404
return tryExtensions(path.resolve(requestPath, 'index'), exts, isMain);
@@ -528,9 +503,10 @@ function trySelfParentPath(parent) {
528503
function trySelf(parentPath, request) {
529504
if (!parentPath) return false;
530505

531-
const { data: pkg, path: pkgPath } = readPackageScope(parentPath) || {};
532-
if (!pkg || pkg.exports === undefined) return false;
533-
if (typeof pkg.name !== 'string') return false;
506+
const { data: pkg, path: pkgPath } = readPackageScope(parentPath);
507+
if (!pkg || pkg.exports == null || pkg.name === undefined) {
508+
return false;
509+
}
534510

535511
let expansion;
536512
if (request === pkg.name) {
@@ -565,7 +541,7 @@ function resolveExports(nmPath, request) {
565541
return;
566542
const pkgPath = path.resolve(nmPath, name);
567543
const pkg = _readPackage(pkgPath);
568-
if (pkg?.exports != null) {
544+
if (pkg.exists && pkg.exports != null) {
569545
try {
570546
const { packageExportsResolve } = require('internal/modules/esm/resolve');
571547
return finalizeEsmResolution(packageExportsResolve(
@@ -1028,7 +1004,7 @@ Module._resolveFilename = function(request, parent, isMain, options) {
10281004

10291005
if (request[0] === '#' && (parent?.filename || parent?.id === '<repl>')) {
10301006
const parentPath = parent?.filename ?? process.cwd() + path.sep;
1031-
const pkg = readPackageScope(parentPath) || {};
1007+
const pkg = readPackageScope(parentPath) || { __proto__: null };
10321008
if (pkg.data?.imports != null) {
10331009
try {
10341010
const { packageImportsResolve } = require('internal/modules/esm/resolve');
@@ -1274,9 +1250,9 @@ Module._extensions['.js'] = function(module, filename) {
12741250
content = fs.readFileSync(filename, 'utf8');
12751251
}
12761252
if (StringPrototypeEndsWith(filename, '.js')) {
1277-
const pkg = readPackageScope(filename);
1253+
const pkg = readPackageScope(filename) || { __proto__: null };
12781254
// Function require shouldn't be used in ES modules.
1279-
if (pkg?.data?.type === 'module') {
1255+
if (pkg.data?.type === 'module') {
12801256
const parent = moduleParentCache.get(module);
12811257
const parentPath = parent?.filename;
12821258
const packageJsonPath = path.resolve(pkg.path, 'package.json');

‎lib/internal/modules/esm/package_config.js‎

Lines changed: 8 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,10 @@
11
'use strict';
22

33
const {
4-
JSONParse,
5-
ObjectPrototypeHasOwnProperty,
6-
SafeMap,
74
StringPrototypeEndsWith,
85
} = primordials;
96
const { URL, fileURLToPath } = require('internal/url');
10-
const {
11-
ERR_INVALID_PACKAGE_CONFIG,
12-
} = require('internal/errors').codes;
13-
14-
const { filterOwnProperties } = require('internal/util');
15-
16-
17-
/**
18-
* @typedef {string | string[] | Record<string, unknown>} Exports
19-
* @typedef {'module' | 'commonjs'} PackageType
20-
* @typedef {{
21-
* pjsonPath: string,
22-
* exports?: ExportConfig,
23-
* name?: string,
24-
* main?: string,
25-
* type?: PackageType,
26-
* }} PackageConfig
27-
*/
28-
29-
/** @type {Map<string, PackageConfig>} */
30-
const packageJSONCache = new SafeMap();
31-
32-
33-
/**
34-
* @param {string} path
35-
* @param {string} specifier
36-
* @param {string | URL | undefined} base
37-
* @returns {PackageConfig}
38-
*/
39-
function getPackageConfig(path, specifier, base) {
40-
const existing = packageJSONCache.get(path);
41-
if (existing !== undefined) {
42-
return existing;
43-
}
44-
const packageJsonReader = require('internal/modules/package_json_reader');
45-
const source = packageJsonReader.read(path).string;
46-
if (source === undefined) {
47-
const packageConfig = {
48-
pjsonPath: path,
49-
exists: false,
50-
main: undefined,
51-
name: undefined,
52-
type: 'none',
53-
exports: undefined,
54-
imports: undefined,
55-
};
56-
packageJSONCache.set(path, packageConfig);
57-
return packageConfig;
58-
}
59-
60-
let packageJSON;
61-
try {
62-
packageJSON = JSONParse(source);
63-
} catch (error) {
64-
throw new ERR_INVALID_PACKAGE_CONFIG(
65-
path,
66-
(base ? `"${specifier}" from ` : '') + fileURLToPath(base || specifier),
67-
error.message,
68-
);
69-
}
70-
71-
let { imports, main, name, type } = filterOwnProperties(packageJSON, ['imports', 'main', 'name', 'type']);
72-
const exports = ObjectPrototypeHasOwnProperty(packageJSON, 'exports') ? packageJSON.exports : undefined;
73-
if (typeof imports !== 'object' || imports === null) {
74-
imports = undefined;
75-
}
76-
if (typeof main !== 'string') {
77-
main = undefined;
78-
}
79-
if (typeof name !== 'string') {
80-
name = undefined;
81-
}
82-
// Ignore unknown types for forwards compatibility
83-
if (type !== 'module' && type !== 'commonjs') {
84-
type = 'none';
85-
}
86-
87-
const packageConfig = {
88-
pjsonPath: path,
89-
exists: true,
90-
main,
91-
name,
92-
type,
93-
exports,
94-
imports,
95-
};
96-
packageJSONCache.set(path, packageConfig);
97-
return packageConfig;
98-
}
99-
7+
const packageJsonReader = require('internal/modules/package_json_reader');
1008

1019
/**
10210
* @param {URL | string} resolved
@@ -109,7 +17,11 @@ function getPackageScopeConfig(resolved) {
10917
if (StringPrototypeEndsWith(packageJSONPath, 'node_modules/package.json')) {
11018
break;
11119
}
112-
const packageConfig = getPackageConfig(fileURLToPath(packageJSONUrl), resolved);
20+
const packageConfig = packageJsonReader.read(fileURLToPath(packageJSONUrl), {
21+
__proto__: null,
22+
specifier: resolved,
23+
isESM: true,
24+
});
11325
if (packageConfig.exists) {
11426
return packageConfig;
11527
}
@@ -124,7 +36,8 @@ function getPackageScopeConfig(resolved) {
12436
}
12537
}
12638
const packageJSONPath = fileURLToPath(packageJSONUrl);
127-
const packageConfig = {
39+
return {
40+
__proto__: null,
12841
pjsonPath: packageJSONPath,
12942
exists: false,
13043
main: undefined,
@@ -133,12 +46,9 @@ function getPackageScopeConfig(resolved) {
13346
exports: undefined,
13447
imports: undefined,
13548
};
136-
packageJSONCache.set(packageJSONPath, packageConfig);
137-
return packageConfig;
13849
}
13950

14051

14152
module.exports = {
142-
getPackageConfig,
14353
getPackageScopeConfig,
14454
};

‎lib/internal/modules/esm/resolve.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,9 @@ const {
5353
} = require('internal/errors').codes;
5454

5555
const { Module: CJSModule } = require('internal/modules/cjs/loader');
56-
const { getPackageConfig, getPackageScopeConfig } = require('internal/modules/esm/package_config');
56+
const { getPackageScopeConfig } = require('internal/modules/esm/package_config');
5757
const { getConditionsSet } = require('internal/modules/esm/utils');
58+
const packageJsonReader = require('internal/modules/package_json_reader');
5859
const { internalModuleStat } = internalBinding('fs');
5960

6061
/**
@@ -734,8 +735,7 @@ function packageResolve(specifier, base, conditions) {
734735
const packageConfig = getPackageScopeConfig(base);
735736
if (packageConfig.exists) {
736737
const packageJSONUrl = pathToFileURL(packageConfig.pjsonPath);
737-
if (packageConfig.name === packageName &&
738-
packageConfig.exports !== undefined && packageConfig.exports !== null) {
738+
if (packageConfig.exports != null && packageConfig.name === packageName) {
739739
return packageExportsResolve(
740740
packageJSONUrl, packageSubpath, packageConfig, base, conditions);
741741
}
@@ -759,8 +759,8 @@ function packageResolve(specifier, base, conditions) {
759759
}
760760

761761
// Package match.
762-
const packageConfig = getPackageConfig(packageJSONPath, specifier, base);
763-
if (packageConfig.exports !== undefined && packageConfig.exports !== null) {
762+
const packageConfig = packageJsonReader.read(packageJSONPath, { __proto__: null, specifier, base, isESM: true });
763+
if (packageConfig.exports != null) {
764764
return packageExportsResolve(
765765
packageJSONUrl, packageSubpath, packageConfig, base, conditions);
766766
}

‎lib/internal/modules/package_json_reader.js‎

Lines changed: 83 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,106 @@
11
'use strict';
22

3-
const { SafeMap } = primordials;
3+
const {
4+
JSONParse,
5+
ObjectPrototypeHasOwnProperty,
6+
SafeMap,
7+
} = primordials;
8+
const {
9+
ERR_INVALID_PACKAGE_CONFIG,
10+
} = require('internal/errors').codes;
411
const { internalModuleReadJSON } = internalBinding('fs');
5-
const { pathToFileURL } = require('url');
612
const { toNamespacedPath } = require('path');
13+
const { kEmptyObject } = require('internal/util');
14+
const { fileURLToPath, pathToFileURL } = require('internal/url');
715

816
const cache = new SafeMap();
917

1018
let manifest;
1119

1220
/**
13-
*
21+
* @typedef {{
22+
* exists: boolean,
23+
* pjsonPath: string,
24+
* exports?: string | string[] | Record<string, unknown>,
25+
* imports?: string | string[] | Record<string, unknown>,
26+
* name?: string,
27+
* main?: string,
28+
* type: 'commonjs' | 'module' | 'none',
29+
* }} PackageConfig
30+
*/
31+
32+
/**
1433
* @param {string} jsonPath
34+
* @param {{
35+
* base?: string,
36+
* specifier: string,
37+
* isESM: boolean,
38+
* }} options
39+
* @returns {PackageConfig}
1540
*/
16-
function read(jsonPath) {
41+
function read(jsonPath, { base, specifier, isESM } = kEmptyObject) {
1742
if (cache.has(jsonPath)) {
1843
return cache.get(jsonPath);
1944
}
2045

21-
const { 0: string, 1: containsKeys } = internalModuleReadJSON(
46+
const string = internalModuleReadJSON(
2247
toNamespacedPath(jsonPath),
2348
);
24-
const result = { string, containsKeys };
25-
const { getOptionValue } = require('internal/options');
49+
const result = {
50+
__proto__: null,
51+
exists: false,
52+
pjsonPath: jsonPath,
53+
main: undefined,
54+
name: undefined,
55+
type: 'none', // Ignore unknown types for forwards compatibility
56+
exports: undefined,
57+
imports: undefined,
58+
};
59+
2660
if (string !== undefined) {
61+
let parsed;
62+
try {
63+
parsed = JSONParse(string);
64+
} catch (error) {
65+
if (isESM) {
66+
throw new ERR_INVALID_PACKAGE_CONFIG(
67+
jsonPath,
68+
(base ? `"${specifier}" from ` : '') + fileURLToPath(base || specifier),
69+
error.message,
70+
);
71+
} else {
72+
error.message = 'Error parsing ' + jsonPath + ': ' + error.message;
73+
error.path = jsonPath;
74+
throw error;
75+
}
76+
}
77+
78+
result.exists = true;
79+
80+
// ObjectPrototypeHasOwnProperty is used to avoid prototype pollution.
81+
if (ObjectPrototypeHasOwnProperty(parsed, 'name') && typeof parsed.name === 'string') {
82+
result.name = parsed.name;
83+
}
84+
85+
if (ObjectPrototypeHasOwnProperty(parsed, 'main') && typeof parsed.main === 'string') {
86+
result.main = parsed.main;
87+
}
88+
89+
if (ObjectPrototypeHasOwnProperty(parsed, 'exports')) {
90+
result.exports = parsed.exports;
91+
}
92+
93+
if (ObjectPrototypeHasOwnProperty(parsed, 'imports')) {
94+
result.imports = parsed.imports;
95+
}
96+
97+
// Ignore unknown types for forwards compatibility
98+
if (ObjectPrototypeHasOwnProperty(parsed, 'type') && (parsed.type === 'commonjs' || parsed.type === 'module')) {
99+
result.type = parsed.type;
100+
}
101+
27102
if (manifest === undefined) {
103+
const { getOptionValue } = require('internal/options');
28104
manifest = getOptionValue('--experimental-policy') ?
29105
require('internal/process/policy').manifest :
30106
null;

0 commit comments

Comments
 (0)