Improvement: lint against ambiguous search/aggregate waits in Playwright

[harsh-vador]

Describe your changes:

Fixes #31859

Follow-up to #31860, which fixed the stale-response race in the Explore filter dropdowns. This one goes after the test-side half of that bug so it cannot be written again.

The mistake worth linting. A facet dropdown fires two aggregations against the same field: one when it opens (value=.*) and one per typed search (value=.*text.*). A wait like waitForResponse('…/aggregate?…&field=ownerDisplayName*deleted=true*') matches both. In #31859 it resolved off the dropdown-open request, so the test ran ahead of the search it had queued, and the orphaned response landed in a dropdown opened later — behind a passing assertion.

• playwright/utils/searchAggregation.ts — waitForAggregation(page, { field, value, deleted }). Matches on parsed URL params rather than a glob, which removes the encoding footguns entirely. value is required and takes null for "the dropdown-open request", so intent is stated at every call site instead of being inferred. Backslashes are stripped from both sides of the comparison because getAggregateFieldOptions runs the search text through escapeESReservedCharacters before putting it in value — without that, any value containing - or : would never match and would time out.
• eslint-rules/openmetadata-playwright.mjs — new rule require-aggregation-wait-helper, flagging raw waits on search/aggregate in string, template-literal and URL-predicate form. The helper module itself is exempt.
• Severity: warn. 36 call sites exist today; this PR migrates 8, leaving 27. That matches the convention already in eslint.config.mjs — error for rules with a zero backlog, warn for ones being worked down. Promote to error once the rest are migrated.
• Migrated the sites where the ambiguity is a live latent bug: ExploreDiscovery.spec.ts (4 waits, replacing the value-globs from Fixes 31859: discard an Explore filter search that resolves after its dropdown closed #31860 with the helper), utils/explore.ts (2), utils/glossary.ts, DataProductCertificationFilter.spec.ts. The explore-tree drill-down is a POST aggregate with no field/value pair to discriminate on, so it carries a narrow suppression with the reason inline.

Two of the 36 sites are legitimate dropdown-open waits (utils/advancedSearch.ts, AdvancedSearchSuggestions.spec.ts) — the helper expresses those as value: null, which is why the option exists rather than the rule demanding a value.

Stacked on fix/explore-quick-filter-stale-options (#31860) because both touch ExploreDiscovery.spec.ts; GitHub will retarget this to main when that merges.

Type of change:

• Improvement

High-level design:

N/A — small change.

Tests:

Use cases covered

• A wait armed for a typed search no longer resolves on the dropdown's open request.
• A deliberate wait for the open request is expressible (value: null) and not flagged.
• Search values containing ES reserved characters still match.
• Raw waits on the aggregate endpoint are reported in all three forms (string, template literal, URL predicate).

Unit tests

• eslint-rules/openmetadata-playwright.test.mjs — 4 valid / 3 invalid cases via RuleTester, plus the plugin-export assertion, in the same style as the existing rule tests.
• yarn test:eslint-rules → 93 tests, 93 pass.
• npx eslint playwright eslint-rules → 0 errors (299 warnings: 272 pre-existing + the 27 remaining sites this rule now names).
• npx tsc --noEmit → 0 errors under playwright/.

Backend integration tests

• Not applicable (no backend changes).

Ingestion integration tests

• Not applicable (no ingestion changes).

Playwright (UI) tests

• Migrated 8 existing waits; no new specs.
• The E2E suite has not been run locally. The migrated waits are stricter than the globs they replace, so the risk to flag in review is a wait that never matches and times out. Mitigated by matching on the documented shape of getAggregateFieldOptions (field, value, deleted on every GET aggregate) and by the backslash normalisation above, but the AUT run is the real check.

Manual testing performed

Lint and rule-unit level only, as above.

UI screen recording / screenshots:

Not applicable — test tooling only, no product code.

Checklist:

• I have read the CONTRIBUTING document.
• My PR is linked to a GitHub issue.
• I have commented on my code, particularly in hard-to-understand areas.
• I have added tests and listed them above.

🤖 Generated with Claude Code

Greptile Summary

This PR introduces a parsed-URL Playwright helper for aggregation waits and a repository lint rule discouraging ambiguous raw waits.

• Migrates selected Explore, glossary, and certification-filter waits to the new helper.
• Adds ESLint rule coverage for direct, predicate, local-variable, outer-scope, reassigned, and concatenated matchers.
• Enables the rule as a warning while existing call sites are migrated.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename	Overview
openmetadata-ui/src/main/resources/ui/eslint-rules/openmetadata-playwright.mjs	Adds the Playwright-specific aggregation-wait lint rule and identifier lookup support.
openmetadata-ui/src/main/resources/ui/eslint-rules/openmetadata-playwright.test.mjs	Adds RuleTester coverage for supported raw-wait matcher forms and plugin export registration.
openmetadata-ui/src/main/resources/ui/playwright/utils/searchAggregation.ts	Adds parsed-URL matching for typed and dropdown-open aggregation requests.
openmetadata-ui/src/main/resources/ui/eslint.config.mjs	Registers the new Playwright plugin and enables its aggregation-wait rule as a warning.

_{Reviews (7): Last reviewed commit: "Address review: widen the rule's matcher..." | Re-trigger Greptile}

[github-actions]

❌ PR checklist incomplete

This PR cannot be merged until the following are addressed on its linked issue:

• Issue Explore filter dropdown shows another filter's options when a queued search resolves after it closes #31859 is missing Shipping → Release.

The fields live on the linked issue in the Shipping project (open the issue → right sidebar → Projects). After you set them, re-run this check (or push a commit) — issue/project changes do not re-trigger it automatically.

Maintainers can bypass this check by adding the skip-pr-checks label.

[github-actions]

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

[github-actions]

✅ Playwright Results — workflow succeeded

Validated commit 2cc0b7f804531440bd030e7c9f51796f6922e94f in Playwright run 32477173313, attempt 1.

✅ 564 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped · 🧰 0 lifecycle flaky

Performance

Blocking targets: ✅ met · Optimization targets: 🟡 in progress

Shard-job maxima below are not the full workflow wall time; the linked run includes build, fixture, planning, and reporting.

🕒 Full workflow signal wall (to summary) 48m 43s

⏱️ Max setup 4m 24s · max shard execution 15m 37s · max shard-job elapsed before upload 18m 41s · reporting 4s

🌐 214.33 requests/attempt · 2.81 app boots/UI scenario · 6.08% common-shard skew

Optimization targets still in progress:

• Browser traffic was 214.33 requests per attempt (convergence target: fewer than 200).
• Application boot ratio was 2.81 per UI scenario (1642 boots / 585 scenarios; convergence target: at most 1).

Shard	Passed	Failed	Flaky	Skipped	Lifecycle failed	Lifecycle flaky
✅ Shard chromium-01	103	0	0	0	0	0
✅ Shard chromium-02	108	0	0	0	0	0
✅ Shard chromium-03	95	0	0	0	0	0
✅ Shard chromium-04	104	0	0	0	0	0
✅ Shard data-asset-rules-01	61	0	0	0	0	0
✅ Shard domain-isolation-01	16	0	0	0	0	0
✅ Shard global-state-01	34	0	0	0	0	0
✅ Shard ingestion-01	1	0	0	0	0	0
✅ Shard reindex-01	2	0	0	0	0	0
✅ Shard search-01	11	0	0	0	0	0
✅ Shard search-rbac-01	29	0	0	0	0	0

📦 Download artifacts

How to debug locally

# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

[github-actions]

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

[github-actions]

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

[github-actions]

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

[github-actions]

Jest test Coverage

UI tests summary

Lines	Statements	Branches	Functions
	67.03% (80390/119920)	51.47% (49240/95666)	52.44% (14701/28029)

[sonarqubecloud]

Quality Gate passed for 'open-metadata-ui'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[gitar-bot]

Code Review ✅ Approved 2 resolved / 2 findings

Adds the waitForAggregation Playwright helper and a new ESLint rule to prevent ambiguous search and aggregate waits, resolving the empty-string value and lint rule coverage findings.

✅ 2 resolved

✅ Edge Case: Empty-string value reintroduces the open-request ambiguity

📄 openmetadata-ui/src/main/resources/ui/playwright/utils/searchAggregation.ts:71-75 📄 openmetadata-ui/src/main/resources/ui/playwright/utils/explore.ts:47-50
matches only special-cases value === null for the dropdown-open request; a non-null empty string falls into the typed-search branch where normalize(value).includes(normalize('')) is always true, so it matches the open request (value=.*) too — exactly the ambiguity the helper exists to prevent. In searchAndClickOnOption, value: filter.value ?? null only maps undefined/null to null, so a caller passing filter.value === '' would silently get open-request matching. Consider treating empty string as null (or asserting non-empty) so intent stays explicit.

✅ Quality: Lint rule misses concatenated/reassigned aggregate URLs

📄 openmetadata-ui/src/main/resources/ui/eslint-rules/openmetadata-playwright.mjs:28-42 📄 openmetadata-ui/src/main/resources/ui/eslint-rules/openmetadata-playwright.mjs:78-80
resolveMatcherText only reads text directly or follows an Identifier to a const ... = init declaration, then flags when the source text contains the contiguous substring search/aggregate. A raw wait built by string concatenation (e.g. page.waitForResponse('/api/v1/search/' + 'aggregate?*')) or via a reassigned let/parameter (where def.node.init is undefined) yields text without the contiguous substring, so it silently escapes the rule. This is an acknowledged, low-impact gap (warn severity, test-only), but the sibling rule openmetadata-performance.mjs already has a findReferencedVariable/findVariable helper that walks scope.upper more robustly; reusing that pattern would narrow the gap further.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact

gitar display:verbose

_{Was this helpful? React with 👍 / 👎 | Powered by Gitar — free for open source}