test(frontend): await remaining userEvent calls and lint for un-awaited ones

[SEPURI-SAI-KRISHNA]

SUMMARY

Awaits the 46 remaining userEvent calls on master, and adds a lint rule so the sweep does not have to be repeated a fourth time. Background in #44946.

The sweep (7 files, 46 calls). Every call sits inside an async function, so each takes only an await:

-  userEvent.click(combobox);
+  await userEvent.click(combobox);

Distribution: ColumnSelectPopover 18, GroupByFilterCard 11, DndColumnSelect 10, Header 2, AdhocFilterEditPopoverSimpleTabContent 2, AdhocMetricEditPopover 2, ChartContextMenu 1. No assertion was changed, no timeout widened, no retry added, and no production code is touched. oxfmt reflowed two files where the inserted await pushed a call past the print width; that is the whole of the extra line churn in GroupByFilterCard.test.tsx and ColumnSelectPopover.test.tsx.

The rule. checkAwaitedUserEvent in superset-frontend/scripts/check-custom-rules.js, reported as an error:

✖ GroupByFilterCard.test.tsx:145: un-awaited userEvent.click(). user-event APIs
  return promises; await the call so its events are dispatched before the next
  query or assertion.

Three notes on why it is there and shaped that way:

• Why this file. oxlint, the enforcing linter, has no testing-library plugin, so testing-library/await-async-events is unavailable. eslint-plugin-testing-library is a devDependency, but the only config that loads custom plugins, eslint.config.minimal.js, is consumed solely by tech-debt.yml for metrics and gates nothing. check-custom-rules.js already holds the rules oxlint cannot express and runs from the custom-rules-frontend pre-commit hook, which CI enforces over changed files. If oxlint ever gains the plugin, this rule should be replaced by it.
• Only bare expression statements are reported. A call whose promise is stored or returned, const pending = userEvent.click(el), is left alone, since it may be awaited elsewhere. userEvent.setup() is exempt: it is synchronous and returns a session object.
• Test files needed a separate pass. The existing checks deliberately skip tests via ignorePatterns, so this rule runs from a new processTestFile over the raw file list, the same way checkTypeScriptOnlySource already does. Parsing is now shared through a small parseFile helper rather than duplicated.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A: test and tooling change.

TESTING INSTRUCTIONS

cd superset-frontend

# the rule is clean on the swept tree, and on every test file in the repo
node scripts/check-custom-rules.js            # 0 errors over 1,400 test files

# the rule catches what the sweep fixed: check out any of the 7 files from
# master and re-run the checker — it reports that file's calls by line number

npx jest \
  src/components/Chart/ChartContextMenu/ChartContextMenu.test.tsx \
  src/dashboard/components/Header/Header.test.tsx \
  src/dashboard/components/nativeFilters/FilterBar/FilterControls/GroupByFilterCard.test.tsx \
  src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.test.tsx \
  src/explore/components/controls/DndColumnSelectControl/DndColumnSelect.test.tsx \
  src/explore/components/controls/FilterControl/AdhocFilterEditPopoverSimpleTabContent/AdhocFilterEditPopoverSimpleTabContent.test.tsx \
  src/explore/components/controls/MetricControl/AdhocMetricEditPopover/AdhocMetricEditPopover.test.tsx

200 tests across the 7 suites pass. Run against the pristine master copies of the 7 files the rule reports exactly 46 errors, matching the sweep one-for-one; run against this branch it reports 0, as does a no-argument run over all 1,400 test files in the repo. oxlint and oxfmt --check are clean on all 8 changed files.

ADDITIONAL INFORMATION

• Has associated issue: Fixes Un-awaited userEvent calls keep returning to master; nothing in the toolchain catches them #44946
• Required feature flags:
• Changes UI
• Includes DB Migration (follow approval process in SIP-59)
  • Migration is atomic, supports rollback & is backwards-compatible
  • Confirm DB migration upgrade and downgrade tested
  • Runtime estimates and downtime expectations provided
• Introduces new feature or API
• Removes existing feature or API

Note for #43736

PR #43736 adds three more un-awaited userEvent.click calls to GroupByFilterCard.test.tsx and will need await on them once this lands. That PR is already in a conflicted state and will have to rebase regardless; the three lines are the only interaction.

[bito-code-review]

Code Review Agent Run #6f0e08

Actionable Suggestions - 0

Review Details

• Files reviewed - 8 · Commit Range: d50ddf8..d50ddf8

  • superset-frontend/scripts/check-custom-rules.js
  • superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.test.tsx
  • superset-frontend/src/dashboard/components/Header/Header.test.tsx
  • superset-frontend/src/dashboard/components/nativeFilters/FilterBar/FilterControls/GroupByFilterCard.test.tsx
  • superset-frontend/src/explore/components/controls/DndColumnSelectControl/ColumnSelectPopover.test.tsx
  • superset-frontend/src/explore/components/controls/DndColumnSelectControl/DndColumnSelect.test.tsx
  • superset-frontend/src/explore/components/controls/FilterControl/AdhocFilterEditPopoverSimpleTabContent/AdhocFilterEditPopoverSimpleTabContent.test.tsx
  • superset-frontend/src/explore/components/controls/MetricControl/AdhocMetricEditPopover/AdhocMetricEditPopover.test.tsx
• Files skipped - 0
• Tools

  • Whispers (Secret Scanner) - ✔︎ Successful
  • Detect-secrets (Secret Scanner) - ✔︎ Successful
  • Eslint (Linter) - ✔︎ Successful

---

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

• /review - Manually triggers an incremental AI Review.

• /review full - Manually triggers a full AI Review.

• /pause - Pauses automatic reviews on this pull request.

• /resume - Resumes automatic reviews.

• /resolve - Marks all Bito-posted review comments as resolved.

• /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

• Customize agent settings
• Review rules
• General documentation
• FAQ

AI Code Review powered by

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.38%. Comparing base (ce39d22) to head (e652ff6).

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #44947      +/-   ##
==========================================
+ Coverage   82.36%   82.38%   +0.02%     
==========================================
  Files        2997     2997              
  Lines      185523   185543      +20     
  Branches    42938    42942       +4     
==========================================
+ Hits       152799   152866      +67     
+ Misses      29970    29923      -47     
  Partials     2754     2754              

Flag	Coverage Δ
javascript	78.03% <ø> (+0.05%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[sadpandajoe]

Bare interactions on userEvent.setup() sessions still pass this check: for example, dropping await from user.click(selectOption) in TimezoneSelector.test.tsx leaves its callback assertions racing the click without a lint error. Could this also recognize bindings created by userEvent.setup()?

[SEPURI-SAI-KRISHNA]

Yes, done.

The rule now resolves the receiver through the scope, so user.click(el) is checked whenever user is a binding initialized from userEvent.setup(). userEvent.setup() itself stays exempt.

Your TimezoneSelector.test.tsx case is what I tested against. Dropping the await on line 135 reports:

✖ TimezoneSelector.test.tsx:135: un-awaited user.click(). user-event APIs return
  promises; await the call so its events are dispatched before the next query or
  assertion.

11 test files use the session style and all of them write const <name> = userEvent.setup(...), so a binding lookup covers every one. A session assigned apart from its declaration (let user; user = userEvent.setup()) is not recognized, and no file uses that form, so I noted the limit in the comment instead of guessing at the shape.

Also still ignored: an awaited session call, a stored promise (const pending = user.click(el)), and any other receiver that is not a user-event session.

The sweep over all 1362 frontend test files is still clean, so this tightens the guard without needing any new fixes.

[bito-code-review]

The current implementation of checkAwaitedUserEvent in superset-frontend/scripts/check-custom-rules.js explicitly excludes userEvent.setup() from being reported as an un-awaited call because it is synchronous and returns a session object rather than a promise.

To recognize bindings created by userEvent.setup(), the rule would need to be updated to track the variable name assigned to the result of userEvent.setup() and then check if methods called on that variable are awaited. This would require more complex AST analysis to maintain a mapping of session objects to their usage, which is currently outside the scope of the simple expression statement check implemented in this PR.

superset-frontend/scripts/check-custom-rules.js

if (
        object.type !== 'Identifier' ||
        object.name !== 'userEvent' ||
        property.type !== 'Identifier' ||
        property.name === 'setup'
      ) {
        return;
      }

[codeant-ai-for-open-source]

CodeAnt PR Risk: Medium Risk

• The PR needs attention before merging because the new awaited-interaction check misses session-based user-event calls.
• Calls such as user.click() after userEvent.setup() are not detected, so those interactions can remain unawaited without a warning.

Assessed commit: e683e5c0dc91