Chrome 拡張機能

はじめに

注

拡張機能は、永続的なコンテキストで起動した場合にのみChromiumで動作します。カスタムブラウザ引数を使用すると、Playwrightの機能が一部損なわれる可能性があるため、自己責任でご使用ください。

Google ChromeとMicrosoft Edgeは、拡張機能をサイドロードするために必要なコマンドラインフラグを削除しました。そのため、PlaywrightにバンドルされているChromiumを使用してください。

以下のスニペットは、ソースが./my-extensionにあるManifest v3拡張機能のサービスワーカーを取得します。

ヘッドレスモードで拡張機能を実行できるchromiumチャネルの使用に注意してください。あるいは、ブラウザをヘッドモードで起動することもできます。

const { chromium } = require('playwright');

(async () => {
  const pathToExtension = require('path').join(__dirname, 'my-extension');
  const userDataDir = '/tmp/test-user-data-dir';
  const browserContext = await chromium.launchPersistentContext(userDataDir, {
    channel: 'chromium',
    args: [
      `--disable-extensions-except=${pathToExtension}`,
      `--load-extension=${pathToExtension}`
    ]
  });
  let [serviceWorker] = browserContext.serviceWorkers();
  if (!serviceWorker)
    serviceWorker = await browserContext.waitForEvent('serviceworker');

  // Test the service worker as you would any other worker.
  await browserContext.close();
})();

テスト実行時に拡張機能をロードするには、テストフィクスチャを使用してコンテキストを設定できます。また、拡張機能IDを動的に取得し、それを使用してポップアップページなどをロードしてテストすることもできます。

ヘッドレスモードで拡張機能を実行できるchromiumチャネルの使用に注意してください。あるいは、ブラウザをヘッドモードで起動することもできます。

まず、拡張機能をロードするフィクスチャを追加します

fixtures.ts

import { test as base, chromium, type BrowserContext } from '@playwright/test';
import path from 'path';

export const test = base.extend<{
  context: BrowserContext;
  extensionId: string;
}>({
  context: async ({ }, use) => {
    const pathToExtension = path.join(__dirname, 'my-extension');
    const context = await chromium.launchPersistentContext('', {
      channel: 'chromium',
      args: [
        `--disable-extensions-except=${pathToExtension}`,
        `--load-extension=${pathToExtension}`,
      ],
    });
    await use(context);
    await context.close();
  },
  extensionId: async ({ context }, use) => {
    // for manifest v3:
    let [serviceWorker] = context.serviceWorkers();
    if (!serviceWorker)
      serviceWorker = await context.waitForEvent('serviceworker');

    const extensionId = serviceWorker.url().split('/')[2];
    await use(extensionId);
  },
});
export const expect = test.expect;

次に、これらのフィクスチャをテストで使用します

import { test, expect } from './fixtures';

test('example test', async ({ page }) => {
  await page.goto('https://example.com');
  await expect(page.locator('body')).toHaveText('Changed by my-extension');
});

test('popup page', async ({ page, extensionId }) => {
  await page.goto(`chrome-extension://${extensionId}/popup.html`);
  await expect(page.locator('body')).toHaveText('my-extension popup');
});