@spec handle_control(
  {term(), [{:opcode, control()}]},
  socket()
) :: reply_inbound()

Generally this will only receive :pong messages in response to our keepalive ping messages. Client-side websocket libraries handle these control frames automatically in order to adhere to the spec, so unless a customer is writing their own low-level websocket it should be handled for them.

@spec handle_in(
  {binary(), [{:opcode, :text}]},
  socket()
) :: reply_inbound()

Receive messages from clients. We expect all incoming messages to be JSON encoded text, so if something else comes in we blow up.

@spec handle_inbound(map(), socket()) :: reply_inbound()

Callbacks for parsed JSON payloads coming in from a client.

See: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md

@spec handle_info(term(), socket()) :: reply_message()

Receive messages from inside the house.

• :keepalive - Regularly send messages with opcode of 0x09, ie :ping. The graphql-ws library has a strong opinion that it does not want to implement client-side keepalive, so in order to keep the websocket from closing we need to send it messages.

• subscription:data - After we subscribe to an Absinthe subscription, we may receive messages for the relevant subscription. The graphql-ws will have sent us an id along with the subscription query, so we need to map our internal topic back to that id in order for the client to figure out what to do with our message.

• :complete - If we get a query or a mutation on the websocket, we're supposed to reply with a Next message followed by a Complete message. We follow through on the latter by putting a message on our process queue.

• fallthrough - If c:Absinthe.GraphqlWs.Socket.handle_message/2 is defined on the socket, then uncaught messages will be sent there.

Subscribe messages in graphql-ws may include a subscription, implying a subscription to a long term stream of data. These messages may also be queries or mutations, so do not require a stream.

@spec terminate(term(), socket()) :: :ok

Process was stopped.