feat: implement GraphQL health check endpoint and enhance runtime configuration options

Author: productdevbook

src/index.ts

@@ -1,10 +1,12 @@
 import type { Nitro } from 'nitropack/types'
+import type { NitroGraphQLOptions } from './types'
 import { writeFileSync } from 'node:fs'
 import { fileURLToPath } from 'node:url'
 import { watch } from 'chokidar'
+import defu from 'defu'
+
 import { defineNitroModule } from 'nitropack/kit'
 import { dirname, join, resolve } from 'pathe'
-
 import { rollupConfig } from './rollup'
 import { relativeWithDot, scanDefs, scanResolvers } from './utils'
 import { clientTypeGeneration, serverTypeGeneration } from './utils/server-type-generation'
@@ -18,6 +20,14 @@ export default defineNitroModule({
       clientDir: '',
     }
 
+    nitro.options.runtimeConfig.graphql = defu(nitro.options.runtimeConfig.graphql || {}, {
+      endpoint: {
+        graphql: '/api/graphql',
+        healthCheck: '/api/graphql/health',
+      },
+      playground: true,
+    } as NitroGraphQLOptions)
+
     const graphqlBuildDir = resolve(nitro.options.buildDir, 'graphql')
     nitro.graphql.buildDir = graphqlBuildDir
 
@@ -72,32 +82,36 @@ export default defineNitroModule({
     await serverTypeGeneration(nitro)
     await clientTypeGeneration(nitro, nitro.graphql.clientDir)
 
-    // Define the main GraphQL endpoint
-    const endpoint = '/api/graphql'
-
     const runtime = fileURLToPath(
       new URL('routes', import.meta.url),
     )
     // Main GraphQL endpoint
     nitro.options.handlers.push({
-      route: endpoint,
+      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
       handler: join(runtime, 'graphql'),
       method: 'get',
     })
 
     // Main GraphQL endpoint
     nitro.options.handlers.push({
-      route: endpoint,
+      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
       handler: join(runtime, 'graphql'),
       method: 'post',
     })
 
     nitro.options.handlers.push({
-      route: endpoint,
+      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
       handler: join(runtime, 'graphql'),
       method: 'options',
     })
 
+    // Health check endpoint
+    nitro.options.handlers.push({
+      route: nitro.options.runtimeConfig.graphql?.endpoint?.healthCheck || '/api/graphql/health',
+      handler: join(runtime, 'health'),
+      method: 'get',
+    })
+
     // Auto-import utilities
     if (nitro.options.imports) {
       nitro.options.imports.presets.push({

src/routes/health.ts

@@ -0,0 +1,47 @@
+import { defineEventHandler, setResponseStatus } from 'h3'
+import { useRuntimeConfig } from 'nitropack/runtime'
+
+export default defineEventHandler(async (event) => {
+  const runtime = useRuntimeConfig()
+
+  if (!runtime.graphql || !runtime.graphql.endpoint?.graphql) {
+    setResponseStatus(event, 404)
+    return {
+      status: 'error',
+      message: 'GraphQL health check endpoint is not configured',
+      timestamp: new Date().toISOString(),
+    }
+  }
+
+  try {
+    const response = await $fetch(runtime.graphql!.endpoint?.graphql, {
+      method: 'POST',
+      body: {
+        query: 'query Health { __typename }',
+        operationName: 'Health',
+      },
+      headers: {
+        'Content-Type': 'application/json',
+        'Accept': 'application/json',
+      },
+    })
+
+    if (response && typeof response === 'object' && 'data' in response) {
+      return {
+        status: 'healthy',
+        message: 'GraphQL server is running',
+        timestamp: new Date().toISOString(),
+      }
+    }
+
+    throw new Error('Invalid response from GraphQL server')
+  }
+  catch (error) {
+    setResponseStatus(event, 503)
+    return {
+      status: 'unhealthy',
+      message: (error instanceof Error ? error.message : 'GraphQL server is not responding'),
+      timestamp: new Date().toISOString(),
+    }
+  }
+})

src/types.ts

@@ -44,8 +44,10 @@ export interface CodegenClientConfig extends TypeScriptPluginConfig, TypeScriptD
 }
 
 export interface NitroGraphQLOptions {
-  endpoint?: string
-  healthCheckEndpoint?: string
+  endpoint?: {
+    graphql?: string
+    healthCheck?: string
+  }
   playground?: boolean
   cors?: YogaServerOptions<{ req: IncomingMessage, res: ServerResponse }, any>['cors']
   typedefs?: string[]