Refactored prebuild of react native dependencies #49614

chrfalch · 2025-02-22T19:52:59Z

Summary:

Refactored, extended and implemented almost all (except for Folly) dependencies:

Refactored prebuild into separate folder with simple cli interface
Added scheme parameter to be able to work with multiple frameworks
Refactored steps so that cleaning happens before building (easier to see / debug the output)
Added support for more configuration settings
- Using glob for setting files (easier to convert from podspec)
- Added more flexible configuration settings for c/c++ compiler
- Added support for including resources (copied to Resources in framework)
- Changed copyHeaderRule to headerSkipFolderNames which takes a partial path that will be removed from the target directory when copying headers
- Added support for prepareScript to be a direct command (if it is not a file)
Added code generation of Package.swift
Added prebuild of:
- glog
- double-conversion
- fast_float
- fmt
- boost
- socket-rocket
Added support for embedding resources
Added support for copying resource bundles
Updated gitignore.

Changelog:

[INTERNAL] - Changed and extended prebuild of React Native Dependencies

Test Plan:

Tested in this AppDelegate.mm:

Imports:

#import "AppDelegate.h"
#import <glog/logging.h>
#import <double-conversion.h>
#include <fmt/core.h>
#include <boost/assert.hpp>
#include <fast_float/fast_float.h>
#include <string>
#import <SocketRocket/SRWebSocket.h>

Code:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  std::string input = "3.1416 xyz ";
  double_conversion::DoubleToStringConverter::EcmaScriptConverter();
  LOG(INFO) << "Hello from GLOG";
  fmt::print("Hello, world from FMT!\n");
  BOOST_ASSERT(100 == 100);
  double result;
  fast_float::from_chars(input.data(), input.data() + input.size(), result);
  LOG(INFO) << "Answer :" << result;

  NSArray *frameworks = [NSBundle allFrameworks];

  for (NSBundle *framework in frameworks) {
    NSString *frameworkName = framework.bundleURL.lastPathComponent;
    if ([frameworkName isEqualToString: @"ReactNativeDependencies.framework"]) {
      NSBundle *bundle = [NSBundle bundleWithURL:[framework bundleURL]];
      NSURL *bundleURL = [bundle URLForResource:@"ReactNativeDependencies_glog" withExtension:@"bundle"];
      NSBundle *resourceBundle = [NSBundle bundleWithURL:bundleURL];
      NSURL* url = [resourceBundle URLForResource:@"PrivacyInfo" withExtension:@"xcprivacy"];
      if (url == nil) {
        @throw [NSException exceptionWithName:@"ResourceNotFoundException"
                                       reason:@"Could not find PrivacyInfo.xcprivacy in ReactNativeDependencies_glog bundle"
                                     userInfo:nil];
      }
      break;
    }
  }
  return YES;
}

@throw

- Refactored prebuild into separate folder with simple cli interface - Added scheme parameter to be able to work with multiple frameworks - Refactored steps so that cleaning happens before building (easier to see / debug the output) - Added support for more configuration settings - Using glob for setting files (easier to convert from podspec) - Added more flexible configuration settings for c/c++ compiler - Added support for including resources (copied to Resources in framework) - Changed `copyHeaderRule` to `headerSkipFolderNames` which takes a partial path that will be removed from the target directory when copying headers - Added support for prepareScript to be a direct command (if it is not a file) - Added code generation of Package.swift - Added prebuild of: - glog - double-conversion - fast_float - fmt - boost - socket-rocket - Added support for embedding resources - Added support for copying resource bundles - Updated gitignore. Tested in this `AppDelegate.mm`: Imports: ```obj-c #import "AppDelegate.h" #import <glog/logging.h> #import <double-conversion.h> #include <fmt/core.h> #include <boost/assert.hpp> #include <fast_float/fast_float.h> #include <string> #import <SocketRocket/SRWebSocket.h> ``` Code: ```obj-c - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { std::string input = "3.1416 xyz "; double_conversion::DoubleToStringConverter::EcmaScriptConverter(); LOG(INFO) << "Hello from GLOG"; fmt::print("Hello, world from FMT!\n"); BOOST_ASSERT(100 == 100); double result; fast_float::from_chars(input.data(), input.data() + input.size(), result); LOG(INFO) << "Answer :" << result; NSArray *frameworks = [NSBundle allFrameworks]; for (NSBundle *framework in frameworks) { NSString *frameworkName = framework.bundleURL.lastPathComponent; if ([frameworkName isEqualToString: @"ReactNativeDependencies.framework"]) { NSBundle *bundle = [NSBundle bundleWithURL:[framework bundleURL]]; NSURL *bundleURL = [bundle URLForResource:@"ReactNativeDependencies_glog" withExtension:@"bundle"]; NSBundle *resourceBundle = [NSBundle bundleWithURL:bundleURL]; NSURL* url = [resourceBundle URLForResource:@"PrivacyInfo" withExtension:@"xcprivacy"]; if (url == nil) { @throw [NSException exceptionWithName:@"ResourceNotFoundException" reason:@"Could not find PrivacyInfo.xcprivacy in ReactNativeDependencies_glog bundle" userInfo:nil]; } break; } } return YES; } ```

cipolleschi

I had some time and I went through the code as I was too curious!

Great job, really, the code is much cleaner and it reads much better.

I left some questions here and there and also some suggestions. There are a couple of bits that I'd rather we change, but we can discuss them on Monday.

cipolleschi · 2025-02-23T17:09:34Z

scripts/releases/prebuild/build.js

+      `${scheme}.framework`,
+      'Headers',
+    );
+    if (fs.existsSync(headerFolder)) {


we can probably skip this step. We can always delete the folder, if it's not there, nothing happens.

cipolleschi · 2025-02-23T17:15:20Z

scripts/releases/prebuild/configuration.js

+*/
+
+//TODO: Add support for mac,  Mac (catalyst), tvOS, xros and xrsimulator
+const platforms /*: $ReadOnlyArray<Platform> */ = ['iOS', 'iOS Simulator'];


We should handle all the OOT platforms here. In the script in main, I already listed them. I'd also use all lowercase letters and I'd reuse what is there in the script in main.

Also, glog now builds for all the platforms. Can we verify that this is true also for all the other dependencies?

cipolleschi · 2025-02-23T17:16:24Z

scripts/releases/prebuild/index.js

+  const argv = await cli.argv;
+
+  // Verify that the platforms argument is valid
+  const invalidPlatforms = arrayLike(argv.platforms).filter(


I'd rather extract all the validation in a separate function.

cipolleschi · 2025-02-23T17:16:58Z

scripts/releases/prebuild/index.js

+  }
+
+  // Prepare platforms and dependencies
+  const resolved_platforms = platforms.filter(p => argv.platforms.includes(p));


Suggested change

const resolved_platforms = platforms.filter(p => argv.platforms.includes(p));

const resolvedPlatforms = platforms.filter(p => argv.platforms.includes(p));

cipolleschi · 2025-02-23T17:17:08Z

scripts/releases/prebuild/index.js

+
+  // Prepare platforms and dependencies
+  const resolved_platforms = platforms.filter(p => argv.platforms.includes(p));
+  const resolved_dependencies = dependencies.filter(d =>


Suggested change

const resolved_dependencies = dependencies.filter(d =>

const resolvedDependencies = dependencies.filter(d =>

cipolleschi · 2025-02-23T17:23:31Z

scripts/releases/prebuild/types.js

+  headerSkipFolderNames?: string,
+}>;
+
+export type Define = $ReadOnly<{


What do we mean with Defines? To which field does this correspond?

cipolleschi · 2025-02-23T17:29:23Z

scripts/releases/prebuild/setupDependencies.js

+      const targetDir = path.dirname(targetPath);
+
+      fs.mkdirSync(targetDir, {recursive: true});


this should be lifted up from the sourceFiles.forEach. We try to create a folder for each file, otherwise!

cipolleschi · 2025-02-23T18:06:22Z

scripts/releases/prebuild/compose-framework.js

+  if (fs.existsSync(output)) {
+    fs.rmSync(output, {recursive: true, force: true});
+  }


we can probably just try and delete it

cipolleschi · 2025-02-23T18:08:36Z

scripts/releases/prebuild/compose-framework.js

+/**
+ * Copies the bundles in the source frameworks to the target xcframework inside the xcframework's Resources folder
+ */
+function copyBundles(


as we copy the headers to the .framework folders, before creating the XCFrameworks, wouldn't be easier if we do the same for the resources?
Perhaps we can just reuse part fo the code for copying the headers. WDYT?

cipolleschi · 2025-02-23T18:10:39Z

scripts/releases/prebuild/compose-framework.js

+function copyDirectory(source /*: string*/, target /*: string*/) {
+  if (!fs.existsSync(target)) {
+    fs.mkdirSync(target, {recursive: true});
+  }
+  // Read all files in source
+  const files = fs.readdirSync(source);
+  files.forEach(file => {
+    const sourceFile = path.join(source, file);
+    const targetFile = path.join(target, file);
+    if (fs.statSync(sourceFile).isDirectory()) {
+      copyDirectory(sourceFile, targetFile);
+    } else {
+      fs.copyFileSync(sourceFile, targetFile);
+    }
+  });
+}


I'm definitiely not a JS expert, but why implementing the copy like this, instead of using the execSync(mv -p src dest)` command?
This is one line that relies on a well known working code. While reimplementing the move might bring in some bugs.

Perhapst there are some benefits that I'm not aware of...

chrfalch added 2 commits February 22, 2025 20:36

Adjusted comments/docs

d25424e

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Feb 22, 2025

chrfalch changed the title ~~@chrfalch/prebuild react native dependencies~~ Refactored prebuild of react native dependencies Feb 22, 2025

facebook-github-bot added the Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. label Feb 22, 2025

cipolleschi requested changes Feb 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactored prebuild of react native dependencies #49614

Refactored prebuild of react native dependencies #49614

chrfalch commented Feb 22, 2025

cipolleschi left a comment

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

cipolleschi Feb 23, 2025

	const resolved_platforms = platforms.filter(p => argv.platforms.includes(p));
	const resolvedPlatforms = platforms.filter(p => argv.platforms.includes(p));

	const resolved_dependencies = dependencies.filter(d =>
	const resolvedDependencies = dependencies.filter(d =>

		const targetDir = path.dirname(targetPath);

		fs.mkdirSync(targetDir, {recursive: true});

Refactored prebuild of react native dependencies #49614

Are you sure you want to change the base?

Refactored prebuild of react native dependencies #49614

Conversation

chrfalch commented Feb 22, 2025

Summary:

Changelog:

Test Plan:

cipolleschi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment