Introduce isOSS (#52222)

Summary:
Pull Request resolved: #52222

Changelog: [Internal]
Introduce environment option to force usage of OSS fantom test runner.
If env is not set - check for BUCK file in tester which is checked in for FB but not for OSS.

Reviewed By: rubennorte

Differential Revision: D77160761

Author: andrewdacenko

package.json

@@ -32,7 +32,7 @@
     "test-typescript": "tsc -p packages/react-native/types/tsconfig.json",
     "test-generated-typescript": "tsc -p packages/react-native/types_generated/tsconfig.test.json",
     "test": "jest",
-    "fantom": "JS_DIR='..' yarn jest --config private/react-native-fantom/config/jest.config.js",
+    "fantom": "./scripts/fantom.sh",
     "trigger-react-native-release": "node ./scripts/releases-local/trigger-react-native-release.js",
     "update-lock": "npx yarn-deduplicate"
   },

private/react-native-fantom/build.gradle.kts

@@ -15,6 +15,24 @@ plugins {
   alias(libs.plugins.download)
 }
 
+// This is the version of CMake we're requesting to the Android SDK to use.
+// If missing it will be downloaded automatically. Only CMake versions shipped with the
+// Android SDK are supported (you can find them listed in the SDK Manager of Android Studio).
+val cmakeVersion = System.getenv("CMAKE_VERSION") ?: "3.30.5"
+val cmakePath = "${getSDKPath()}/cmake/$cmakeVersion"
+val cmakeBinaryPath = "${cmakePath}/bin/cmake"
+val ndkBuildJobs = Runtime.getRuntime().availableProcessors().toString()
+
+fun getSDKPath(): String {
+  val androidSdkRoot = System.getenv("ANDROID_SDK_ROOT")
+  val androidHome = System.getenv("ANDROID_HOME")
+  return when {
+    !androidSdkRoot.isNullOrBlank() -> androidSdkRoot
+    !androidHome.isNullOrBlank() -> androidHome
+    else -> throw IllegalStateException("Neither ANDROID_SDK_ROOT nor ANDROID_HOME is set.")
+  }
+}
+
 val FOLLY_VERSION = libs.versions.folly.get()
 val GFLAGS_VERSION = libs.versions.gflags.get()
 val NLOHMANNJSON_VERSION = libs.versions.nlohmannjson.get()
@@ -27,15 +45,24 @@ val downloadsDir =
       File("$buildDir/downloads")
     }
 val thirdParty = File("$buildDir/third-party")
+val reportsDir = File("$buildDir/reports")
 val reactNativeRootDir = projectDir.parentFile.parentFile
-val reactAndroidBuildDir = File("$reactNativeRootDir/packages/react-native/ReactAndroid/build")
-val reactAndroidDownloasdDir =
-    File("$reactNativeRootDir/packages/react-native/ReactAndroid/build/downloads")
+val reactNativeDir = File("$reactNativeRootDir/packages/react-native")
+val reactAndroidDir = File("$reactNativeDir/ReactAndroid")
+val reactAndroidBuildDir = File("$reactAndroidDir/build")
+val reactAndroidDownloasdDir = File("$reactAndroidBuildDir/downloads")
+
+val testerDir = File("$projectDir/tester")
+val testerBuildDir = File("$buildDir/tester")
+val testerBuildOutputFileTree =
+    fileTree(testerBuildDir.toString())
+        .include("**/*.cmake", "**/*.marks", "**/compiler_depends.ts", "**/Makefile", "**/link.txt")
 
 val createNativeDepsDirectories by
     tasks.registering {
       downloadsDir.mkdirs()
       thirdParty.mkdirs()
+      reportsDir.mkdirs()
     }
 
 val downloadFollyDest = File(reactAndroidDownloasdDir, "folly-${FOLLY_VERSION}.tar.gz")
@@ -137,3 +164,48 @@ val prepareAllDependencies by
     tasks.registering {
       dependsOn(prepareRNCodegen, prepareHermesDependencies, prepareNative3pDependencies)
     }
+
+val configureFantomTester by
+    tasks.registering(CustomExecTask::class) {
+      dependsOn(prepareAllDependencies)
+      workingDir(testerDir)
+      inputs.dir(testerDir)
+      outputs.files(testerBuildOutputFileTree)
+      val cmdArgs =
+          mutableListOf(
+              cmakeBinaryPath,
+              // Suppress all warnings as this is the Hermes build and we can't fix them.
+              "--log-level=ERROR",
+              "-S",
+              ".",
+              "-B",
+              testerBuildDir.toString(),
+              "-DCMAKE_BUILD_TYPE=Debug",
+              "-DFANTOM_CODEGEN_DIR=$buildDir/codegen",
+              "-DFANTOM_THIRD_PARTY_DIR=$buildDir/third-party",
+              "-DREACT_ANDROID_DIR=$reactAndroidDir",
+              "-DREACT_COMMON_DIR=$reactNativeDir/ReactCommon",
+              "-DREACT_CXX_PLATFORM_DIR=$reactNativeDir/ReactCxxPlatform",
+              "-DREACT_THIRD_PARTY_NDK_DIR=$reactAndroidBuildDir/third-party-ndk")
+      commandLine(cmdArgs)
+      standardOutputFile.set(project.file("$buildDir/reports/configure-fantom_tester.log"))
+      errorOutputFile.set(project.file("$buildDir/reports/configure-fantom_tester.error.log"))
+    }
+
+val buildFantomTester by
+    tasks.registering(CustomExecTask::class) {
+      dependsOn(configureFantomTester)
+      workingDir(testerDir)
+      inputs.files(testerBuildOutputFileTree)
+      commandLine(
+          cmakeBinaryPath,
+          "--build",
+          testerBuildDir.toString(),
+          "--target",
+          "fantom_tester",
+          "-j",
+          ndkBuildJobs,
+      )
+      standardOutputFile.set(project.file("$buildDir/reports/build-fantom_tester.log"))
+      errorOutputFile.set(project.file("$buildDir/reports/build-fantom_tester.error.log"))
+    }

private/react-native-fantom/prepare.sh renamed to private/react-native-fantom/build.sh

@@ -7,5 +7,5 @@
 set -e
 
 pushd ../..
-./gradlew :private:react-native-fantom:prepareAllDependencies
+./gradlew :private:react-native-fantom:buildFantomTester
 popd

private/react-native-fantom/config/metro.config.js

@@ -34,7 +34,10 @@ const config /*: InputConfigT */ = {
   },
   resolver: {
     blockList: /\/RendererProxy\.fb\.js$/, // Disable dependency injection for the renderer
-    sourceExts: ['fb.js', ...rnTesterConfig.resolver.sourceExts],
+    sourceExts:
+      JS_DIR != null
+        ? ['fb.js', ...rnTesterConfig.resolver.sourceExts]
+        : rnTesterConfig.resolver.sourceExts,
     nodeModulesPaths:
       JS_DIR != null ? [path.join(JS_DIR, 'public', 'node_modules')] : [],
     hasteImplModulePath: path.resolve(__dirname, 'hasteImpl.js'),

private/react-native-fantom/package.json

@@ -4,6 +4,9 @@
   "version": "0.0.0",
   "main": "src/index.js",
   "description": "Internal integration testing and benchmarking tool for React Native",
+  "scripts": {
+    "build": "./build.sh"
+  },
   "peerDependencies": {
     "jest": "^29.7.0",
     "jest-snapshot": "^29.7.0"

private/react-native-fantom/runner/EnvironmentOptions.js

@@ -15,3 +15,5 @@ export const logCommands: boolean = Boolean(process.env.FANTOM_LOG_COMMANDS);
 export const enableCppDebugging: boolean = Boolean(
   process.env.FANTOM_ENABLE_CPP_DEBUGGING,
 );
+
+export const isOSS: boolean = Boolean(process.env.FANTOM_FORCE_OSS_BUILD);

private/react-native-fantom/runner/runner.js

@@ -9,6 +9,7 @@
  */
 
 import type {FailureDetail, TestSuiteResult} from '../runtime/setup';
+import type {TestSnapshotResults} from '../runtime/snapshotContext';
 import type {
   AsyncCommandResult,
   ConsoleLogMessage,
@@ -25,6 +26,7 @@ import {
   updateSnapshotsAndGetJestSnapshotResult,
 } from './snapshotUtils';
 import {
+  HermesVariant as HermesVariantEnum,
   getBuckModesForPlatform,
   getBuckOptionsForHermes,
   getDebugInfoFromCommandResult,
@@ -34,6 +36,7 @@ import {
   printConsoleLog,
   runBuck2,
   runBuck2Sync,
+  runCommand,
   symbolicateStackTrace,
 } from './utils';
 import fs from 'fs';
@@ -151,22 +154,34 @@ function generateBytecodeBundle({
   isOptimizedMode: boolean,
   hermesVariant: HermesVariant,
 }): void {
-  const hermesCompilerCommandResult = runBuck2Sync(
-    [
-      'run',
-      ...getBuckModesForPlatform(isOptimizedMode),
-      ...getBuckOptionsForHermes(hermesVariant),
-      getHermesCompilerTarget(hermesVariant),
-      '--',
-      '-emit-binary',
-      isOptimizedMode ? '-O' : null,
-      '-max-diagnostic-width',
-      '80',
-      '-out',
-      bytecodePath,
-      sourcePath,
-    ].filter(Boolean),
-  );
+  const hermescArgs = [
+    '-emit-binary',
+    isOptimizedMode ? '-O' : null,
+    '-max-diagnostic-width',
+    '80',
+    '-out',
+    bytecodePath,
+    sourcePath,
+  ].filter(Boolean);
+  const hermesCompilerCommandResult = false
+    ? runCommand(
+        path.join(
+          __dirname,
+          '..',
+          '..',
+          '..',
+          'packages/react-native/ReactAndroid/hermes-engine/build/hermes/bin/hermesc',
+        ),
+        hermescArgs,
+      )
+    : runBuck2Sync([
+        'run',
+        ...getBuckModesForPlatform(isOptimizedMode),
+        ...getBuckOptionsForHermes(hermesVariant),
+        getHermesCompilerTarget(hermesVariant),
+        '--',
+        ...hermescArgs,
+      ]);
 
   if (hermesCompilerCommandResult.status !== 0) {
     throw new Error(getDebugInfoFromCommandResult(hermesCompilerCommandResult));
@@ -215,6 +230,47 @@ module.exports = async function runTest(
   const testResultsByConfig = [];
 
   for (const testConfig of testConfigs) {
+    if (
+      EnvironmentOptions.isOSS &&
+      testConfig.mode === FantomTestConfigMode.Optimized
+    ) {
+      testResultsByConfig.push([
+        {
+          ancestorTitles: ['"@fantom_mode opt" in docblock'],
+          duration: 0,
+          failureDetails: [] as Array<Error>,
+          failureMessages: [] as Array<string>,
+          fullName: 'Optimized mode is not yet supoprted in OSS',
+          numPassingAsserts: 0,
+          snapshotResults: {} as TestSnapshotResults,
+          status: 'pending' as 'passed' | 'failed' | 'pending',
+          testFilePath: testPath,
+          title: 'Optimized mode is not yet supoprted in OSS',
+        },
+      ]);
+      continue;
+    }
+
+    if (testConfig.hermesVariant !== HermesVariantEnum.Hermes) {
+      testResultsByConfig.push([
+        {
+          ancestorTitles: [
+            '"@fantom_hermes_variant static_hermes" in docblock (shermes 🧪)',
+          ],
+          duration: 0,
+          failureDetails: [] as Array<Error>,
+          failureMessages: [] as Array<string>,
+          fullName: 'Static Hermes is not yet supoprted in OSS',
+          numPassingAsserts: 0,
+          snapshotResults: {} as TestSnapshotResults,
+          status: 'pending' as 'passed' | 'failed' | 'pending',
+          testFilePath: testPath,
+          title: 'Static Hermes is not yet supoprted in OSS',
+        },
+      ]);
+      continue;
+    }
+
     const entrypointContents = entrypointTemplate({
       testPath: `${path.relative(BUILD_OUTPUT_PATH, testPath)}`,
       setupModulePath: `${path.relative(BUILD_OUTPUT_PATH, setupModulePath)}`,
@@ -261,28 +317,37 @@ module.exports = async function runTest(
       });
     }
 
-    const rnTesterCommandResult = runBuck2(
-      [
-        'run',
-        ...getBuckModesForPlatform(
-          testConfig.mode === FantomTestConfigMode.Optimized,
-        ),
-        ...getBuckOptionsForHermes(testConfig.hermesVariant),
-        '//xplat/js/react-native-github/private/react-native-fantom/tester:tester',
-        '--',
-        '--bundlePath',
-        testConfig.mode === FantomTestConfigMode.DevelopmentWithSource
-          ? testJSBundlePath
-          : testBytecodeBundlePath,
-        '--featureFlags',
-        JSON.stringify(testConfig.flags.common),
-        '--minLogLevel',
-        EnvironmentOptions.printCLIOutput ? 'info' : 'error',
-      ],
-      {
-        withFDB: EnvironmentOptions.enableCppDebugging,
-      },
-    );
+    const rnTesterCommandArgs = [
+      '--bundlePath',
+      testConfig.mode === FantomTestConfigMode.DevelopmentWithSource
+        ? testJSBundlePath
+        : testBytecodeBundlePath,
+      '--featureFlags',
+      JSON.stringify(testConfig.flags.common),
+      '--minLogLevel',
+      EnvironmentOptions.printCLIOutput ? 'info' : 'error',
+    ];
+
+    const rnTesterCommandResult = EnvironmentOptions.isOSS
+      ? runCommand(
+          path.join(__dirname, '..', 'build', 'tester', 'fantom_tester'),
+          rnTesterCommandArgs,
+        )
+      : runBuck2(
+          [
+            'run',
+            ...getBuckModesForPlatform(
+              testConfig.mode === FantomTestConfigMode.Optimized,
+            ),
+            ...getBuckOptionsForHermes(testConfig.hermesVariant),
+            '//xplat/js/react-native-github/private/react-native-fantom/tester:tester',
+            '--',
+            ...rnTesterCommandArgs,
+          ],
+          {
+            withFDB: EnvironmentOptions.enableCppDebugging,
+          },
+        );
 
     const processedResult = await processRNTesterCommandResult(
       rnTesterCommandResult,

private/react-native-fantom/tester/CMakeLists.txt

@@ -7,36 +7,21 @@ cmake_minimum_required(VERSION 3.13)
 set(CMAKE_VERBOSE_MAKEFILE on)
 
 project(fantom_tester)
-find_library(LIB_HERMES libhermes
-  NAMES hermes
-  HINTS ${REACT_ANDROID_DIR}/hermes-engine/build/hermes/API/hermes
-  REQUIRED)
-# Ensure the library path is correct and the library exists
-if(NOT LIB_HERMES)
-  message(FATAL_ERROR "libhermes not found at the specified path.")
-endif()
-# Check if the found library is a framework (macOS specific)
-get_filename_component(LIB_EXT ${LIB_HERMES} EXT)
-if(LIB_EXT STREQUAL ".framework")
-  # For frameworks, we need to use a different approach
-  add_library(hermes-engine::libhermes INTERFACE IMPORTED)
-  set_target_properties(hermes-engine::libhermes PROPERTIES
-    INTERFACE_LINK_LIBRARIES ${LIB_HERMES})
-else()
-  # For regular libraries, use ALIAS as before
-  add_library(hermes-engine::libhermes ALIAS ${LIB_HERMES})
-endif()
-
-find_package(OpenSSL REQUIRED)
 
 include_directories(${REACT_ANDROID_DIR}/hermes-engine/build/prefab-headers)
 
-include(${REACT_COMMON_DIR}/cmake-utils/react-native-flags.cmake)
-
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules/")
-
 include(Deps)
 
+find_library(LIB_HERMES libhermes
+  NAMES hermes
+  HINTS ${REACT_ANDROID_DIR}/hermes-engine/build/hermes/API/hermes
+  REQUIRED)
+add_library(hermes-engine::libhermes INTERFACE IMPORTED)
+set_target_properties(hermes-engine::libhermes PROPERTIES
+  INTERFACE_LINK_LIBRARIES ${LIB_HERMES})
+find_package(OpenSSL REQUIRED)
+
 # Boost in NDK is not compatible with desktop build
 add_third_party_subdir(boost)