mirror of
https://github.com/supabase/supabase.git
synced 2026-10-11 12:25:05 +03:00
## Summary Re-ports PR #43119 against the current `ProjectHome` codebase (the original PR targeted `HomeNew/` which was removed during the `homeNew` graduation in #43437). Also unifies the `connectSheet` and `connectSection` feature flags into a single `connectSection` flag — the `connectSheet` flag is removed entirely, so both the ConnectSheet (header) and ConnectSection (homepage row) are controlled by one experiment. - Adds `connectSection` PostHog experiment flag that controls two things: 1. Swaps the Getting Started section for a Connect section on the project homepage for new projects (< 10 days old) 2. Swaps the legacy Connect dialog for the new ConnectSheet panel in the header - **Control** (`getting-started`): existing Getting Started section + legacy Connect dialog in header - **Treatment** (`connect`): new 4-tile Connect section + ConnectSheet in header - `undefined` (loading): neither section renders, avoiding flash - Tiles filtered by the same `useIsFeatureEnabled` flags as ConnectSheet (`show_app_frameworks`, `show_mobile_frameworks`, `show_orms`) - Connect tile clicks tracked via `home_connect_action_clicked`; section render tracked via `home_connect_section_exposed`; sheet opens tracked via `connect_sheet_opened` with source attribution (`header_button` or `connect_section`) ## Changes - `packages/common/telemetry-constants.ts` — new `home_connect_section_exposed`, `home_connect_action_clicked`, and `connect_sheet_opened` event types - `ConnectSheet/ConnectSheet.tsx` — read `connectTab` query param and sync to active mode on open; `handleModeChange` keeps param in sync on tab switch; fire `connect_sheet_opened` event with source attribution on open - `ConnectButton/ConnectButton.tsx` — set `connectSource=header_button` query param on click - `ProjectHome/ConnectSection.tsx` — new component (4-tile connect card); set `connectSource=connect_section` on tile click - `ProjectHome/Home.tsx` — experiment flag wiring - `LayoutHeader/LayoutHeader.tsx` — read `connectSection` flag instead of `connectSheet` to toggle ConnectSheet vs legacy Connect dialog ## Test plan To test on the Vercel preview, set `connectSection=connect` to 100% in PostHog (or override via cookie `ph_override_connectSection=connect`). No separate `connectSheet` flag is needed — `connectSection` controls both features. - [x] Treatment (`connect` variant) — "Get connected" section renders on new project, Getting Started hidden - [x] Control (`getting-started`) — Getting Started renders, Connect section hidden - [x] Mature project (> 10 days) — neither section regardless of flag - [x] Clicking each tile opens ConnectSheet on the correct tab (Framework / Direct / ORM / MCP) - [x] Switching tabs inside sheet updates `connectTab` URL param - [x] Closing sheet clears `connectTab` param - [x] Direct URL deep-link (`?showConnect=true&connectTab=orm`) opens sheet on correct tab - [x] Dark mode — background gradient renders correctly - [x] Light mode — background switches to light gradient - [x] Responsive layout — 4 cols (xl), 2×2 (md), stacked (mobile) - [x] Telemetry — `home_connect_section_exposed` fires once on load; `home_connect_action_clicked` fires with correct `mode` - [x] Treatment — header Connect button opens ConnectSheet (not legacy Connect dialog) - [x] Control — header Connect button opens legacy Connect dialog (not ConnectSheet) - [x] Telemetry — clicking a ConnectSection tile fires `connect_sheet_opened` with `source: 'connect_section'` - [x] Telemetry — clicking header Connect button fires `connect_sheet_opened` with `source: 'header_button'` --------- Co-authored-by: Ali Waseem <waseema393@gmail.com>
484 lines
17 KiB
TypeScript
484 lines
17 KiB
TypeScript
import { act, renderHook } from '@testing-library/react'
|
|
import { describe, expect, test } from 'vitest'
|
|
|
|
import { useConnectState } from './useConnectState'
|
|
|
|
describe('useConnectState', () => {
|
|
// ============================================================================
|
|
// Initial State Tests
|
|
// ============================================================================
|
|
|
|
describe('initial state', () => {
|
|
test('should initialize with framework mode by default', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
expect(result.current.state.mode).toBe('framework')
|
|
})
|
|
|
|
test('should initialize with nextjs as default framework', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
expect(result.current.state.framework).toBe('nextjs')
|
|
})
|
|
|
|
test('should initialize with app variant for nextjs', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
expect(result.current.state.frameworkVariant).toBe('app')
|
|
})
|
|
|
|
test('should initialize with supabasejs library', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
expect(result.current.state.library).toBe('supabasejs')
|
|
})
|
|
|
|
test('should accept initial state override', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({ mode: 'direct', connectionMethod: 'transaction' })
|
|
)
|
|
expect(result.current.state.mode).toBe('direct')
|
|
expect(result.current.state.connectionMethod).toBe('transaction')
|
|
})
|
|
|
|
test('should merge initial state with defaults', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'react' }))
|
|
expect(result.current.state.mode).toBe('framework')
|
|
expect(result.current.state.framework).toBe('react')
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Mode Switching Tests
|
|
// ============================================================================
|
|
|
|
describe('setMode', () => {
|
|
test('should switch to direct mode', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.setMode('direct')
|
|
})
|
|
|
|
expect(result.current.state.mode).toBe('direct')
|
|
})
|
|
|
|
test('should initialize direct mode defaults when switching', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.setMode('direct')
|
|
})
|
|
|
|
expect(result.current.state.connectionMethod).toBeDefined()
|
|
expect(result.current.state.connectionType).toBeDefined()
|
|
})
|
|
|
|
test('should switch to orm mode and initialize defaults', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.setMode('orm')
|
|
})
|
|
|
|
expect(result.current.state.mode).toBe('orm')
|
|
expect(result.current.state.orm).toBe('prisma')
|
|
})
|
|
|
|
test('should switch to mcp mode and initialize defaults', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.setMode('mcp')
|
|
})
|
|
|
|
expect(result.current.state.mode).toBe('mcp')
|
|
expect(result.current.state.mcpClient).toBeDefined()
|
|
})
|
|
|
|
test('should preserve framework state when switching back to framework mode', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
// Change framework
|
|
act(() => {
|
|
result.current.updateField('framework', 'react')
|
|
})
|
|
|
|
// Switch to direct
|
|
act(() => {
|
|
result.current.setMode('direct')
|
|
})
|
|
|
|
// Switch back to framework
|
|
act(() => {
|
|
result.current.setMode('framework')
|
|
})
|
|
|
|
expect(result.current.state.framework).toBe('react')
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Field Update Tests
|
|
// ============================================================================
|
|
|
|
describe('updateField', () => {
|
|
test('should update framework selection', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.updateField('framework', 'react')
|
|
})
|
|
|
|
expect(result.current.state.framework).toBe('react')
|
|
})
|
|
|
|
test('should cascade variant reset when changing framework', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
// Start with nextjs which has variants
|
|
expect(result.current.state.frameworkVariant).toBe('app')
|
|
|
|
// Switch to a framework with multiple variants
|
|
act(() => {
|
|
result.current.updateField('framework', 'react')
|
|
})
|
|
|
|
// Should have the first variant of react
|
|
expect(result.current.state.frameworkVariant).toBeDefined()
|
|
})
|
|
|
|
test('should remove variant when switching to framework without variants', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
// Start with nextjs which has variants
|
|
expect(result.current.state.frameworkVariant).toBe('app')
|
|
|
|
// Switch to remix which has no variants
|
|
act(() => {
|
|
result.current.updateField('framework', 'remix')
|
|
})
|
|
|
|
expect(result.current.state.frameworkVariant).toBeUndefined()
|
|
})
|
|
|
|
test('should update library when variant changes', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.updateField('frameworkVariant', 'pages')
|
|
})
|
|
|
|
expect(result.current.state.library).toBe('supabasejs')
|
|
})
|
|
|
|
test('should update connection method', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'direct' }))
|
|
|
|
act(() => {
|
|
result.current.updateField('connectionMethod', 'transaction')
|
|
})
|
|
|
|
expect(result.current.state.connectionMethod).toBe('transaction')
|
|
})
|
|
|
|
test('should clear useSharedPooler when connectionMethod changes to direct', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({
|
|
mode: 'direct',
|
|
connectionMethod: 'transaction',
|
|
useSharedPooler: true,
|
|
})
|
|
)
|
|
|
|
act(() => {
|
|
result.current.updateField('connectionMethod', 'direct')
|
|
})
|
|
|
|
// useSharedPooler is cleared because it depends on connectionMethod: ['transaction']
|
|
// When the dependency is not satisfied, the field is removed from state
|
|
expect(result.current.state.useSharedPooler).toBeUndefined()
|
|
})
|
|
|
|
test('should update MCP client', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'mcp' }))
|
|
|
|
act(() => {
|
|
result.current.updateField('mcpClient', 'codex')
|
|
})
|
|
|
|
expect(result.current.state.mcpClient).toBe('codex')
|
|
})
|
|
|
|
test('should update boolean fields', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
act(() => {
|
|
result.current.updateField('frameworkUi', true)
|
|
})
|
|
|
|
expect(result.current.state.frameworkUi).toBe(true)
|
|
})
|
|
|
|
test('should update ORM selection', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'orm' }))
|
|
|
|
act(() => {
|
|
result.current.updateField('orm', 'drizzle')
|
|
})
|
|
|
|
expect(result.current.state.orm).toBe('drizzle')
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Active Fields Tests
|
|
// ============================================================================
|
|
|
|
describe('activeFields', () => {
|
|
test('should return framework mode fields', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('framework')
|
|
})
|
|
|
|
test('should include variant field for nextjs', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'nextjs' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('frameworkVariant')
|
|
})
|
|
|
|
test('should include frameworkUi field for nextjs', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'nextjs' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('frameworkUi')
|
|
})
|
|
|
|
test('should not include frameworkUi for non-nextjs/react frameworks', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'remix' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).not.toContain('frameworkUi')
|
|
})
|
|
|
|
test('should return direct mode fields', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'direct' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('connectionMethod')
|
|
expect(fieldIds).toContain('connectionType')
|
|
})
|
|
|
|
test('should show useSharedPooler only for transaction connection method', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({ mode: 'direct', connectionMethod: 'transaction' })
|
|
)
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('useSharedPooler')
|
|
})
|
|
|
|
test('should hide useSharedPooler for direct connection method', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({ mode: 'direct', connectionMethod: 'direct' })
|
|
)
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).not.toContain('useSharedPooler')
|
|
})
|
|
|
|
test('should return orm mode fields', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'orm' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('orm')
|
|
})
|
|
|
|
test('should return mcp mode fields', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'mcp' }))
|
|
|
|
const fieldIds = result.current.activeFields.map((f) => f.id)
|
|
expect(fieldIds).toContain('mcpClient')
|
|
expect(fieldIds).toContain('mcpReadonly')
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Resolved Steps Tests
|
|
// ============================================================================
|
|
|
|
describe('resolvedSteps', () => {
|
|
test('should resolve steps for framework mode', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
expect(result.current.resolvedSteps.length).toBeGreaterThan(0)
|
|
})
|
|
|
|
test('should have install step for framework mode', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const stepIds = result.current.resolvedSteps.map((s) => s.id)
|
|
expect(stepIds).toContain('install')
|
|
})
|
|
|
|
test('should resolve different steps for mcp mode', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'mcp' }))
|
|
|
|
const stepIds = result.current.resolvedSteps.map((s) => s.id)
|
|
// MCP mode (defaults to claude-code) should have claude-add-server step
|
|
expect(stepIds.some((id) => id.includes('claude') || id.includes('mcp'))).toBe(true)
|
|
})
|
|
|
|
test('should resolve different steps for different mcp clients', () => {
|
|
const { result: cursorResult } = renderHook(() =>
|
|
useConnectState({ mode: 'mcp', mcpClient: 'cursor' })
|
|
)
|
|
const { result: codexResult } = renderHook(() =>
|
|
useConnectState({ mode: 'mcp', mcpClient: 'codex' })
|
|
)
|
|
|
|
// Codex has more steps than cursor
|
|
expect(codexResult.current.resolvedSteps.length).toBeGreaterThanOrEqual(
|
|
cursorResult.current.resolvedSteps.length
|
|
)
|
|
})
|
|
|
|
test('should include skills install step', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const stepIds = result.current.resolvedSteps.map((s) => s.id)
|
|
expect(stepIds).toContain('install-skills')
|
|
})
|
|
|
|
test('should resolve steps for direct mode', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'direct' }))
|
|
|
|
expect(result.current.resolvedSteps.length).toBeGreaterThan(0)
|
|
})
|
|
|
|
test('should resolve steps for orm mode', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'orm' }))
|
|
|
|
expect(result.current.resolvedSteps.length).toBeGreaterThan(0)
|
|
const stepIds = result.current.resolvedSteps.map((s) => s.id)
|
|
expect(stepIds).toContain('install')
|
|
expect(stepIds).toContain('configure')
|
|
})
|
|
|
|
test('should resolve shadcn steps when frameworkUi is true', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({ framework: 'nextjs', frameworkUi: true })
|
|
)
|
|
|
|
const stepIds = result.current.resolvedSteps.map((s) => s.id)
|
|
expect(stepIds).toContain('shadcn-add')
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Field Options Tests
|
|
// ============================================================================
|
|
|
|
describe('getFieldOptions', () => {
|
|
test('should return framework options', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const options = result.current.getFieldOptions('framework')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'nextjs')).toBe(true)
|
|
expect(options.some((o) => o.value === 'react')).toBe(true)
|
|
})
|
|
|
|
test('should return variant options for nextjs', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'nextjs' }))
|
|
|
|
const options = result.current.getFieldOptions('frameworkVariant')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'app')).toBe(true)
|
|
expect(options.some((o) => o.value === 'pages')).toBe(true)
|
|
})
|
|
|
|
test('should return empty variant options for frameworks without variants', () => {
|
|
const { result } = renderHook(() => useConnectState({ framework: 'remix' }))
|
|
|
|
const options = result.current.getFieldOptions('frameworkVariant')
|
|
expect(options).toEqual([])
|
|
})
|
|
|
|
test('should return connection method options', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'direct' }))
|
|
|
|
const options = result.current.getFieldOptions('connectionMethod')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'direct')).toBe(true)
|
|
expect(options.some((o) => o.value === 'transaction')).toBe(true)
|
|
})
|
|
|
|
test('should return connection type options', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'direct' }))
|
|
|
|
const options = result.current.getFieldOptions('connectionType')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'uri')).toBe(true)
|
|
expect(options.some((o) => o.value === 'psql')).toBe(true)
|
|
})
|
|
|
|
test('should return ORM options', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'orm' }))
|
|
|
|
const options = result.current.getFieldOptions('orm')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'prisma')).toBe(true)
|
|
expect(options.some((o) => o.value === 'drizzle')).toBe(true)
|
|
})
|
|
|
|
test('should return MCP client options', () => {
|
|
const { result } = renderHook(() => useConnectState({ mode: 'mcp' }))
|
|
|
|
const options = result.current.getFieldOptions('mcpClient')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
expect(options.some((o) => o.value === 'cursor')).toBe(true)
|
|
})
|
|
|
|
test('should return empty array for unknown field', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const options = result.current.getFieldOptions('unknownField')
|
|
expect(options).toEqual([])
|
|
})
|
|
|
|
test('should return library options for selected framework', () => {
|
|
const { result } = renderHook(() =>
|
|
useConnectState({ framework: 'nextjs', frameworkVariant: 'app' })
|
|
)
|
|
|
|
const options = result.current.getFieldOptions('library')
|
|
expect(options.length).toBeGreaterThan(0)
|
|
})
|
|
})
|
|
|
|
// ============================================================================
|
|
// Schema Access Tests
|
|
// ============================================================================
|
|
|
|
describe('schema', () => {
|
|
test('should expose the connect schema', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
expect(result.current.schema).toBeDefined()
|
|
expect(result.current.schema.modes).toBeDefined()
|
|
expect(result.current.schema.fields).toBeDefined()
|
|
expect(result.current.schema.steps).toBeDefined()
|
|
})
|
|
|
|
test('should have all expected modes in schema', () => {
|
|
const { result } = renderHook(() => useConnectState())
|
|
|
|
const modeIds = result.current.schema.modes.map((m) => m.id)
|
|
expect(modeIds).toContain('framework')
|
|
expect(modeIds).toContain('direct')
|
|
expect(modeIds).toContain('orm')
|
|
expect(modeIds).toContain('mcp')
|
|
})
|
|
})
|
|
})
|