wundergraph.server.ts Reference

On WS Connection Init Hook

The onConnectionInit hook is called when the engine is initiating a WebSocket connection with a GraphQL Server. It can be enabled for specific data-sources. Using this hook, you're able to populate the websocket connection_init message payload.

This hook is useful, e.g. when you'd like to authorize the websocket connection through a connection_init message payload.

1
{ "type": "connection_init", "payload": { "Authorization": "Bearer <token>" } }

Similar to all other hooks, the onConnectionInit hook is called with the following parameters:

  • user: The user object when the user is authenticated
  • clientRequest: The original client request object, including Headers
  • log: The logger object
  • internalClient: The internal client object
  • datasourceId: The id of the data-source
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// wundergraph.config.ts
const chat = introspect.graphql({
id: 'chatId',
apiNamespace: 'chat',
url: 'http://localhost:8085/query',
})
// wundergraph.server.ts
export default configureWunderGraphServer<HooksConfig, InternalClient>(() => ({
hooks: {
global: {
wsTransport: {
onConnectionInit: {
enableForDataSources: ['chatId'],
hook: async ({ clientRequest, dataSourceId }) => {
let token = clientRequest.headers.get('Authorization') || ''
if (dataSourceId === 'chatId') {
token = 'secret'
}
return {
payload: {
Authorization: token,
},
}
},
},
},
},
},
}))

Was this article helpful to you?
Provide feedback

Edit this page