Chrome 拡張機能

はじめに

注意

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

以下のスニペットは、ソースが ./my-extension にある Manifest v2 拡張機能の バックグラウンドページ を取得します。

ヘッドレスモードで拡張機能を実行できる 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 [backgroundPage] = browserContext.backgroundPages();
  if (!backgroundPage)
    backgroundPage = await browserContext.waitForEvent('backgroundpage');

  // Test the background page as you would any other page.
  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 v2:
    let [background] = context.backgroundPages()
    if (!background)
      background = await context.waitForEvent('backgroundpage')
    */

    // for manifest v3:
    let [background] = context.serviceWorkers();
    if (!background)
      background = await context.waitForEvent('serviceworker');

    const extensionId = background.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');
});