[Infra] Reduce test flakes due to async variable assignment #13610
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
ncooke3
commented
Sep 9, 2024
| @@ -590,12 +590,11 @@ class AuthBackendRPCImplementationTests: RPCBaseTests { | |||
| try self.rpcIssuer.respond(withJSON: [:]) | |||
| } | |||
| _ = try? await rpcImplementation.call(with: request) | |||
| // Make sure completeRequest updates. | |||
| usleep(10000) | |||
There was a problem hiding this comment.
I believe this leads to flakes on slower CI machines where this is not a long enough wait.
ncooke3
commented
Sep 9, 2024
ncooke3
commented
Sep 9, 2024
| @@ -52,7 +52,7 @@ class FakeBackendRPCIssuer: NSObject, AuthBackendRPCIssuer { | |||
| /** @property completeRequest | |||
| @brief The last request to be processed by the backend. | |||
| */ | |||
| var completeRequest: URLRequest? | |||
| var completeRequest: Task<URLRequest, Never>! | |||
There was a problem hiding this comment.
In the tests, it wouldn't make sense to access this property before doing _ = try? await rpcImplementation.call(with: request), so this is implicitly unwrapped.
ncooke3
commented
Sep 9, 2024
ncooke3
commented
Sep 9, 2024
Comment on lines
+151
to
+152
| completeRequest = Task { | ||
| await AuthBackend.request(withURL: requestURL!, |
There was a problem hiding this comment.
Before, assigning this property in the task led to it being resolved later than the method returns, causing for the need to sleep since it was assigned as a side effect of the _ = try? await rpcImplementation.call(with: request) call. Now, the task is synchronously assigned to it's resolved value can be async-ly waited on later.
andrewheard
approved these changes
Sep 9, 2024
|
Great cleanup. Thanks! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This pattern should hopefully reduce testing flakes such as this: https://github.com/firebase/firebase-ios-sdk/actions/runs/10770066986/job/29862664996
Comments throughout to document approach.
#no-changelog