MacOS test app and fix hermes vendoring from react-native-macos

.changeset/silly-mice-warn.md

@@ -0,0 +1,5 @@
+---
+"react-native-node-api": patch
+---
+
+Detects "pod install" from React Native MacOS apps and vendors Hermes accordingly

.github/workflows/check.yml

@@ -107,6 +107,40 @@ jobs:
         # TODO: Enable release mode when it works
         # run: npm run test:ios -- --mode Release
         working-directory: apps/test-app
+  test-macos:
+    # Disabling this on main for now, as initializing the template takes a long time and
+    # we don't have macOS-specific code yet
+    if: contains(github.event.pull_request.labels.*.name, 'MacOS 💻')
+    name: Test app (macOS)
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/jod
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: "17"
+          distribution: "temurin"
+      # Install CMake 3 since 4.x may have compatibility issues with Hermes build system
+      - name: Install compatible CMake version
+        uses: jwlawson/actions-setup-cmake@v2
+        with:
+          cmake-version: "3.31.2"
+      - run: rustup target add x86_64-apple-darwin
+      - run: npm ci
+      - run: npm run bootstrap
+        env:
+          CMAKE_RN_TRIPLETS: arm64;x86_64-apple-darwin
+          FERRIC_TARGETS: aarch64-apple-darwin,x86_64-apple-darwin
+      - run: npm run init-macos-test-app
+      - run: pod install --project-directory=macos
+        working-directory: apps/macos-test-app
+      - name: Build MacOS test app
+        run: npx react-native build-macos --mode Release
+        working-directory: apps/macos-test-app
+      # TODO: Run the app eventually
   test-android:
     if: github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Android 🤖')
     name: Test app (Android)

.gitignore

@@ -4,3 +4,6 @@ node_modules/
 dist/
 
 *.tsbuildinfo
+
+# Treading the MacOS app as ephemeral
+apps/macos-test-app

apps/test-app/metro.config.js

@@ -1,5 +1,6 @@
 const { makeMetroConfig } = require("@rnx-kit/metro-config");
-module.exports = makeMetroConfig({
+
+const config = makeMetroConfig({
   transformer: {
     getTransformOptions: async () => ({
       transform: {
@@ -9,3 +10,13 @@ module.exports = makeMetroConfig({
     }),
   },
 });
+
+if (config.watchFolders.length === 0) {
+  // This patch is needed to locate packages in the monorepo from the MacOS app
+  // which is intentionally kept outside of the workspaces configuration to prevent
+  // duplicate react-native version and pollution of the package lock.
+  const path = require("node:path");
+  config.watchFolders.push(path.resolve(__dirname, "../.."));
+}
+
+module.exports = config;

eslint.config.js

@@ -47,6 +47,7 @@ export default tseslint.config(
   {
     files: [
       "apps/test-app/*.js",
+      "apps/macos-test-app/*.js",
       "packages/node-addon-examples/**/*.js",
       "packages/host/babel-plugin.js",
       "packages/host/react-native.config.js",
@@ -68,6 +69,7 @@ export default tseslint.config(
   },
   {
     files: [
+      "**/metro.config.js",
       "packages/gyp-to-cmake/bin/*.js",
       "packages/host/bin/*.mjs",
       "packages/host/scripts/*.mjs",

package.json

@@ -26,7 +26,8 @@
     "test": "npm test --workspace react-native-node-api --workspace cmake-rn --workspace gyp-to-cmake --workspace node-addon-examples",
     "bootstrap": "node --run build && npm run bootstrap --workspaces --if-present",
     "prerelease": "node --run build && npm run prerelease --workspaces --if-present",
-    "release": "changeset publish"
+    "release": "changeset publish",
+    "init-macos-test-app": "node scripts/init-macos-test-app.ts"
   },
   "author": {
     "name": "Callstack",
@@ -64,6 +65,7 @@
     "globals": "^16.0.0",
     "prettier": "^3.6.2",
     "react-native": "0.81.4",
+    "read-pkg": "^9.0.1",
     "tsx": "^4.20.5",
     "typescript": "^5.8.0",
     "typescript-eslint": "^8.38.0"

packages/ferric-example/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@react-native-node-api/ferric-example",
+  "version": "0.1.1",
   "private": true,
   "type": "commonjs",
-  "version": "0.1.1",
   "homepage": "https://github.com/callstackincubator/react-native-node-api",
   "repository": {
     "type": "git",
@@ -11,6 +11,12 @@
   },
   "main": "ferric_example.js",
   "types": "ferric_example.d.ts",
+  "files": [
+    "ferric_example.js",
+    "ferric_example.d.ts",
+    "ferric_example.apple.node",
+    "ferric_example.android.node"
+  ],
   "scripts": {
     "build": "ferric build",
     "bootstrap": "node --run build"

packages/ferric/src/cargo.ts

@@ -19,22 +19,46 @@ import {
   isThirdTierTarget,
 } from "./targets.js";
 
-const APPLE_XCFRAMEWORK_CHILDS_PER_TARGET: Record<AppleTargetName, string> = {
-  "aarch64-apple-darwin": "macos-arm64_x86_64", // Universal
-  "x86_64-apple-darwin": "macos-arm64_x86_64", // Universal
+/**
+ * A per apple target mapping to a list of xcframework slices in order of priority
+ */
+const APPLE_XCFRAMEWORK_SLICES_PER_TARGET: Record<AppleTargetName, string[]> = {
+  "aarch64-apple-darwin": [
+    "macos-arm64_x86_64", // Universal
+    "macos-arm64",
+  ],
+  "x86_64-apple-darwin": [
+    "macos-arm64_x86_64", // Universal
+    "macos-x86_64",
+  ],
 
-  "aarch64-apple-ios": "ios-arm64",
-  "aarch64-apple-ios-sim": "ios-arm64_x86_64-simulator", // Universal
-  "x86_64-apple-ios": "ios-arm64_x86_64-simulator", // Universal
+  "aarch64-apple-ios": ["ios-arm64"],
+  "aarch64-apple-ios-sim": [
+    "ios-arm64_x86_64-simulator", // Universal
+    "ios-arm64-simulator",
+  ],
+  "x86_64-apple-ios": [
+    "ios-arm64_x86_64-simulator", // Universal
+    "ios-x86_64-simulator",
+  ],
 
-  "aarch64-apple-visionos": "xros-arm64",
-  "aarch64-apple-visionos-sim": "xros-arm64_x86_64-simulator", // Universal
+  "aarch64-apple-visionos": ["xros-arm64"],
+  "aarch64-apple-visionos-sim": [
+    "xros-arm64_x86_64-simulator", // Universal
+    "xros-arm64-simulator",
+  ],
   // The x86_64 target for vision simulator isn't supported
   // see https://doc.rust-lang.org/rustc/platform-support.html
 
-  "aarch64-apple-tvos": "tvos-arm64",
-  "aarch64-apple-tvos-sim": "tvos-arm64_x86_64-simulator",
-  "x86_64-apple-tvos": "tvos-arm64_x86_64-simulator",
+  "aarch64-apple-tvos": ["tvos-arm64"],
+  "aarch64-apple-tvos-sim": [
+    "tvos-arm64_x86_64-simulator", // Universal
+    "tvos-arm64-simulator",
+  ],
+  "x86_64-apple-tvos": [
+    "tvos-arm64_x86_64-simulator", // Universal
+    "tvos-x86_64-simulator",
+  ],
 
   // "aarch64-apple-ios-macabi": "", // Catalyst
   // "x86_64-apple-ios-macabi": "ios-x86_64-simulator",
@@ -145,11 +169,19 @@ export function getTargetAndroidPlatform(target: AndroidTargetName) {
 }
 
 export function getWeakNodeApiFrameworkPath(target: AppleTargetName) {
-  return joinPathAndAssertExistence(
+  const xcframeworkPath = joinPathAndAssertExistence(
     weakNodeApiPath,
     "weak-node-api.xcframework",
-    APPLE_XCFRAMEWORK_CHILDS_PER_TARGET[target],
   );
+  const result = APPLE_XCFRAMEWORK_SLICES_PER_TARGET[target].find((slice) => {
+    const candidatePath = path.join(xcframeworkPath, slice);
+    return fs.existsSync(candidatePath);
+  });
+  assert(
+    result,
+    `No matching slice found in weak-node-api.xcframework for target ${target}`,
+  );
+  return joinPathAndAssertExistence(xcframeworkPath, result);
 }
 
 export function getWeakNodeApiAndroidLibraryPath(target: AndroidTargetName) {

packages/host/apple/NodeApiHostModuleProvider.mm

@@ -0,0 +1,21 @@
+#import "CxxNodeApiHostModule.hpp"
+#import "WeakNodeApiInjector.hpp"
+
+#import <ReactCommon/CxxTurboModuleUtils.h>
+@interface NodeApiHost : NSObject
+
+@end
+
+@implementation NodeApiHost
++ (void)load {
+  callstack::nodeapihost::injectIntoWeakNodeApi();
+
+  facebook::react::registerCxxModuleToGlobalModuleMap(
+      callstack::nodeapihost::CxxNodeApiHostModule::kModuleName,
+      [](std::shared_ptr<facebook::react::CallInvoker> jsInvoker) {
+        return std::make_shared<callstack::nodeapihost::CxxNodeApiHostModule>(
+            jsInvoker);
+      });
+}
+
+@end

packages/host/react-native-node-api.podspec

@@ -25,10 +25,9 @@ Pod::Spec.new do |s|
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => min_ios_version_supported }
   s.source       = { :git => "https://github.com/callstackincubator/react-native-node-api.git", :tag => "#{s.version}" }
 
-  s.source_files = "ios/**/*.{h,m,mm}", "cpp/**/*.{hpp,cpp,c,h}", "weak-node-api/include/*.h", "weak-node-api/*.hpp"
+  s.source_files = "apple/**/*.{h,m,mm}", "cpp/**/*.{hpp,cpp,c,h}", "weak-node-api/include/*.h", "weak-node-api/*.hpp"
   s.public_header_files = "weak-node-api/include/*.h"
 
   s.vendored_frameworks = "auto-linked/apple/*.xcframework", "weak-node-api/weak-node-api.xcframework"