CCM-12223: dynamodb error handling

Author: harrim91

lambdas/backend-api/src/__tests__/templates/infra/routing-config-repository/query.test.ts

@@ -225,6 +225,22 @@ describe('RoutingConfigRepo#query', () => {
 
       expect(result.data).toEqual([]);
     });
+
+    test('handles exceptions from dynamodb', async () => {
+      const { repo, mocks } = setup();
+
+      const e = new Error('oh no');
+
+      mocks.dynamo.on(QueryCommand).rejectsOnce(e);
+
+      const result = await repo.query(owner).list();
+
+      expect(result.error).toMatchObject({
+        actualError: e,
+        errorMeta: expect.objectContaining({ code: 500 }),
+      });
+      expect(result.data).toBeUndefined();
+    });
   });
 
   describe('count', () => {
@@ -280,5 +296,21 @@ describe('RoutingConfigRepo#query', () => {
 
       expect(result.data).toEqual({ count: 0 });
     });
+
+    test('handles exceptions from dynamodb', async () => {
+      const { repo, mocks } = setup();
+
+      const e = new Error('oh no');
+
+      mocks.dynamo.on(QueryCommand).rejectsOnce(e);
+
+      const result = await repo.query(owner).count();
+
+      expect(result.error).toMatchObject({
+        actualError: e,
+        errorMeta: expect.objectContaining({ code: 500 }),
+      });
+      expect(result.data).toBeUndefined();
+    });
   });
 });

lambdas/backend-api/src/__tests__/templates/infra/routing-config-repository/repository.test.ts

@@ -1,6 +1,7 @@
 import { DynamoDBDocumentClient, GetCommand } from '@aws-sdk/lib-dynamodb';
 import 'aws-sdk-client-mock-jest';
 import { mockClient } from 'aws-sdk-client-mock';
+import { ZodError } from 'zod';
 import { RoutingConfigRepository } from '@backend-api/templates/infra/routing-config-repository';
 import { routingConfig } from '../../fixtures/routing-config';
 
@@ -83,7 +84,12 @@ describe('RoutingConfigRepository', () => {
         'nhs-notify-client-id'
       );
 
-      expect(result.error).not.toBeUndefined();
+      expect(result.error).toMatchObject({
+        actualError: expect.any(ZodError),
+        errorMeta: expect.objectContaining({
+          code: 500,
+        }),
+      });
       expect(result.data).toBeUndefined();
 
       expect(mocks.dynamo).toHaveReceivedCommandWith(GetCommand, {
@@ -94,5 +100,27 @@ describe('RoutingConfigRepository', () => {
         },
       });
     });
+
+    test('returns errors if the database call fails', async () => {
+      const { repo, mocks } = setup();
+
+      const e = new Error('Oh No');
+
+      mocks.dynamo.on(GetCommand).rejectsOnce(e);
+
+      const result = await repo.get(
+        'b9b6d56b-421e-462f-9ce5-3012e3fdb27f',
+        'nhs-notify-client-id'
+      );
+
+      expect(result.error).toMatchObject({
+        actualError: e,
+        errorMeta: expect.objectContaining({
+          code: 500,
+        }),
+      });
+
+      expect(result.data).toBeUndefined();
+    });
   });
 });

lambdas/backend-api/src/templates/infra/routing-config-repository/query.ts

@@ -4,9 +4,10 @@ import {
   type NativeAttributeValue,
   type QueryCommandInput,
 } from '@aws-sdk/lib-dynamodb';
-import { ApplicationResult, success } from '@backend-api/utils/result';
+import { ApplicationResult, failure, success } from '@backend-api/utils/result';
 import {
   $RoutingConfig,
+  ErrorCase,
   type RoutingConfig,
   type RoutingConfigStatus,
 } from 'nhs-notify-backend-client';
@@ -37,49 +38,65 @@ export class RoutingConfigQuery {
 
   /** Execute the query and return a list of all matching RoutingConfigs */
   async list(): Promise<ApplicationResult<RoutingConfig[]>> {
-    this.returnCount = false;
-
-    const query = this.build();
-
-    const collected: RoutingConfig[] = [];
-
-    const paginator = paginateQuery({ client: this.docClient }, query);
-
-    for await (const page of paginator) {
-      for (const item of page.Items ?? []) {
-        const parsed = $RoutingConfig.safeParse(item);
-        if (parsed.success) {
-          collected.push(parsed.data);
-        } else {
-          logger.warn('Filtered out invalid RoutingConfig item', {
-            owner: this.owner,
-            id: item.id,
-            issues: parsed.error.issues,
-          });
+    try {
+      this.returnCount = false;
+
+      const query = this.build();
+
+      const collected: RoutingConfig[] = [];
+
+      const paginator = paginateQuery({ client: this.docClient }, query);
+
+      for await (const page of paginator) {
+        for (const item of page.Items ?? []) {
+          const parsed = $RoutingConfig.safeParse(item);
+          if (parsed.success) {
+            collected.push(parsed.data);
+          } else {
+            logger.warn('Filtered out invalid RoutingConfig item', {
+              owner: this.owner,
+              id: item.id,
+              issues: parsed.error.issues,
+            });
+          }
         }
       }
-    }
 
-    return success(collected);
+      return success(collected);
+    } catch (error) {
+      return failure(
+        ErrorCase.INTERNAL,
+        'Error listing Routing Configs',
+        error
+      );
+    }
   }
 
   /** Execute the query and return a count of all matching RoutingConfigs */
   async count(): Promise<ApplicationResult<{ count: number }>> {
-    this.returnCount = true;
+    try {
+      this.returnCount = true;
 
-    const query = this.build();
+      const query = this.build();
 
-    let count = 0;
+      let count = 0;
 
-    const paginator = paginateQuery({ client: this.docClient }, query);
+      const paginator = paginateQuery({ client: this.docClient }, query);
 
-    for await (const page of paginator) {
-      if (page.Count) {
-        count += page.Count;
+      for await (const page of paginator) {
+        if (page.Count) {
+          count += page.Count;
+        }
       }
-    }
 
-    return success({ count });
+      return success({ count });
+    } catch (error) {
+      return failure(
+        ErrorCase.INTERNAL,
+        'Error counting Routing Configs',
+        error
+      );
+    }
   }
 
   private build() {

lambdas/backend-api/src/templates/infra/routing-config-repository/repository.ts

@@ -17,31 +17,31 @@ export class RoutingConfigRepository {
     id: string,
     owner: string
   ): Promise<ApplicationResult<RoutingConfig>> {
-    const result = await this.client.send(
-      new GetCommand({
-        TableName: this.tableName,
-        Key: {
-          id,
-          owner,
-        },
-      })
-    );
+    try {
+      const result = await this.client.send(
+        new GetCommand({
+          TableName: this.tableName,
+          Key: {
+            id,
+            owner,
+          },
+        })
+      );
 
-    if (!result.Item) {
-      return failure(ErrorCase.NOT_FOUND, 'Routing Config not found');
-    }
+      if (!result.Item) {
+        return failure(ErrorCase.NOT_FOUND, 'Routing Config not found');
+      }
 
-    const parsed = $RoutingConfig.safeParse(result.Item);
+      const parsed = $RoutingConfig.parse(result.Item);
 
-    if (!parsed.success) {
+      return success(parsed);
+    } catch (error) {
       return failure(
         ErrorCase.INTERNAL,
         'Error retrieving Routing Config',
-        parsed.error
+        error
       );
     }
-
-    return success(parsed.data);
   }
 
   query(owner: string): RoutingConfigQuery {