如何测试 Redux 的 dispatch() 是否已在 React Component (Jest + Enzyme) 中被调用

Question

我有很多调用 dispatch() (Redux) 的功能性 React 组件。 dispatch() 函数本身是由 react-redux 的 useDispatch() 钩子传入的。

作为一个简化的例子：

const LogoutButton: FC = () => {
  const dispatch: Dispatch = useDispatch();
  
  return (
   <button onClick={() => {
     console.log("Clicked...") // To check that onClick() simulation is working
     dispatch(authActions.logout())  
   }}>
   LOGOUT
   </button> 
  )
}

使用 Jest 和 Enzyme，我需要做什么才能断言 expect(dispatch).toHaveBeenCalledWith(authActions.logout)？

我没有模拟商店或使用 redux-mock-store 的功能。相反，我将组件包装在我为测试而制作的 Root 组件中。它与我真正的 Root 组件相同，但需要道具来设置测试的初始存储（和 history.location）：

const TestRoot: FC<RootProps> = ({ children, initialState = {}, initialEntries = defaultLocation }) => {
  const store = createStore(reducers, initialState, applyMiddleware(thunk));

  return (
    <Provider store={store}>
      <MemoryRouter initialEntries={initialEntries}>
        <ScrollToTop />
        <StylesProvider jss={jss}>
          <ThemeProvider theme={theme}>{children}</ThemeProvider>
        </StylesProvider>
      </MemoryRouter>
    </Provider>
  );
};

在测试中用于设置 Enzyme-wrapped 组件，如：

wrappedLogoutButton = mount(
  <TestRoot initialState={initialState}>
    <LogoutButton />
  </TestRoot>
);

这个设置对我来说很有效（到目前为止），如果我不需要，我不想更改它。我确实尝试将一个 redux-mock-store 模拟存储注入到 TestRoot 中，但这搞砸了我编写的每一个测试套件。

我尝试了多种方法来模拟或监视dispatch() 和useDispatch()，但我无法看到模拟被调用。 onClick() 模拟正在运行，因为我可以看到正在记录“点击...”。这是一个示例测试（真实代码，不是简化示例）：

test('should log learner out', () => {
    const event = {
      preventDefault: () => {},
      target: { textContent: en.common['log-out-title'] } as unknown,
    } as React.MouseEvent<HTMLButtonElement, MouseEvent>;

    const wrappedLogOut = wrappedMenuDrawer.find(ListItem).at(3).find('a');

    // @ts-ignore
    act(() => wrappedLogOut.prop('onClick')(event));

    // TODO: test authService.logout is called
    // assert that dispatch was called with authActions.logout()
    expect(amplitude.logAmpEvent).toHaveBeenCalledWith('from main menu', { to: 'LOGOUT' }); // This assertion passes
  });

根据文档、Medium 帖子和 Stack Overflow 上的类似问题，我尝试过在调度时模拟/监视的方法/变体，包括：

import * as reactRedux from 'react-redux'
const spy = jest.spyOn(reactRedux, 'useDispatch'

import store from '../../store';
const spy = jest.spyOn(store, 'dispatch')

const mockUseDispatch = jest.fn();
const mockDispatch = jest.fn();

jest.mock('react-redux', () => ({
  useDispatch: () => mockUseDispatch.mockReturnValue(mockDispatch),
}));

// or...

jest.mock('react-redux', () => ({
  useDispatch: () => mockUseDispatch,
}));

mockUseDispatch.mockReturnValue(mockDispatch) // inside the actual test
  

Answer 1

您可以通过多种方式做到这一点。阿法克：

• 你可以模拟 useDispatch 钩子来返回你自己的假调度函数。 我在我自己的 React 库的测试代码中使用了帮助管理绑定调度到动作。这里是hooks.test.tsx。

• 由于您使用测试 React 存储包装组件，因此您也可以直接将 store.dispatch 替换为假函数。请参阅here 进行讨论。

第一个的好处是你可以根据需要轻松地从 react-redux 中模拟更多的东西。