ktx-akshay
7999fd33f3
## Summary Adds **10 E2E tests** covering the two defects fixed in #13244, plus the `SELECT *` behaviour change that shipped alongside them. Also introduces per-shard backend configuration so the `SELECT *` tests can actually run in CI. ## Test coverage ### `logsVisualizePersistence.spec.js` — 7 tests (quick mode **off**) | # | Test | Defect | Fix code exercised | |---|---|---|---| | 1 | Renders without the false required-fields error | A | `convertPanelData.ts` `!query?.customQuery` | | 2 | Restores chart type, query and chart after URL refresh (h-bar) | B | `setupLogsTab` re-run + `isInitialVisualizeRestore` | | 3 | Re-renders after reload with the default chart type | B | permanent No-Data half | | 4 | Restores a non-default chart type (area) after refresh | B | `restoreVisualizationFromUrlOnLoad()` | | 5 | Chart still renders after reload with a VRL function applied | B | `prepareVisualizeMode()` VRL copy | | 6 | Never shows required-fields error toggling Visualize → Logs → Visualize | A | manual-toggle rebuild path | | 7 | No `SELECT *` toast opening Visualize with no stream in the URL | B | page-load ordering guard | **Defect A** — false "Please select required fields to render the chart" on the custom-query Timechart panel. **Defect B** — URL refresh produced a `SELECT *` toast plus permanent No Data. ### `logsVisualizeSelectStar.spec.js` — 3 tests (quick mode **on**, dedicated shard) | # | Test | Behaviour verified | Call site | |---|---|---|---| | 8 | Table chart on `SELECT *` → toast shown **and** chart type reverts | Table is blocked | `Index.vue:2265` (watcher) | | 9 | Histogram chart on `SELECT *` → no toast, renders | Line/bar/area/scatter allowed | entry path | | 10 | `SELECT *` line chart survives browser refresh → no toast, state restored | Restore path doesn't re-emit | `Index.vue:2465` (restore) | ## Infrastructure changes | File | Change | Why | |---|---|---| | `ci_matrix.json` | New `Logs-SelectStar` shard with `quick_mode_enabled: "true"` | `isSelectStarForTable()` only exists when the server runs with quick mode on | | `playwright.yml` | Per-shard `ZO_QUICK_MODE_ENABLED` env on `Start OpenObserve` | The flag is read once at server start — a shard is the smallest unit that can vary it | | `build-ci-matrix.js` | Emit `quick_mode_enabled` (defaults `"false"`) | The field was being silently stripped by the emit whitelist | | `logsPage.js` | 13 assertion helpers + fixed chart-type detection | Detection read `data-selected` off the wrong element and matched retired CSS classes, so it always returned `null` | All 24 existing shards are unaffected — they omit the field and default to `false`. ## Notes on test quality - Every negative assertion ("no toast", "no error") is sequenced after a deterministic positive end-state, and gated on a precondition so it cannot pass vacuously. - Toast absence is proved with a MutationObserver recorder installed before the navigation under test, since toasts auto-dismiss. - The quick-mode precondition is a hard assertion, not `test.skip` — a misconfigured shard fails loudly instead of silently reporting "skipped".
Playwright CI shard matrices — single source of truth
Manifest index
Each Playwright workflow builds its matrix from one of these JSON files (via a
generate_matrix job). Shared workflows use an OSS base + an ENT overlay
(*.ent.json, in the enterprise repo); ENT-only workflows use a standalone manifest.
| Manifest | Drives workflow | Kind |
|---|---|---|
ci_matrix.json (+ ENT ci_matrix.ent.json) |
playwright.yml (PR gate) |
shared base + overlay |
ci_matrix_regression.json (+ ENT ci_matrix_regression.ent.json) |
playwright_regression.yml |
shared base + overlay |
ci_matrix_cloud.json (ENT repo) |
playwright_alpha1.yml |
ENT-only standalone |
ci_matrix_env.json (ENT repo) |
playwright_env.yml |
ENT-only standalone |
ci_matrix_env_scheduled.json (ENT repo) |
playwright_env_scheduled.yml |
ENT-only standalone |
ci_matrix_firefox.json (ENT repo) |
playwright-firefox-ondemand.yml |
ENT-only standalone |
Base manifests + build-ci-matrix.js live in OSS; overlays and ENT-only manifests live
in o2-enterprise/tests/ui-testing/ci-matrix/. The merge script is shared (ENT reuses it
from its OSS checkout).
The shared PR-gate matrix (below refers to ci_matrix.json)
ci_matrix.json (this directory) is the only place the Playwright UI shard list
lives. Both the OSS and Enterprise playwright.yml workflows build their test matrix
from it at run time via .github/scripts/build-ci-matrix.js, so a spec added here runs
in both repos automatically — no more hand-syncing two workflow files.
Adding / moving a spec
- A spec both OSS and ENT run: edit
ci_matrix.jsononly. Add the filename to therun_filesof the right shard (testfolder). Done — ENT picks it up on its next run. - An enterprise-only spec: edit
o2-enterprise/tests/ui-testing/ci-matrix/ci_matrix.ent.json(the overlay), never this file. Two shapes:- add it to an existing shared shard →
"append": { "<testfolder>": ["my.spec.js"] } - a whole new ENT-only shard → add an object to
"shards": [ … ].
- add it to an existing shared shard →
- A new shard: add a new object to
ci_matrix.jsonwithtestfolder,actual_folder,browser,run_files.
Fields
| field | meaning |
|---|---|
testfolder |
shard label — becomes the job name e2e / <testfolder> (must be unique) |
actual_folder |
real directory under playwright-tests/ (e.g. Logs-Core → Logs) |
browser |
chrome |
run_files |
spec filenames run by this shard |
disabled |
(optional) specs intentionally turned off — see below |
Disabling a spec (JSON has no // comments)
Every shard ships with a "disabled": [] placeholder, so turning a spec off is a
fill-in-the-blank — don't delete the spec you want to remember, move it into that
shard's disabled array with a reason. build-ci-matrix.js never emits disabled, so
those specs don't run, but the record survives and is git-diffable:
{
"testfolder": "Alerts",
"run_files": ["alerts-ui-operations.spec.js"],
"disabled": [
{ "file": "alerts-e2e-flow.spec.js", "reason": "flaky; pending rewrite" }
]
}
A spec cannot be in both run_files and disabled — the build fails if it is. Any
_comment (or _-prefixed) key is also ignored, for free-form notes.
Enterprise-only disabled specs go in the overlay's disabled map, keyed by shard:
"disabled": { "Alerts": [ { "file": "…", "reason": "…" } ] }.
The ENT overlay only ever carries the delta from OSS. It must not re-list any spec
already in ci_matrix.json; build-ci-matrix.js fails the run if it does.