module: improve getPackageType performance

PR-URL: #57599
Reviewed-By: Yagiz Nizipli <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Ulises Gascón <[email protected]>

Author: dario-piotrowicz

lib/internal/modules/package_json_reader.js

@@ -174,8 +174,8 @@ function getPackageScopeConfig(resolved) {
  * @param {URL} url - The URL to get the package type for.
  */
 function getPackageType(url) {
-  // TODO(@anonrig): Write a C++ function that returns only "type".
-  return getPackageScopeConfig(url).type;
+  const type = modulesBinding.getPackageType(`${url}`);
+  return type ?? 'none';
 }
 
 const invalidPackageNameRegEx = /^\.|%|\\/;

src/node_modules.cc

@@ -398,6 +398,7 @@ void BindingData::GetNearestParentPackageJSONType(
   args.GetReturnValue().Set(value);
 }
 
+template <bool return_only_type>
 void BindingData::GetPackageScopeConfig(
     const FunctionCallbackInfo<Value>& args) {
   CHECK_GE(args.Length(), 1);
@@ -436,7 +437,15 @@ void BindingData::GetPackageScopeConfig(
     error_context.specifier = resolved.ToString();
     auto package_json = GetPackageJSON(realm, *file_url, &error_context);
     if (package_json != nullptr) {
-      return args.GetReturnValue().Set(package_json->Serialize(realm));
+      if constexpr (return_only_type) {
+        Local<Value> value;
+        if (ToV8Value(realm->context(), package_json->type).ToLocal(&value)) {
+          args.GetReturnValue().Set(value);
+        }
+        return;
+      } else {
+        return args.GetReturnValue().Set(package_json->Serialize(realm));
+      }
     }
 
     auto last_href = std::string(package_json_url->get_href());
@@ -454,6 +463,12 @@ void BindingData::GetPackageScopeConfig(
     }
   }
 
+  if constexpr (return_only_type) {
+    return;
+  }
+
+  // If the package.json could not be found return a string containing a path
+  // to the non-existent package.json file in the initial requested location
   auto package_json_url_as_path =
       url::FileURLToPath(realm->env(), *package_json_url);
   CHECK(package_json_url_as_path);
@@ -526,7 +541,9 @@ void BindingData::CreatePerIsolateProperties(IsolateData* isolate_data,
             target,
             "getNearestParentPackageJSON",
             GetNearestParentPackageJSON);
-  SetMethod(isolate, target, "getPackageScopeConfig", GetPackageScopeConfig);
+  SetMethod(
+      isolate, target, "getPackageScopeConfig", GetPackageScopeConfig<false>);
+  SetMethod(isolate, target, "getPackageType", GetPackageScopeConfig<true>);
   SetMethod(isolate, target, "enableCompileCache", EnableCompileCache);
   SetMethod(isolate, target, "getCompileCacheDir", GetCompileCacheDir);
   SetMethod(isolate, target, "flushCompileCache", FlushCompileCache);
@@ -559,7 +576,8 @@ void BindingData::RegisterExternalReferences(
   registry->Register(ReadPackageJSON);
   registry->Register(GetNearestParentPackageJSONType);
   registry->Register(GetNearestParentPackageJSON);
-  registry->Register(GetPackageScopeConfig);
+  registry->Register(GetPackageScopeConfig<false>);
+  registry->Register(GetPackageScopeConfig<true>);
   registry->Register(EnableCompileCache);
   registry->Register(GetCompileCacheDir);
   registry->Register(FlushCompileCache);

src/node_modules.h

@@ -59,6 +59,7 @@ class BindingData : public SnapshotableObject {
       const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetNearestParentPackageJSONType(
       const v8::FunctionCallbackInfo<v8::Value>& args);
+  template <bool return_only_type>
   static void GetPackageScopeConfig(
       const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetPackageJSONScripts(

typings/internalBinding/modules.d.ts

@@ -26,5 +26,8 @@ export interface ModulesBinding {
   getNearestRawParentPackageJSON(origin: URL['pathname']): [ReturnType<JSON['stringify']>, DeserializedPackageConfig['path']] | undefined
   getNearestParentPackageJSONType(path: string): PackageConfig['type']
   getPackageScopeConfig(path: string): SerializedPackageConfig | undefined
-  getPackageJSONScripts(): string | undefined
+  getPackageType(path: string): PackageConfig['type'] | undefined
+  enableCompileCache(path?: string): { status: number, message?: string, directory?: string }
+  getCompileCacheDir(): string | undefined
+  flushCompileCache(keepDeserializedCache?: boolean): void
 }