fix: hide onboarding wizard when tracker state is unavailable #1906
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
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
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
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
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,114 @@ | ||
| import { ref } from 'vue'; | ||
| import { createPinia, setActivePinia } from 'pinia'; | ||
|
|
||
| import { beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { useOnboardingStore } from '~/components/Onboarding/store/onboardingStatus'; | ||
| import { useServerStore } from '~/store/server'; | ||
|
|
||
| type OnboardingQueryResult = { | ||
| customization?: { | ||
| onboarding?: { | ||
| status?: 'INCOMPLETE' | 'UPGRADE' | 'DOWNGRADE' | 'COMPLETED'; | ||
| isPartnerBuild?: boolean; | ||
| completed?: boolean; | ||
| completedAtVersion?: string | null; | ||
| }; | ||
| }; | ||
| }; | ||
|
|
||
| const { state, refetchMock, useQueryMock } = vi.hoisted(() => ({ | ||
| state: { | ||
| onboardingResult: null as unknown as ReturnType<typeof ref<OnboardingQueryResult | null>>, | ||
| onboardingLoading: null as unknown as ReturnType<typeof ref<boolean>>, | ||
| onboardingError: null as unknown as ReturnType<typeof ref<unknown>>, | ||
| osVersionRef: null as unknown as ReturnType<typeof ref<string>>, | ||
| }, | ||
| refetchMock: vi.fn(), | ||
| useQueryMock: vi.fn(), | ||
| })); | ||
|
|
||
| const createOnboardingResult = (): OnboardingQueryResult => ({ | ||
| customization: { | ||
| onboarding: { | ||
| status: 'INCOMPLETE', | ||
| isPartnerBuild: false, | ||
| completed: false, | ||
| completedAtVersion: null, | ||
| }, | ||
| }, | ||
| }); | ||
|
|
||
| describe('onboardingStatus store', () => { | ||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| setActivePinia(createPinia()); | ||
|
|
||
| state.onboardingResult = ref<OnboardingQueryResult | null>(createOnboardingResult()); | ||
| state.onboardingLoading = ref(false); | ||
| state.onboardingError = ref(null); | ||
| state.osVersionRef = ref('7.3.0'); | ||
| refetchMock.mockResolvedValue(undefined); | ||
|
|
||
| useQueryMock.mockReturnValue({ | ||
| result: state.onboardingResult, | ||
| loading: state.onboardingLoading, | ||
| error: state.onboardingError, | ||
| refetch: refetchMock, | ||
| }); | ||
|
|
||
| vi.mocked(useServerStore).mockReturnValue({ | ||
| osVersion: state.osVersionRef, | ||
| } as unknown as ReturnType<typeof useServerStore>); | ||
| }); | ||
|
|
||
| it('blocks onboarding modal while the onboarding query is still loading', () => { | ||
| state.onboardingResult.value = null; | ||
| state.onboardingLoading.value = true; | ||
|
|
||
| const store = useOnboardingStore(); | ||
|
|
||
| expect(store.hasOnboardingState).toBe(false); | ||
| expect(store.canDisplayOnboardingModal).toBe(false); | ||
| expect(store.shouldShowOnboarding).toBe(false); | ||
| }); | ||
|
|
||
| it('blocks onboarding modal when the onboarding query errors', () => { | ||
| state.onboardingResult.value = null; | ||
| state.onboardingError.value = new Error('Network error'); | ||
|
|
||
| const store = useOnboardingStore(); | ||
|
|
||
| expect(store.hasOnboardingState).toBe(false); | ||
| expect(store.hasOnboardingQueryError).toBe(true); | ||
| expect(store.canDisplayOnboardingModal).toBe(false); | ||
| expect(store.shouldShowOnboarding).toBe(false); | ||
| }); | ||
|
|
||
| it('allows onboarding modal when the onboarding query succeeds', () => { | ||
| const store = useOnboardingStore(); | ||
|
|
||
| expect(store.hasOnboardingQueryError).toBe(false); | ||
| expect(store.hasOnboardingState).toBe(true); | ||
| expect(store.canDisplayOnboardingModal).toBe(true); | ||
| expect(store.shouldShowOnboarding).toBe(true); | ||
| }); | ||
|
|
||
| it('keeps onboarding modal display enabled during refetch when onboarding data already exists', () => { | ||
| state.onboardingLoading.value = true; | ||
|
|
||
| const store = useOnboardingStore(); | ||
|
|
||
| expect(store.hasOnboardingState).toBe(true); | ||
| expect(store.canDisplayOnboardingModal).toBe(true); | ||
| expect(store.shouldShowOnboarding).toBe(true); | ||
| }); | ||
| }); | ||
|
|
||
| vi.mock('@vue/apollo-composable', () => ({ | ||
| useQuery: () => useQueryMock(), | ||
| })); | ||
|
|
||
| vi.mock('~/store/server', () => ({ | ||
| useServerStore: vi.fn(), | ||
| })); |
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.
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.
Uh oh!
There was an error while loading. Please reload this page.