cube-js/cube

How to mock messages using @cubejs-client/react with websocket transport?

Open

#2,146 创建于 2021年2月18日

在 GitHub 查看
 (4 评论) (0 反应) (0 负责人)Rust (19,563 star) (1,965 fork)batch import
client:reacthelp wanted

描述

Problem

I am using @cubejs-client/react with @cubejs-client/ws-transport and I'm running into some blockers trying to mock anything.

I use msw for mocking all my "normal" network requests for use in unit testing, integration tests, storybook and a fully mocked dev environment.

I've been searching for a way to mock CubeJS websocket messages in a similar way, but haven't found anything :(

I tried setting up mock-socket and jest-mock-socket but that didn't seem to work for CubeJS?

Do you have any solution in place for mocking CubeJS responses? Ideally I'm looking for something that works like this:

received queryA
respond with resultA

received queryB
respond with resultB

Something like the MockedProvider that apollo has for their ApolloClient. But for @cubejs-client/react

I need a solution that will work in basically any environment: test, local dev, cypress & storybook.

I considered writing a mock for the useCubeQuery hook, but that seems like a slippery slope to go down that road and end up testing implementation details that might break in future versions.

Are there any official mocking/ testing solutions for the frontend clients?

贡献者指南

技术栈
typescriptreact
领域
frontendtesting
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
4
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
understanding of CubeJS clientwebsocket mockingReact testing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
20
研究方向
Investigate the CubeJS client internals, particularly the ws transport and useCubeQuery hook, to understand how WebSocket messages are handled. Look at existing mocking patterns in the repository (e.g., any test utilities or mock setups). Consider creating a MockedProvider component similar to Apollo's, which intercepts queries and returns mock responses. The solution should work across test environments, storybook, and local dev. Reference the @cubejs client/react and @cubejs client/ws transport packages for implementation.