テスト
parseUrlやhrefのテストをNodeで、useAppStateを使うコンポーネントのテストをブラウザで書けるようになります。テストごとにストアと保存した値を消す手順もわかります。
このページの内容
純粋な関数
src/state.test.tsimport { expect, test } from 'vitest';
import { density, listState } from './state';
test('a page below 1 reads as the first page', () => {
expect(listState.parseUrl({ page: '0' }).page).toBe(1);
});
test('a link leaves the defaults out', () => {
expect(listState.href('/products', { page: 1 })).toBe('/products');
});
test('a compact cookie reads back as compact', () => {
const cookies = new Map([
[density.cookieName, density.cookieValue({ density: 'compact' })],
]);
expect(density.parseCookies(cookies).density).toBe('compact');
});parseUrl、href、searchはブラウザのAPIを使いません。CookieのparseCookiesとcookieValueも同じです。Nodeで動くふつうのテストで確かめられます。
parseUrlにはURLSearchParamsか、フレームワークがページに渡す形のオブジェクトを渡します。parseCookiesにはMapで作ったCookieを渡します。
ブラウザでのテスト
useAppStateを使うコンポーネントは、本物のNavigation APIとWeb Storage、Cookie Store APIの上で動きます。ブラウザの中でテストします。このパッケージ自身はVitestのブラウザモードでテストしています。
Cookieの状態を確かめるテストは、HTTPSで配信します。Cookie Store APIが付けるSecureの扱いはCookieを参照してください。
テスト間の後始末
import { resetStateRegistry } from '@k8ordo/state';
import { afterEach } from 'vitest';
import { density, prefs } from './state';
afterEach(async () => {
resetStateRegistry();
localStorage.removeItem(prefs.storageKey);
await cookieStore.delete(density.cookieName);
});ストアはProviderの下にはなく、モジュールの中の登録表に残ります。resetStateRegistry()で登録表を空にしないと、前のテストの状態が次のテストに持ち越されます。
登録表を空にしても、ブラウザに保存した値は残ります。localStorageとsessionStorageの値は定義のstorageKeyで、CookieはcookieNameで消します。
落とし穴
resetStateRegistry()の前に、コンポーネントをアンマウントします。マウントされたままのフックは、クロージャを通して古いストアを持ち続けます。
ルーターの代わり
import { mountPageUrl } from '@k8ordo/state/testing';
beforeEach(() => mountPageUrl());URLを変えるupdate()はnavigation.navigate()を呼びます。どのリスナーもintercept()を呼ばなければ、別のドキュメントの読み込みになります。テストを動かしているページごと移動してしまいます。@k8ordo/state/testingのmountPageUrl()は、ルーターの代わりにnavigateイベントをintercept()します。
mountPageUrl()は後始末の関数を返します。この関数はresetStateRegistry()を呼び、URLと履歴エントリの状態を呼ぶ前のものに戻します。VitestとStorybookはbeforeEachが返した関数をテストのあとに呼ぶので、そのまま返せば足ります。
beforeEach(() => mountPageUrl({ search: 'q=css', hash: '3' }));テストを始めるURLは引数で決めます。searchは、ページに元からあるパラメーターの後ろに、渡した綴りのまま足されます。hashはフラグメントになります。
ほかのタブの再現
localStorage.setItem(
prefs.storageKey,
JSON.stringify({ view: 'table', pageSize: 20 }),
);
window.dispatchEvent(
new StorageEvent('storage', {
key: prefs.storageKey,
storageArea: localStorage,
}),
);storageイベントは、書き込んだドキュメント自身では発火しません。setItemで値を書いてから、StorageEventを自分で発火させると、ほかのタブからの書き込みの代わりになります。
await cookieStore.set(
density.cookieName,
encodeURIComponent(density.cookieValue({ density: 'compact' })),
);Cookie Store APIのchangeイベントは、同じタブでも発火します。テストが自分でcookieStore.set()を呼べば、それがほかのタブからの書き込みの代わりになります。値はupdate()が書くときと同じく、パーセントエンコードして書きます。