テスト
Vitestのブラウザモードで、テストごとに状態を戻し、プロバイダの下でフックを描画して確かめられるようになります。
このページの内容
テストごとの初期化
color-scheme.test.tsximport { resetStateRegistry } from '@k8ordo/state';
import { beforeEach } from 'vitest';
beforeEach(() => {
localStorage.clear();
前のテストで保存した選択を消す
document.documentElement.classList.remove('dark');
プロバイダのeffectが付けたクラスを外す
resetStateRegistry();
@k8ordo/stateのストアをリセットする
});localStorageと<html>のクラス、@k8ordo/stateのストアは、どれもテストをまたいで残ります。ストアはキーごとに1つ作られ、resetStateRegistry()を呼ぶまで前のテストの値を保ちます。
メモ
resetStateRegistry()は、フックを使うコンポーネントをアンマウントしてから呼びます。マウントされたままのフックは古いストアを持ち続けます。vitest-browser-reactなら、前のテストの描画は各テストの前に片付けられます。
フックの描画
color-scheme.test.tsximport {
ColorSchemeProvider,
colorSchemeState,
useColorScheme,
} from '@k8ordo/color-scheme';
import type { ReactNode } from 'react';
import { expect, it, vi } from 'vitest';
import { renderHook } from 'vitest-browser-react';
const wrapper = ({ children }: { children: ReactNode }) => (
<ColorSchemeProvider>{children}</ColorSchemeProvider>
);
it('starts from a stored preference', async () => {
localStorage.setItem(
colorSchemeState.storageKey,
JSON.stringify({ preference: 'dark' }),
);
const { result } = await renderHook(() => useColorScheme(), {
wrapper,
});
expect(result.current.preference).toBe('dark');
expect(result.current.scheme).toBe('dark');
expect(
document.documentElement.classList.contains('dark'),
).toBe(true);
});useColorScheme()をプロバイダの外で呼ぶと、useColorScheme needs <ColorSchemeProvider> above itで始まるエラーになります。プロバイダをrenderHookのwrapperに渡して描画します。
localStorageのキーは、文字列で書かずにcolorSchemeState.storageKeyから読みます。キーの組み立て方は@k8ordo/stateが決めます。
選択の変更
color-scheme.test.tsxit('stores a choice, and stores none for system', async () => {
const { result } = await renderHook(() => useColorScheme(), {
wrapper,
});
result.current.setPreference('dark');
await vi.waitFor(() => {
expect(result.current.scheme).toBe('dark');
});
expect(
document.documentElement.classList.contains('dark'),
).toBe(true);
expect(localStorage.getItem(colorSchemeState.storageKey)).toBe(
'{"preference":"dark"}',
);
result.current.setPreference('system');
await vi.waitFor(() => {
expect(result.current.preference).toBe('system');
});
expect(
localStorage.getItem(colorSchemeState.storageKey),
).toBe('{}');
});setPreferenceを呼んでも、その場では再描画されません。localStorageへの書き込みも同じタスクの終わりにまとめて行われ、再描画までには終わっています。
schemeかpreferenceが変わるまでvi.waitForで待ってから、保存した値とクラスを確かめます。
'system'に戻すと、保存した値は{}になります。setPreferenceに渡す値ごとの保存した値は設定の保存先にあります。
OSがダークのブラウザ
vite.config.tsimport { playwright } from '@vitest/browser-playwright';
import { defineConfig } from 'vitest/config';
export default defineConfig({
test: {
browser: {
enabled: true,
provider: playwright({
contextOptions: { colorScheme: 'dark' },
}),
instances: [{ browser: 'chromium' }],
},
},
});'system'がどちらになるかは、テストを動かすブラウザのprefers-color-schemeで決まります。Playwrightで起動したブラウザは、指定しなければライトを好みます。'system'がOSの設定に従うことを確かめるときは、9行目のcolorScheme: 'dark'でブラウザのほうをダークにします。
この設定は、そのブラウザで動くすべてのテストにかかります。既定値から始まることだけを確かめるなら、defaultPreference="dark"を渡したプロバイダをwrapperにすれば足ります。
インラインスクリプト
テストのようにサーバーを通さずブラウザだけで描画すると、ColorSchemeScriptのインラインスクリプトは実行されません。Reactは、ブラウザで自分が作ったインラインの<script>を実行しません。
描画すると、開発ビルドのReactはEncountered a script tag while rendering React componentで始まるエラーをコンソールに出します。フックのテストではColorSchemeScriptを描かず、プロバイダだけをwrapperに渡します。
テストで確かめる<html>のクラスは、プロバイダのeffectが付けたクラスです。スクリプトが最初の描画の前にクラスを付けることは、パッケージ側のテストで確かめています。