Merge branch 'idempotency-persistence-store' of github.com:jeffrey-baker-vg/aws-lambda-powertools-typescript into idempotency-persistence-store

Author: vgphoenixcampos

packages/idempotency/src/persistence/IdempotencyRecord.ts

@@ -7,23 +7,23 @@ class IdempotencyRecord {
     private status: IdempotencyRecordStatus,
     public expiryTimestamp: number | undefined,
     public inProgressExpiryTimestamp: number | undefined,
-    public responseData: Record<string, unknown> |undefined, 
-    public payloadHash: string | undefined) {}
-      
+    public responseData: Record<string, unknown> | undefined,
+    public payloadHash: string | undefined) { }
+
+  public getResponse(): Record<string, unknown> | undefined {
+    return this.responseData;
+  }
+
   public getStatus(): IdempotencyRecordStatus {
-    if (this.isExpired()){
+    if (this.isExpired()) {
       return IdempotencyRecordStatus.EXPIRED;
-    } else if (Object.values(IdempotencyRecordStatus).includes(this.status)){
+    } else if (Object.values(IdempotencyRecordStatus).includes(this.status)) {
       return this.status;
     } else {
       throw new IdempotencyInvalidStatusError();
     }
   }
 
-  public responseJsonAsObject(): Record<string, unknown> | undefined {
-    return this.responseData;
-  } 
-    
   private isExpired(): boolean {
     return this.expiryTimestamp !== undefined && (Date.now() > this.expiryTimestamp);
   }

packages/idempotency/tests/unit/persistence/IdempotencyRecord.test.ts

@@ -1,3 +1,4 @@
+import { IdempotencyInvalidStatusError } from '../../../src/Exceptions';
 import { IdempotencyRecord } from '../../../src/persistence/IdempotencyRecord';
 import { IdempotencyRecordStatus } from '../../../src/types/IdempotencyRecordStatus';
 /**
@@ -38,15 +39,38 @@ describe('Given an idempotency record that is not expired', () => {
     Date.now = jest.fn(() => mockNowBeforeExiryTime);
     idempotencyRecord = new IdempotencyRecord(mockIdempotencyKey, IdempotencyRecordStatus.INPROGRESS, expiryTimeAfterNow, mockInProgressExpiry, mockData, mockPayloadHash);
   });
+  describe('When checking the status of the idempotency record', () => {  
+    test('Then the status is EXPIRED', () => {
+      expect(idempotencyRecord.getStatus()).toEqual(IdempotencyRecordStatus.INPROGRESS); 
+    });
+
+    test('Then the record is returned', () => {
+      expect(idempotencyRecord.getResponse()).toEqual(mockData); 
+    });
+  });
+});
+
+describe('Given an idempotency record that has a status not in the IdempotencyRecordStatus enum', () => {
+  let idempotencyRecord: IdempotencyRecord; 
+  beforeEach(() => {
+    const mockNowBeforeExiryTime = 1487076707000;
+    const expiryTimeAfterNow = 1487076708000;
+    Date.now = jest.fn(() => mockNowBeforeExiryTime);
+    idempotencyRecord = new IdempotencyRecord(mockIdempotencyKey, 'NOT_A_STATUS' as IdempotencyRecordStatus, expiryTimeAfterNow, mockInProgressExpiry, mockData, mockPayloadHash);
+  });
   describe('When checking the status of the idempotency record', () => {
-    let resultingStatus: IdempotencyRecordStatus;
+    let resultingError: Error;
     beforeEach(() => {
-      resultingStatus = idempotencyRecord.getStatus();
+      try {
+        idempotencyRecord.getStatus();
+      } catch (e: unknown) {
+        resultingError = e as Error;
+      }
+
     });
-  
-    test('Then the status is EXPIRED', () => {
-      expect(resultingStatus).toEqual(IdempotencyRecordStatus.INPROGRESS); 
+    
+    test('Then an IdempotencyInvalidStatusError is thrown ', () => {
+      expect(resultingError).toBeInstanceOf(IdempotencyInvalidStatusError); 
     });
   });
-});
-  
+});