Introduce GraphQLWebSocketClient

[lyubo]

Partially resolves #77

This implementation uses WebSocket communication channel between the server and the client.
Supported protocol is graphql-transport-ws
All operations (queries, mutations, subscriptions) are supported.

This implementation itself adds no new dependencies. Added development dependencies (ws, @types/ws, graphql-ws) are used to setup a test server.

[Jaikant]

Any plans to merge?

[jasonkuhrt]

Need to look

[adnankurt16]

is there any progress? when is it merged? @jasonkuhrt

[lyubo]

@jasonkuhrt What changes do I have to make? It's not clear to me. Should I find a dependency which declares such data structure?

[jasonkuhrt]

I find it highly surprising that we have to invent this much code inline to get client side GraphQL websockets working.

I see two approaches here:

1. Take the time to add some research about the current landscape
2. Roll with this PR and let future PRs refine if needed

I'm inclined toward (2) because I do not have time to actively develop on this project right now. Currently I just help the community iterate.

[jasonkuhrt]

I'll give a few more days for community feedback and then merge this otherwise.

[jasonkuhrt]

Ok it has been a few days. Let's give it a try. Super open to hearing feedback and receiving more iteration around this.

[ehynds]

Super excited to see this! What's the best way to try this out? Can you release under the next tag, @jasonkuhrt?

[jasonkuhrt]

Will do, looks like CI needs some fixing, something it depends on changed.

[jasonkuhrt]

@ehynds ci back up, yes please try next

https://github.com/prisma-labs/graphql-request/runs/6162357648?check_suite_focus=true

https://github.com/prisma-labs/graphql-request/releases/tag/next

[adnankurt16]

@lyubo i am getting an error, you can send any sample?

TypeError: this.socket.send is not a function
    at GraphQLWebSocketClient.makeSubscribe (graphql-ws.js?50e4:208:1)
    at GraphQLWebSocketClient.rawSubscribe (graphql-ws.js?50e4:241:1)

[lyubo]

@adnankurt16

i am getting an error, you can send any sample?

TypeError: this.socket.send is not a function
    at GraphQLWebSocketClient.makeSubscribe (graphql-ws.js?50e4:208:1)
    at GraphQLWebSocketClient.rawSubscribe (graphql-ws.js?50e4:241:1)

You can look at test code: tests/graphql-ws.test.ts

Basically, you should do the following:

  socket = new WebSocket(url, GRAPHQL_TRANSPORT_WS_PROTOCOL);
  client = new GraphQLWebSocketClient(socket);

If you want to know when the socket gets acknowledged (according to the graphql-trasport-ws protocol) you can supply a callback function:

   async function onAcknowledged(payload: any): Promise<void> {
      ...
   }

  client = new GraphQLWebSocketClient(socket), { onAcknowledged })

The WebSocket implementation I use in my code is reconnecting-websocket

[artalar]

Any plans to document it? 👀

[rotembm12]

is there a doc that shows how to subscribe to GQL events?

[SimenB]

I'm getting a TS error after upgrading to 5.0.0.

../../node_modules/graphql-request/dist/graphql-ws.d.ts:19:25 - error TS2304: Cannot find name 'WebSocket'.

19     constructor(socket: WebSocket, { onInit, onAcknowledged, onPing, onPong }: SocketHandler);

I tried adding a dependency on @types/ws, but that didn't help

[Qix-]

Running into the same issue, this broke us. Node does not have WebSocket available in the global scope like the DOM does. Adding "dom" to the libs list in tsconfig "solves" this but is not correct.

[EmirBoyaci]

I'm getting a TS error after upgrading to 5.0.0.

../../node_modules/graphql-request/dist/graphql-ws.d.ts:19:25 - error TS2304: Cannot find name 'WebSocket'.

19     constructor(socket: WebSocket, { onInit, onAcknowledged, onPing, onPong }: SocketHandler);

I tried adding a dependency on @types/ws, but that didn't help

I am getting exact same error, any news here?