Skip to content

fix: allow un-called async util references #1061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: allow un-called async util references #1061

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eca0fac
fix: allow un-called async util references
Aug 8, 2025
36b3bec
test: add coverage edge case
Aug 11, 2025
c4f1ec8
Merge branch 'main' into allow-async-refs
puglyfe Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 22 additions & 13 deletions lib/rules/await-async-utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,20 +121,29 @@ export default createTestingLibraryRule<Options, MessageIds>({
functionWrappersNames.push((node.id as TSESTree.Identifier).name);
}
},
'CallExpression Identifier'(node: TSESTree.Identifier) {
CallExpression(node: TSESTree.CallExpression) {
const callExpressionIdentifier = getDeepestIdentifierNode(node);

if (!callExpressionIdentifier) {
return;
}

const isAsyncUtilOrKnownAliasAroundIt =
helpers.isAsyncUtil(node) ||
functionWrappersNames.includes(node.name);
helpers.isAsyncUtil(callExpressionIdentifier) ||
functionWrappersNames.includes(callExpressionIdentifier.name);
if (!isAsyncUtilOrKnownAliasAroundIt) {
return;
}

// detect async query used within wrapper function for later analysis
if (helpers.isAsyncUtil(node)) {
detectAsyncUtilWrapper(node);
if (helpers.isAsyncUtil(callExpressionIdentifier)) {
detectAsyncUtilWrapper(callExpressionIdentifier);
}

const closestCallExpression = findClosestCallExpressionNode(node, true);
const closestCallExpression = findClosestCallExpressionNode(
callExpressionIdentifier,
true
);

if (!closestCallExpression?.parent) {
return;
Expand All @@ -146,12 +155,12 @@ export default createTestingLibraryRule<Options, MessageIds>({
);

if (references.length === 0) {
if (!isPromiseHandled(node)) {
if (!isPromiseHandled(callExpressionIdentifier)) {
context.report({
node,
messageId: getMessageId(node),
node: callExpressionIdentifier,
messageId: getMessageId(callExpressionIdentifier),
data: {
name: node.name,
name: callExpressionIdentifier.name,
},
});
}
Expand All @@ -160,10 +169,10 @@ export default createTestingLibraryRule<Options, MessageIds>({
const referenceNode = reference.identifier as TSESTree.Identifier;
if (!isPromiseHandled(referenceNode)) {
context.report({
node,
messageId: getMessageId(node),
node: callExpressionIdentifier,
messageId: getMessageId(callExpressionIdentifier),
data: {
name: node.name,
name: callExpressionIdentifier.name,
},
});
return;
Expand Down
5 changes: 5 additions & 0 deletions tests/lib/rules/await-async-queries.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ ruleTester.run(RULE_NAME, rule, {
testingFramework: '@marko/testing-library',
}),

// async queries not called are valid
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this behavior already existed - just codifying it via test.

...createTestCase((query) => `expect(screen.${query}).toBeDefined()`, {
isAsync: false,
}),

// async queries are valid with await operator
...createTestCase(
(query) => `
Expand Down
8 changes: 8 additions & 0 deletions tests/lib/rules/await-async-utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,14 @@ ruleTester.run(RULE_NAME, rule, {
const aPromise = ${asyncUtil}(() => getByLabelText('email'));
await aPromise;
});
`,
})),
...ASYNC_UTILS.map((asyncUtil) => ({
code: `
import { ${asyncUtil} } from '${testingFramework}';
test('${asyncUtil} util not called is valid', () => {
expect(${asyncUtil}).toBeDefined();
});
`,
})),
...ASYNC_UTILS.map((asyncUtil) => ({
Expand Down