Optimize CommentContainer.spec.tsx test initialization #4327
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.
What does this PR do?
Use
waitFor
andgetByTestId
for the initialization of theCommentContainer.spec.tsx
tests.This cuts a problematic test
render username and body
's render time down from roughly 1320ms to 795ms. Since we're seeing this test take minutes to run on GitHub Actions CI, this should help it finish without timing out.I realize replacing a
findBy
with awaitFor
+get
is considered less optimal for most occasions, I have documented why this is more optimal in the code. Several folks have found this to be the case for finding objects in particularly large test DOM's on StackOverflow and GitHub issues. For now, this is a nice quick fix to get some speed during a particularly slow test.These changes will impact:
What changes to the GraphQL/Database Schema does this PR introduce?
None
Does this PR introduce any new environment variables or feature flags?
No
If any indexes were added, were they added to
INDEXES.md
?No new indices.
How do I test this PR?
Where any tests migrated to React Testing Library?
No
How do we deploy this PR?
No special considerations.