使用 Jest 模拟的模块函数永远不会被调用

Question

我遇到了一个非常奇怪的情况，我的 Jest 测试在我的 Windows 10 桌面和 Macbook Pro 中通过，但在我其他朋友的 2 个 Windows 10 桌面中却没有通过。

正在测试的代码

import { addTerminalItem } from '../../store'
...
class LoginUser extends EventHandler {
  ...
  async handle () {
    if (this.isFromOauthRedirect) {
      try {
        await this._handleOauthRedirect()
      } catch (e) {
        addTerminalItem(new ErrorMessage(e.message))
      }
      return
    }

    if (await zaClient.isUserLoggedIn('testUserId')) {
      // TODO: user is already logged in, do something
    } else {
      const loginStartSecret = uuidv4()
      localStorage.setItem(LOGIN_START_SECRET, loginStartSecret)
      addTerminalItem(new LoginMessage(loginStartSecret))
    }
  }
  ...
}

export const loginUser = new LoginUser()

---

测试代码执行以下操作：

1. 添加 invalidLOGIN_START_SECRET以便实际代码在进入第一个catch.
2. 将事件处理程序订阅到事件WELCOME_MESSAGE_RENDERED。
3. 模拟store.addTerminalItem模块功能。
4. 发布事件以便async handle()触发上述函数。
5. 检查模拟函数是否被调用。

---

import * as store from '../../../store'
...
test('different login start secret in localstorage', async () => {
  localStorage.setItem(LOGIN_START_SECRET, 'different-secret')
  zaClient.login = jest.fn(() => true)
  store.addTerminalItem = jest.fn()

  await pubsub.publish(WELCOME_MESSAGE_RENDERED)

  expect(store.addTerminalItem).toHaveBeenCalledWith(expect.any(ErrorMessage))
  const errorMessage = store.addTerminalItem.mock.calls[0][0]
  expect(errorMessage.message).toBe(loginSecurityErrorMsg)
})

正如我在我的计算机上所说，它正确显示addTerminalItem在我家里的两台机器上使用正确的参数调用了一次函数。然而，这个模拟函数从未被调用，并且在我朋友的两台机器上失败了。他们收到的实际错误消息如下：

expect(jest.fn()).toHaveBeenCalledWith(...expected)

Expected: Any<ErrorMessage>

Number of calls: 0

到目前为止，我们尝试过以下操作：

• 新鲜git clone，，yarn install和yarn test。我通过了，他们没有。
• 通过addTerminalItem模拟，我们添加了一个console.log内部addTerminalItem，它正确地不记录，但仍然是 0 次调用。
• 通过addTerminalItem间谍，我们添加了一个console.log内部addTerminalItem并且它正确记录，但仍然是 0 次调用（这对我来说没有意义）
• 我们匹配了我们的纱线版本。
• 我们仔细调试代码，以确保所有其他事情都按预期工作。

如果有人可以在这里给我们任何指示，我们将不胜感激。

Answer 1

如果没有手头的代码，很难确定，但请尝试使用jest.mock：

import {addTerminalItem} from "../../../store";

jest.mock('../../../store', () => ({
  addTerminalItem: jest.fn() 
));

//... stuff ...

test('different login start secret in localstorage', async () => {
  localStorage.setItem(LOGIN_START_SECRET, 'different-secret')
  zaClient.login = jest.fn(() => true)
  
  await pubsub.publish(WELCOME_MESSAGE_RENDERED)

  expect(addTerminalItem).toHaveBeenCalledWith(expect.any(ErrorMessage))
  const errorMessage = addTerminalItem.mock.calls[0][0]
  expect(errorMessage.message).toBe(loginSecurityErrorMsg)
})