fix: don't fail if graphql-ws is not installed (#79)

* fix: don't fail if graphql-ws is not installed

* fix linter

Author: tobiasdiez

examples/websocket.ts

@@ -64,7 +64,7 @@ app.use(
   '/ws',
   startServerAndCreateH3Handler(apollo, {
     websocket: {
-      ...defineGraphqlWebSocket({ schema }),
+      ...(await defineGraphqlWebSocket({ schema })),
       error(peer, error) {
         console.error('[ws] error', peer, error)
         // In a real app, you would want to properly log this error
@@ -90,7 +90,7 @@ app.use(
 app.use(
   '/_ws',
   defineWebSocketHandler({
-    ...defineGraphqlWebSocket({ schema }),
+    ...(await defineGraphqlWebSocket({ schema })),
     error(peer, error) {
       console.log('[ws] error', peer, error)
     },

src/websocket.ts

@@ -1,9 +1,4 @@
-import {
-  makeServer,
-  ServerOptions,
-  ConnectionInitMessage,
-  GRAPHQL_TRANSPORT_WS_PROTOCOL,
-} from 'graphql-ws'
+import type { ServerOptions, ConnectionInitMessage } from 'graphql-ws'
 import {
   defineWebSocket,
   defineWebSocketHandler,
@@ -43,10 +38,14 @@ interface Client {
  * Use this over {@link defineGraphqlWebSocketHandler} if you need more control over the WebSocket server or
  * if you want to add custom hooks (e.g. for authentication or logging).
  */
-export function defineGraphqlWebSocket<
+export async function defineGraphqlWebSocket<
   P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'],
   E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>,
->(options: ServerOptions<P, Extra & Partial<E>>): Partial<Hooks> {
+>(options: ServerOptions<P, Extra & Partial<E>>): Promise<Partial<Hooks>> {
+  // Local import since graphql-ws is only an optional peer dependency
+  const { makeServer, GRAPHQL_TRANSPORT_WS_PROTOCOL } = await import(
+    'graphql-ws'
+  )
   const server = makeServer(options)
   const peers = new WeakMap<Peer, Client>()
   return defineWebSocket({
@@ -103,11 +102,11 @@ export function defineGraphqlWebSocket<
  *
  * @category Server/h3
  */
-export function defineGraphqlWebSocketHandler<
+export async function defineGraphqlWebSocketHandler<
   P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'],
   E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>,
 >(
   options: ServerOptions<P, Extra & Partial<E>>,
-): EventHandler<EventHandlerRequest, never> {
-  return defineWebSocketHandler(defineGraphqlWebSocket(options))
+): Promise<EventHandler<EventHandlerRequest, never>> {
+  return defineWebSocketHandler(await defineGraphqlWebSocket(options))
 }