Use find_package instead of include to locate "weak-node-api"

Author: kraenhansen

.changeset/quick-poets-greet.md

@@ -0,0 +1,7 @@
+---
+"gyp-to-cmake": minor
+"cmake-rn": minor
+"react-native-node-api": minor
+---
+
+Use `find_package` instead of `include` to locate "weak-node-api"

packages/cmake-rn/README.md

@@ -10,14 +10,14 @@ Android's dynamic linker imposes restrictions on the access to global symbols (s
 
 The implementation of Node-API is split between Hermes and our host package and to avoid addons having to explicitly link against either, we've introduced a `weak-node-api` library (published in `react-native-node-api` package). This library exposes only Node-API and will have its implementation injected by the host.
 
-To link against `weak-node-api` just include the CMake config exposed through `WEAK_NODE_API_CONFIG` and add `weak-node-api` to the `target_link_libraries` of the addon's library target.
+To link against `weak-node-api` just use `find_package` to import the `weak-node-api` target and add it to the `target_link_libraries` of the addon's library target.
 
 ```cmake
 cmake_minimum_required(VERSION 3.15...3.31)
 project(tests-buffers)
 
 # Defines the "weak-node-api" target
-include(${WEAK_NODE_API_CONFIG})
+find_package(weak-node-api REQUIRED CONFIG)
 
 add_library(addon SHARED addon.c)
 target_link_libraries(addon PRIVATE weak-node-api)

packages/cmake-rn/src/weak-node-api.ts

@@ -58,7 +58,9 @@ export function getWeakNodeApiVariables(
   triplet: SupportedTriplet | "apple",
 ): Record<string, string> {
   return {
-    // Expose an includable CMake config file declaring the weak-node-api target
+    // Enable use of `find_package(weak-node-api REQUIRED CONFIG)`
+    "weak-node-api_DIR": path.dirname(weakNodeApiCmakePath),
+    // Enable use of `include(${WEAK_NODE_API_CONFIG})`
     WEAK_NODE_API_CONFIG: weakNodeApiCmakePath,
     WEAK_NODE_API_INC: getNodeApiIncludePaths().join(";"),
     WEAK_NODE_API_LIB: getWeakNodeApiPath(triplet),

packages/gyp-to-cmake/src/transformer.ts

@@ -85,7 +85,7 @@ export function bindingGypToCmakeLists({
   ];
 
   if (weakNodeApi) {
-    lines.push(`include(\${WEAK_NODE_API_CONFIG})`, "");
+    lines.push(`find_package(weak-node-api REQUIRED CONFIG)`, "");
   }
 
   for (const target of gyp.targets) {

packages/host/android/CMakeLists.txt

@@ -5,12 +5,7 @@ set(CMAKE_CXX_STANDARD 20)
 
 find_package(ReactAndroid REQUIRED CONFIG)
 find_package(hermes-engine REQUIRED CONFIG)
-
-add_library(weak-node-api INTERFACE)
-target_include_directories(weak-node-api INTERFACE
-  ../../weak-node-api/generated
-  ../../weak-node-api/include
-)
+find_package(weak-node-api REQUIRED CONFIG)
 
 add_library(node-api-host SHARED
   src/main/cpp/OnLoad.cpp

packages/host/android/build.gradle

@@ -14,6 +14,17 @@ if (!System.getenv("REACT_NATIVE_OVERRIDE_HERMES_DIR")) {
     ].join('\n'))
 }
 
+def findWeakNodeApiDir() {
+    def searchDir = rootDir.toPath()
+    do {
+        def p = searchDir.resolve("node_modules/weak-node-api")
+        if (p.toFile().exists()) {
+            return p.toRealPath().toString()
+        }
+    } while (searchDir = searchDir.getParent())
+    throw new GradleException("Could not find `weak-node-api`");
+}
+
 buildscript {
   ext.getExtOrDefault = {name ->
     return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['NodeApiModules_' + name]
@@ -86,7 +97,7 @@ android {
       cmake {
         targets "node-api-host"
         cppFlags "-frtti -fexceptions -Wall -fstack-protector-all"
-        arguments "-DANDROID_STL=c++_shared"
+        arguments "-DANDROID_STL=c++_shared", "-Dweak-node-api_DIR=${findWeakNodeApiDir()}"
         abiFilters (*reactNativeArchitectures())
 
         buildTypes {

packages/weak-node-api/src/weak-node-api.ts

@@ -22,5 +22,5 @@ export const androidPrebuildPath = path.resolve(
 
 export const weakNodeApiCmakePath = path.resolve(
   weakNodeApiPath,
-  "weak-node-api.cmake",
+  "weak-node-api-config.cmake",
 );

packages/weak-node-api/weak-node-api-config.cmake

@@ -0,0 +1,39 @@
+
+# Get the current file directory
+get_filename_component(WEAK_NODE_API_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" DIRECTORY)
+
+if(NOT DEFINED WEAK_NODE_API_LIB)
+    # Auto-detect library path for Android NDK builds
+    if(ANDROID)
+        # Define the library path pattern for Android
+        set(WEAK_NODE_API_LIB_PATH "weak-node-api.android.node/${ANDROID_ABI}/libweak-node-api.so")
+        
+        # Try Debug first, then Release using the packaged Android node structure
+        set(WEAK_NODE_API_LIB_DEBUG "${WEAK_NODE_API_CMAKE_DIR}/build/Debug/${WEAK_NODE_API_LIB_PATH}")
+        set(WEAK_NODE_API_LIB_RELEASE "${WEAK_NODE_API_CMAKE_DIR}/build/Release/${WEAK_NODE_API_LIB_PATH}")
+        
+        if(EXISTS "${WEAK_NODE_API_LIB_DEBUG}")
+            set(WEAK_NODE_API_LIB "${WEAK_NODE_API_LIB_DEBUG}")
+            message(STATUS "Using Debug weak-node-api library: ${WEAK_NODE_API_LIB}")
+        elseif(EXISTS "${WEAK_NODE_API_LIB_RELEASE}")
+            set(WEAK_NODE_API_LIB "${WEAK_NODE_API_LIB_RELEASE}")
+            message(STATUS "Using Release weak-node-api library: ${WEAK_NODE_API_LIB}")
+        else()
+            message(FATAL_ERROR "Could not find weak-node-api library for Android ABI ${ANDROID_ABI}. Expected at:\n  ${WEAK_NODE_API_LIB_DEBUG}\n  ${WEAK_NODE_API_LIB_RELEASE}")
+        endif()
+    else()
+        message(FATAL_ERROR "WEAK_NODE_API_LIB is not set")
+    endif()
+endif()
+
+if(NOT DEFINED WEAK_NODE_API_INC)
+    set(WEAK_NODE_API_INC "${WEAK_NODE_API_CMAKE_DIR}/include;${WEAK_NODE_API_CMAKE_DIR}/generated")
+    message(STATUS "Using weak-node-api include directories: ${WEAK_NODE_API_INC}")
+endif()
+
+add_library(weak-node-api SHARED IMPORTED)
+
+set_target_properties(weak-node-api PROPERTIES
+    IMPORTED_LOCATION "${WEAK_NODE_API_LIB}"
+    INTERFACE_INCLUDE_DIRECTORIES "${WEAK_NODE_API_INC}"
+)