is there a mismatch between urqls Operation and graphql-ws SubscribePayload ?

[97amarnathk]

While using graphql-ws with urql , I notice that there is a type mismatch between the SubscribePayload received by graphql-ws server and what urql is sending to it.

According to graphql-ws, the type is

export interface SubscribePayload {
    readonly operationName?: string | null;
    readonly query: string;
    readonly variables?: Record<string, unknown> | null;
}

And according to urql it is

export interface Operation<Data = any, Variables = any>
  extends GraphQLRequest<Data, Variables> {
  readonly kind: OperationType;
  context: OperationContext;
}

And this operation is being passed directly to the graphql-ws client as:

forwardSubscription: (operation) => {
  return {
     subscribe: (sink) => {
     const dispose = subscriptionClient.subscribe(operation, sink);
     return {
      unsubscribe: dispose,
    };
   },
};

[enisdenjo]

The Operation interface extends GraphQLRequest which has the necessary fields for the payload (query and variables).

[enisdenjo]

Hey guys, consider checking the new recipe about ws server and client auth usage with token expiration, validation and refresh. It showcases my explanation above in code.

[97amarnathk]

A minor problem is that 4401 is also a fatal exception by default.
https://github.com/enisdenjo/graphql-ws/blob/master/src/client.ts#L472-L479

I am using 4430 (or any other code reserved for application and not used by graphql-ws)
https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent

[enisdenjo]

My bad! I changed the example to use 4403: Forbidden instead.

Furthermore, I recommend using 4403 because returning false from onConnect automatically closes the connection with a 4403: Forbidden.

[jyshin97]

@enisdenjo thank you so much for the lib! I noticed in the example you still had

       if (socket.readyState === WebSocket.OPEN)
         socket.close(CloseCode.Unauthorized, 'Unauthorized');
     }, getCurrentTokenExpiresIn());

when I'm assuming it should be

       if (socket.readyState === WebSocket.OPEN)
         socket.close(CloseCode.Forbidden, 'Forbidden');
     }, getCurrentTokenExpiresIn());

[enisdenjo]

Thanks @jyshin97 for pointing that out, fixed in 1aee1e8. 😄