fix: Correctly assign the hermes-engine pod tag when installing pods from a different folder
#38754
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
CLA Signed
Base commit: 1f24750 |
cipolleschi
approved these changes
Aug 3, 2023
|
@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
@cipolleschi merged this pull request in 08688d3. |
lunaleaps
pushed a commit
that referenced
this pull request
Aug 7, 2023
…s from a different folder (#38754) Summary: This PR aims to fix an issue where installing iOS pods from a different directory causes the `hermes-engine` `:tag:` not to be properly resolved. Ever since #37148 was merged, the `setup_hermes` script tries to resolve the `node_modules/react-native/sdks/.hermesversion` file and use its content to generate the pod tag, in order to verify when it changes over time. This works perfectly when installing pods within the `ios` folder, as the `react_native_path` should point to the correct relative folder (`../node_modules/react-native` by default). However, when installing pods from a different directory (the project root, for example) and leveraging the `--project-directory` flag, the file fails to resolve, as the current working directory is considered when resolving the `.hermesversion` file. ### Quick Example: - `react_native_path`: `../node_modules/react-native` (the default config) **Installing pods from the `ios` folder:** - `cd ios` - `bundle exec pod install` - `hermestag_file` resolved path: `$project_root/node_modules/react-native` ✅ - `hermes-engine` `:tag:`: `hermes-2023-03-20-RNv0.72.0-49794cfc7c81fb8f69fd60c3bbf85a7480cc5a77` ✅ **Installing pods from the `$project_root` folder** - `bundle exec pod install --project-directory=ios` - `hermestag_file` resolved path: `$parent_folder/$project_root/node_modules/react-native` ❌ - `hermes-engine` `:tag:`: `''` ❌ ### The fix Turns out that the same file had a resolved reference to the `react-native` folder, assigned to the `react_native_dir` variable: ```ruby react_native_dir = Pod::Config.instance.installation_root.join(react_native_path) ``` By resolving the `.hermesversion` using that folder, we guarantee that the relative path will always reference the directory where the `Podfile` is defined, which is the expected behaviour. ## Changelog: [Internal] - Fix an issue where installing pods from a different directory would fail to resolve `hermes-engine` tags correctly. For more details, see: https://reactnative.dev/contributing/changelogs-in-pull-requests Pull Request resolved: #38754 Test Plan: - Init a new `react-native` repo - Remove the generated `Podfile.lock` file - Navigate to the project root folder - `bundle exec pod install -project-directory=ios` - Check that the `hermes-engine` entry has a properly populated `:tag:` attribute: **Before:** ``` hermes-engine: :podspec: "../node_modules/react-native/sdks/hermes-engine/hermes-engine.podspec" :tag: '' ``` **After:** ``` hermes-engine: :podspec: "../node_modules/react-native/sdks/hermes-engine/hermes-engine.podspec" :tag: hermes-2023-03-20-RNv0.72.0-49794cfc7c81fb8f69fd60c3bbf85a7480cc5a77 ``` Reviewed By: cortinico Differential Revision: D48029413 Pulled By: cipolleschi fbshipit-source-id: 82d465abd5c888eeb9eacd32858fa4ecf4f8c217
This was referenced Aug 10, 2023
This was referenced Jan 4, 2024
This was referenced Feb 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
This PR aims to fix an issue where installing iOS pods from a different directory causes the
hermes-engine:tag:not to be properly resolved.Ever since #37148 was merged, the
setup_hermesscript tries to resolve thenode_modules/react-native/sdks/.hermesversionfile and use its content to generate the pod tag, in order to verify when it changes over time.This works perfectly when installing pods within the
iosfolder, as thereact_native_pathshould point to the correct relative folder (../node_modules/react-nativeby default).However, when installing pods from a different directory (the project root, for example) and leveraging the
--project-directoryflag, the file fails to resolve, as the current working directory is considered when resolving the.hermesversionfile.Quick Example:
react_native_path:../node_modules/react-native(the default config)Installing pods from the
iosfolder:cd iosbundle exec pod installhermestag_fileresolved path:$project_root/node_modules/react-native✅hermes-engine:tag::hermes-2023-03-20-RNv0.72.0-49794cfc7c81fb8f69fd60c3bbf85a7480cc5a77✅Installing pods from the
$project_rootfolderbundle exec pod install --project-directory=ioshermestag_fileresolved path:$parent_folder/$project_root/node_modules/react-native❌hermes-engine:tag::''❌The fix
Turns out that the same file had a resolved reference to the
react-nativefolder, assigned to thereact_native_dirvariable:By resolving the
.hermesversionusing that folder, we guarantee that the relative path will always reference the directory where thePodfileis defined, which is the expected behaviour.Changelog:
Test Plan:
react-nativerepoPodfile.lockfilebundle exec pod install -project-directory=ioshermes-engineentry has a properly populated:tag:attribute:Before:
After: