module: improve getPackageType performance

Author: dario-piotrowicz

lib/internal/modules/package_json_reader.js

@@ -185,8 +185,7 @@ 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;
+  return modulesBinding.getPackageType(`${url}`);
 }
 
 const invalidPackageNameRegEx = /^\.|%|\\/;

src/node_modules.cc

@@ -404,23 +404,22 @@ void BindingData::GetNearestParentPackageJSONType(
   }
 }
 
-void BindingData::GetPackageScopeConfig(
-    const FunctionCallbackInfo<Value>& args) {
+const BindingData::PackageConfig* BindingData::FindPackageScopeConfig(
+    Realm* realm, const FunctionCallbackInfo<Value>& args) {
   CHECK_GE(args.Length(), 1);
   CHECK(args[0]->IsString());
-
-  Realm* realm = Realm::GetCurrent(args);
   Utf8Value resolved(realm->isolate(), args[0]);
   auto package_json_url_base = ada::parse(resolved.ToStringView());
   if (!package_json_url_base) {
     url::ThrowInvalidURL(realm->env(), resolved.ToStringView(), std::nullopt);
-    return;
+    return nullptr;
   }
+
   auto package_json_url =
       ada::parse("./package.json", &package_json_url_base.value());
   if (!package_json_url) {
     url::ThrowInvalidURL(realm->env(), "./package.json", resolved.ToString());
-    return;
+    return nullptr;
   }
 
   std::string_view node_modules_package_path = "/node_modules/package.json";
@@ -437,20 +436,20 @@ void BindingData::GetPackageScopeConfig(
     auto file_url = url::FileURLToPath(realm->env(), *package_json_url);
     if (!file_url) {
       url::ThrowInvalidURL(realm->env(), resolved.ToStringView(), std::nullopt);
-      return;
+      return nullptr;
     }
     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));
+      return package_json;
     }
 
     auto last_href = std::string(package_json_url->get_href());
     auto last_pathname = std::string(package_json_url->get_pathname());
     package_json_url = ada::parse("../package.json", &package_json_url.value());
     if (!package_json_url) {
       url::ThrowInvalidURL(realm->env(), "../package.json", last_href);
-      return;
+      return nullptr;
     }
 
     // Terminates at root where ../package.json equals ../../package.json
@@ -460,6 +459,23 @@ void BindingData::GetPackageScopeConfig(
     }
   }
 
+  return nullptr;
+}
+
+void BindingData::GetPackageScopeConfig(
+    const FunctionCallbackInfo<Value>& args) {
+  Realm* realm = Realm::GetCurrent(args);
+
+  auto package_json = FindPackageScopeConfig(realm, args);
+  if (package_json != nullptr) {
+    return args.GetReturnValue().Set(package_json->Serialize(realm));
+  }
+
+  Utf8Value resolved(realm->isolate(), args[0]);
+  auto package_json_url_base = ada::parse(resolved.ToStringView());
+  auto package_json_url =
+      ada::parse("./package.json", &package_json_url_base.value());
+
   auto package_json_url_as_path =
       url::FileURLToPath(realm->env(), *package_json_url);
   CHECK(package_json_url_as_path);
@@ -470,6 +486,22 @@ void BindingData::GetPackageScopeConfig(
   }
 }
 
+void BindingData::GetPackageType(const FunctionCallbackInfo<Value>& args) {
+  Realm* realm = Realm::GetCurrent(args);
+
+  auto package_scope = FindPackageScopeConfig(realm, args);
+
+  std::string resultType = "none";
+
+  if (package_scope != nullptr) {
+    resultType = package_scope->type;
+  }
+
+  return args.GetReturnValue().Set(
+      String::NewFromUtf8(realm->isolate(), resultType.c_str())
+          .ToLocalChecked());
+}
+
 void FlushCompileCache(const FunctionCallbackInfo<Value>& args) {
   Isolate* isolate = args.GetIsolate();
   Local<Context> context = isolate->GetCurrentContext();
@@ -605,6 +637,7 @@ void BindingData::CreatePerIsolateProperties(IsolateData* isolate_data,
             "getNearestParentPackageJSON",
             GetNearestParentPackageJSON);
   SetMethod(isolate, target, "getPackageScopeConfig", GetPackageScopeConfig);
+  SetMethod(isolate, target, "getPackageType", GetPackageType);
   SetMethod(isolate, target, "enableCompileCache", EnableCompileCache);
   SetMethod(isolate, target, "getCompileCacheDir", GetCompileCacheDir);
   SetMethod(isolate, target, "flushCompileCache", FlushCompileCache);
@@ -659,6 +692,7 @@ void BindingData::RegisterExternalReferences(
   registry->Register(GetNearestParentPackageJSONType);
   registry->Register(GetNearestParentPackageJSON);
   registry->Register(GetPackageScopeConfig);
+  registry->Register(GetPackageType);
   registry->Register(EnableCompileCache);
   registry->Register(GetCompileCacheDir);
   registry->Register(FlushCompileCache);

src/node_modules.h

@@ -59,8 +59,11 @@ class BindingData : public SnapshotableObject {
       const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetNearestParentPackageJSONType(
       const v8::FunctionCallbackInfo<v8::Value>& args);
+  static const BindingData::PackageConfig* FindPackageScopeConfig(
+      Realm* realm, const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetPackageScopeConfig(
       const v8::FunctionCallbackInfo<v8::Value>& args);
+  static void GetPackageType(const v8::FunctionCallbackInfo<v8::Value>& args);
   static void GetPackageJSONScripts(
       const v8::FunctionCallbackInfo<v8::Value>& args);
 

typings/internalBinding/modules.d.ts

@@ -25,6 +25,7 @@ export interface ModulesBinding {
   getNearestParentPackageJSONType(path: string): PackageConfig['type']
   getNearestParentPackageJSON(path: string): SerializedPackageConfig | undefined
   getPackageScopeConfig(path: string): SerializedPackageConfig | undefined
+  getPackageType(path: string): PackageConfig['type']
   enableCompileCache(path?: string): { status: number, message?: string, directory?: string }
   getCompileCacheDir(): string | undefined
   flushCompileCache(keepDeserializedCache?: boolean): void