mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 10:55:06 +03:00
0b53a1869f
Add `useSiwcQueryParamOptIn`, which flips on the ChatGPT sign-in rollout localStorage flag when `?siwc-enabled=1` is present, and call it from both pages/sign-in.tsx and pages/sign-up.tsx. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added support for enabling the sign-in experience via `?siwc-enabled=1`, automatically updating the stored opt-in flag on both sign-in and sign-up pages. * **Tests** * Added coverage confirming the stored flag is updated only for `siwc-enabled=1`, and not for missing, non-`1`, `0`, or repeated/array values. * Added assertions that the behavior is triggered consistently when rendering the sign-in and sign-up pages. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
88 lines
2.8 KiB
TypeScript
88 lines
2.8 KiB
TypeScript
import { renderHook } from '@testing-library/react'
|
||
import mockRouter from 'next-router-mock'
|
||
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
||
|
||
import { useSiwcQueryParamOptIn } from '../useSiwcQueryParamOptIn'
|
||
|
||
vi.mock('next/router', () => import('next-router-mock'))
|
||
|
||
// tests/vitestSetup.ts globally mocks `common`'s useParams to always return `{ ref: 'default' }`,
|
||
// which would make this hook's `siwcEnabled` lookup always undefined. Restore the real
|
||
// implementation here so useParams reflects the mocked router's query params.
|
||
vi.mock('common', async (importOriginal) => {
|
||
const actual = await importOriginal<typeof import('common')>()
|
||
return { ...actual }
|
||
})
|
||
|
||
const mockSetValue = vi.hoisted(() => vi.fn())
|
||
const mockUseLocalStorageQuery = vi.hoisted(() => vi.fn())
|
||
|
||
vi.mock('../useLocalStorage', () => ({
|
||
useLocalStorageQuery: mockUseLocalStorageQuery,
|
||
}))
|
||
|
||
describe('useSiwcQueryParamOptIn', () => {
|
||
beforeEach(() => {
|
||
mockRouter.setCurrentUrl('/sign-in')
|
||
mockSetValue.mockClear()
|
||
mockUseLocalStorageQuery.mockReturnValue([false, mockSetValue])
|
||
})
|
||
|
||
it('enables the flag when siwc-enabled=1 is present', () => {
|
||
mockRouter.setCurrentUrl('/sign-in?siwc-enabled=1')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).toHaveBeenCalledWith(true)
|
||
})
|
||
|
||
it('does nothing when the param is absent', () => {
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).not.toHaveBeenCalled()
|
||
})
|
||
|
||
it('does nothing for a non-"1" value', () => {
|
||
mockRouter.setCurrentUrl('/sign-in?siwc-enabled=true')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).not.toHaveBeenCalled()
|
||
})
|
||
|
||
it('does nothing when siwc-enabled=0', () => {
|
||
mockRouter.setCurrentUrl('/sign-in?siwc-enabled=0')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).not.toHaveBeenCalled()
|
||
})
|
||
|
||
it('only considers the first value when the param is repeated (array value)', () => {
|
||
// useParams (from 'common') flattens repeated query params to their first occurrence, so
|
||
// only the first "0" here is seen by the hook, and it does nothing.
|
||
mockRouter.setCurrentUrl('/sign-in?siwc-enabled=0&siwc-enabled=1')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).not.toHaveBeenCalled()
|
||
})
|
||
|
||
it('still calls the setter when the flag is already true (idempotent no-op is the setter’s job)', () => {
|
||
mockUseLocalStorageQuery.mockReturnValue([true, mockSetValue])
|
||
mockRouter.setCurrentUrl('/sign-in?siwc-enabled=1')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).toHaveBeenCalledWith(true)
|
||
})
|
||
|
||
it('works the same way on the sign-up URL', () => {
|
||
mockRouter.setCurrentUrl('/sign-up?siwc-enabled=1')
|
||
|
||
renderHook(() => useSiwcQueryParamOptIn())
|
||
|
||
expect(mockSetValue).toHaveBeenCalledWith(true)
|
||
})
|
||
})
|