refactor: swap old TM addon loader with AddonRegistry

Author: Mariusz Pasinski

packages/react-native-node-api-modules/cpp/CxxNodeApiHostModule.cpp

@@ -4,6 +4,7 @@
 #include <algorithm>    // std::equal, std::all_of
 #include <cctype>       // std::isalnum
 #include "CxxNodeApiHostModule.hpp"
+#include "AddonRegistry.hpp"
 #include "Logger.hpp"
 
 using namespace facebook;
@@ -124,6 +125,8 @@ rpartition(const std::string_view &input, char delimiter) {
 
 namespace callstack::nodeapihost {
 
+AddonRegistry g_platformAddonRegistry;
+
 CxxNodeApiHostModule::CxxNodeApiHostModule(
     std::shared_ptr<react::CallInvoker> jsInvoker)
     : TurboModule(CxxNodeApiHostModule::kModuleName, jsInvoker) {
@@ -216,109 +219,20 @@ CxxNodeApiHostModule::resolveRelativePath(facebook::jsi::Runtime &rt,
                                                 mergedSubpath);
 
   if (!isCached) {
-    const std::string libraryNameStr(requiredPath);
-    auto [it, inserted] = nodeAddons_.emplace(libraryNameStr, NodeAddon());
-    NodeAddon &addon = it->second;
-
-    // Check if this module has been loaded already, if not then load it...
-    if (inserted) {
-      if (!loadNodeAddon(addon, libraryNameStr)) {
-        return jsi::Value::undefined();
-      }
-    }
-
-    // Initialize the addon if it has not already been initialized
-    if (!rt.global().hasProperty(rt, addon.generatedName.data())) {
-      initializeNodeModule(rt, addon);
-    }
-
-    // Look up the exports (using JSI), add to cache and return
-    exports = rt.global().getProperty(rt, addon.generatedName.data());
+    // Ask the global addon registry to load given Node-API addon.
+    // If other runtime loaded it already, the OS will return the same pointer.
+    // NOTE: This method might try multiple platform-specific paths.
+    const std::string packageNameCopy(requiredPackageName);
+    auto &addon = g_platformAddonRegistry.loadAddon(packageNameCopy, mergedSubpath);
+
+    // Create a `napi_env` and initialize the addon
+    exports = g_platformAddonRegistry.instantiateAddonInRuntime(rt, addon);
     updateRequireCache(rt, requiredPackageName, mergedSubpath, exports);
   }
 
   return std::move(exports);
 }
 
-bool CxxNodeApiHostModule::loadNodeAddon(NodeAddon &addon,
-                                         const std::string &libraryName) const {
-#if defined(__APPLE__)
-  std::string libraryPath =
-      "@rpath/" + libraryName + ".framework/" + libraryName;
-#elif defined(__ANDROID__)
-  std::string libraryPath = "lib" + libraryName + ".so";
-#else
-  abort()
-#endif
-
-  log_debug("[%s] Loading addon by '%s'", libraryName.c_str(),
-            libraryPath.c_str());
-
-  typename LoaderPolicy::Symbol initFn = NULL;
-  typename LoaderPolicy::Module library =
-      LoaderPolicy::loadLibrary(libraryPath.c_str());
-  if (NULL != library) {
-    log_debug("[%s] Loaded addon", libraryName.c_str());
-    addon.moduleHandle = library;
-
-    // Generate a name allowing us to reference the exports object from JSI
-    // later Instead of using random numbers to avoid name clashes, we just use
-    // the pointer address of the loaded module
-    addon.generatedName.resize(32, '\0');
-    snprintf(addon.generatedName.data(), addon.generatedName.size(),
-             "RN$NodeAddon_%p", addon.moduleHandle);
-
-    initFn = LoaderPolicy::getSymbol(library, "napi_register_module_v1");
-    if (NULL != initFn) {
-      log_debug("[%s] Found napi_register_module_v1 (%p)", libraryName.c_str(),
-                initFn);
-      addon.init = (napi_addon_register_func)initFn;
-    } else {
-      log_debug("[%s] Failed to find napi_register_module_v1. Expecting the "
-                "addon to call napi_module_register to register itself.",
-                libraryName.c_str());
-    }
-    // TODO: Read "node_api_module_get_api_version_v1" to support the addon
-    // declaring its Node-API version
-    // @see
-    // https://github.com/callstackincubator/react-native-node-api-modules/issues/4
-  } else {
-    log_debug("[%s] Failed to load library", libraryName.c_str());
-  }
-  return NULL != initFn;
-}
-
-bool CxxNodeApiHostModule::initializeNodeModule(jsi::Runtime &rt,
-                                                NodeAddon &addon) {
-  // We should check if the module has already been initialized
-  assert(NULL != addon.moduleHandle);
-  assert(NULL != addon.init);
-  napi_status status = napi_ok;
-  // TODO: Read the version from the addon
-  // @see
-  // https://github.com/callstackincubator/react-native-node-api-modules/issues/4
-  napi_env env = reinterpret_cast<napi_env>(rt.createNodeApiEnv(8));
-
-  // Create the "exports" object
-  napi_value exports;
-  status = napi_create_object(env, &exports);
-  assert(status == napi_ok);
-
-  // Call the addon init function to populate the "exports" object
-  // Allowing it to replace the value entirely by its return value
-  exports = addon.init(env, exports);
-
-  napi_value global;
-  napi_get_global(env, &global);
-  assert(status == napi_ok);
-
-  status =
-      napi_set_named_property(env, global, addon.generatedName.data(), exports);
-  assert(status == napi_ok);
-
-  return true;
-}
-
 std::pair<jsi::Value, bool>
 CxxNodeApiHostModule::lookupRequireCache(::jsi::Runtime &rt,
                    const std::string_view &packageName,

packages/react-native-node-api-modules/cpp/CxxNodeApiHostModule.hpp

@@ -50,19 +50,8 @@ class JSI_EXPORT CxxNodeApiHostModule : public facebook::react::TurboModule {
                           facebook::jsi::Value &value);
 
 protected:
-  struct NodeAddon {
-    void *moduleHandle;
-    napi_addon_register_func init;
-    std::string generatedName;
-  };
-  std::unordered_map<std::string, NodeAddon> nodeAddons_;
   std::unordered_map<std::string, ResolverFunc> prefixResolvers_;
   std::unordered_map<std::string, ResolverFunc> packageOverrides_;
-  using LoaderPolicy = PosixLoader; // FIXME: HACK: This is temporary workaround
-                                    // for my lazyness (work on iOS and Android)
-
-  bool loadNodeAddon(NodeAddon &addon, const std::string &path) const;
-  bool initializeNodeModule(facebook::jsi::Runtime &rt, NodeAddon &addon);
 };
 
 } // namespace callstack::nodeapihost