Add support for Sentry

.changeset/quiet-dots-tease.md

@@ -0,0 +1,5 @@
+---
+"easy-apigateway": minor
+---
+
+Add support for Sentry

package.json

@@ -23,9 +23,13 @@
     "express": ">= 4.17 < 5",
     "yup": ">= 0.32.11"
   },
+  "peerDependencies": {
+    "@sentry/serverless": ">= 7.13"
+  },
   "devDependencies": {
     "@changesets/changelog-github": "^0.4.1",
     "@changesets/cli": "^2.18.0",
+    "@sentry/serverless": "^7.13.0",
     "@types/aws-lambda": "^8.10.84",
     "@types/etag": "^1.8.1",
     "@types/express": "^4.17.13",

src/framework.ts

@@ -12,6 +12,12 @@ import {
   defaultPermissionEvaluators,
   PermissionEvaluatorFactory,
 } from "./permissions";
+import {
+  captureErrorWithSentry,
+  createSentryWrapper,
+  setSentryUser,
+  type SentryWrapper,
+} from "./sentry";
 import type {
   AuthContext,
   AuthorizedLambdaHandler,
@@ -26,9 +32,16 @@ import { createYupValidationErrorResponse } from "./yup";
  * A framework to create lambda handlers for REST APIs.
  */
 export class LambdaFramework {
+  private readonly sentryWrapper: SentryWrapper;
   private readonly permissionEvaluatorFactory: PermissionEvaluatorFactory;
 
   constructor(private readonly options: LambdaFrameworkOptions) {
+    this.sentryWrapper = createSentryWrapper(
+      options.sentry
+        ? { ...options.sentry, environment: options.stage }
+        : undefined
+    );
+
     this.permissionEvaluatorFactory = new PermissionEvaluatorFactory({
       ...defaultPermissionEvaluators,
       ...options.permissionEvaluators,
@@ -59,6 +72,7 @@ export class LambdaFramework {
   > {
     return this.unauthorized((event) => {
       const context = this.createAuthContext(event);
+      setSentryUser({ id: context.principalId });
       return handler(event, context);
     }, lambdaOptions);
   }
@@ -82,7 +96,7 @@ export class LambdaFramework {
     handler: HTTPLambdaHandler,
     lambdaOptions?: LambdaOptions
   ): HTTPLambdaHandler {
-    return async (event, ...args) => {
+    return this.sentryWrapper(async (event, ...args) => {
       try {
         const result = await handler(event, ...args);
 
@@ -97,7 +111,7 @@ export class LambdaFramework {
       } catch (error) {
         return this.createErrorResponse(error, event);
       }
-    };
+    });
   }
 
   /**
@@ -192,6 +206,7 @@ export class LambdaFramework {
 
     if (statusCode >= 500) {
       console.warn("Error in lambda handler:", error);
+      captureErrorWithSentry(error);
     }
 
     // TODO: can we somehow elegantly propagate properties from the error?

src/options.ts

@@ -24,5 +24,17 @@ export function parseLambdaFrameworkOptionsFromEnv(
 
   return {
     stage: get("STAGE", "development"),
+    includeStackTrace: get("NODE_ENV", "development") === "development",
+    sentry: parseSentry(get),
   };
 }
+
+function parseSentry(get: Get): LambdaFrameworkOptions["sentry"] {
+  const dsn = get("SENTRY_DSN", "");
+  if (!dsn) return;
+
+  const enabled = Boolean(get("SENTRY_ENABLED", "true"));
+  const tracesSampleRate = parseFloat(get("SENTRY_TRACES_SAMPLE_RATE", "0"));
+
+  return { dsn, tracesSampleRate, enabled };
+}

src/sentry.ts

@@ -0,0 +1,31 @@
+import { AWSLambda, type User } from "@sentry/serverless";
+import type { Handler } from "aws-lambda";
+
+export type SentryOptions = {
+  environment: string;
+  dsn: string;
+  enabled: boolean;
+  tracesSampleRate?: number;
+};
+
+export type SentryWrapper = <TEvent, TResult>(
+  handler: Handler<TEvent, TResult>,
+  wrapOptions?: Partial<AWSLambda.WrapperOptions>
+) => Handler<TEvent, TResult>;
+
+export function createSentryWrapper(options?: SentryOptions): SentryWrapper {
+  console.log("Sentry DSN:", options?.dsn);
+  if (!options?.dsn) return (handler) => handler;
+
+  AWSLambda.init(options);
+
+  return (handler, wrapOptions) => AWSLambda.wrapHandler(handler, wrapOptions);
+}
+
+export function setSentryUser(user?: User): void {
+  AWSLambda.setUser(user ?? null);
+}
+
+export function captureErrorWithSentry(err: unknown): void {
+  AWSLambda.captureException(err);
+}