feat: ✨ warming body in lambda lib

apps/api/bronya.config.ts

@@ -4,7 +4,7 @@ import { join, resolve } from "node:path";
 import { Api, type ApiConstructProps } from "@bronya.js/api-construct";
 import { createApiCliPlugins } from "@bronya.js/api-construct/plugins/cli";
 import { isCdk } from "@bronya.js/core";
-import { logger } from "@libs/lambda";
+import { logger, warmingRequestBody } from "@libs/lambda";
 import { LambdaIntegration, ResponseType } from "aws-cdk-lib/aws-apigateway";
 import { Certificate } from "aws-cdk-lib/aws-certificatemanager";
 import { RuleTargetInput, Rule, Schedule } from "aws-cdk-lib/aws-events";
@@ -79,13 +79,6 @@ const prismaSchema = resolve(libsDbDirectory, "prisma", prismaSchemaFile);
  */
 const prismaQueryEngineFile = "libquery_engine-linux-arm64-openssl-1.0.x.so.node";
 
-/**
- * The body of a warming request.
- *
- * TODO: actually recognize warming requests in the route handlers.
- */
-const warmingRequestBody = { body: "warming request" };
-
 /**
  * Shared ESBuild options.
  */

libs/lambda/src/handler.ts

@@ -0,0 +1,30 @@
+import type { APIGatewayProxyEvent, Context, APIGatewayProxyResult } from "aws-lambda";
+
+import { warmingRequestBody } from "./request";
+import { createOKResult, createErrorResult } from "./response";
+
+export type ResponseHelpers = {
+  ok: typeof createOKResult;
+  error: typeof createErrorResult;
+};
+
+export type ExtendedApiGatewayHandler = (
+  event: APIGatewayProxyEvent,
+  context: Context,
+  res: ResponseHelpers,
+) => APIGatewayProxyResult | Promise<APIGatewayProxyResult>;
+
+export function createHandler(handler: ExtendedApiGatewayHandler): ExtendedApiGatewayHandler {
+  return async function (event, context) {
+    const res: ResponseHelpers = {
+      ok: (payload, headers, requestId) => createOKResult(payload, headers, requestId),
+      error: (statusCode, e, requestId) => createErrorResult(statusCode, e, requestId),
+    };
+
+    if (event.body === JSON.stringify(warmingRequestBody)) {
+      return res.ok("Successfully warmed!", event.headers, context.awsRequestId);
+    }
+
+    return handler(event, context, res);
+  };
+}

libs/lambda/src/index.ts

@@ -2,3 +2,5 @@ export * from "./logger";
 export * from "./compress";
 export * from "./response";
 export * from "./constants";
+export * from "./request";
+export * from "./handler";

libs/lambda/src/request.ts

@@ -0,0 +1,7 @@
+/**
+ * The body of a warming request.
+ *
+ * A warming request is periodically sent to ensure that the Lambda function is active.
+ * Ideally, it wouldn't trigger any expensive computations.
+ */
+export const warmingRequestBody = { body: "warming request" };