zzos/react-native
1
0
Fork 0
mirror of https://github.com/react/react-native.git synced 2026-09-28 13:23:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document Fantom convention: prefer testing through the public API (#57467)

Browse Source 
Summary:
Pull Request resolved: https://github.com/react/react-native/pull/57467

Adds a convention to the Fantom README recommending that tests exercise React Native through its public API (importing from `react-native`) whenever possible, rather than reaching into internal modules. Exercising the public surface also drives the underlying native (Fabric/TurboModules) code, so tests stay close to real usage and are more resilient to internal refactors.

Changelog:
[Internal]

Reviewed By: christophpurrer

Differential Revision: D110918650

fbshipit-source-id: b19dc4b4a380030196a4e83890aae6720a64c77f
This commit is contained in:
Rubén Norte
2026-07-08 00:45:28 -07:00
committed by meta-codesync[bot]
parent 5e64e90751
commit 7a5ab34451
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
private/react-native-fantom/__docs__/README.md
+13
View File
@@ -180,6 +180,19 @@ hi
### Conventions
- Prefer testing React Native through its public API (import from
`'react-native'`) whenever possible, rather than reaching into internal
modules or relying on private/protected members (e.g. `__`-prefixed methods
and fields such as `__getValue()`). Exercising the public API also drives the
underlying native (Fabric/TurboModules) code, so tests stay close to real
usage and are more resilient to internal refactors. Observe results through
the public surface too — e.g. assert the rendered output
(`root.getRenderedOutput(...)`) or values delivered to public listeners
rather than reading private state.
- When Fantom doesn't support something (a native module, a capability, a way
to observe a result, etc.), it's fine to reach into internals to work around
that limitation. Prefer a short comment explaining why the internal access is
necessary.
- Place test files in `__tests__` directories alongside the code being tested.
- Benchmark tests use the `-benchmark-itest.js` suffix.
- Use `Fantom.runTask()` to render and run synchronous operations; it ensures