feat(event-handler): add resolution logic to base router

Author: svozza

packages/event-handler/src/rest/BaseRouter.ts

@@ -3,7 +3,7 @@ import {
   getStringFromEnv,
   isDevMode,
 } from '@aws-lambda-powertools/commons/utils/env';
-import type { Context } from 'aws-lambda';
+import type { APIGatewayProxyResult, Context } from 'aws-lambda';
 import type { ResolveOptions } from '../types/index.js';
 import type {
   ErrorConstructor,
@@ -16,6 +16,11 @@ import type {
   RouterOptions,
 } from '../types/rest.js';
 import { HttpVerbs } from './constants.js';
+import {
+  handlerResultToProxyResult,
+  proxyEventToWebRequest,
+  responseToProxyResult,
+} from './converters.js';
 import { ErrorHandlerRegistry } from './ErrorHandlerRegistry.js';
 import {
   MethodNotAllowedError,
@@ -24,6 +29,7 @@ import {
 } from './errors.js';
 import { Route } from './Route.js';
 import { RouteHandlerRegistry } from './RouteHandlerRegistry.js';
+import { isAPIGatewayProxyEvent } from './utils.js';
 
 abstract class BaseRouter {
   protected context: Record<string, unknown>;
@@ -133,11 +139,49 @@ abstract class BaseRouter {
     };
   }
 
-  public abstract resolve(
+  public async resolve(
     event: unknown,
     context: Context,
     options?: ResolveOptions
-  ): Promise<unknown>;
+  ): Promise<APIGatewayProxyResult | undefined> {
+    if (!isAPIGatewayProxyEvent(event)) {
+      this.logger.warn(
+        'Received an event that is not compatible with this resolver'
+      );
+      return;
+    }
+
+    try {
+      const request = proxyEventToWebRequest(event);
+      const path = new URL(request.url).pathname as Path;
+      const method = request.method.toUpperCase() as HttpMethod;
+
+      const route = this.routeRegistry.resolve(method, path);
+
+      if (route === null) {
+        throw new NotFoundError(`Route ${path} for method ${method} not found`);
+      }
+
+      const result = await route.handler.apply(options?.scope ?? this, [
+        route.params,
+        {
+          event,
+          context,
+          request,
+        },
+      ]);
+
+      return await handlerResultToProxyResult(result);
+    } catch (error) {
+      const result = await this.handleError(error as Error, {
+        request: proxyEventToWebRequest(event),
+        event,
+        context,
+        scope: options?.scope,
+      });
+      return await responseToProxyResult(result);
+    }
+  }
 
   public route(handler: RouteHandler, options: RouteOptions): void {
     const { method, path } = options;

packages/event-handler/src/rest/converters.ts

@@ -1,4 +1,6 @@
-import type { APIGatewayProxyEvent } from 'aws-lambda';
+import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
+import type { HandlerResponse } from '../types/rest.js';
+import { isAPIGatewayProxyResult } from './utils.js';
 
 const createBody = (body: string | null, isBase64Encoded: boolean) => {
   if (body === null) return null;
@@ -9,7 +11,9 @@ const createBody = (body: string | null, isBase64Encoded: boolean) => {
   return Buffer.from(body, 'base64').toString('utf8');
 };
 
-export const proxyEventToWebRequest = (event: APIGatewayProxyEvent) => {
+export const proxyEventToWebRequest = (
+  event: APIGatewayProxyEvent
+): Request => {
   const { httpMethod, path, domainName } = event.requestContext;
 
   const headers = new Headers();
@@ -23,7 +27,7 @@ export const proxyEventToWebRequest = (event: APIGatewayProxyEvent) => {
     }
   }
   const hostname = headers.get('Host') ?? domainName;
-  const protocol = headers.get('X-Forwarded-Proto') ?? 'http';
+  const protocol = headers.get('X-Forwarded-Proto') ?? 'https';
 
   const url = new URL(path, `${protocol}://${hostname}/`);
 
@@ -45,4 +49,45 @@ export const proxyEventToWebRequest = (event: APIGatewayProxyEvent) => {
     headers,
     body: createBody(event.body, event.isBase64Encoded),
   });
-}
+};
+
+export const responseToProxyResult = async (
+  response: Response
+): Promise<APIGatewayProxyResult> => {
+  const headers: Record<string, string> = {};
+  const multiValueHeaders: Record<string, Array<string>> = {};
+
+  for (const [key, value] of response.headers.entries()) {
+    const values = value.split(',').map((v) => v.trimStart());
+    if (values.length > 1) {
+      multiValueHeaders[key] = values;
+    } else {
+      headers[key] = value;
+    }
+  }
+
+  return {
+    statusCode: response.status,
+    headers,
+    multiValueHeaders,
+    body: await response.text(),
+    isBase64Encoded: false,
+  };
+};
+
+export const handlerResultToProxyResult = async (
+  response: HandlerResponse
+): Promise<APIGatewayProxyResult> => {
+  if (isAPIGatewayProxyResult(response)) {
+    return response;
+  }
+  if (response instanceof Response) {
+    return await responseToProxyResult(response);
+  }
+  return {
+    statusCode: 200,
+    body: JSON.stringify(response),
+    headers: { 'Content-Type': 'application/json' },
+    isBase64Encoded: false,
+  };
+};

packages/event-handler/src/rest/utils.ts

@@ -1,5 +1,5 @@
 import { isRecord, isString } from '@aws-lambda-powertools/commons/typeutils';
-import type { APIGatewayProxyEvent } from 'aws-lambda';
+import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 import type { CompiledRoute, Path, ValidationResult } from '../types/rest.js';
 import { PARAM_PATTERN, SAFE_CHARS, UNSAFE_CHARS } from './constants.js';
 
@@ -68,3 +68,26 @@ export const isAPIGatewayProxyEvent = (
     (event.body === null || isString(event.body))
   );
 };
+
+/**
+ * Type guard to check if the provided result is an API Gateway Proxy result.
+ *
+ * We use this function to ensure that the result is an object and has the
+ * required properties without adding a dependency.
+ *
+ * @param result - The result to check
+ */
+export const isAPIGatewayProxyResult = (
+  result: unknown
+): result is APIGatewayProxyResult => {
+  if (!isRecord(result)) return false;
+  return (
+    typeof result.statusCode === 'number' &&
+    isString(result.body) &&
+    (result.headers === undefined || isRecord(result.headers)) &&
+    (result.multiValueHeaders === undefined ||
+      isRecord(result.multiValueHeaders)) &&
+    (result.isBase64Encoded === undefined ||
+      typeof result.isBase64Encoded === 'boolean')
+  );
+};

packages/event-handler/src/types/rest.ts

@@ -53,9 +53,11 @@ interface CompiledRoute {
 
 type DynamicRoute = Route & CompiledRoute;
 
+type HandlerResponse = Response | JSONObject;
+
 type RouteHandler<
   TParams = Record<string, unknown>,
-  TReturn = Response | JSONObject,
+  TReturn = HandlerResponse,
 > = (args: TParams, options?: RequestOptions) => Promise<TReturn>;
 
 type HttpMethod = keyof typeof HttpVerbs;
@@ -106,6 +108,7 @@ export type {
   ErrorHandlerRegistryOptions,
   ErrorHandler,
   ErrorResolveOptions,
+  HandlerResponse,
   HttpStatusCode,
   HttpMethod,
   Path,