From d76e8be5df3b11594fb56067e53be6c671bd2dc5 Mon Sep 17 00:00:00 2001 From: Jacob Smith <3012099+JakobJingleheimer@users.noreply.github.com> Date: Sun, 6 Oct 2024 10:57:01 +0200 Subject: [PATCH] fixup: throw on relative `statLocation` with remediation instructions --- lib/internal/modules/package_json_reader.js | 29 ++++++++++++++-- test/fixtures/packages/nested/package.json | 1 + .../packages/nested/sub-pkg-cjs/index.js | 4 +++ .../packages/nested/sub-pkg-cjs/package.json | 1 + .../packages/nested/sub-pkg-mjs/index.js | 3 ++ .../packages/nested/sub-pkg-mjs/package.json | 1 + test/parallel/test-get-package-json.js | 33 +++++++++++++++++++ 7 files changed, 69 insertions(+), 3 deletions(-) create mode 100644 test/fixtures/packages/nested/package.json create mode 100644 test/fixtures/packages/nested/sub-pkg-cjs/index.js create mode 100644 test/fixtures/packages/nested/sub-pkg-cjs/package.json create mode 100644 test/fixtures/packages/nested/sub-pkg-mjs/index.js create mode 100644 test/fixtures/packages/nested/sub-pkg-mjs/package.json diff --git a/lib/internal/modules/package_json_reader.js b/lib/internal/modules/package_json_reader.js index dd06eb732923be..9466bbb57190d9 100644 --- a/lib/internal/modules/package_json_reader.js +++ b/lib/internal/modules/package_json_reader.js @@ -2,11 +2,18 @@ const { ArrayIsArray, + ArrayPrototypeJoin, JSONParse, ObjectDefineProperty, + StringPrototypeEndsWith, } = primordials; +const { + codes: { + ERR_INVALID_ARG_VALUE, + }, +} = require('internal/errors'); const modulesBinding = internalBinding('modules'); -const { resolve } = require('path'); +const path = require('path'); const { kEmptyObject } = require('internal/util'); const { fileURLToPath, URL } = require('internal/url'); const { @@ -111,7 +118,7 @@ function read(jsonPath, { base, specifier, isESM } = kEmptyObject) { */ function readPackage(requestPath) { // TODO(@anonrig): Remove this function. - return read(resolve(requestPath, 'package.json')); + return read(path.resolve(requestPath, 'package.json')); } /** @@ -122,10 +129,26 @@ function readPackage(requestPath) { * @returns {undefined | DeserializedPackageConfig} */ function getNearestParentPackageJSON(startLocation, everything = false) { - const startPath = URL.canParse(startLocation) ? fileURLToPath(startLocation) : startLocation; + let startPath = URL.canParse(startLocation) ? fileURLToPath(startLocation) : startLocation; + validateString(startPath, 'startPath'); validateBoolean(everything, 'everything'); + if (!path.isAbsolute(startPath)) { + throw new ERR_INVALID_ARG_VALUE( + 'startLocation', + startLocation, + ArrayPrototypeJoin([ + 'must be a fully resolved location. To use a relative location, first wrap with', + '`import.meta.resolve(startLocation)` in ESM', + 'or', + '`path.resolve(__dirname, startLocation) in CJS', + ], ' '), + ); + } + + if (!StringPrototypeEndsWith(startPath, path.sep)) startPath += path.sep; + if (everything) { const result = modulesBinding.getNearestRawParentPackageJSON(startPath); diff --git a/test/fixtures/packages/nested/package.json b/test/fixtures/packages/nested/package.json new file mode 100644 index 00000000000000..0ce6c71db42e8c --- /dev/null +++ b/test/fixtures/packages/nested/package.json @@ -0,0 +1 @@ +{"name": "package-with-sub-package"} diff --git a/test/fixtures/packages/nested/sub-pkg-cjs/index.js b/test/fixtures/packages/nested/sub-pkg-cjs/index.js new file mode 100644 index 00000000000000..9db89b8bf068c8 --- /dev/null +++ b/test/fixtures/packages/nested/sub-pkg-cjs/index.js @@ -0,0 +1,4 @@ +const { getPackageJSON } = require('node:module'); +const { resolve } = require('node:path'); + +module.exports = getPackageJSON(resolve(__dirname, '..')); diff --git a/test/fixtures/packages/nested/sub-pkg-cjs/package.json b/test/fixtures/packages/nested/sub-pkg-cjs/package.json new file mode 100644 index 00000000000000..2dec7591cd6db8 --- /dev/null +++ b/test/fixtures/packages/nested/sub-pkg-cjs/package.json @@ -0,0 +1 @@ +{"name": "sub-package", "type": "commonjs"} diff --git a/test/fixtures/packages/nested/sub-pkg-mjs/index.js b/test/fixtures/packages/nested/sub-pkg-mjs/index.js new file mode 100644 index 00000000000000..6dd75e8525d8cf --- /dev/null +++ b/test/fixtures/packages/nested/sub-pkg-mjs/index.js @@ -0,0 +1,3 @@ +import { getPackageJSON } from 'node:module'; + +export default getPackageJSON(import.meta.resolve('..')); diff --git a/test/fixtures/packages/nested/sub-pkg-mjs/package.json b/test/fixtures/packages/nested/sub-pkg-mjs/package.json new file mode 100644 index 00000000000000..c294ec5158824a --- /dev/null +++ b/test/fixtures/packages/nested/sub-pkg-mjs/package.json @@ -0,0 +1 @@ +{"name": "sub-package", "type": "module"} diff --git a/test/parallel/test-get-package-json.js b/test/parallel/test-get-package-json.js index 47c98972d99d90..8d02cf2d4f396a 100644 --- a/test/parallel/test-get-package-json.js +++ b/test/parallel/test-get-package-json.js @@ -104,3 +104,36 @@ const pkgType = 'module'; // a non-default value }, }); } + +{ // Throws on unresolved location + let err; + try { + getPackageJSON('..') + } catch (e) { + err = e; + } + + assert.strictEqual(err.code, 'ERR_INVALID_ARG_VALUE'); + assert.match(err.message, /fully resolved/); + assert.match(err.message, /relative/); + assert.match(err.message, /import\.meta\.resolve/); + assert.match(err.message, /path\.resolve\(__dirname/); +} + +{ // Can crawl up (CJS) + const pathToMod = fixtures.path('packages/nested/sub-pkg-cjs/index.js'); + const parentPkg = require(pathToMod); + + assert.strictEqual(parentPkg.data.name, 'package-with-sub-package'); + const pathToParent = fixtures.path('packages/nested/package.json'); + assert.strictEqual(parentPkg.path, pathToParent); +} + +{ // Can crawl up (ESM) + const pathToMod = fixtures.path('packages/nested/sub-pkg-mjs/index.js'); + const parentPkg = require(pathToMod).default; + + assert.strictEqual(parentPkg.data.name, 'package-with-sub-package'); + const pathToParent = fixtures.path('packages/nested/package.json'); + assert.strictEqual(parentPkg.path, pathToParent); +}