Add command to patch xcode project

Author: kraenhansen

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

@@ -3,19 +3,7 @@ require "json"
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
 require_relative "./scripts/patch-hermes"
-
-NODE_PATH ||= `which node`.strip
-CLI_COMMAND ||= "'#{NODE_PATH}' '#{File.join(__dir__, "dist/node/cli/run.js")}'"
-COPY_FRAMEWORKS_COMMAND ||= "#{CLI_COMMAND} link --apple '#{Pod::Config.instance.installation_root}'"
-
-# We need to run this now to ensure the xcframeworks are copied vendored_frameworks are considered
-XCFRAMEWORKS_DIR ||= File.join(__dir__, "xcframeworks")
-unless defined?(@xcframeworks_copied)
-  puts "Executing #{COPY_FRAMEWORKS_COMMAND}"
-  system(COPY_FRAMEWORKS_COMMAND) or raise "Failed to copy xcframeworks"
-  # Setting a flag to avoid running this command on every require
-  @xcframeworks_copied = true
-end
+require_relative "./scripts/patch-xcode-project"
 
 if ENV['RCT_NEW_ARCH_ENABLED'] == '0'
   Pod::UI.warn "React Native Node-API doesn't support the legacy architecture (but RCT_NEW_ARCH_ENABLED == '0')"
@@ -35,16 +23,6 @@ Pod::Spec.new do |s|
 
   s.dependency "weak-node-api"
 
-  s.vendored_frameworks = "auto-linked/apple/*.xcframework"
-  s.script_phase = {
-    :name => 'Copy Node-API xcframeworks',
-    :execution_position => :before_compile,
-    :script => <<-CMD
-      set -e
-      #{COPY_FRAMEWORKS_COMMAND}
-    CMD
-  }
-
   # Use install_modules_dependencies helper to install the dependencies (requires React Native version >=0.71.0).
   # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
   if respond_to?(:install_modules_dependencies, true)

packages/host/scripts/patch-xcode-project.rb

@@ -0,0 +1,13 @@
+unless defined?(@exit_hooks_installed)
+  # Setting a flag to avoid running this command on every require
+  @exit_hooks_installed = true
+
+  NODE_PATH ||= `which node`.strip
+  CLI_COMMAND ||= "'#{NODE_PATH}' '#{File.join(__dir__, "../dist/node/cli/run.js")}'"
+  PATCH_XCODE_PROJECT_COMMAND ||= "#{CLI_COMMAND} patch-xcode-project '#{Pod::Config.instance.installation_root}'"
+  
+  # Using an at_exit hook to ensure the command is executed after the pod install is complete
+  at_exit do
+    system(PATCH_XCODE_PROJECT_COMMAND) or raise "Failed to patch the Xcode project"
+  end
+end

packages/host/src/node/cli/apple.ts

@@ -3,16 +3,64 @@ import path from "node:path";
 import fs from "node:fs";
 
 import plist from "@expo/plist";
+import * as xcode from "@bacons/xcode";
+import * as xcodeJson from "@bacons/xcode/json";
 import * as zod from "zod";
 
-import { spawn } from "@react-native-node-api/cli-utils";
+import { chalk, spawn } from "@react-native-node-api/cli-utils";
 
 import { getLatestMtime, getLibraryName } from "../path-utils.js";
 import {
   getLinkedModuleOutputPath,
   LinkModuleOptions,
   LinkModuleResult,
 } from "./link-modules.js";
+import { findXcodeProject } from "./xcode-helpers.js";
+
+const PACKAGE_ROOT = path.resolve(__dirname, "..", "..", "..");
+const CLI_PATH = path.resolve(PACKAGE_ROOT, "bin", "react-native-node-api.mjs");
+const BUILD_PHASE_PREFIX = "[Node-API]";
+const BUILD_PHASE_NAME = `${BUILD_PHASE_PREFIX} Copy, rename and sign frameworks`;
+
+export async function ensureXcodeBuildPhase(fromPath: string) {
+  // Locate the app's Xcode project
+  const xcodeProjectPath = await findXcodeProject(fromPath);
+  const pbxprojPath = path.join(xcodeProjectPath, "project.pbxproj");
+  assert(
+    fs.existsSync(pbxprojPath),
+    `Expected a project.pbxproj file at '${pbxprojPath}'`,
+  );
+  const xcodeProject = xcode.XcodeProject.open(pbxprojPath);
+  // Create a build phase on the main target to stage and rename the addon Xcframeworks
+  const mainTarget = xcodeProject.rootObject.getMainAppTarget();
+  assert(mainTarget, "Unable to find a main target");
+
+  const existingBuildPhases = mainTarget.props.buildPhases.filter((phase) =>
+    phase.getDisplayName().startsWith(BUILD_PHASE_PREFIX),
+  );
+
+  for (const existingBuildPhase of existingBuildPhases) {
+    console.log(
+      "Removing existing build phase:",
+      chalk.dim(existingBuildPhase.getDisplayName()),
+    );
+    existingBuildPhase.removeFromProject();
+  }
+
+  mainTarget.createBuildPhase(xcode.PBXShellScriptBuildPhase, {
+    name: BUILD_PHASE_NAME,
+    shellScript: [
+      "set -e",
+      `'${process.execPath}' '${CLI_PATH}' link --apple '${fromPath}'`,
+    ].join("\n"),
+  });
+
+  await fs.promises.writeFile(
+    pbxprojPath,
+    xcodeJson.build(xcodeProject.toJSON()),
+    "utf8",
+  );
+}
 
 /**
  * Reads and parses a plist file, converting it to XML format if needed.

packages/host/src/node/cli/program.ts

@@ -26,7 +26,7 @@ import {
 import { command as vendorHermes } from "./hermes";
 import { packageNameOption, pathSuffixOption } from "./options";
 import { linkModules, pruneLinkedModules, ModuleLinker } from "./link-modules";
-import { linkXcframework } from "./apple";
+import { ensureXcodeBuildPhase, linkXcframework } from "./apple";
 import { linkAndroidDir } from "./android";
 
 // We're attaching a lot of listeners when spawning in parallel
@@ -249,3 +249,24 @@ program
       });
     }),
   );
+
+program
+  .command("patch-xcode-project")
+  .description("Patch the Xcode project to include the Node-API build phase")
+  .argument("[path]", "Some path inside the app package", process.cwd())
+  .action(
+    wrapAction(async (pathInput) => {
+      const resolvedPath = path.resolve(process.cwd(), pathInput);
+      console.log(
+        "Patching Xcode project in",
+        prettyPath(resolvedPath),
+        "to include a build phase to copy, rename and sign Node-API frameworks",
+      );
+      assert.equal(
+        process.platform,
+        "darwin",
+        "Patching Xcode project is only supported on macOS",
+      );
+      await ensureXcodeBuildPhase(resolvedPath);
+    }),
+  );