fix(android): Append .exe to hermesc binary path for Windows users

[JoseLion]

Summary

Resolves #34116.

In a nutshell, the problem was a missing .exe extension on the hermesc binary path when running on Windows OS. The missing extension causes the method .exists() of the File instance to always return false, so none of the conditions ever met and an error was thrown whenever a release build with Hermes enabled was run on Windows. More details can be found in the comments on the above issues.

Changelog

[Android] [Fixed] - Fix error of release builds with Hermes enabled for Windows users

Test Plan

Reproduce

Changes on Gradle scrips are better tested on an actual application. To reproduce the issue you can:

1. Create or reuse a React Native application with version v0.69.1 on a Windows machine
2. Enable Hermes on Android following the steps on the documentation
3. Clean the build folder: cd android && ./gradlew clean
4. Bundle the JS and assets for a release version: ./gradlew bundleReleaseJsAndAssets
5. The build fails with the following error:

Execution failed for task ':app:bundleReleaseJsAndAssets'.
> java.lang.Exception: Couldn't determine Hermesc location. Please set `project.ext.react.hermesCommand` to the path of the hermesc binary file. node_modules/react-native/sdks/hermesc/%OS-BIN%/hermesc

Test the changes

Follow the same steps above using the fix on this PR and the error should disappear 🙂

[facebook-github-bot]

Hi @JoseLion!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[JoseLion]

Added this line because vscode-java extension creates this folder on Java projects 🙂

[cortinico]

I have the same problem. Still I won't add bin/ here (I added it in my global .gitignore).

The problem is on VS Code's end, as they used a folder name which is too generic and potentially used in production. This has the risk of accidentally make us skip artifacts during NPM packaging or git commits.

[analysis-bot]

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	7,799,665	-2,828
android	hermes	armeabi-v7a	7,194,370	-892
android	hermes	x86	8,110,306	-2,191
android	hermes	x86_64	8,090,015	-2,022
android	jsc	arm64-v8a	9,696,735	+0
android	jsc	armeabi-v7a	8,451,995	+0
android	jsc	x86	9,647,485	+0
android	jsc	x86_64	10,245,252	+0

Base commit: c37f719
Branch: main

[cortinico]

Thank you very much for doing this @JoseLion

[cortinico]

I have the same problem. Still I won't add bin/ here (I added it in my global .gitignore).

The problem is on VS Code's end, as they used a folder name which is too generic and potentially used in production. This has the risk of accidentally make us skip artifacts during NPM packaging or git commits.

[cortinico]

Great stuff. Can I ask you to do the same logic here:

react-native/packages/react-native-gradle-plugin/src/main/kotlin/com/facebook/react/utils/PathUtils.kt

Lines 125 to 161 in c37f719

	internal fun detectOSAwareHermesCommand(projectRoot: File, hermesCommand: String): String {
	// 1. If the project specifies a Hermes command, don't second guess it.
	if (hermesCommand.isNotBlank()) {
	val osSpecificHermesCommand =
	if ("%OS-BIN%" in hermesCommand) {
	hermesCommand.replace("%OS-BIN%", getHermesOSBin())
	} else {
	hermesCommand
	}
	return osSpecificHermesCommand
	// Execution on Windows fails with / as separator
	.replace('/', File.separatorChar)
	}
	// 2. If the project is building hermes-engine from source, use hermesc from there
	val builtHermesc =
	getBuiltHermescFile(projectRoot, System.getenv("REACT_NATIVE_OVERRIDE_HERMES_DIR"))
	if (builtHermesc.exists()) {
	return builtHermesc.absolutePath
	}
	// 3. If the react-native contains a pre-built hermesc, use it.
	val prebuiltHermesPath =
	HERMESC_IN_REACT_NATIVE_PATH.replace("%OS-BIN%", getHermesOSBin())
	// Execution on Windows fails with / as separator
	.replace('/', File.separatorChar)
	val prebuiltHermes = File(projectRoot, prebuiltHermesPath)
	if (prebuiltHermes.exists()) {
	return prebuiltHermes.absolutePath
	}
	error(
	"Couldn't determine Hermesc location. " +
	"Please set `react.hermesCommand` to the path of the hermesc binary file. " +
	"node_modules/react-native/sdks/hermesc/%OS-BIN%/hermesc")
	}

[JoseLion]

Sure! Thanks for the review BTW 🙂

[JoseLion]

Done! I took a slightly different approach since the Kotlin was a bit different, but it's still the same concept 😁

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[analysis-bot]

Platform	Engine	Arch	Size (bytes)	Diff
ios	-	universal	n/a	--

Base commit: c37f719
Branch: main

[facebook-github-bot]

@philIip has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[cortinico]

Sorry this took longer. This can be merged 👍
I've also added tests which will appear in the final commit

[react-native-bot]

This pull request was successfully merged by @JoseLion in 7fcdb9d.

^{When will my fix make it into a release? | Upcoming Releases}