feat: log verbose errors to the console if a query fails

Author: johannschopplich

docs/config/index.md

@@ -123,6 +123,16 @@ interface ModuleOptions {
      * @default 1
      */
     maxAge?: number
+
+    /**
+     * Log verbose errors to the console if a query fails
+     *
+     * @remarks
+     * This will log the full query to the console, which may contain sensitive data.
+     *
+     * @default false
+     */
+    verboseErrors?: boolean
   }
 }
 ```

src/module.ts

@@ -109,6 +109,16 @@ export interface ModuleOptions {
      * @default 1
      */
     maxAge?: number
+
+    /**
+     * Log verbose errors to the console if a query fails
+     *
+     * @remarks
+     * This will log the full query to the console, which may contain sensitive data.
+     *
+     * @default false
+     */
+    verboseErrors?: boolean
   }
 }
 
@@ -136,6 +146,7 @@ export default defineNuxtModule<ModuleOptions>({
       storage: 'cache',
       swr: false,
       maxAge: 1,
+      verboseErrors: false,
     },
   },
   async setup(options, nuxt) {

src/runtime/server/handler.ts

@@ -1,3 +1,4 @@
+import { consola } from 'consola'
 import { createError, defineEventHandler, getRouterParam, readBody } from 'h3'
 import type { ModuleOptions } from '../../module'
 import { createAuthHeader } from '../utils'
@@ -42,6 +43,12 @@ async function fetcher({
     return result
   }
   catch (err) {
+    if (kql.server.verboseErrors) {
+      if (isQueryRequest)
+        consola.error('Failed to execute KQL query:', query)
+      else consola.error(`Failed to fetch "${path}" with options:`, { headers, method, query, body })
+    }
+
     throw createError({
       statusCode: 500,
       statusMessage: isQueryRequest