feat(await-async-events): instance of userEvent is recognized as async #830
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
Kvanttinen
force-pushed
the
pr/await-async-events-rule-validates-userevent-session
branch
from
89e5f97
to
f28f7e1
Compare
Kvanttinen
force-pushed
the
pr/await-async-events-rule-validates-userevent-session
branch
from
f28f7e1
to
8ba464f
Compare
|
any updates? |
|
@ka2jun8 Sorry for the late response! I'll review this soon. |
feat(await-async-events): added comments feat(await-async-events): better test case feat(await-async-events): edge case fixed, test added feat(await-async-events): use actual userEvent import for check, tests
Belco90
force-pushed
the
pr/await-async-events-rule-validates-userevent-session
branch
from
8f1e313
to
636dee8
Compare
Belco90
requested changes
Jan 12, 2024
Comment on lines
+336
to
+341
| const getUserEventImportIdentifier = (node: ImportModuleNode | null) => { | ||
| if (!node) { | ||
| return null; | ||
| } | ||
|
|
||
| if (isImportDeclaration(node)) { |
There was a problem hiding this comment.
This function should always receive a node. If the node is not available, then avoid calling this function in the corresponding code.
Suggested change
| const getUserEventImportIdentifier = (node: ImportModuleNode | null) => { | |
| if (!node) { | |
| return null; | |
| } | |
| if (isImportDeclaration(node)) { | |
| const getUserEventImportIdentifier = (node: ImportModuleNode) => { | |
| if (isImportDeclaration(node)) { |
| } | ||
|
|
||
| return null; | ||
| return getUserEventImportIdentifier(importedUserEventLibraryNode); |
There was a problem hiding this comment.
Here you should call getUserEventImportIdentifier only if importedUserEventLibraryNode exists.
Comment on lines
+703
to
+711
| if ( | ||
| token.type === 'Identifier' && | ||
| token.value === userEventImport.name && | ||
| tokensAndComments[index + 1].value === '.' && | ||
| tokensAndComments[index + 2].value === 'setup' && | ||
| tokensAndComments[index + 3].value === '(' && | ||
| tokensAndComments[index - 1].value === '=' | ||
| ) { | ||
| return tokensAndComments[index - 2].value; |
There was a problem hiding this comment.
This looks a bit brittle and hardcoded… I'm trying to think a better way to implement this in a more generic way with AST selectors.
| * Finds if the userEvent is used as an instance | ||
| */ | ||
|
|
||
| export function getUserEventInstance( |
There was a problem hiding this comment.
I think this one should belong to the detect-testing-library-utils too.
| @@ -32,7 +32,7 @@ const USER_EVENT_ASYNC_FUNCTIONS = [ | |||
| 'upload', | |||
| ] as const; | |||
| const FIRE_EVENT_ASYNC_FRAMEWORKS = [ | |||
| '@testing-library/vue', | |||
| // '@testing-library/vue', | |||
|
I gave it a first round. After the changes requested are applied, I'll give it another round. |
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.
Checks
Changes
Adds a feature that events from the instance of userEvent are recognized as async events.
Example:
const user = userEvent.setup();
user.click(button);
The 'user' will be flagged in this case.
Context
Closes #812
My first open source PR, and not used to GitHub that much, so there might be some errors with the process. Changes itself are quite simple, but I didn't find a more elegant way to do that.