Frequent socket closes (with code 1001)

[morajabi]

Here's my config:

// https://github.com/enisdenjo/graphql-ws
let restartRequestedBeforeConnected = false
let gracefullyRestart = () => {
  restartRequestedBeforeConnected = true
}

wsClient.current = createWSClient({
  url: `${baseUrl}/graphql`,
  retryAttempts: 50,
  keepAlive: ms('1 hour'),
  lazy: typeof window === 'undefined',
  webSocketImpl: typeof window === 'undefined' ? require('ws') : WebSocket,
  connectionParams: () => {
    return {
      token: getToken(),
      activeSpaceId: getActiveSpaceId(),
      appVersion: process.env.appVersion,
    }
  },

  on: {
    closed: console.error,

    connected: (socket: unknown) => {
      console.info('client connected.', socket)
      gracefullyRestart = () => {
        if (socket instanceof WebSocket) {
          if (socket.readyState === WebSocket.OPEN) {
            console.info('emitted client restart')
            socket.close(4205, 'Client Restart')
          }
        } else {
          console.error('socket not instance of websocket')
        }
      }

      // just in case you were eager to restart
      if (restartRequestedBeforeConnected) {
        restartRequestedBeforeConnected = false
        gracefullyRestart()
      }
    },
  },
})

I use it with URQL:

export const client = createClient({
  url: '/graphql',
  exchanges: [
    devtoolsExchange,
    dedupExchange,
//    ...,
    subscriptionExchange({
      enableAllOperations: true,
      forwardSubscription(operation) {
        return {
          subscribe: sink => {
            const dispose = wsClient.current?.subscribe(operation, sink)

            return {
              unsubscribe: () => dispose?.(),
            }
          },
        }
      },
    }),
  ],
})

[enisdenjo]

Hey hey, the close event is triggered by the server. Client is just communicating it. Our server implementation closes with 1001 when the server is going away (or shutting down as the close reason suggests).

graphql-ws/src/use/ws.ts

Lines 126 to 128 in 88a12ef

	for (const client of ws.clients) {
	client.close(1001, 'Going away');
	}

Looking at the close reason from the provided dev-tools screenshot, the server is closing the client with a "shutting down" reason. This tells me that you're not using the graphql-ws server implementation, but rather a different one. So, sadly, I cannot be of much help - you have to check your server implementation out.

[enisdenjo]

As mentioned in the original answer: I doubt its the built-in graphql-ws/lib/use/ws server implementation we are dealing here with.

Which server do you use? Or, are you implementing a server yourself?

[morajabi]

Yes your severer has keepalive but I didn't know we needed one using ws module’s server.

[enisdenjo]

I am having a hard time understanding you.

Are you implementing your own server using import { makeServer } from 'graphql-ws', or are you using the built in implementation from import { createServer } from 'graphql-ws/lib/use/ws', or are you using a different server altogether?

[morajabi]

I’m using makeServer and connecting it to ws package for the server.

[enisdenjo]

So, no, you're not using the built in WS implementation. You're implementing your own server. In this case, no need to change the readme because its up to the user how he wants to implement the server.