Merge pull request #1167 from b4s36t4/fix/webhook-plugin-errors

fix: return error response for webhook non-timeout error

Author: VisargD

plugins/default/webhook.ts

@@ -4,7 +4,7 @@ import {
   PluginHandler,
   PluginParameters,
 } from '../types';
-import { post } from '../utils';
+import { post, TimeoutError } from '../utils';
 
 function parseHeaders(headers: unknown): Record<string, string> {
   try {
@@ -107,20 +107,30 @@ export const handler: PluginHandler = async (
       responseData: response.data,
       requestContext: {
         headers,
-        timeout: 3000,
+        timeout: parameters.timeout || 3000,
       },
     };
   } catch (e: any) {
     error = e;
     delete error.stack;
 
+    const isTimeoutError = e instanceof TimeoutError;
+
+    const responseData = !isTimeoutError && e.response?.body;
+    const responseDataContentType = e.response?.headers?.get('content-type');
+
     data = {
       explanation: `Webhook error: ${e.message}`,
       webhookUrl: parameters.webhookURL || 'No URL provided',
       requestContext: {
         headers: parameters.headers || {},
-        timeout: 3000,
+        timeout: parameters.timeout || 3000,
       },
+      // return response body if it's not a ok response and not a timeout error
+      ...(responseData &&
+        responseDataContentType === 'application/json' && {
+          responseData: JSON.parse(responseData),
+        }),
     };
   }
 

plugins/utils.ts

@@ -9,6 +9,7 @@ export interface ErrorResponse {
   status: number;
   statusText: string;
   body: string;
+  headers?: Headers;
 }
 
 export class HttpError extends Error {
@@ -21,7 +22,7 @@ export class HttpError extends Error {
   }
 }
 
-class TimeoutError extends Error {
+export class TimeoutError extends Error {
   url: string;
   timeout: number;
   method: string;
@@ -222,6 +223,7 @@ export async function post<T = any>(
         status: response.status,
         statusText: response.statusText,
         body: errorBody,
+        headers: response.headers,
       };
 
       throw new HttpError(

src/middlewares/hooks/index.ts

@@ -306,6 +306,8 @@ export class HooksManager {
         transformed: result.transformed || false,
         created_at: createdAt,
         log: result.log || null,
+        fail_on_error:
+          (check.parameters as Record<string, any>)?.failOnError || false,
       };
     } catch (err: any) {
       console.error(`Error executing check "${check.id}":`, err);
@@ -390,7 +392,10 @@ export class HooksManager {
     }
 
     hookResult = {
-      verdict: checkResults.every((result) => result.verdict || result.error),
+      // if guardrail has error, make verdict false else do the normal check
+      verdict: checkResults.every(
+        (result) => result.verdict || (result.error && !result.fail_on_error)
+      ),
       id: hook.id,
       transformed: checkResults.some((result) => result.transformed),
       checks: checkResults,

src/middlewares/hooks/types.ts

@@ -80,6 +80,7 @@ export interface GuardrailCheckResult {
     };
   };
   log?: any;
+  fail_on_error?: boolean;
 }
 
 export interface GuardrailResult {