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

[MarkLyck]

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?

[github-actions]

If you are interested in working on this issue, please leave a comment below and we will be happy to assign the issue to you.
If this is the first time you are contributing a Pull Request to Cube.js, please check our contribution guidelines.
You can also post any questions while contributing in the #contributors channel in the Cube.js Slack.

[vasilev-alex]

hi @MarkLyck! I don't believe we have anything that could work for you at the moment. But it's not a bad idea to implement tooling for testing.

[MarkLyck]

@vasilev-alex thanks for the response. I really hope you add some test tools one day :)

If anyone else is running into trouble testing cubejs w/ web sockets. The hacky workaround I did was basically to not use the web sockets in my test environment. This is far from ideal, as there is a major implementation differrence between my test env and my production env. But it does let me use MSW for all test purposes.

  if (IS_MOCKED_ENV) {
    cubejsApi = cubejs(authToken, { apiUrl })
    return cubejsApi
  }

  cubejsApi = cubejs({
    transport: new WebSocketTransport({
      authorization: authToken,
      apiUrl: apiUrl.replace('http', 'ws'),
    }),
  })
  
  return cubejsApi