docs(idempotency): simplify snippets (#4150)

Author: dreamorosi

docs/features/idempotency.md

@@ -144,7 +144,7 @@ You can quickly start by initializing the `DynamoDBPersistenceLayer` class and u
 
 === "index.ts"
 
-    ```typescript hl_lines="2-3 21 35-38"
+    ```typescript hl_lines="2-3 21 31-33"
     --8<-- "examples/snippets/idempotency/makeIdempotentBase.ts"
     ```
 
@@ -206,7 +206,7 @@ Similar to the `makeIdempotent` function wrapper, you can quickly make your Lamb
 
 === "index.ts"
 
-    ```typescript hl_lines="22 36-40"
+    ```typescript hl_lines="22 33-35"
     --8<-- "examples/snippets/idempotency/makeHandlerIdempotent.ts"
     ```
 
@@ -237,7 +237,7 @@ Imagine the function executes successfully, but the client never receives the re
 
 === "index.ts"
 
-    ```typescript hl_lines="4 27 49"
+    ```typescript hl_lines="4 27"
     --8<-- "examples/snippets/idempotency/makeIdempotentJmes.ts"
     ```
 
@@ -304,7 +304,7 @@ If an error is thrown _outside_ the scope of the decorated function and after yo
 
 === "Handling exceptions"
 
-    ```typescript hl_lines="39-40 47-48"
+    ```typescript
     --8<-- "examples/snippets/idempotency/workingWithExceptions.ts"
     ```
 
@@ -774,7 +774,7 @@ You can use the `keyPrefix` parameter in any of the idempotency configurations t
 
 === "Using a custom prefix with function wrapper"
 
-    ```typescript hl_lines="25"
+    ```typescript hl_lines="21"
     --8<-- "examples/snippets/idempotency/customKeyPrefixFnWrapper.ts"
     ```
 
@@ -864,7 +864,7 @@ Below an example implementation of a custom persistence layer backed by a generi
 
 === "CustomPersistenceLayer"
 
-    ```typescript hl_lines="9 19 28 35 52 95"
+    ```typescript hl_lines="9 19 28 35 54 97"
     --8<-- "examples/snippets/idempotency/advancedBringYourOwnPersistenceLayer.ts"
     ```
 
@@ -891,7 +891,7 @@ You can set up a `responseHook` in the `IdempotentConfig` class to manipulate th
 
 === "Using an Idempotent Response Hook"
 
-    ```typescript hl_lines="16 19 27 56"
+    ```typescript hl_lines="16 19 27"
     --8<-- "examples/snippets/idempotency/workingWithResponseHook.ts"
     ```
 

examples/snippets/idempotency/advancedBringYourOwnPersistenceLayer.ts

@@ -44,8 +44,10 @@ class CustomPersistenceLayer extends BasePersistenceLayer {
       return new IdempotencyRecord({
         ...(item as unknown as IdempotencyRecordOptions),
       });
-    } catch (_error) {
-      throw new IdempotencyItemNotFoundError();
+    } catch (error) {
+      throw new IdempotencyItemNotFoundError('Item not found in store', {
+        cause: error,
+      });
     }
   }
 

examples/snippets/idempotency/advancedBringYourOwnPersistenceLayerUsage.ts

@@ -38,16 +38,12 @@ export const handler = async (
 ): Promise<Response> => {
   config.registerLambdaContext(context);
 
-  try {
-    const transactionId = randomUUID();
-    const payment = await createSubscriptionPayment(transactionId, event);
+  const transactionId = randomUUID();
+  const payment = await createSubscriptionPayment(transactionId, event);
 
-    return {
-      paymentId: payment.id,
-      message: 'success',
-      statusCode: 200,
-    };
-  } catch (_error) {
-    throw new Error('Error creating payment');
-  }
+  return {
+    paymentId: payment.id,
+    message: 'success',
+    statusCode: 200,
+  };
 };

examples/snippets/idempotency/customKeyPrefixDecorator.ts

@@ -13,17 +13,13 @@ class Lambda {
     keyPrefix: 'createSubscriptionPayment',
   })
   async handler(_event: unknown, _context: Context) {
-    try {
-      // ... create payment
+    // ... create payment
 
-      return {
-        paymentId: randomUUID(),
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: randomUUID(),
+      message: 'success',
+      statusCode: 200,
+    };
   }
 }
 

examples/snippets/idempotency/customKeyPrefixFnWrapper.ts

@@ -8,17 +8,13 @@ const persistenceStore = new DynamoDBPersistenceLayer({
 
 export const handler = makeIdempotent(
   async () => {
-    try {
-      // ... create payment
+    // ... create payment
 
-      return {
-        paymentId: randomUUID(),
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: randomUUID(),
+      message: 'success',
+      statusCode: 200,
+    };
   },
   {
     persistenceStore,

examples/snippets/idempotency/customKeyPrefixMiddleware.ts

@@ -15,15 +15,11 @@ export const handler = middy()
     })
   )
   .handler(async () => {
-    try {
-      // ... create payment
+    // ... create payment
 
-      return {
-        paymentId: randomUUID(),
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: randomUUID(),
+      message: 'success',
+      statusCode: 200,
+    };
   });

examples/snippets/idempotency/customizePersistenceLayer.ts

@@ -16,17 +16,13 @@ const persistenceStore = new DynamoDBPersistenceLayer({
 
 export const handler = middy(
   async (_event: Request, _context: Context): Promise<Response> => {
-    try {
-      // ... create payment
+    // ... create payment
 
-      return {
-        paymentId: '1234567890',
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: '1234567890',
+      message: 'success',
+      statusCode: 200,
+    };
   }
 ).use(
   makeHandlerIdempotent({

examples/snippets/idempotency/makeHandlerIdempotent.ts

@@ -21,17 +21,13 @@ const createSubscriptionPayment = async (
 
 export const handler = middy(
   async (event: Request, _context: Context): Promise<Response> => {
-    try {
-      const payment = await createSubscriptionPayment(event);
+    const payment = await createSubscriptionPayment(event);
 
-      return {
-        paymentId: payment.id,
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: payment.id,
+      message: 'success',
+      statusCode: 200,
+    };
   }
 ).use(
   makeHandlerIdempotent({

examples/snippets/idempotency/makeIdempotentAnyFunction.ts

@@ -42,18 +42,15 @@ export const handler = async (
   context: Context
 ): Promise<Response> => {
   config.registerLambdaContext(context);
-  try {
-    const transactionId = randomUUID();
-    const payment = await createSubscriptionPayment(transactionId, event);
 
-    await reportSubscriptionMetrics(transactionId, event.user);
+  const transactionId = randomUUID();
+  const payment = await createSubscriptionPayment(transactionId, event);
 
-    return {
-      paymentId: payment.id,
-      message: 'success',
-      statusCode: 200,
-    };
-  } catch (_error) {
-    throw new Error('Error creating payment');
-  }
+  await reportSubscriptionMetrics(transactionId, event.user);
+
+  return {
+    paymentId: payment.id,
+    message: 'success',
+    statusCode: 200,
+  };
 };

examples/snippets/idempotency/makeIdempotentBase.ts

@@ -20,17 +20,13 @@ const createSubscriptionPayment = async (
 
 export const handler = makeIdempotent(
   async (event: Request, _context: Context): Promise<Response> => {
-    try {
-      const payment = await createSubscriptionPayment(event);
+    const payment = await createSubscriptionPayment(event);
 
-      return {
-        paymentId: payment.id,
-        message: 'success',
-        statusCode: 200,
-      };
-    } catch (_error) {
-      throw new Error('Error creating payment');
-    }
+    return {
+      paymentId: payment.id,
+      message: 'success',
+      statusCode: 200,
+    };
   },
   {
     persistenceStore,