mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Ruslan Shestopalyuk
e3183739bb
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/53300 # Changelog: [Internal] - This adds two new modes to Fantom, allowing to run the native (C++) side with enabling either: * Address sanitizer, which would detect memory overwrites * Thread sanitizer, which can detect potential threading issues, such as race conditions This are opt-in for now. Currently, both modes already detect different errors, which have a high chance to be real issues and have to be fixed. Reviewed By: lenaic Differential Revision: D80339524 fbshipit-source-id: 784ddb9f0af79a04b074e107e4955724d54d5685
113 lines
3.5 KiB
JavaScript
113 lines
3.5 KiB
JavaScript
/**
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* @flow strict
|
|
* @format
|
|
*/
|
|
|
|
const VALID_ENVIRONMENT_VARIABLES = [
|
|
'FANTOM_DEBUG_CPP',
|
|
'FANTOM_ENABLE_ASAN',
|
|
'FANTOM_ENABLE_TSAN',
|
|
'FANTOM_ENABLE_CPP_DEBUGGING',
|
|
'FANTOM_FORCE_CI_MODE',
|
|
'FANTOM_FORCE_OSS_BUILD',
|
|
'FANTOM_FORCE_TEST_MODE',
|
|
'FANTOM_LOG_COMMANDS',
|
|
'FANTOM_PRINT_OUTPUT',
|
|
'FANTOM_DEBUG_JS',
|
|
'FANTOM_PROFILE_JS',
|
|
'FANTOM_ENABLE_JS_MEMORY_INSTRUMENTATION',
|
|
];
|
|
|
|
/**
|
|
* Prints the output of the Fantom tester to the test output.
|
|
*/
|
|
export const printCLIOutput: boolean = Boolean(process.env.FANTOM_PRINT_OUTPUT);
|
|
|
|
/**
|
|
* Logs all external commands executed by the runner.
|
|
*/
|
|
export const logCommands: boolean = Boolean(process.env.FANTOM_LOG_COMMANDS);
|
|
|
|
/**
|
|
* Enables the C++ debugger for the current test run.
|
|
*/
|
|
export const debugCpp: boolean =
|
|
Boolean(process.env.FANTOM_DEBUG_CPP) ||
|
|
// Legacy
|
|
Boolean(process.env.FANTOM_ENABLE_CPP_DEBUGGING);
|
|
|
|
/**
|
|
* Indicates if the current test run is done in an OSS environment (as opposed
|
|
* to internal Meta infra).
|
|
*/
|
|
export const isOSS: boolean = Boolean(process.env.FANTOM_FORCE_OSS_BUILD);
|
|
|
|
/**
|
|
* Indicates if the current test run is done in CI, which forces:
|
|
* 1. Prebuilding all binaries (Fantom tester and Hermes compiler).
|
|
* 2. Running benchmarks in test mode (see below).
|
|
*/
|
|
export const isCI: boolean =
|
|
Boolean(process.env.FANTOM_FORCE_CI_MODE) ||
|
|
Boolean(process.env.SANDCASTLE) ||
|
|
Boolean(process.env.GITHUB_ACTIONS);
|
|
|
|
/**
|
|
* Forces benchmarks to run in test mode (running a single time to ensure
|
|
* correctness instead of multiples times to measure performance).
|
|
*/
|
|
export const forceTestModeForBenchmarks: boolean = Boolean(
|
|
process.env.FANTOM_FORCE_TEST_MODE,
|
|
);
|
|
|
|
export const debugJS: boolean = Boolean(process.env.FANTOM_DEBUG_JS);
|
|
|
|
export const profileJS: boolean = Boolean(process.env.FANTOM_PROFILE_JS);
|
|
|
|
/**
|
|
* Enables address sanitizer (ASAN) build mode for the C++ side.
|
|
*/
|
|
export const enableASAN: boolean = Boolean(process.env.FANTOM_ENABLE_ASAN);
|
|
|
|
/**
|
|
* Enables thread sanitizer (TSAN) build mode for the C++ side.
|
|
*/
|
|
export const enableTSAN: boolean = Boolean(process.env.FANTOM_ENABLE_TSAN);
|
|
|
|
export const enableJSMemoryInstrumentation: boolean = Boolean(
|
|
process.env.FANTOM_ENABLE_JS_MEMORY_INSTRUMENTATION,
|
|
);
|
|
|
|
/**
|
|
* Throws an error if there is an environment variable defined with the FANTOM_
|
|
* prefix that is not recognized.
|
|
*/
|
|
export function validateEnvironmentVariables(): void {
|
|
for (const key of Object.keys(process.env)) {
|
|
if (
|
|
key.startsWith('FANTOM_') &&
|
|
!VALID_ENVIRONMENT_VARIABLES.includes(key)
|
|
) {
|
|
throw new Error(
|
|
`Unexpected Fantom environment variable: ${key}=${String(process.env[key])}. Accepted variables are: ${VALID_ENVIRONMENT_VARIABLES.join(', ')}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
// Enabling memory instrumentation is only necessary when taking JS heap
|
|
// snapshots in optimized builds (where it is disabled by default).
|
|
// This isn't supported in CI or in OSS because that would require adding
|
|
// another dimension to the build matrix, duplicating the number of binaries
|
|
// we need to build before starting test execution.
|
|
if ((isCI || isOSS) && enableJSMemoryInstrumentation) {
|
|
throw new Error(
|
|
'Memory instrumentation is not supported in CI or OSS environments, as it requires a custom Hermes build that is not prebuilt in those environments.',
|
|
);
|
|
}
|
|
}
|