UI崩壊の不安を解消:StorybookとChromaticによるビジュアルレグレッションテスト

Programming tutorial - IT technology blog
Programming tutorial - IT technology blog

CSSに潜む幽霊

想像してみてください。ヘッダーコンポーネントのパディング変数を1つ調整したとします。ローカルの開発サーバーでは完璧に見えます。しかし3日後、緊急のバグ報告が届きます。モバイル版の購入ボタンが画面外に押し出され、コンバージョン率が急落しているというのです。CSS ModulesやTailwindを使っていたとしても、現代のフロントエンドアプリは相互に関連し合っているため、「ローカル」な修正がグローバルな影響を及ぼすことがあります。

ロジックはJestの中にあり、レイアウトはブラウザの中にあります。 ユニットテストは関数が正しいデータを返すかどうかのチェックには優れていますが、ボタンが不可視になったり、サイドバーが左に15ピクセルずれたりすることには無力です。

ビジュアルレグレッションテスト(Visual Regression Testing)はこれを解決します。変更前後のUIのスクリーンショットをピクセル単位で比較することで、意図しないずれを即座にキャッチできます。私の経験では、40以上のコンポーネントを持つプロジェクトにこれを導入したところ、最初の1ヶ月でビジュアルバグの報告が約80%減少しました。

最強のコンビ:StorybookとChromatic

Storybookは、コンポーネントを独立して管理する場所です。UI要素をスタンドアロンのユニットとして構築することを強制されるため、メンテナンス性が大幅に向上します。しかし、Storybookは受動的です。すべての「ストーリー」を手動でクリックして正しく見えるか確認するのを待つだけです。ライブラリが100以上の状態に成長すると、手動での検証は現実的ではなくなります。

Chromaticはこのプロセスに永続的な「視覚的メモリ」を追加します。Storybookのメンテナーによって構築されたこのツールは、「見る」作業を自動化します。コードをプッシュするたびに、Chromaticはブラウザ群を起動してストーリーをレンダリングし、承認済みのベースラインと比較します。まるで写真のような記憶力を持ち、数秒ですべてのピクセルをレビューしてくれるチームメイトがいるようなものです。

はじめに:インストール

すでにStorybookが動作しているモダンなフレームワークのプロジェクトがあることを前提とします。もしない場合は、npx storybook@latest initを実行すれば約2分でセットアップできます。Chromaticをワークフローに取り入れるには、開発用依存関係としてインストールします。

npm install --save-dev chromatic

次に、プロジェクトをリンクします。chromatic.comにアクセスしてサインアップしてください。プロジェクトを作成すると、固有のproject-tokenが発行されます。これはUIの指紋のようなものなので、公開リポジトリには含めないようにしてください。

自動化:CI/CDとの統合

ローカルでテストを実行するのも良いですが、本当の安心感は自動化から得られます。package.jsonにトークンをハードコードしてはいけません。代わりにCI環境に重役を任せましょう。GitHub Actionsの場合は、.github/workflows/chromatic.ymlを作成します。

name: "UIレグレッションテスト"

on: push

jobs:
  chromatic-deployment:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # 必須!Chromaticはベースラインを見つけるために履歴を必要とします
      - name: 依存関係のインストール
        run: npm ci
      - name: Chromaticへのパブリッシュ
        uses: chromaui/action@v1
        with:
          projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}

fetch-depth: 0に注目してください。これは非常に重要です。ChromaticはGitの履歴を遡って、最後に「承認」されたベースラインコミットを見つける必要があります。これがないと、新しい変更を何と比較すべきか判断できなくなります。

信頼できる情報源(Source of Truth)の確立

最初の実行で「ベースライン」が確立されます。これはUIがあるべき姿を示す画像セットです。それ以降のプルリクエスト(PR)では、Chromaticが差分をハイライトします。変更が検出されるとビルドが一時停止し、人間が介入して判断します。「これはバグか、それともデザインを改善した結果か?」と。

実際のワークフロー

これが導入されると、日々のリズムが良い方向に変わります:

  • ビルド: コンポーネントのホバー状態やグローバルテーマを更新します。
  • プッシュ: ブランチをGitHubにプッシュします。
  • スキャン: ChromaticがChrome、Firefox、Safariで同時にスナップショットを自動的にキャプチャします。
  • 検証: ピクセルが移動した場合、サイドバイサイド(横並び)の差分へのリンクが含まれた PRコメントが届きます。変更箇所はハイコントラストな「ネオン」モードで強調され、1pxのずれも見逃すことはありません。

レスポンシブ対応のテストも同様に簡単です。ストーリーのパラメータに数行追加するだけで、モバイル用の320pxやデスブル用の1200pxなど、特定のブレークポイントでスナップショットを撮るようChromaticに指示できます。

// Button.stories.ts
export const ResponsiveTest = {
  parameters: {
    chromatic: { viewports: [320, 1200] },
  },
};

意図的な変更の承認

すべてのハイライトがエラーというわけではありません。プライマリボタンを青からインディゴに意図的に変更した場合も、Chromaticはフラグを立てます。その場合はダッシュボードで「Accept(承認)」をクリックするだけです。これでインディゴのボタンが新しいベースラインになります。これにより、ブランドのビジュアルアイデンティティが何百ものコミットを経てどのように進化したか、透明性の高い検索可能な監査証跡が作成されます。

ビジュアルテストは単にバグを見つけるためのものではなく、開発速度(ベロシティ)を高めるためのものです。ログインフォームのリファクタリング中に料金表が壊れていないと確信できれば、自信を持ってマージできます。UIレビューを主観的な「良さそうに見える」から、客観的でデータ駆動型のプロセスへと変えてくれます。

自信を持ってスケールさせる

このスタックを導入することは、フロントエンドチームにとって最もインパクトのある施策の一つです。デザインの意図とコードの現実の間のギャップを埋めてくれます。まずはボタン、入力フォーム、モーダルなどのコアなデザインシステムコンポーネントのスナップショットから始めましょう。規模が大きくなるにつれて、フルページのテンプレートへと広げていってください。「ちょっとしたCSSの修正」が週末を台無しにしようとする時、未来のあなたは過去の自分に感謝することでしょう。

Share: