Skip to content
⚠️ This article was written in 2020. Some content may be outdated.

Storybook 元件文件與測試

最近在團隊中落地Storybook 元件文件與測試,積累了不少經驗。整理出來供參考,希望對做類似工作的同學有所幫助。

核心概念

以下是一個完整的示例:

javascript
import { test, expect } from '@playwright/test'

test.describe('使用者登入流程', () => {
  test('成功登入跳轉到首頁', async ({ page }) => {
    await page.goto('/login')
    await page.fill('[data-testid="email"]', 'admin@example.com')
    await page.fill('[data-testid="password"]', 'admin123')
    await page.click('[data-testid="submit-btn"]')
    await expect(page).toHaveURL('/dashboard')
    await expect(page.locator('.welcome')).toContainText('歡迎回來')
  })
})

注意邊界條件處理,這在生產環境中至關重要。

深度解析

關鍵在於理解核心邏輯:

javascript
import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { LoginForm } from './LoginForm'

describe('LoginForm', () => {
  it('提交有效的登入表單', async () => {
    const onSubmit = jest.fn()
    render(<LoginForm onSubmit={onSubmit} />)
    await userEvent.type(screen.getByLabelText(/郵箱/), 'user@example.com')
    await userEvent.type(screen.getByLabelText(/密碼/), 'password123')
    await userEvent.click(screen.getByRole('button', { name: /登入/ }))
    await waitFor(() => {
      expect(onSubmit).toHaveBeenCalledWith({
        email: 'user@example.com', password: 'password123'
      })
    })
  })
})

效能最佳化需要結合具體場景,不是所有情況都需要過度最佳化。

落地經驗

我們可以通過以下方式來改進:

javascript
import { test, expect } from '@playwright/test'

test.describe('使用者登入流程', () => {
  test('成功登入跳轉到首頁', async ({ page }) => {
    await page.goto('/login')
    await page.fill('[data-testid="email"]', 'admin@example.com')
    await page.fill('[data-testid="password"]', 'admin123')
    await page.click('[data-testid="submit-btn"]')
    await expect(page).toHaveURL('/dashboard')
    await expect(page.locator('.welcome')).toContainText('歡迎回來')
  })
})

這套方案已經在線上穩定運行了半年以上,經過了實際驗證。

調優策略

先來看基本的實現方式:

javascript
import { render, screen, waitFor } from '@testing-library/react'
import userEvent from '@testing-library/user-event'
import { LoginForm } from './LoginForm'

describe('LoginForm', () => {
  it('提交有效的登入表單', async () => {
    const onSubmit = jest.fn()
    render(<LoginForm onSubmit={onSubmit} />)
    await userEvent.type(screen.getByLabelText(/郵箱/), 'user@example.com')
    await userEvent.type(screen.getByLabelText(/密碼/), 'password123')
    await userEvent.click(screen.getByRole('button', { name: /登入/ }))
    await waitFor(() => {
      expect(onSubmit).toHaveBeenCalledWith({
        email: 'user@example.com', password: 'password123'
      })
    })
  })
})

這段程式碼展示了基本的使用方式。實際專案中還需要考慮錯誤處理和邊界條件。

注意事項

在這個基礎上,我們可以進一步最佳化:

javascript
import { test, expect } from '@playwright/test'

test.describe('使用者登入流程', () => {
  test('成功登入跳轉到首頁', async ({ page }) => {
    await page.goto('/login')
    await page.fill('[data-testid="email"]', 'admin@example.com')
    await page.fill('[data-testid="password"]', 'admin123')
    await page.click('[data-testid="submit-btn"]')
    await expect(page).toHaveURL('/dashboard')
    await expect(page.locator('.welcome')).toContainText('歡迎回來')
  })
})

這種模式在大型專案中非常實用,能顯著降低維護成本。

小結

  • 不要為了用新技術而用新技術
  • 程式碼示例僅供參考,需根據業務場景調整
  • Storybook 元件文件與測試不是銀彈,需要根據專案規模和技術棧選擇

MIT Licensed