-
-
Notifications
You must be signed in to change notification settings - Fork 10.1k
CLI: Review onboarding trigger logic on first dev run #34552
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
yannbf
merged 8 commits into
project/sb-agentic-setup
from
sidnioulz/fix-onboarding-ux-trigger
Apr 16, 2026
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
627ebbd
feat(init): write onboarding-pending cache entry after successful init
Sidnioulz 53aae10
feat(init): remove --initial-path=/onboarding from dev subprocess launch
Sidnioulz 09dc917
feat(dev): resolve initialPath from onboarding-pending cache with CLI…
Sidnioulz a34e916
Avoid onboarding agents
Sidnioulz b6829a8
fix(dev): remove detectAgent guard, restore addon-onboarding check an…
Sidnioulz 8334c6d
fix(dev): drop addon check, restore detectAgent guard, simplify resol…
Sidnioulz 7c569fd
Merge branch 'project/sb-agentic-setup' into sidnioulz/fix-onboarding…
Sidnioulz 96d1021
gracefully handle cache failures
yannbf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| // Use vi.hoisted so these are available when vi.mock factory runs | ||
| const { mockCacheGet, mockCacheRemove, mockDetectAgent } = vi.hoisted(() => ({ | ||
| mockCacheGet: vi.fn(), | ||
| mockCacheRemove: vi.fn(), | ||
| mockDetectAgent: vi.fn(), | ||
| })); | ||
|
|
||
| vi.mock('storybook/internal/common', async (importOriginal) => { | ||
| const actual = await importOriginal<typeof import('storybook/internal/common')>(); | ||
| return { | ||
| ...actual, | ||
| cache: { | ||
| get: mockCacheGet, | ||
| set: vi.fn(), | ||
| remove: mockCacheRemove, | ||
| }, | ||
| }; | ||
| }); | ||
|
|
||
| vi.mock('storybook/internal/telemetry', async (importOriginal) => { | ||
| const actual = await importOriginal<typeof import('storybook/internal/telemetry')>(); | ||
| return { ...actual, detectAgent: mockDetectAgent }; | ||
| }); | ||
|
|
||
| import { resolveOnboardingInitialPath } from './build-dev.ts'; | ||
|
|
||
| describe('resolveOnboardingInitialPath', () => { | ||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| mockDetectAgent.mockReturnValue(undefined); // default: not an agent | ||
| }); | ||
|
|
||
| it('returns /onboarding and removes cache entry when onboarding-pending is set and no CLI initialPath', async () => { | ||
| mockCacheGet.mockResolvedValue(true); | ||
| const result = await resolveOnboardingInitialPath(undefined); | ||
| expect(result).toBe('/onboarding'); | ||
| expect(mockCacheRemove).toHaveBeenCalledWith('onboarding-pending'); | ||
| }); | ||
|
|
||
| it('returns undefined and does not remove cache when onboarding-pending is absent', async () => { | ||
| mockCacheGet.mockResolvedValue(undefined); | ||
| const result = await resolveOnboardingInitialPath(undefined); | ||
| expect(result).toBeUndefined(); | ||
| expect(mockCacheRemove).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('returns CLI initialPath and does NOT remove cache when CLI initialPath is already set', async () => { | ||
| mockCacheGet.mockResolvedValue(true); | ||
| const result = await resolveOnboardingInitialPath('/my-story'); | ||
| expect(result).toBe('/my-story'); | ||
| expect(mockCacheRemove).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('returns undefined and does NOT remove cache when running in an agent context', async () => { | ||
| mockDetectAgent.mockReturnValue({ name: 'claude' }); | ||
| mockCacheGet.mockResolvedValue(true); | ||
| const result = await resolveOnboardingInitialPath(undefined); | ||
| expect(result).toBeUndefined(); | ||
| expect(mockCacheRemove).not.toHaveBeenCalled(); | ||
| }); | ||
| }); |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make onboarding cache persistence best-effort so
initcannot fail after successful setup.A failure in
cache.set(...)currently bubbles up and can failinit, even though onboarding redirection is non-critical state.Proposed fix
const shouldOnboard = newUser; if (shouldOnboard && FeatureCompatibilityService.supportsOnboarding(projectType)) { - await cache.set('onboarding-pending', true); + try { + await cache.set('onboarding-pending', true); + } catch (error) { + logger.debug( + `Failed to persist onboarding state: ${ + error instanceof Error ? error.message : String(error) + }` + ); + } }🤖 Prompt for AI Agents