Rewrite synchronization and test-exec troubleshooting guides #4735
+406
−285
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
d4vidi
changed the title
d4vidi
changed the title
d4vidi
force-pushed
the
docs/sync-troublshoot-and-dbg
branch
2 times, most recently
from
df74dac to
8be4648
Compare
d4vidi
force-pushed
the
docs/sync-troublshoot-and-dbg
branch
from
8be4648 to
d4f8289
Compare
noomorph
reviewed
Mar 19, 2025
docs/articles/how-detox-works.md
Outdated
|
|
||
| ## How Detox Automatically Synchronizes With Your App | ||
|
|
||
| One of the key features of Detox is its ability to automatically synchronize the test execution with your app. The most annoying aspect of end-to-end tests is flakiness—tests sometimes fail without anything changing. Flakiness happens because tests are nondeterministic. Every time a test is running, things take place in a slightly different order inside your app. | ||
| One of the key features of Detox is its ability to automatically synchronize the test execution with your app. The most annoying aspect of end-to-end tests is flakiness—tests sometimes fail without anything changing. Flakiness happens because tests are nondeterministic. Every time a test is running, things take place in a slightly different order or execution-time inside your app. |
There was a problem hiding this comment.
Suggested change
| One of the key features of Detox is its ability to automatically synchronize the test execution with your app. The most annoying aspect of end-to-end tests is flakiness—tests sometimes fail without anything changing. Flakiness happens because tests are nondeterministic. Every time a test is running, things take place in a slightly different order or execution-time inside your app. | |
| One of the key features of Detox is its ability to synchronize test execution with the app’s state, reducing instability caused by timing uncertainties. One of the biggest challenges in end-to-end testing is knowing exactly when the app is in a reliable state for assertions. Instability can arise due to asynchronous operations completing in different orders, depending on factors like system load, network conditions, and execution timing. |
There was a problem hiding this comment.
I've completely rephrased this section. Will push soon.
docs/articles/how-detox-works.md
Outdated
|
|
||
| Detox tries to eliminate flakiness by automatically synchronizing your tests with the app. A test cannot continue to the next command until the app becomes idle. Detox monitors your app very closely in order to know when it’s idle. It tracks several asynchronous operations and waits until they complete. This includes: | ||
| Detox tries to eliminate flakiness by automatically synchronizing your tests with the app. A test cannot continue to the next command until the app becomes idle. Detox monitors your app very closely in order to know when it’s idle. It tracks several asynchronous operations and waits until they complete. |
There was a problem hiding this comment.
Suggested change
| Detox tries to eliminate flakiness by automatically synchronizing your tests with the app. A test cannot continue to the next command until the app becomes idle. Detox monitors your app very closely in order to know when it’s idle. It tracks several asynchronous operations and waits until they complete. | |
| Detox reduces timing-related instability by dynamically synchronizing tests with the app’s actual execution state. Instead of relying on fixed delays or polling, Detox detects when the app is truly idle, ensuring actions and assertions happen at the right time. This synchronization not only improves reliability but can also **speed up test execution**, as it prevents unnecessary waiting. Detox tracks several key asynchronous operations to determine when the app is in a ready state. |
d4vidi
force-pushed
the
docs/sync-troublshoot-and-dbg
branch
from
3c735ab to
590b0fb
Compare
|
@noomorph please have an additional glance over the latest commit |
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.
Description
In this pull request, I have rewritten the synchronization troubleshooting guide, in the sense of making it more practical, up to date (with knowledge+insights we've gathered) and thorough in terms of debugging and bug-fixing possibilities.
I've also extended the detox debugging guide such that it would explain how to utilize
--inspect-brkusing Webstorm.cc @Kerzman