Update XCFramework setup to work with React Native 0.71.11 #5924
Conversation
The method we used to generate React-Codegen (get_react_codegen_spec) was moved to a different file in newer versions of React Native. We need to update the script for generating it accordingly.
The file was automatically deleted via the generate-podspecs.sh script. It has been manually added as a temporary measure, to enable further testing.
This reverts commit 9707305.
This is intended as a temporary workaround, we should implement a more robust fix before merging.
This reverts commit 21a4fbe.
…0.71-ios # Conflicts: # gutenberg # ios-xcframework/Podfile.lock
The issue is due to RNReanimated looking for react-native in the
node_modules relative to its location, which is how most projects would
be setup. Unfortunately, our projects is not standard.
When running `pod install` or `pod update`, we'd get:
```
Installing RNReanimated 2.17.0 (was 2.9.1-wp-4)
internal/modules/cjs/loader.js:934
throw err;
^
Error: Cannot find module 'react-native/package.json'
Require stack:
- /Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/[eval]
at Function.Module._resolveFilename (internal/modules/cjs/loader.js:931:15)
at Function.resolve (internal/modules/cjs/helpers.js:113:19)
at [eval]:1:9
at Script.runInThisContext (vm.js:134:12)
at Object.runInThisContext (vm.js:310:38)
at internal/process/execution.js:81:19
at [eval]-wrapper:6:22
at evalScript (internal/process/execution.js:80:60)
at internal/main/eval_string.js:27:3 {
code: 'MODULE_NOT_FOUND',
requireStack: [
'/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/[eval]'
]
}
[!] Invalid `RNReanimated.podspec` file: no implicit conversion of nil into String.
# from /var/folders/dq/cdqxvx3s5ps75564rpmb_dc00000gn/T/d20230627-89428-abwplk/RNReanimated.podspec:5
# -------------------------------------------
# reanimated_package_json = JSON.parse(File.read(File.join(__dir__, "package.json")))
> config = find_config()
# assert_no_multiple_instances(config)
# -------------------------------------------
```
Using only our custom specs, the build failed with ``` Multiple commands produce '/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/DerivedData/XCFrameworkScaffold/Build/Products/Debug-iphonesimulator/ReactCommon/ReactCommon.framework/Headers/CallbackWrapper.h' - Target 'ReactCommon' (project 'Pods') has copy command from '/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/Pods/ReactCommon/react/bridging/CallbackWrapper.h' to '/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/DerivedData/XCFrameworkScaffold/Build/Products/Debug-iphonesimulator/ReactCommon/ReactCommon.framework/Headers/CallbackWrapper.h' - Target 'ReactCommon' (project 'Pods') has copy command from '/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/Pods/ReactCommon/react/nativemodule/core/ReactCommon/CallbackWrapper.h' to '/Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/DerivedData/XCFrameworkScaffold/Build/Products/Debug-iphonesimulator/ReactCommon/ReactCommon.framework/Headers/CallbackWrapper.h' ``` However, with this setup the build fails with: ``` /Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/Pods/../../gutenberg/node_modules/react-native/React/FBReactNativeSpec/../../scripts/xcode/with-environment.sh: line 35: .xcode.env: command not found /Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/Pods/../../gutenberg/node_modules/react-native/React/FBReactNativeSpec/../../scripts/xcode/with-environment.sh: line 35: node: command not found [Warning] You need to configure your node path in the environment. You can set it up quickly by running: echo 'export NODE_BINARY=' > .xcode.env in the ios folder. This is needed by React Native to work correctly. We fallback to the DEPRECATED behavior of finding . This will be REMOVED in a future version. You can read more about this here: https://reactnative.dev/docs/environment-setup#optional-configuring-your-environment /Users/gio/Developer/a8c/gutenberg-mobile/ios-xcframework/Pods/../../gutenberg/node_modules/react-native/React/FBReactNativeSpec/../../scripts/xcode/with-environment.sh: line 41: /scripts/find-node-for-xcode.sh: No such file or directory [Error] Could not find node. It looks like that the .xcode.env or .xcode.env.local ```
This way, users can override what CocoaPods does without modifying the codebase via the `.local` file.
Otherwise, we're getting a compilation failure. See wordpress-mobile/WordPress-iOS@eadad98#commitcomment-119894859
They will take place if the process runs with `HERMES_ENABLED` true.
Yep, I also encountered this issue when closing the editor. The interesting part is that the stack trace of the crash looks related to other crashes we currently have in production (example). We couldn't find a consistent way to reproduce them, so maybe now with Hermes we have a new path to debug it 🙏 . UPDATE: It also crashes when reloading Metro.
This is great, I confirmed that I can build the app locally using a local installation of Gutenberg 🎊 .
Thank you so much @mokagio for your effort on the Gutenberg Mobile project and enabling the XCFramework 🙇 ! We can take over the last fixes related to the Editor to mark the XCFramework ready to be merged. We'll share keep you updated on the PRs once we finish the investigations. |
…71.11-xcframework # Conflicts: # bin/generate-podspecs.sh # bundle/ios/App.js # bundle/ios/App.js.map # gutenberg # ios-xcframework/Podfile # ios-xcframework/Podfile.lock # third-party-podspecs/FBReactNativeSpec/FBReactNativeSpec.podspec.json # third-party-podspecs/hermes-engine.podspec.json
|
Wanna run full suite of Android and iOS UI tests? Click here and 'Approve' CI job! |
I managed to provide a fix to the crash mentioned in the PR's description 🎊 , more info in this comment. I tested using a local build with local Gutenberg installation and confirmed the crash is no longer happening. However, after updating the upstream branch (17eae86) looks like something got broken in the CI 🤔. I'll investigate further tomorrow to find out what recent change caused the issue. Error: |
|
I investigated the issue shared in this comment and seems the problem is caused by the fact that the As far as I checked, I think setting the env var in |
I encountered this same issue locally when testing a different PR related to this work. I do not remember which specific PR. At the time, relocating the environment variable logic out of |
|
@mokagio I went ahead and updated the PR with some commits in order to address recent feedback. Let me know if that's ok for you and if you have any concerns/questions. Thanks 🙇 ! |
I fixed this issue via 630b737. I tested on a separate branch and confirmed the CI job is not failing on that step. |
| # We are still trying to decide whether to adopt Hermes or not. | ||
| # | ||
| # This switch allows us to switch between approaches on the go. | ||
| HERMES_ENABLED = ENV.fetch('HERMES_ENABLED', true) |
There was a problem hiding this comment.
We could leave this open until we confirm that Hermes works as expected on iOS through testing.
|
Heads up that we managed to produce an installable build using these changes 🎊. I also tested building the app locally and worked, the only caveat is that I had to use Xcode 14.3 (I was previously using Xcode 14.0). |
|
For the sake of continuing the RN upgrade, I'm going to go ahead and merge this into |
What is says on the title. See also the work done in #5908 and #5912.
Leaving this as a draft so I can rebase freely until I have generated an binary that runs fine via installable builds in Jetpack/WordPress iOS.This build made from
b275a9dbuilds and has green unit tests.However, the editor results empty and crashes when it's dismissedUPDATE: This crash has been fixed as mentioned here..These are warnings thrown in the console when loading the editor:
And this is how it crashes:
For what is worth, the crashes happen in the version using JavaScriptCore instead of Hermes.