Speed up directory monitoring tests #1325
Open
Conversation
This file contains hidden or 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
|
@swift-ci please test |
The directory monitoring tests check for whether the documentation is rebuilt if the documentation catalog is edited when running a live server with `docc preview`. These tests assumed an extremely generous timeout for receiving the directory change signal, and ran much slower than the rest of the test suite. The timeouts have been reduced to a more reasonable threshold that succeeds even with throttled resources on a single-core machine.
d-ronnqvist
reviewed
Oct 31, 2025
Comment on lines
-83
to
+87
| wait(for: [updated], timeout: 5.0) | ||
| wait(for: [updated], timeout: 1.5) | ||
| } | ||
|
|
||
| if isTreeReloadExpected { | ||
| wait(for: [reloaded], timeout: 5.0) | ||
| wait(for: [reloaded], timeout: 1.5) |
There was a problem hiding this comment.
These timeouts don't speed up the test as long as it passes. Even if I increase both of these to 100 second testMonitorUpdates only takes ~5 seconds for me to run locally.
There was a problem hiding this comment.
If we want this to succeed faster then we'd need to change the 1 second throttle time here.
| } | ||
|
|
||
| wait(for: [didNotTriggerUpdateForHiddenFile], timeout: 20) | ||
| wait(for: [didNotTriggerUpdateForHiddenFile], timeout: 2) |
There was a problem hiding this comment.
This also doesn't speed up the test as long as it passes. Even if I increase both of these to 200 second testMonitorDoesNotTriggerUpdates only takes ~20 seconds for me to run locally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
The directory monitoring tests check for whether the documentation is rebuilt if the documentation catalog is edited when running a live server with
docc preview. These tests assumed an extremely generous timeout of 5 seconds for changes to the directory, and 10 seconds for a lack of change. Thus, they ran much slower than the rest of the test suite. The timeouts have been reduced to a more reasonable threshold of 1.5 seconds, which still succeeds with throttled CPU resources.Dependencies
N/A
Testing
This was tested by restricting CPU resources to 20% of a single core and running the tests 100 times:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
[ ] Added tests./bin/testscript and it succeeded[ ] Updated documentation if necessary