テスト
ルート表のmatchはNodeで、<Router>を描画してページを移るテストはブラウザで書けるようになります。ルート表に無いURLへ移るときと、履歴の移動を確かめるときの注意もわかります。
このページの内容
ルート表のテスト
src/routes.test.tsimport { expect, it } from 'vitest';
import { routes } from './routes';
it('sends /products/new to its own page', () => {
const found = routes.match('/products/new');
expect(found?.pattern).toBe('/products/new');
});
it('reads the id of a product page', () => {
const found = routes.match('/products/42');
expect(found?.params).toStrictEqual({ id: '42' });
});defineRoutesが返すルート表のmatchは、ブラウザ無しで動く関数です。どのパターンに当たるかと受け取るparamsを、Nodeで動くふつうのテストで確かめられます。照合の順序も同じように確かめられます。
matchPathも同じです。今のパスによってリンクの見た目を変えるコードは、パスを引数で受け取る形にするとNodeで確かめられます。
ブラウザでのテスト
src/app.browser.test.tsximport { navigateTo, Router } from '@k8ordo/router';
import { expect, it } from 'vitest';
import { render } from 'vitest-browser-react';
import { routes } from './routes';
it('shows the product page once finished resolves', async () => {
await render(<Router routes={routes} />);
await navigateTo('/products/:id', { id: '1' }).finished;
新しいページが画面に出るまで待つ
const heading = document.querySelector('h1');
expect(heading?.textContent).toBe('Product 1');
});<Router>を描画してページを移るテストは、Navigation APIのあるブラウザで動かします。このパッケージ自身はVitestのブラウザモードで、ChromiumとFirefox、WebKitでテストしています。
finishedは、新しいページが画面に出たときに解決します。待ったあとは、通るまで繰り返す書き方をしなくても画面を確かめられます。
ページのuseEffectは、画面に出たあとに走ります。useEffectの結果は、expect.elementやvi.waitForのように通るまで繰り返す書き方で確かめます。
ルート表に無いURL
src/app.browser.test.tsxconst interceptEverything = (event: NavigateEvent) => {
if (event.canIntercept) event.intercept();
};
const navigateOutside = async (url: string) => {
navigation.addEventListener('navigate', interceptEverything);
try {
await navigation.navigate(url, { history: 'replace' }).finished;
} finally {
navigation.removeEventListener('navigate', interceptEverything);
}
};
let home: string;
beforeEach(() => {
home = location.href;
});
afterEach(async () => {
await navigateOutside(home);
});<Router>が扱わないナビゲーションは、ブラウザのふつうのページの読み込みになります。テストの中で起きると、テストを動かしているページごと移動してしまいます。
テストの前にルート表に無いURLへ移るときと、テストのあとに元のURLへ戻すときのナビゲーションがこれにあたります。その間だけnavigateイベントにリスナーを追加して、テスト自身がintercept()します。終わったらremoveEventListenerで外します。
メモ
<Router>を描画したあとの、ルート表にあるパスへのナビゲーションは<Router>が扱います。テストがintercept()する必要はありません。
履歴の移動
Vitestのブラウザモードは、テストをiframeの中で動かします。iframeの中では、FirefoxとWebKitは履歴を移動してもスクロールの位置を戻しません。Firefoxは履歴の移動のハンドラを2回走らせます。
このパッケージは、履歴の移動のテストだけをPlaywrightでトップレベルに開いたページで行っています。戻ったときのスクロールの位置まで確かめるなら、同じようにiframeの外で確かめてください。