Jest伪造计时器与承诺

Question

在使用假定时器和承诺的组合时,我在使用Jest测试框架(版本23.2.0)时能够很好地工作.我哪里错了？

假设我有以下模块:

// timing.js

export const timeout = ms =>
  new Promise(resolve => {
    setTimeout(resolve, ms)
  })

我的测试文件看起来像:

// timing.test.js

import { timeout } from './timing'

describe('timeout()', () => {
  beforeEach(() => {
    jest.useFakeTimers()
  })

  it('resolves in a given amount of time', () => {
    const spy = jest.fn()

    timeout(100).then(spy)
    expect(spy).not.toHaveBeenCalled()

    jest.advanceTimersByTime(100)
    expect(spy).toHaveBeenCalled()
  })
})

这失败,输出如下:

? timeout › resolves in a given amount of time

expect(jest.fn()).toHaveBeenCalled()

Expected mock function to have been called, but it was not called.

  15 |
  16 |     jest.advanceTimersByTime(100)
> 17 |     expect(spy).toHaveBeenCalled()
     |                 ^
  18 |   })
  19 | })
  20 |

  at Object.<anonymous> (src/timing.test.js:17:17)

但是,如果我删除了承诺:

// timing.js
export const timeout = ms => ({
  then: resolve => {
    setTimeout(resolve, ms)
  }
})

......测试将通过

timeout
  ? resolves in a given amount of time (5ms)

Test Suites: 1 passed, 1 total
Tests:       1 passed, 1 total
Snapshots:   0 total
Time:        1.304s

UPDATE

虽然它不是最优雅的解决方案,但我目前正在使用以下测试.它有效,但我仍然很感兴趣为什么原来没有

import { timeout } from './timing'

describe('timeout', () => {
  it('resolves in a given amount of time', done => {
    setTimeout(() => done(new Error('it didn\'t resolve or took longer than expected')), 10)
    return timeout(9).then(done)
  })
})

Answer 1

目前,它不受支持

你没有做错什么 - 它现在不起作用 - 抱歉.在我们结束之前,以下事情必须发生:

• Jest需要合并正在进行的工作以合并lolex作为他们的假计时器实现在这里https://github.com/facebook/jest/pull/5171
• Lolex需要通过承诺支持抽水 - 我们在最近的Node.js合作伙伴峰会上与V8团队讨论了这个问题.这将暴露我们将使用的钩子,允许做类似的事情advanceTimeByTime(100)并使其与promises一起工作.

要点中的问题是后来.then(spy)才会被调用.

由于我们是志愿者 - 这些事情没有具体的时间表.我希望SimenB在未来2-3个月内完成合并,我将在下个月与V8团队合作.

你现在能做什么

您始终可以编写异步测试:

// note this is an async function now
it('resolves in a given amount of time', async () => {
  // this is in a promise.reoslve.then to not 'lock' on the await
  Promise.resolve().then(() => jest.advanceTimersByTime(100));
  await timeout(100);
});

如果还有其他想要等待的事情,您可以在超时后添加期望.

Answer 2

在我的情况下，计时器回调调用了其他异步函数，因此其他解决方案对我不起作用。我最终通过手动确保承诺队列为空来解决这个问题，所有异步代码都将完成运行，我可以让测试工作：

function flushPromises() {
  // Wait for promises running in the non-async timer callback to complete.
  // From /sf/answers/4110126121/
  return new Promise(resolve => setImmediate(resolve));
}

test('example', async () => {
  jest.useFakeTimers();

  example_function_to_set_a_timer();

  // Wait for one virtual second
  jest.advanceTimersByTime(1000);

  // Wait for any async functions to finish running
  await flushPromises();

  // Continue with tests as normal
  expect(...);
});

Answer 3

因为jest@26.0.0您可以在两种不同的伪计时器实现之间进行选择。

我发现，jest.useFakeTimers('legacy')使用承诺作品的flushPromises解决办法，但它不工作Date，而jest.useFakeTimers('modern')与作品Date，因为但与承诺await flushPromises()永远不会消失。

我发现最好的解决方案是使用它@sinonjs/fake-timers，因为它可以同时使用 Promise 并且Date没有任何变通方法或黑客：

import FakeTimers from "@sinonjs/fake-timers";

// Before tests:
const clock = FakeTimers.install();

// In tests:
await clock.tickAsync(100);

// After tests:
clock.uninstall();