feat: Guided Tours E2E Tests#2415
Draft
camielvs wants to merge 1 commit into
Draft
Conversation
🎩 PreviewA preview build has been created at: |
This was referenced Jun 12, 2026
This was referenced Jun 12, 2026
Collaborator
Author
3 tasks
Data-driven driver that walks each tour's JSON: asserts every step's data-tour anchor, performs the gating interaction (or clicks Next), and verifies advancement, finishing on the completion step. One thin spec per tour (navigating-editor, first-pipeline, subgraphs, using-secrets). The using-secrets spec drives the no-backend path: it fails the health ping and /api/secrets so the tour's in-memory mock backend handles the secret steps, runs them fully hands-on with normal gating, and asserts the Submit Run confirm stays disabled in mock mode. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
camielvs
force-pushed
the
06-11-feat_guided_tours_completion_metrics
branch
from
586e87d to
6bffb2c
Compare
camielvs
force-pushed
the
06-12-feat_guided_tours_e2e_tests
branch
from
f7adb0c to
f9ccfa0
Compare
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This PR is 100% AI generated.
End-to-end tests that replicate and verify the exact flow of every guided tour, so a UI change that breaks a tour is caught here (and points at the tour + step to fix) rather than shipping a broken tour.
Rather than four bespoke specs, this is a single data-driven driver that reads each tour's real JSON definition and walks it the way a user would:
tests/e2e/tours/tourDriver.ts—runTour(page, tour)opens the tour, then for each step: asserts the step's spotlight anchor resolves in the DOM (the core regression signal), performs the gating interaction (or clicks Next for passive steps), and waits for the tour to advance (synchronised on the?step=NURL the tour writes). It finishes on the completion step. A handler exists for everyinteractiontype — drag-from-library, edge connection, task select, set-argument, undock/redock window, subgraph navigate/unpack, marquee multi-select, create-subgraph, and the full secrets flow.navigating-editor,first-pipeline,subgraphs,using-secrets. Each loads the shipped tour JSON vialoadTour(...), so the test tracks the real tour and new steps are covered automatically (modulo a brand-new interaction type needing a handler).eslint.config.js— teachplaywright/expect-expectthatrunTourasserts internally.Because the driver asserts each step's
data-tour*anchor, removing or renaming an anchor a tour depends on fails the matching step by design.The
using-secretsspec exercises the no-backend path from #2405 / #2406: it fails the health ping and/api/secretsso the tour's in-memory mock backend serves the secret steps. The tour runs fully hands-on with normal gating, no/api/secretscalls fire, and the Submit Run confirm is asserted disabled (real run not wired in mock mode).Related Issue and Pull requests
Closes https://github.com/Shopify/oasis-frontend/issues/644
Sits on top of the guided-tour stack (#2405 / #2406 and the framework/tour PRs below them).
Type of Change
Checklist
Test Instructions
pnpm test:e2e tests/e2e/tours/— all four tour specs pass (run in parallel against a local dev server).using-secretsspec drives the no-backend path: it routes the health ping and/api/secretsto fail, so the tour'smockBackendactivates and the in-memory mock serves the secret steps. It asserts no/api/secretscalls fire and that Submit Run stays disabled in mock mode.Additional Comments
The centered tour popover overlaps a few dialog controls (Add Secret / submit confirm / the "Use Secret" lock button). The driver dispatches the click directly to those elements (
clickThrough) so React's handler still fires — the only spot where it doesn't use a real mouse click.