Skip to content

Commit eb5f757

Browse files
anonriglemire
authored and
marco-ippolito
committed
src: move package resolver to c++
Co-authored-by: Daniel Lemire <[email protected]> PR-URL: #50322 Backport-PR-URL: #56590 Reviewed-By: Jacob Smith <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]>
1 parent e954ef6 commit eb5f757

27 files changed

+825
-400
lines changed

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

+14-15
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ ObjectDefineProperty(Module, '_readPackage', {
470470
* @param {string} originalPath The specifier passed to `require`
471471
*/
472472
function tryPackage(requestPath, exts, isMain, originalPath) {
473-
const pkg = _readPackage(requestPath).main;
473+
const { main: pkg, pjsonPath } = _readPackage(requestPath);
474474

475475
if (!pkg) {
476476
return tryExtensions(path.resolve(requestPath, 'index'), exts, isMain);
@@ -489,14 +489,13 @@ function tryPackage(requestPath, exts, isMain, originalPath) {
489489
'Please verify that the package.json has a valid "main" entry',
490490
);
491491
err.code = 'MODULE_NOT_FOUND';
492-
err.path = path.resolve(requestPath, 'package.json');
492+
err.path = pjsonPath;
493493
err.requestPath = originalPath;
494494
// TODO(BridgeAR): Add the requireStack as well.
495495
throw err;
496496
} else {
497-
const jsonPath = path.resolve(requestPath, 'package.json');
498497
process.emitWarning(
499-
`Invalid 'main' field in '${jsonPath}' of '${pkg}'. ` +
498+
`Invalid 'main' field in '${pjsonPath}' of '${pkg}'. ` +
500499
'Please either fix that or report it to the module author',
501500
'DeprecationWarning',
502501
'DEP0128',
@@ -582,28 +581,28 @@ function trySelfParentPath(parent) {
582581
function trySelf(parentPath, request) {
583582
if (!parentPath) { return false; }
584583

585-
const { data: pkg, path: pkgPath } = packageJsonReader.readPackageScope(parentPath);
586-
if (!pkg || pkg.exports == null || pkg.name === undefined) {
584+
const pkg = packageJsonReader.getNearestParentPackageJSON(parentPath);
585+
if (pkg?.data.exports === undefined || pkg.data.name === undefined) {
587586
return false;
588587
}
589588

590589
let expansion;
591-
if (request === pkg.name) {
590+
if (request === pkg.data.name) {
592591
expansion = '.';
593-
} else if (StringPrototypeStartsWith(request, `${pkg.name}/`)) {
594-
expansion = '.' + StringPrototypeSlice(request, pkg.name.length);
592+
} else if (StringPrototypeStartsWith(request, `${pkg.data.name}/`)) {
593+
expansion = '.' + StringPrototypeSlice(request, pkg.data.name.length);
595594
} else {
596595
return false;
597596
}
598597

599598
try {
600599
const { packageExportsResolve } = require('internal/modules/esm/resolve');
601600
return finalizeEsmResolution(packageExportsResolve(
602-
pathToFileURL(pkgPath + '/package.json'), expansion, pkg,
603-
pathToFileURL(parentPath), getCjsConditions()), parentPath, pkgPath);
601+
pathToFileURL(pkg.path + '/package.json'), expansion, pkg.data,
602+
pathToFileURL(parentPath), getCjsConditions()), parentPath, pkg.path);
604603
} catch (e) {
605604
if (e.code === 'ERR_MODULE_NOT_FOUND') {
606-
throw createEsmNotFoundErr(request, pkgPath + '/package.json');
605+
throw createEsmNotFoundErr(request, pkg.path + '/package.json');
607606
}
608607
throw e;
609608
}
@@ -1180,7 +1179,7 @@ Module._resolveFilename = function(request, parent, isMain, options) {
11801179

11811180
if (request[0] === '#' && (parent?.filename || parent?.id === '<repl>')) {
11821181
const parentPath = parent?.filename ?? process.cwd() + path.sep;
1183-
const pkg = packageJsonReader.readPackageScope(parentPath) || { __proto__: null };
1182+
const pkg = packageJsonReader.getNearestParentPackageJSON(parentPath) || { __proto__: null };
11841183
if (pkg.data?.imports != null) {
11851184
try {
11861185
const { packageImportsResolve } = require('internal/modules/esm/resolve');
@@ -1504,9 +1503,9 @@ Module._extensions['.js'] = function(module, filename) {
15041503
const content = getMaybeCachedSource(module, filename);
15051504

15061505
if (StringPrototypeEndsWith(filename, '.js')) {
1507-
const pkg = packageJsonReader.readPackageScope(filename) || { __proto__: null };
1506+
const pkg = packageJsonReader.getNearestParentPackageJSON(filename);
15081507
// Function require shouldn't be used in ES modules.
1509-
if (pkg.data?.type === 'module') {
1508+
if (pkg?.data.type === 'module') {
15101509
if (getOptionValue('--experimental-require-module')) {
15111510
module._compile(content, filename, true);
15121511
return;

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ const {
2020
const experimentalNetworkImports =
2121
getOptionValue('--experimental-network-imports');
2222
const { containsModuleSyntax } = internalBinding('contextify');
23-
const { getPackageScopeConfig, getPackageType } = require('internal/modules/esm/resolve');
23+
const { getPackageScopeConfig } = require('internal/modules/esm/resolve');
24+
const { getPackageType } = require('internal/modules/esm/package_config');
2425
const { fileURLToPath } = require('internal/url');
2526
const { ERR_UNKNOWN_FILE_EXTENSION } = require('internal/errors').codes;
2627

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ class ModuleJob extends ModuleJobBase {
244244
const packageConfig =
245245
StringPrototypeStartsWith(this.module.url, 'file://') &&
246246
RegExpPrototypeExec(/\.js(\?[^#]*)?(#.*)?$/, this.module.url) !== null &&
247-
require('internal/modules/esm/resolve')
247+
require('internal/modules/esm/package_config')
248248
.getPackageScopeConfig(this.module.url);
249249
if (packageConfig.type === 'module') {
250250
e.message +=

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

+22-47
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,44 @@
11
'use strict';
22

3-
const {
4-
StringPrototypeEndsWith,
5-
} = primordials;
6-
const { URL, fileURLToPath } = require('internal/url');
7-
const packageJsonReader = require('internal/modules/package_json_reader');
3+
const { ArrayIsArray } = primordials;
4+
const modulesBinding = internalBinding('modules');
5+
const { deserializePackageJSON } = require('internal/modules/package_json_reader');
86

9-
/**
10-
* @typedef {object} PackageConfig
11-
* @property {string} pjsonPath - The path to the package.json file.
12-
* @property {boolean} exists - Whether the package.json file exists.
13-
* @property {'none' | 'commonjs' | 'module'} type - The type of the package.
14-
* @property {string} [name] - The name of the package.
15-
* @property {string} [main] - The main entry point of the package.
16-
* @property {PackageTarget} [exports] - The exports configuration of the package.
17-
* @property {Record<string, string | Record<string, string>>} [imports] - The imports configuration of the package.
18-
*/
19-
/**
20-
* @typedef {string | string[] | Record<string, string | Record<string, string>>} PackageTarget
21-
*/
7+
// TODO(@anonrig): Merge this file with internal/esm/package_json_reader.js
228

239
/**
2410
* Returns the package configuration for the given resolved URL.
2511
* @param {URL | string} resolved - The resolved URL.
26-
* @returns {PackageConfig} - The package configuration.
12+
* @returns {import('typings/internalBinding/modules').PackageConfig} - The package configuration.
2713
*/
2814
function getPackageScopeConfig(resolved) {
29-
let packageJSONUrl = new URL('./package.json', resolved);
30-
while (true) {
31-
const packageJSONPath = packageJSONUrl.pathname;
32-
if (StringPrototypeEndsWith(packageJSONPath, 'node_modules/package.json')) {
33-
break;
34-
}
35-
const packageConfig = packageJsonReader.read(fileURLToPath(packageJSONUrl), {
36-
__proto__: null,
37-
specifier: resolved,
38-
isESM: true,
39-
});
40-
if (packageConfig.exists) {
41-
return packageConfig;
42-
}
43-
44-
const lastPackageJSONUrl = packageJSONUrl;
45-
packageJSONUrl = new URL('../package.json', packageJSONUrl);
15+
const result = modulesBinding.getPackageScopeConfig(`${resolved}`);
4616

47-
// Terminates at root where ../package.json equals ../../package.json
48-
// (can't just check "/package.json" for Windows support).
49-
if (packageJSONUrl.pathname === lastPackageJSONUrl.pathname) {
50-
break;
51-
}
17+
if (ArrayIsArray(result)) {
18+
return deserializePackageJSON(`${resolved}`, result, false /* checkIntegrity */);
5219
}
53-
const packageJSONPath = fileURLToPath(packageJSONUrl);
20+
21+
// This means that the response is a string
22+
// and it is the path to the package.json file
5423
return {
5524
__proto__: null,
56-
pjsonPath: packageJSONPath,
25+
pjsonPath: result,
5726
exists: false,
58-
main: undefined,
59-
name: undefined,
6027
type: 'none',
61-
exports: undefined,
62-
imports: undefined,
6328
};
6429
}
6530

31+
/**
32+
* Returns the package type for a given URL.
33+
* @param {URL} url - The URL to get the package type for.
34+
*/
35+
function getPackageType(url) {
36+
// TODO(@anonrig): Write a C++ function that returns only "type".
37+
return getPackageScopeConfig(url).type;
38+
}
39+
6640

6741
module.exports = {
6842
getPackageScopeConfig,
43+
getPackageType,
6944
};

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

+4-14
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ const legacyMainResolveExtensionsIndexes = {
199199
* 4. TRY(pkg_url/index.js, pkg_url/index.json, pkg_url/index.node)
200200
* 5. NOT_FOUND
201201
* @param {URL} packageJSONUrl
202-
* @param {PackageConfig} packageConfig
202+
* @param {import('typings/internalBinding/modules').PackageConfig} packageConfig
203203
* @param {string | URL | undefined} base
204204
* @returns {URL}
205205
*/
@@ -522,7 +522,7 @@ function resolvePackageTarget(packageJSONUrl, target, subpath, packageSubpath,
522522
}
523523
return resolveResult;
524524
}
525-
if (lastException === undefined || lastException === null) {
525+
if (lastException == null) {
526526
return lastException;
527527
}
528528
throw lastException;
@@ -595,7 +595,7 @@ function isConditionalExportsMainSugar(exports, packageJSONUrl, base) {
595595
*/
596596
function packageExportsResolve(
597597
packageJSONUrl, packageSubpath, packageConfig, base, conditions) {
598-
let exports = packageConfig.exports;
598+
let { exports } = packageConfig;
599599
if (isConditionalExportsMainSugar(exports, packageJSONUrl, base)) {
600600
exports = { '.': exports };
601601
}
@@ -760,15 +760,6 @@ function packageImportsResolve(name, base, conditions) {
760760
throw importNotDefined(name, packageJSONUrl, base);
761761
}
762762

763-
/**
764-
* Returns the package type for a given URL.
765-
* @param {URL} url - The URL to get the package type for.
766-
*/
767-
function getPackageType(url) {
768-
const packageConfig = getPackageScopeConfig(url);
769-
return packageConfig.type;
770-
}
771-
772763
/**
773764
* Parse a package name from a specifier.
774765
* @param {string} specifier - The import specifier.
@@ -816,6 +807,7 @@ function parsePackageName(specifier, base) {
816807
* @returns {URL} - The resolved URL.
817808
*/
818809
function packageResolve(specifier, base, conditions) {
810+
// TODO(@anonrig): Move this to a C++ function.
819811
if (BuiltinModule.canBeRequiredWithoutScheme(specifier)) {
820812
return new URL('node:' + specifier);
821813
}
@@ -1237,8 +1229,6 @@ module.exports = {
12371229
decorateErrorWithCommonJSHints,
12381230
defaultResolve,
12391231
encodedSepRegEx,
1240-
getPackageScopeConfig,
1241-
getPackageType,
12421232
packageExportsResolve,
12431233
packageImportsResolve,
12441234
throwIfInvalidParentURL,

0 commit comments

Comments
 (0)