orca/tests/e2e/onboarding.spec.ts

569 lines
24 KiB
TypeScript

/* eslint-disable max-lines -- Why: onboarding E2E coverage shares one first-launch wizard fixture and step helpers; splitting this file would make the linear flow harder to audit. */
/**
* E2E tests for the first-launch Onboarding flow.
*
* The onboarding overlay is gated by `OnboardingState.closedAt === null` (see
* `shouldShowOnboarding` in `should-show-onboarding.ts`). Each test gets a fresh
* Electron instance + isolated userData dir, so persistence starts clean and
* the overlay renders on first paint without any setup.
*/
import { test, expect } from './helpers/orca-app'
import { waitForSessionReady } from './helpers/store'
import type { Page } from '@stablyai/playwright-test'
import type { GlobalSettings, TuiAgent } from '../../src/shared/types'
type OnboardingState = {
closedAt: number | null
outcome: 'completed' | 'dismissed' | null
lastCompletedStep: number
checklist: Record<string, boolean>
}
const ORCHESTRATION_ENABLED_STORAGE_KEY = 'orca.orchestration.enabled'
const BROWSER_USE_ENABLED_STORAGE_KEY = 'orca.browserUse.enabled'
async function getOnboardingState(page: Page): Promise<OnboardingState> {
return page.evaluate(() => window.api.onboarding.get() as Promise<OnboardingState>)
}
async function getSettings(page: Page): Promise<GlobalSettings> {
return page.evaluate(() => window.api.settings.get())
}
async function getDocumentThemeClass(page: Page): Promise<'dark' | 'light'> {
return page.evaluate(() =>
document.documentElement.classList.contains('dark') ? 'dark' : 'light'
)
}
async function installSafeOnboardingFeatureSetupDeps(page: Page): Promise<void> {
await page.evaluate(() => {
window.__onboardingFeatureSetupDeps = {
getCliStatus: async () => ({
platform: 'darwin',
commandName: 'orca',
commandPath: '/usr/local/bin/orca',
pathDirectory: '/usr/local/bin',
pathConfigured: true,
launcherPath: '/Applications/Orca.app/Contents/MacOS/Orca',
installMethod: 'symlink',
supported: true,
state: 'installed',
currentTarget: '/Applications/Orca.app/Contents/MacOS/Orca',
unsupportedReason: null,
detail: null
}),
installCli: async () => {
throw new Error('CLI registration should not run in this onboarding E2E')
},
writeClipboardText: async (text) => {
localStorage.setItem('orca.e2e.onboardingFeatureSetupClipboard', text)
},
getComputerUsePermissionStatus: async () => ({
platform: 'darwin',
permissions: [
{ id: 'accessibility', status: 'granted' },
{ id: 'screenshots', status: 'granted' }
]
}),
openComputerUsePermissionSetup: async () => {
throw new Error('Computer Use setup should not open in this onboarding E2E')
},
setStorageItem: (key, value) => localStorage.setItem(key, value),
removeStorageItem: (key) => localStorage.removeItem(key),
notifyOrchestrationStateChanged: () => {
window.dispatchEvent(new CustomEvent('orca:orchestration-setup-state'))
}
}
})
}
async function expectSkillSetupTerminalReady(page: Page): Promise<void> {
await expect(page.getByRole('region', { name: /Skill setup command/i })).toBeInViewport({
timeout: 10_000
})
await expect(
page.getByText(/Press Enter to run the command and confirm npm if asked/i)
).toBeVisible()
await expect
.poll(
async () =>
page.evaluate(() => document.activeElement?.classList.contains('xterm-helper-textarea')),
{
timeout: 10_000,
message: 'Skill setup command terminal did not receive keyboard focus'
}
)
.toBe(true)
}
function onboardingFooter(page: Page) {
return page.locator('footer').filter({ hasText: /Skip all onboarding/i })
}
function onboardingFooterButton(page: Page, name: RegExp) {
return onboardingFooter(page).getByRole('button', { name })
}
async function continueOnboarding(page: Page): Promise<void> {
await onboardingFooterButton(page, /^Continue\b/).click()
}
async function setupOnboardingFeatures(page: Page): Promise<void> {
await onboardingFooterButton(page, /^Set up\b/).click()
}
test.describe('Onboarding flow', () => {
// Why: the shared fixture pre-seeds onboarding as closed so non-onboarding
// tests don't get blocked by the fullscreen overlay. Opt out here so this
// spec actually exercises the first-launch flow.
test.use({ dismissOnboarding: false })
test.beforeEach(async ({ orcaPage }) => {
// Per-test userData is freshly minted by the orcaPage fixture, so persisted
// onboarding state defaults to `closedAt: null, lastCompletedStep: -1` and
// the overlay paints on its own once App's bootstrap effect resolves.
await waitForSessionReady(orcaPage)
})
test('renders on first launch with the agent step active', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
await expect(orcaPage.getByText('1 of 4')).toBeVisible()
await expect(onboardingFooterButton(orcaPage, /^Continue\b/)).toBeVisible()
await expect(onboardingFooterButton(orcaPage, /Skip all onboarding/i)).toBeVisible()
// Why: Back is not rendered on the first step (was previously rendered-but-
// disabled with `disabled:invisible`, now conditionally mounted).
await expect(orcaPage.getByRole('button', { name: 'Back', exact: true })).toHaveCount(0)
// Footer hint shows the platform-correct continue shortcut (⌘ on Mac,
// Ctrl elsewhere). Match either form so the test runs cross-platform.
// Why: scope to the footer action so background UI shortcut hints cannot
// false-positive this assertion.
await expect(
onboardingFooterButton(orcaPage, /^Continue\b/)
.locator('span')
.filter({ hasText: /⌘|Ctrl/ })
.first()
).toBeVisible()
})
test('Continue advances steps, persists progress, and applies user-visible settings', async ({
orcaPage
}) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
// --- Step 1: agent ---
// Force a deterministic, non-default selection so the assertion below
// proves the wizard actually wrote the user's choice (not just the
// pre-selected detected agent). Codex sits in the top-6 catalog when no
// agents are detected, otherwise behind the "Show N more agents" details
// expander — open it if codex isn't visible.
const targetAgent: TuiAgent = 'codex'
const codexButton = orcaPage.getByRole('button', { name: /^Codex\s/ })
// Why: isVisible() is a one-shot probe — on slow renderer paint it would
// race the wizard mount and falsely take the "show more agents" branch.
// waitFor with a small timeout actually retries until the button paints.
const codexVisible = await codexButton
.first()
.waitFor({ state: 'visible', timeout: 1_000 })
.then(() => true)
.catch(() => false)
if (!codexVisible) {
await orcaPage.getByText(/Show \d+ more agents/).click()
}
await codexButton.click()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await expect(orcaPage.getByText('2 of 4')).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000,
message: 'lastCompletedStep did not advance to 1 after first Continue'
})
.toBe(1)
// The agent choice must be persisted to settings (the user will see this
// pre-selected when they later open a new tab / agent picker).
await expect
.poll(async () => (await getSettings(orcaPage)).defaultTuiAgent, { timeout: 5_000 })
.toBe(targetAgent)
// --- Step 2: theme ---
// Default settings.theme is 'system', so the document class can resolve to
// either 'dark' or 'light' depending on the host. Click the opposite tile
// so we always observe a live flip — the assertion that proves the wizard
// applies the choice immediately, not just on Continue.
// Why: 'system' resolves async on mount, so wait for the class to settle
// before snapshotting — otherwise startingTheme can be stale.
await orcaPage.waitForFunction(
() =>
document.documentElement.classList.contains('dark') ||
document.documentElement.classList.contains('light')
)
const startingTheme = await getDocumentThemeClass(orcaPage)
const oppositeTheme: 'dark' | 'light' = startingTheme === 'dark' ? 'light' : 'dark'
const oppositeTileName = oppositeTheme === 'light' ? /Bright & crisp/ : /Easy on the eyes/
await orcaPage.getByRole('button', { name: oppositeTileName }).click()
await expect
.poll(async () => getDocumentThemeClass(orcaPage), { timeout: 5_000 })
.toBe(oppositeTheme)
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Set up Orca for agents/i })).toBeVisible()
await expect(orcaPage.getByText('3 of 4')).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000,
message: 'lastCompletedStep did not advance to 2 after second Continue'
})
.toBe(2)
await expect
.poll(async () => (await getSettings(orcaPage)).theme, { timeout: 5_000 })
.toBe(oppositeTheme)
// --- Step 3: notifications ---
// Why: the wizard force-defaults every toggle ON (use-onboarding-flow.ts),
// which intentionally diverges from the app defaults (terminalBell=false,
// suppressWhenFocused=true). Use the default setup action without touching
// the toggles; the assertions prove the wizard wrote its opt-in defaults
// through IPC, including the inverted suppressWhenFocused.
// Why: the feature checklist also defaults ON; inject safe deps so this
// E2E validates persistence without registering the real CLI or opening
// OS permission prompts.
await installSafeOnboardingFeatureSetupDeps(orcaPage)
const browserUse = orcaPage.getByRole('checkbox', { name: /Agent Browser Use/i })
const computerUse = orcaPage.getByRole('checkbox', { name: /Computer Use/i })
const orchestration = orcaPage.getByRole('checkbox', { name: /Agent Orchestration/i })
await expect(browserUse).toHaveAttribute('aria-checked', 'true')
await expect(computerUse).toHaveAttribute('aria-checked', 'true')
await expect(orchestration).toHaveAttribute('aria-checked', 'true')
await setupOnboardingFeatures(orcaPage)
await expectSkillSetupTerminalReady(orcaPage)
await expect(onboardingFooterButton(orcaPage, /^Continue\b/)).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
await expect(orcaPage.getByText('4 of 4')).toBeVisible()
await expect(orcaPage.getByRole('button', { name: 'Continue' })).toHaveCount(0)
await expect(orcaPage.getByRole('button', { name: /Open a folder/i })).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000
})
.toBe(3)
// Verify all three notification fields landed in settings, including the
// inverted suppressWhenFocused boundary (UI: notifyWhenFocused=true →
// persisted: suppressWhenFocused=false).
await expect
.poll(
async () => {
const s = await getSettings(orcaPage)
return {
agentTaskComplete: s.notifications.agentTaskComplete,
terminalBell: s.notifications.terminalBell,
suppressWhenFocused: s.notifications.suppressWhenFocused,
enabled: s.notifications.enabled
}
},
{ timeout: 5_000 }
)
.toEqual({
agentTaskComplete: true,
terminalBell: true,
suppressWhenFocused: false,
enabled: true
})
await expect
.poll(
async () =>
orcaPage.evaluate(
({ orchestrationKey, browserUseKey }) => ({
orchestration: localStorage.getItem(orchestrationKey),
browserUse: localStorage.getItem(browserUseKey)
}),
{
orchestrationKey: ORCHESTRATION_ENABLED_STORAGE_KEY,
browserUseKey: BROWSER_USE_ENABLED_STORAGE_KEY
}
),
{ timeout: 5_000 }
)
.toEqual({ orchestration: '1', browserUse: '1' })
})
test('Cmd/Ctrl+Enter advances steps like Continue', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
// Why: the OS the renderer reports drives whether Cmd or Ctrl is the
// accelerator (OnboardingFlow.tsx checks navigator.userAgent).
const isMac = await orcaPage.evaluate(() => navigator.userAgent.includes('Mac'))
const accelerator = isMac ? 'Meta+Enter' : 'Control+Enter'
// Why: in headless Linux CI the window-level capture-phase listener can
// miss synthetic keyboard events when no element holds focus. Click an
// inert area inside the overlay first to anchor focus, then press.
await orcaPage.locator('footer').click({ position: { x: 1, y: 1 } })
await orcaPage.keyboard.press(accelerator)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000
})
.toBe(1)
})
test('selected agent button reports aria-pressed=true', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
const codexButton = orcaPage.getByRole('button', { name: /^Codex\s/ })
const codexVisible = await codexButton
.first()
.waitFor({ state: 'visible', timeout: 1_000 })
.then(() => true)
.catch(() => false)
if (!codexVisible) {
await orcaPage.getByText(/Show \d+ more agents/).click()
}
await codexButton.click()
// Why: AgentButton now sets aria-pressed so screen readers and assistive
// tech can announce the selection. Verify the attribute reflects state.
await expect(codexButton).toHaveAttribute('aria-pressed', 'true')
})
test('notification toggles flip independently and persist on Continue', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Set up Orca for agents/i })).toBeVisible()
// Why: NotificationStep buttons expose role="switch" + aria-checked. Flip
// terminalBell off and verify the toggle reflects + persists. The other
// two toggles stay at their wizard-default ON state.
const bellSwitch = orcaPage.getByRole('switch', { name: /Terminal bell/i })
await expect(bellSwitch).toHaveAttribute('aria-checked', 'true')
await bellSwitch.click()
await expect(bellSwitch).toHaveAttribute('aria-checked', 'false')
await installSafeOnboardingFeatureSetupDeps(orcaPage)
await setupOnboardingFeatures(orcaPage)
await expect(orcaPage.getByRole('region', { name: /Skill setup command/i })).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
await expect
.poll(
async () => {
const s = await getSettings(orcaPage)
return {
agentTaskComplete: s.notifications.agentTaskComplete,
terminalBell: s.notifications.terminalBell
}
},
{ timeout: 5_000 }
)
.toEqual({ agentTaskComplete: true, terminalBell: false })
})
test('can opt into orchestration setup without enabling browser or computer use', async ({
orcaPage
}) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Set up Orca for agents/i })).toBeVisible()
// Why: this flow validates the orchestration-only setup path without
// touching Browser Use, Computer Use permission prompts, or real CLI mutation.
await orcaPage.evaluate(() => {
window.__onboardingFeatureSetupDeps = {
getCliStatus: async () => ({
platform: 'darwin',
commandName: 'orca',
commandPath: '/usr/local/bin/orca',
pathDirectory: '/usr/local/bin',
pathConfigured: true,
launcherPath: '/Applications/Orca.app/Contents/MacOS/Orca',
installMethod: 'symlink',
supported: true,
state: 'installed',
currentTarget: '/Applications/Orca.app/Contents/MacOS/Orca',
unsupportedReason: null,
detail: null
}),
installCli: async () => {
throw new Error('CLI registration should not run in this onboarding E2E')
},
writeClipboardText: async () => undefined,
getComputerUsePermissionStatus: async () => {
throw new Error('Computer Use permissions should stay untouched')
},
openComputerUsePermissionSetup: async () => {
throw new Error('Computer Use setup should stay untouched')
},
setStorageItem: (key, value) => localStorage.setItem(key, value),
removeStorageItem: (key) => localStorage.removeItem(key),
notifyOrchestrationStateChanged: () => {
window.dispatchEvent(new CustomEvent('orca:orchestration-setup-state'))
}
}
})
const browserUse = orcaPage.getByRole('checkbox', { name: /Agent Browser Use/i })
const computerUse = orcaPage.getByRole('checkbox', { name: /Computer Use/i })
const orchestration = orcaPage.getByRole('checkbox', { name: /Agent Orchestration/i })
await expect(browserUse).toHaveAttribute('aria-checked', 'true')
await expect(computerUse).toHaveAttribute('aria-checked', 'true')
await expect(orchestration).toHaveAttribute('aria-checked', 'true')
await browserUse.click()
await computerUse.click()
await expect(browserUse).toHaveAttribute('aria-checked', 'false')
await expect(computerUse).toHaveAttribute('aria-checked', 'false')
await expect(orchestration).toHaveAttribute('aria-checked', 'true')
await setupOnboardingFeatures(orcaPage)
await expect(orcaPage.getByRole('region', { name: /Skill setup command/i })).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000
})
.toBe(3)
await expect
.poll(
async () =>
orcaPage.evaluate(
({ orchestrationKey, browserUseKey }) => ({
orchestration: localStorage.getItem(orchestrationKey),
browserUse: localStorage.getItem(browserUseKey)
}),
{
orchestrationKey: ORCHESTRATION_ENABLED_STORAGE_KEY,
browserUseKey: BROWSER_USE_ENABLED_STORAGE_KEY
}
),
{ timeout: 5_000 }
)
.toEqual({ orchestration: '1', browserUse: '0' })
})
test('typing in the clone-url input does not hijack Enter as a global shortcut', async ({
orcaPage
}) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
// Advance to the repo step.
await continueOnboarding(orcaPage)
await continueOnboarding(orcaPage)
await installSafeOnboardingFeatureSetupDeps(orcaPage)
await setupOnboardingFeatures(orcaPage)
await expectSkillSetupTerminalReady(orcaPage)
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
// Why: focus the clone-url input and press Cmd/Ctrl+Enter. The capture-
// phase keydown handler should bail via isEditableTarget, so the folder
// picker IPC must NOT fire (the heading should remain visible — no
// navigation, no opened OS dialog). A bare Enter press also must not
// submit the empty form (the Clone button is disabled when blank).
const isMac = await orcaPage.evaluate(() => navigator.userAgent.includes('Mac'))
const accelerator = isMac ? 'Meta+Enter' : 'Control+Enter'
const input = orcaPage.getByPlaceholder('git@github.com:org/repo.git')
await input.click()
await input.press(accelerator)
// Brief wait so any (incorrect) handler firing would have already happened.
await orcaPage.waitForTimeout(250)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
// Onboarding must still be open (closedAt remains null).
expect((await getOnboardingState(orcaPage)).closedAt).toBeNull()
})
test('Back returns to the previous step without losing progress', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000
})
.toBe(1)
// Why: exact match — the app sidebar also exposes a "Go back" button that
// would otherwise match this regex.
await orcaPage.getByRole('button', { name: 'Back', exact: true }).click()
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible()
await expect(orcaPage.getByText('1 of 4')).toBeVisible()
// Why: "without losing progress" means persisted lastCompletedStep stays
// at 1 — Back rewinds the visible step but must not roll persistence back.
// Poll because persistence flushes async via IPC after the Back click.
await expect
.poll(async () => (await getOnboardingState(orcaPage)).lastCompletedStep, {
timeout: 5_000
})
.toBe(1)
})
test('Skip all onboarding on the repo step dismisses onboarding', async ({ orcaPage }) => {
await expect(orcaPage.getByRole('heading', { name: /Pick your default agent/i })).toBeVisible({
timeout: 15_000
})
// Advance through the first three steps. The footer skip affordance
// dismisses the whole wizard even from the repo step.
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Make it feel like home/i })).toBeVisible()
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Set up Orca for agents/i })).toBeVisible()
await installSafeOnboardingFeatureSetupDeps(orcaPage)
await setupOnboardingFeatures(orcaPage)
await expectSkillSetupTerminalReady(orcaPage)
await continueOnboarding(orcaPage)
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toBeVisible()
await onboardingFooterButton(orcaPage, /Skip all onboarding/i).click()
// The overlay is unmounted once `closedAt` is set, so the heading must
// disappear from the DOM, not merely become invisible.
await expect(orcaPage.getByRole('heading', { name: /Point Orca at some code/i })).toHaveCount(
0,
{ timeout: 10_000 }
)
// Why: DOM unmount fires when closedAt flips in the renderer, but the
// main-process write can lag by an IPC tick. Poll until the persisted
// record reflects the dismissal before asserting on its shape.
await expect
.poll(async () => (await getOnboardingState(orcaPage)).closedAt !== null, {
timeout: 5_000
})
.toBe(true)
const final = await getOnboardingState(orcaPage)
expect(final.outcome).toBe('dismissed')
expect(final.checklist.dismissed).toBe(true)
// Why: dismiss path resets lastCompletedStep to -1 (use-onboarding-flow.ts
// closeWith) so a future re-open would start at step 1. Lock that in.
expect(final.lastCompletedStep).toBe(-1)
})
})