All files / api/src/utils hooks.ts

0.76% Statements 1/130
100% Branches 0/0
0% Functions 0/5
0.76% Lines 1/130

Press n or j to go to the next uncovered block, b, p or k for the previous block.

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 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177                1x                                                                                                                                                                                                                                                                                                                                                
import type { AppContext } from '@api/types/hono';
import type {
  SuperAgentsRequestBody,
  SuperAgentsRequestData,
} from '@shared/types/api/request/body';
import type { SuperAgentsResponseBody } from '@shared/types/api/response/body';
import type { HookLog } from '@shared/types/data';
 
import { HookType } from '@shared/types/middleware/hooks';
 
function createHookResponse(
  baseResponse: Response,
  baseResponseBody:
    | SuperAgentsResponseBody
    | ReadableStream
    | FormData
    | ArrayBuffer
    | null,
  hookLogs: HookLog[],
  failedHook?: HookLog,
  override: {
    status?: number;
    headers?: Record<string, string>;
  } = {},
): Response {
  const responseBody = {
    hook_results: {
      input_hooks: hookLogs.filter((h) => h.hook.type === HookType.INPUT_HOOK),
      output_hooks: hookLogs.filter(
        (h) => h.hook.type === HookType.OUTPUT_HOOK,
      ),
    },
    ...(failedHook ? { error: failedHook } : baseResponseBody),
  };
 
  const response = new Response(JSON.stringify(responseBody), {
    status: override.status || baseResponse.status,
    statusText: baseResponse.statusText,
    headers: override.headers || baseResponse.headers,
  });
 
  return response;
}
 
function handleFailedOutputHook(
  response: Response,
  saResponseBody:
    | SuperAgentsResponseBody
    | ReadableStream
    | FormData
    | ArrayBuffer,
  hookLogs: HookLog[],
  failedHook?: HookLog,
): Response {
  if (!saResponseBody) {
    return new Response(saResponseBody, {
      ...response,
      status: 246,
      statusText: 'Hooks failed',
      headers: response.headers,
    });
  }
 
  return createHookResponse(response, null, hookLogs, failedHook, {
    status: 446,
    headers: { 'content-type': 'application/json' },
  });
}
 
export async function outputHookHandler(
  c: AppContext,
  saRequestData: SuperAgentsRequestData,
  response: Response,
  saResponseBody: SuperAgentsResponseBody,
  retryAttemptsMade: number,
): Promise<Response> {
  try {
    if (retryAttemptsMade > 0) {
      // Reset the output hook results
      const hookLogs = c.get('hook_logs');
 
      // Remove the output hook results
      const filteredHookLogs = hookLogs?.filter(
        (h) => h.hook.type !== HookType.OUTPUT_HOOK,
      );
 
      c.set('hook_logs', filteredHookLogs);
    }
 
    const executeHooks = c.get('executeHooks');
 
    const hookLogs = await executeHooks(
      c,
      HookType.OUTPUT_HOOK,
      response.status,
      false,
      saRequestData,
      saResponseBody,
    );
 
    for (const hookLog of hookLogs) {
      if (hookLog.result.deny_request) {
        return handleFailedOutputHook(
          response,
          saResponseBody,
          hookLogs,
          hookLog,
        );
      }
    }
 
    return createHookResponse(response, saResponseBody, hookLogs);
  } catch (err) {
    console.error(err);
    return response;
  }
}
 
function handleFailedInputHook(
  hookLogs: HookLog[],
  failedHook?: HookLog,
): Response {
  return createHookResponse(new Response(), null, hookLogs, failedHook, {
    status: 446,
    headers: { 'content-type': 'application/json' },
  });
}
 
export async function inputHookHandler(
  c: AppContext,
  saRequestData: SuperAgentsRequestData,
): Promise<{
  errorResponse?: Response;
  transformedSuperAgentsBody?: SuperAgentsRequestBody;
}> {
  try {
    const executeHooks = c.get('executeHooks');
 
    const hookLogs = await executeHooks(
      c,
      HookType.INPUT_HOOK,
      null,
      false,
      saRequestData,
    );
 
    let latestTransformedSuperAgentsBody:
      | SuperAgentsRequestBody
      | ReadableStream
      | ArrayBuffer
      | FormData
      | null = null;
 
    for (const hookLog of hookLogs) {
      if (hookLog.result.deny_request) {
        return {
          errorResponse: handleFailedInputHook(hookLogs, hookLog),
          transformedSuperAgentsBody: saRequestData.requestBody,
        };
      }
      if (hookLog.result.request_body_override) {
        latestTransformedSuperAgentsBody = hookLog.result.request_body_override;
      }
    }
    if (latestTransformedSuperAgentsBody) {
      return {
        transformedSuperAgentsBody: latestTransformedSuperAgentsBody,
      };
    }
  } catch (err) {
    console.error(err);
    return {};
  }
 
  return {};
}