|
| 1 | +# 非同期動作のテスト |
| 2 | + |
| 3 | +テストをシンプルにするために、 `vue-test-utils` はDOMの更新を同期的に適用します。しかし、コールバックや Promise のようなコンポーネントの非同期動作をテストする場合、いくつかのテクニックを知っておく必要があります。 |
| 4 | + |
| 5 | +よくある非同期動作の1つとして API 呼び出しと Vuex の action があります。以下の例は API 呼び出しをするメソッドをテストする方法を示しています。この例は HTTP のライブラリである `axios` をモックしてテストを実行するために Jest を使っています。Jestのモックの詳細は[ここ](https://facebook.github.io/jest/docs/en/manual-mocks.html#content)にあります。 |
| 6 | + |
| 7 | +`axios` のモックの実装はこのようにします。 |
| 8 | + |
| 9 | +``` js |
| 10 | +export default { |
| 11 | + get: () => new Promise(resolve => { |
| 12 | + resolve({ data: 'value' }) |
| 13 | + }) |
| 14 | +} |
| 15 | +``` |
| 16 | + |
| 17 | +ボタンをクリックすると以下のコンポーネントは API 呼び出しをします。そして、レスポンスを `value` に代入します。 |
| 18 | + |
| 19 | +``` html |
| 20 | +<template> |
| 21 | + <button @click="fetchResults" /> |
| 22 | +</template> |
| 23 | + |
| 24 | +<script> |
| 25 | + import axios from 'axios' |
| 26 | +
|
| 27 | + export default { |
| 28 | + data () { |
| 29 | + return { |
| 30 | + value: null |
| 31 | + } |
| 32 | + }, |
| 33 | +
|
| 34 | + methods: { |
| 35 | + async fetchResults () { |
| 36 | + const response = await axios.get('mock/service') |
| 37 | + this.value = response.data |
| 38 | + } |
| 39 | + } |
| 40 | + } |
| 41 | +</script> |
| 42 | +``` |
| 43 | + |
| 44 | +テストはこのように書くことができます。 |
| 45 | + |
| 46 | +``` js |
| 47 | +import { shallow } from '@vue/test-utils' |
| 48 | +import Foo from './Foo' |
| 49 | +jest.mock('axios') |
| 50 | + |
| 51 | +test('Foo', () => { |
| 52 | + it('fetches async when a button is clicked', () => { |
| 53 | + const wrapper = shallow(Foo) |
| 54 | + wrapper.find('button').trigger('click') |
| 55 | + expect(wrapper.vm.value).toEqual('value') |
| 56 | + }) |
| 57 | +}) |
| 58 | +``` |
| 59 | + |
| 60 | +`fetchResults` 内の Promise が resolve する前にアサーションが呼ばれるので、このテストは現時点では失敗します。ほとんどのユニットテストライブラリはテストが完了したことをテストランナーに知らせるためのコールバック関数を提供します。Jest と Mocha は両方とも `done` を使います。アサーションが行われる前に確実に各 Promise が resolve するために `done` を `$nextTick` や `setTimeout` と組み合わせて使うことができます。 |
| 61 | + |
| 62 | +``` js |
| 63 | +test('Foo', () => { |
| 64 | + it('fetches async when a button is clicked', (done) => { |
| 65 | + const wrapper = shallow(Foo) |
| 66 | + wrapper.find('button').trigger('click') |
| 67 | + wrapper.vm.$nextTick(() => { |
| 68 | + expect(wrapper.vm.value).toEqual('value') |
| 69 | + done() |
| 70 | + }) |
| 71 | + }) |
| 72 | +}) |
| 73 | +``` |
| 74 | + |
| 75 | +`$nextTick` と `setTimeout` がテストをパスする理由は `$nextTick` と `setTimeout` を処理するタスクキュー前に Promise のコールバック関数を処理するマイクロタスクキューが実行されるからです。つまり、`$nextTick` と `setTimeout` が実行される前に、マイクロタスクキュー上にあるすべての Promise のコールバック関数が実行されます。より詳しい説明は[ここ](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/)を見てください。 |
| 76 | + |
| 77 | +もう1つの解決策は `async` function と npm パッケージの `flush-promises` を使用することです。`flush-promises` は堰き止められている resolve された Promise ハンドラを流します。堰き止められている Promise を流すこととテストの可読性を改善するために `await` を `flushPromises` の呼び出しの前に置きます。 |
| 78 | + |
| 79 | +反映されたテストはこのようになります。 |
| 80 | + |
| 81 | +``` js |
| 82 | +import { shallow } from '@vue/test-utils' |
| 83 | +import flushPromises from 'flush-promises' |
| 84 | +import Foo from './Foo' |
| 85 | +jest.mock('axios') |
| 86 | + |
| 87 | +test('Foo', () => { |
| 88 | + it('fetches async when a button is clicked', async () => { |
| 89 | + const wrapper = shallow(Foo) |
| 90 | + wrapper.find('button').trigger('click') |
| 91 | + await flushPromises() |
| 92 | + expect(wrapper.vm.value).toEqual('value') |
| 93 | + }) |
| 94 | +}) |
| 95 | +``` |
| 96 | + |
| 97 | +同じテクニックをデフォルトで Promise を返す Vuex の action に適用することができます。 |
0 commit comments