Skip to content

feat(issues): Restore issue details tour, remove guide#116355

Merged
scttcper merged 8 commits into
masterfrom
scttcper/restore-issue-details-tour-launcher
May 29, 2026
Merged

feat(issues): Restore issue details tour, remove guide#116355
scttcper merged 8 commits into
masterfrom
scttcper/restore-issue-details-tour-launcher

Conversation

@scttcper
Copy link
Copy Markdown
Member

@scttcper scttcper commented May 27, 2026

The old issue details guide was still wired into anchors that no longer exist, while the current tour had no launcher when the backend marked it unseen.

Removes the stale guide and anchor wrappers, keeps the existing tour, and lazy-loads the start tour modal when we should show it.

Brings back the tour, can be manually triggered #issue-details-tour on the issue details page

image

The old issue details guide was still wired into anchors that no longer exist, while the current tour had no launcher when the backend marked it unseen.

Remove the stale guide and anchor wrappers, keep the existing tour, and lazy-load the start tour modal when the backend says to show it.

Co-Authored-By: Codex GPT-5 <noreply@openai.com>
@github-actions github-actions Bot added the Scope: Frontend Automatically applied to PRs that change frontend components label May 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

📊 Type Coverage Diff

✅ No new type safety issues introduced. Coverage: 93.59%

@scttcper scttcper changed the title fix(issues): Restore issue details tour launcher feat(issues): Restore issue details tour, remove guide May 27, 2026
@scttcper scttcper requested a review from a team May 27, 2026 23:13
@scttcper scttcper marked this pull request as ready for review May 27, 2026 23:13
@scttcper scttcper requested a review from a team as a code owner May 27, 2026 23:13
The issue details guide is gone, so use the existing trace guide as the replacement fixture.

Render all of its anchors so the test covers the actual guide flow instead of depending on missing-step filtering.
Copy link
Copy Markdown
Member

@roggenkemper roggenkemper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall looks good and works as intended - only comment is i wonder if this tour should also highlight the copy button
Screenshot 2026-05-29 at 4 10 16 PM

Comment on lines 837 to 841
orderedStepIds={ORDERED_ISSUE_DETAILS_TOUR}
TourContext={IssueDetailsTourContext}
>
<IssueDetailsTourModal />
<GroupDetailsContent
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The issue details tour modal will not open for SOURCEMAP_CONFIGURATION and LOW_VALUE_SPAN_CONFIGURATION issues because some required tour steps are conditionally rendered and never register.
Severity: MEDIUM

Suggested Fix

Consider setting the requireAllStepsRegistered prop on TourContextProvider to false to allow the tour to run with a subset of steps. Alternatively, conditionally register tour steps based on the issue type's configuration, ensuring that only available steps are expected by the tour context for the tour to be considered 'registered'.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: static/app/views/issueDetails/groupDetails.tsx#L837-L841

Potential issue: The `TourContextProvider` is configured with
`requireAllStepsRegistered` set to `true`, meaning all tour steps must be registered
before the tour can start. However, for `SOURCEMAP_CONFIGURATION` and
`LOW_VALUE_SPAN_CONFIGURATION` issue types, the `filterBar` and `eventNavigation` are
disabled in their configuration. This prevents the `IssueDetailsTour.FILTERS` and
`IssueDetailsTour.NAVIGATION` steps from being rendered and registered. Consequently,
the `isRegistered` state in the tour context never becomes `true`. The
`useIssueDetailsTourModal` hook includes a check `if (!isRegistered || ...)` which then
prevents the tour modal from ever being displayed for these issue types, even when
forced via a URL hash.

Did we get this right? 👍 / 👎 to inform future reviews.

@scttcper scttcper merged commit 3d2d19e into master May 29, 2026
75 checks passed
@scttcper scttcper deleted the scttcper/restore-issue-details-tour-launcher branch May 29, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Scope: Frontend Automatically applied to PRs that change frontend components

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants