feat: Guided Tours Framework (First Pipeline)#2347
Draft
camielvs wants to merge 14 commits into
Draft
Conversation
🎩 PreviewA preview build has been created at: |
This was referenced Jun 2, 2026
Collaborator
Author
This was referenced Jun 2, 2026
f262b2f to
42a8c86
Compare
64f6366 to
da1c54e
Compare
ebfb573 to
3fa9ad5
Compare
da1c54e to
019a78f
Compare
019a78f to
fe394fe
Compare
3fa9ad5 to
fd171b1
Compare
7b2f4da to
34c3158
Compare
This was referenced Jun 3, 2026
925125e to
af99fa3
Compare
0a4fa58 to
07eb4a8
Compare
af99fa3 to
5601892
Compare
07eb4a8 to
768eaa3
Compare
Adds the first guided tour. A 14-step walkthrough of the v2 editor registered against the framework introduced in the parent PR. The tour covers menu bar, canvas, dockable panels, task interaction, and the Windows menu. Interactive steps exercise the framework's three primitives — `select-task`, `undock-window`, `redock-window` — each with a non-interactive fallback for when the prompted state is already met. The tour boots into a fresh temporary pipeline cloned from `example-pipelines/Intro-Hello World.pipeline.component.yaml`. DOM anchors added: - data-tour="editor-top-bar" / -menu-items / -top-bar-actions on the menu bar - data-tour="canvas-undo-redo" on the undo/redo cluster - data-tour="windows-menu-content" / -submenu-content on the Windows dropdown content - data-window-id / data-dock-window-content on docked + floating windows - data-task-name on task / IO nodes (via a new `domAttributes` arg on createEntityNode) WindowsMenu now dispatches a `resize` event on open/close so reactour re-measures the portalled dropdown content during step 14.
768eaa3 to
cf8eb6f
Compare
5601892 to
ef2132f
Compare
cdceeda to
be25cd4
Compare
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
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
The interaction primitives, popover positioning, and CSS utilities needed to power the second guided tour (#2312 — Build Your First Pipeline). No visible behavior on its own; all testing happens in #2312.
Builds directly on #2299 (which added the first three interactions). This PR introduces the remaining interactions a build-from-scratch tour needs, plus a handful of cross-cutting tour-step features.
What's new
New interaction types (
EditorTourBridge.tsx)Each is declared on a tour step via
interaction: "<name>"and auto-advances when its prompted action completes.expand-folder— advances when the named folder in the component library is expanded (matches[data-folder-name=...] [aria-expanded="true"]).library-search— advances when the search box value contains a target substring; debounced so the user finishes typing before the step moves on.add-task— advances when a task whose name matches a target substring is added to the canvas. Baseline counted at step start so pre-existing tasks don't false-trigger.add-input/add-output— generic count-based: advances whenspec.inputs.length/spec.outputs.lengthincreases.connect-edge— advances when a specific edge is drawn, matched by(sourceTaskName, sourcePortName, targetTaskName, targetPortName). The target task/port pair is optional — a step that wants any edge from a source port (e.g. dragging out a preview node) can omit them.set-argument— advances when a specific argument on any task has its value set to a non-empty string.Existing
select-task(from #2299) gets atargetTaskNamenarrowing — only the named task counts, not any task.Cross-cutting step features
ringSelectors— paint per-element rings via the new.tour-ringCSS class. Needed because reactour mergeshighlightedSelectorsinto one bounding-box highlight; per-handle rings (e.g. "highlight this specific output port and that specific input port") need a separate mechanism.requiresTaskSelected— auto-rewind to a previousselect-taskstep if the required task is no longer selected. Lets a downstream step depend on "Train XGBoost is still selected" without crashing if the user deselects.ensureWindowRestored— auto-restore a minimized/hidden dock window at step start, so the panel the step targets is actually visible.resetLibrarySearch— clear the component-library search box before the step's selector is queried (so the step doesn't open with stale filter state from an earlier step).libraryDragAllow— block drags of library items that don't match the step's target, so the user can't drag the wrong component when a step is asking for a specific one.Popover positioning
computeDefaultPopoverPositiongets a symmetric left-anchored tall-strip branch. The existing branch (added in feat: Guided Tours Foundation #2348) handled right-anchored panels for[data-dock-area="right"]in feat: Guided Tour - Navigating the Editor #2306; the new branch handles left docks for first-pipeline steps that highlight the component library.POPOVER_STYLES.clickAreaset topointer-events: noneso reactour's spotlight click-area doesn't intercept clicks on the interactive elements behind it (the user needs to actually drag library items to the canvas).Misc
TourStepregistry types extended with the new interaction fields (targetFolderName,targetSearchTerm,targetTaskName,targetComponentName,targetEdge,targetArgumentName, plus the cross-cutting flags above)..tour-ringCSS utility ineditor.css, with a React Flow handle override (position: absolute) so the class doesn't break handle layout when applied to ports.defaultPipelineYamlWithNamenowJSON.stringifys the name. Unrelated to tours, but pipelines named with YAML-special characters (colons, hashes) were breaking the YAML — first surfaced when a tour pipeline name contained a colon.Related Issue and Pull requests
Progresses https://github.com/Shopify/oasis-frontend/issues/583
Builds on #2299. Consumed by #2312 (First Pipeline tour content).
Type of Change
Checklist
Test Instructions
No visible behavior on its own — every new utility is unused until #2312 lands. Test in context with #2312 on top. Regression-only checks for this PR in isolation:
select-taskwithouttargetTaskNamestill advances on click of any task (the narrowing is opt-in).Additional Comments
Originally bundled into #2312 alongside the tour content; split out so reviewers can read the mechanics and the tour JSON separately.