Skip to content

Commit

Permalink
src: improve package.json reader performance
Browse files Browse the repository at this point in the history
  • Loading branch information
anonrig committed Jun 15, 2023
1 parent b85a2b1 commit 75f9437
Show file tree
Hide file tree
Showing 9 changed files with 179 additions and 181 deletions.
31 changes: 2 additions & 29 deletions lib/internal/modules/cjs/loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ const {
pendingDeprecate,
emitExperimentalWarning,
kEmptyObject,
filterOwnProperties,
setOwnProperty,
getLazy,
} = require('internal/util');
Expand Down Expand Up @@ -353,36 +352,10 @@ function initializeCJS() {
// -> a.<ext>
// -> a/index.<ext>

const packageJsonCache = new SafeMap();

function readPackage(requestPath) {
const jsonPath = path.resolve(requestPath, 'package.json');

const existing = packageJsonCache.get(jsonPath);
if (existing !== undefined) return existing;

const result = packageJsonReader.read(jsonPath);
const json = result.containsKeys === false ? '{}' : result.string;
if (json === undefined) {
packageJsonCache.set(jsonPath, false);
return false;
}

try {
const filtered = filterOwnProperties(JSONParse(json), [
'name',
'main',
'exports',
'imports',
'type',
]);
packageJsonCache.set(jsonPath, filtered);
return filtered;
} catch (e) {
e.path = jsonPath;
e.message = 'Error parsing ' + jsonPath + ': ' + e.message;
throw e;
}
// Return undefined or the filtered package.json as a JS object
return packageJsonReader.read(jsonPath);
}

let _readPackage = readPackage;
Expand Down
72 changes: 14 additions & 58 deletions lib/internal/modules/esm/package_config.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
'use strict';

const {
JSONParse,
ObjectPrototypeHasOwnProperty,
SafeMap,
StringPrototypeEndsWith,
} = primordials;
const { URL, fileURLToPath } = require('internal/url');
const {
ERR_INVALID_PACKAGE_CONFIG,
} = require('internal/errors').codes;

const { filterOwnProperties } = require('internal/util');


/**
* @typedef {string | string[] | Record<string, unknown>} Exports
Expand Down Expand Up @@ -42,59 +34,23 @@ function getPackageConfig(path, specifier, base) {
return existing;
}
const packageJsonReader = require('internal/modules/package_json_reader');
const source = packageJsonReader.read(path).string;
if (source === undefined) {
const packageConfig = {
pjsonPath: path,
exists: false,
main: undefined,
name: undefined,
type: 'none',
exports: undefined,
imports: undefined,
};
packageJSONCache.set(path, packageConfig);
return packageConfig;
}

let packageJSON;
try {
packageJSON = JSONParse(source);
} catch (error) {
throw new ERR_INVALID_PACKAGE_CONFIG(
path,
(base ? `"${specifier}" from ` : '') + fileURLToPath(base || specifier),
error.message,
);
}

let { imports, main, name, type } = filterOwnProperties(packageJSON, ['imports', 'main', 'name', 'type']);
const exports = ObjectPrototypeHasOwnProperty(packageJSON, 'exports') ? packageJSON.exports : undefined;
if (typeof imports !== 'object' || imports === null) {
imports = undefined;
}
if (typeof main !== 'string') {
main = undefined;
}
if (typeof name !== 'string') {
name = undefined;
}
// Ignore unknown types for forwards compatibility
if (type !== 'module' && type !== 'commonjs') {
type = 'none';
}
const result = packageJsonReader.read(path);
const packageJSON = result ?? {
main: undefined,
name: undefined,
type: 'none',
exports: undefined,
imports: undefined,
};

const packageConfig = {
const json = {
__proto__: null,
pjsonPath: path,
exists: true,
main,
name,
type,
exports,
imports,
exists: result !== undefined,
...packageJSON,
};
packageJSONCache.set(path, packageConfig);
return packageConfig;
packageJSONCache.set(path, json);
return json;
}


Expand Down
5 changes: 2 additions & 3 deletions lib/internal/modules/esm/resolve.js
Original file line number Diff line number Diff line change
Expand Up @@ -734,8 +734,7 @@ function packageResolve(specifier, base, conditions) {
const packageConfig = getPackageScopeConfig(base);
if (packageConfig.exists) {
const packageJSONUrl = pathToFileURL(packageConfig.pjsonPath);
if (packageConfig.name === packageName &&
packageConfig.exports !== undefined && packageConfig.exports !== null) {
if (packageConfig.name === packageName && packageConfig.exports !== undefined) {
return packageExportsResolve(
packageJSONUrl, packageSubpath, packageConfig, base, conditions);
}
Expand All @@ -760,7 +759,7 @@ function packageResolve(specifier, base, conditions) {

// Package match.
const packageConfig = getPackageConfig(packageJSONPath, specifier, base);
if (packageConfig.exports !== undefined && packageConfig.exports !== null) {
if (packageConfig.exports !== undefined) {
return packageExportsResolve(
packageJSONUrl, packageSubpath, packageConfig, base, conditions);
}
Expand Down
55 changes: 48 additions & 7 deletions lib/internal/modules/package_json_reader.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
'use strict';

const { SafeMap } = primordials;
const {
JSONParse,
JSONStringify,
SafeMap,
} = primordials;
const { internalModuleReadJSON } = internalBinding('fs');
const { pathToFileURL } = require('url');
const { toNamespacedPath } = require('path');
Expand All @@ -10,30 +14,67 @@ const cache = new SafeMap();
let manifest;

/**
*
* Returns undefined for all failure cases.
* @param {string} jsonPath
* @returns {{
* name?: string,
* main?: string,
* exports?: string | Record<string, unknown>,
* imports?: string | Record<string, unknown>,
* type: 'commonjs' | 'module' | 'none' | unknown,
* } | undefined}
*/
function read(jsonPath) {
if (cache.has(jsonPath)) {
return cache.get(jsonPath);
}

const { 0: string, 1: containsKeys } = internalModuleReadJSON(
const {
0: includesKeys,
1: name,
2: main,
3: exports,
4: imports,
5: type,
6: parseExports,
7: parseImports,
} = internalModuleReadJSON(
toNamespacedPath(jsonPath),
);
const result = { string, containsKeys };
const { getOptionValue } = require('internal/options');
if (string !== undefined) {

let result;

if (includesKeys !== undefined) {
result = {
__proto__: null,
name,
main,
exports,
imports,
type,
};

// Execute JSONParse on demand for improved performance
if (parseExports) {
result.exports = JSONParse(exports);
}

if (parseImports) {
result.imports = JSONParse(imports);
}

if (manifest === undefined) {
const { getOptionValue } = require('internal/options');
manifest = getOptionValue('--experimental-policy') ?
require('internal/process/policy').manifest :
null;
}
if (manifest !== null) {
const jsonURL = pathToFileURL(jsonPath);
manifest.assertIntegrity(jsonURL, string);
manifest.assertIntegrity(jsonURL, JSONStringify(result));
}
}

cache.set(jsonPath, result);
return result;
}
Expand Down
113 changes: 84 additions & 29 deletions src/node_file.cc
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,10 @@
#include "tracing/trace_event.h"

#include "req_wrap-inl.h"
#include "simdjson.h"
#include "stream_base-inl.h"
#include "string_bytes.h"
#include "v8-primitive.h"

#include <fcntl.h>
#include <sys/types.h>
Expand Down Expand Up @@ -1079,41 +1081,94 @@ static void InternalModuleReadJSON(const FunctionCallbackInfo<Value>& args) {
}

const size_t size = offset - start;
char* p = &chars[start];
char* pe = &chars[size];
char* pos[2];
char** ppos = &pos[0];

while (p < pe) {
char c = *p++;
if (c == '\\' && p < pe && *p == '"') p++;
if (c != '"') continue;
*ppos++ = p;
if (ppos < &pos[2]) continue;
ppos = &pos[0];

char* s = &pos[0][0];
char* se = &pos[1][-1]; // Exclude quote.
size_t n = se - s;

if (n == 4) {
if (0 == memcmp(s, "main", 4)) break;
if (0 == memcmp(s, "name", 4)) break;
if (0 == memcmp(s, "type", 4)) break;
} else if (n == 7) {
if (0 == memcmp(s, "exports", 7)) break;
if (0 == memcmp(s, "imports", 7)) break;
simdjson::ondemand::parser parser;
simdjson::padded_string json_string(chars.data() + start, size);
simdjson::ondemand::document document;
simdjson::ondemand::object obj;
auto error = parser.iterate(json_string).get(document);

if (error || document.get_object().get(obj)) {
args.GetReturnValue().Set(Array::New(isolate));
return;
}

auto js_string = [&](std::string_view sv) {
return ToV8Value(env->context(), sv, isolate).ToLocalChecked();
};

bool includes_keys{false};
Local<Value> name = Undefined(isolate);
Local<Value> main = Undefined(isolate);
Local<Value> exports = Undefined(isolate);
Local<Value> imports = Undefined(isolate);
Local<Value> type = Undefined(isolate);
bool parse_exports{false};
bool parse_imports{false};

// Check for "name" field
std::string_view name_value{};
if (!obj["name"].get_string().get(name_value)) {
name = js_string(name_value);
includes_keys = true;
}

// Check for "main" field
std::string_view main_value{};
if (!obj["main"].get_string().get(main_value)) {
main = js_string(main_value);
includes_keys = true;
}

// Check for "exports" field
simdjson::ondemand::object exports_object;
std::string_view exports_value{};
if (!obj["exports"].get_object().get(exports_object)) {
if (!exports_object.raw_json().get(exports_value)) {
exports = js_string(exports_value);
includes_keys = true;
parse_exports = true;
}
} else if (!obj["exports"].get(exports_value)) {
exports = js_string(exports_value);
includes_keys = true;
}

// Check for "imports" field
simdjson::ondemand::object imports_object;
std::string_view imports_value;
if (!obj["imports"].get_object().get(imports_object)) {
if (!imports_object.raw_json().get(imports_value)) {
imports = js_string(imports_value);
includes_keys = true;
parse_imports = true;
}
} else if (!obj["imports"].get(imports_value)) {
imports = js_string(imports_value);
includes_keys = true;
}

// Check for "type" field
std::string_view type_value = "none";
if (!obj["type"].get(type_value)) {
// Ignore unknown types for forwards compatibility
if (type_value != "module" && type_value != "commonjs") {
type_value = "none";
}
includes_keys = true;
}
type = js_string(type_value);

Local<Value> return_value[] = {
String::NewFromUtf8(isolate,
&chars[start],
v8::NewStringType::kNormal,
size).ToLocalChecked(),
Boolean::New(isolate, p < pe ? true : false)
Boolean::New(isolate, includes_keys),
name,
main,
exports,
imports,
type,
Boolean::New(isolate, parse_exports),
Boolean::New(isolate, parse_imports),
};

args.GetReturnValue().Set(
Array::New(isolate, return_value, arraysize(return_value)));
}
Expand Down
Loading

0 comments on commit 75f9437

Please sign in to comment.