change header structure rn deps in XCFrameworks (facebook#50085)

Summary:
Headers are currently copied into each arch in the final xcframework. This is not necessary and will cause a lot of duplication since these files are the same for all archs.

This commit fixes this by only copying headers when we build the final XCFramework:

- ReactNativeDependencies.podspec: Changed the prepare script to be more resilient to different header structs, since we have multiple ways of packaging our tarballs locally and on the servers
- build.js: Removed copying headers when building frameworks
- compose-framework.js: Added copying headers once to the root of the XCFramework.
- rndependencies.rb: updated docs with correct ENV vars

bypass-github-export-checks

## Changelog:

[INTERNAL] - Changes the header structure in our XCFramework to avoid duplication

Pull Request resolved: facebook#50085

Test Plan: Run RNTester with RCT_USE_RN_DEPS=1 to use prebuilt RN Deps.

Reviewed By: javache

Differential Revision: D71385183

Pulled By: cipolleschi

fbshipit-source-id: 160d56dea7f61d1b8d0a45b80f6c0789647358e6

Author: chrfalch

.github/workflows/prebuild-ios.yml

@@ -143,6 +143,12 @@ jobs:
       - name: Yarn Install
         if: steps.restore-xcframework.outputs.cache-hit != 'true'
         uses: ./.github/actions/yarn-install
+      - name: Restore workspace
+        if: steps.restore-xcframework.outputs.cache-hit != 'true'
+        uses: actions/download-artifact@v4
+        with:
+          name: ios-prebuilds-workspace
+          path: packages/react-native/third-party/
       - name: Download slices
         if: steps.restore-xcframework.outputs.cache-hit != 'true'
         uses: actions/download-artifact@v4

packages/react-native/scripts/cocoapods/rndependencies.rb

@@ -11,6 +11,7 @@
 
 ## There are two environment variables that is related to ReactNativeDependencies:
 ## - RCT_USE_RN_DEP: If set to 1, it will use the release tarball from Maven instead of building from source.
+## - RCT_USE_LOCAL_RN_DEP: **TEST ONLY** If set, it will use a local tarball of ReactNativeDependencies if it exists.
 ## - RCT_DEPS_VERSION: **TEST ONLY** If set, it will override the version of ReactNativeDependencies to be used.
 
 ### Adds ReactNativeDependencies as a dependency to the given podspec if we're not

packages/react-native/third-party-podspecs/ReactNativeDependencies.podspec

@@ -41,14 +41,17 @@ Pod::Spec.new do |spec|
   spec.vendored_frameworks  = 'framework/packages/react-native/ReactNativeDependencies.xcframework'
   spec.header_mappings_dir  = 'Headers'
   spec.source_files         = 'Headers/**/*.{h,hpp}'
+
+  # We need to make sure that the headers are copied to the right place - local tar.gz has a different structure
+  # than the one from the maven repo
   spec.prepare_command    = <<-CMD
-    pwd
     CURRENT_PATH=$(pwd)
     mkdir -p Headers
-    BASE_PATH=$(find "$CURRENT_PATH" -type d -name "ios-arm64")
-    rsync -a "$BASE_PATH/ReactNativeDependencies.framework/Headers/" Headers
+    XCFRAMEWORK_PATH=$(find "$CURRENT_PATH" -type d -name "ReactNativeDependencies.xcframework")
+    HEADERS_PATH=$(find "$XCFRAMEWORK_PATH" -type d -name "Headers" | head -n 1)
+    rsync -a "$HEADERS_PATH/" Headers
     mkdir -p framework/packages/react-native
-    rsync -a --remove-source-files "$BASE_PATH/../.." framework/packages/react-native/
+    rsync -a --remove-source-files "$XCFRAMEWORK_PATH/.." framework/packages/react-native/
     find "$CURRENT_PATH" -type d -empty -delete
   CMD
 

scripts/releases/ios-prebuild/build.js

@@ -9,11 +9,7 @@
  * @oncall react_native
  */
 
-const {HEADERS_FOLDER, TARGET_FOLDER} = require('./constants');
-const {getAllFilesRecursively} = require('./folders');
 const {execSync} = require('child_process');
-const fs = require('fs');
-const path = require('path');
 
 /*::
 import type { Dependency, Destination, Platform } from './types';
@@ -45,9 +41,6 @@ async function buildDepenencies(
       ),
     ),
   );
-
-  // Copy headers into framework
-  await copyHeadersToFrameworks(scheme, dependencies, rootFolder, buildFolder);
 }
 
 /**
@@ -72,79 +65,6 @@ async function buildPlatform(
   execSync(command, {cwd: rootFolder, stdio: 'inherit'});
 }
 
-/**
- * Copies headers needed from the package to the framework
- */
-async function copyHeadersToFrameworks(
-  scheme /*: string */,
-  dependencies /*: $ReadOnlyArray<Dependency> */,
-  rootFolder /*: string */,
-  buildFolder /*: string */,
-) {
-  const frameworkFolder = path.join(buildFolder, 'Build', 'Products');
-  const frameworks = fs
-    .readdirSync(frameworkFolder)
-    .filter(f => fs.statSync(path.join(frameworkFolder, f)).isDirectory());
-
-  console.log('Frameworks found:', frameworks.join(', '));
-  const frameworkPaths = frameworks.map(framework =>
-    path.join(frameworkFolder, framework),
-  );
-
-  // Create Header folder
-  frameworkPaths.forEach(fp => {
-    const headerFolder = path.join(
-      fp,
-      'PackageFrameworks',
-      `${scheme}.framework`,
-      'Headers',
-    );
-    // Delete and recreate the folder
-    fs.rmSync(headerFolder, {force: true, recursive: true});
-    fs.mkdirSync(headerFolder, {recursive: true});
-  });
-
-  // Now we can go through all dependencies and copy header files for each depencendy
-  dependencies.forEach(dep => {
-    const depHeadersFolder = path.join(
-      rootFolder,
-      dep.name,
-      TARGET_FOLDER,
-      HEADERS_FOLDER,
-    );
-    const publicHeaderFiles = path.join(depHeadersFolder);
-
-    // Get files in public header files
-    const headerFiles = getAllFilesRecursively(publicHeaderFiles);
-    console.log(
-      `Copying ${headerFiles.length} headers from "${dep.name}" to framework.`,
-    );
-
-    // Copy files into headers in framework
-    headerFiles.map(p => {
-      frameworkPaths.forEach(fp => {
-        const destination = path.join(
-          fp,
-          'PackageFrameworks',
-          `${scheme}.framework`,
-          'Headers',
-          p.replace(publicHeaderFiles, ''),
-        );
-
-        // Create folder if it doesn't exist
-        if (!fs.existsSync(path.dirname(destination))) {
-          fs.mkdirSync(path.dirname(destination), {
-            force: true,
-            recursive: true,
-          });
-        }
-        // Copy
-        fs.copyFileSync(p, destination);
-      });
-    });
-  });
-}
-
 module.exports = {
   buildDepenencies,
 };

scripts/releases/ios-prebuild/compose-framework.js

@@ -9,13 +9,13 @@
  * @oncall react_native
  */
 
+const {HEADERS_FOLDER, TARGET_FOLDER} = require('./constants');
 const {execSync} = require('child_process');
 const fs = require('fs');
 const path = require('path');
 
 /*::
 import type { Dependency, Platform } from './types';
-import {exec} from "child_process";
 */
 
 /**
@@ -64,6 +64,9 @@ async function createFramework(
   // Copy bundles into the framework
   copyBundles(scheme, dependencies, output, frameworkPaths);
 
+  // Copy headers to the framework - start by building the Header folder
+  await copyHeaders(scheme, dependencies, rootFolder);
+
   // Copy Symbols to symbols folder
   const symbolPaths = frameworkPaths.map(framework =>
     path.join(framework, `${scheme}.framework.dSYM`),
@@ -78,6 +81,40 @@ async function createFramework(
   }
 }
 
+/**
+ * Copies headers needed from the package to a Header folder that we'll pass to
+ * each framework arch type
+ */
+async function copyHeaders(
+  scheme /*: string */,
+  dependencies /*: $ReadOnlyArray<Dependency> */,
+  rootFolder /*: string */,
+) {
+  console.log('Copying header files for dependencies...');
+
+  // Create and clean the header folder
+  const headeDestinationFolder = path.join(
+    rootFolder,
+    `${scheme}.xcframework`,
+    'Headers',
+  );
+  fs.rmSync(headeDestinationFolder, {force: true, recursive: true});
+  fs.mkdirSync(headeDestinationFolder, {recursive: true});
+
+  // Now we can go through all dependencies and copy header files for each depencendy
+  dependencies.forEach(dep => {
+    const depHeaders = path.join(
+      rootFolder,
+      dep.name,
+      TARGET_FOLDER,
+      HEADERS_FOLDER,
+    );
+
+    // Copy all header files from the dependency to headerTempFolder
+    execSync(`cp -r ${depHeaders}/* ${headeDestinationFolder}/`);
+  });
+}
+
 /**
  * Copies the bundles in the source frameworks to the target xcframework inside the xcframework's Resources folder
  */