feat(aws-sdk-v3): fix tests

Author: Michael Wittwer

src/aws-sdk-v2.types.ts

@@ -10,4 +10,6 @@ export type BatchWriteItemRequestMap = { [key: string]: WriteRequest[] }
 export type ExpressionAttributeNameMap = { [key: string]: string /* was: AttributeName */ }
 export type ExpressionAttributeValueMap = { [key: string]: AttributeValue /* was: AttributeValue */ }
 
+export type AttributeMap = { [key: string]: AttributeValue }
+
 export type Key = { [key: string]: AttributeValue }

src/dynamo/batchget/batch-get.request.spec.ts

@@ -1,5 +1,6 @@
 // tslint:disable:no-non-null-assertion
 import * as DynamoDB from '@aws-sdk/client-dynamodb'
+import { ReturnConsumedCapacity } from '@aws-sdk/client-dynamodb'
 import { Organization, SimpleWithCompositePartitionKeyModel, SimpleWithPartitionKeyModel } from '../../../test/models'
 import { toDb } from '../../mapper/mapper'
 import { Attributes } from '../../mapper/type/attribute.type'
@@ -12,17 +13,17 @@ describe('batch get', () => {
 
   describe('constructor', () => {
     it('use provided DynamoDB instance', () => {
-      const dynamoDB = new DynamoDB.default()
+      const dynamoDB = new DynamoDB.DynamoDB({})
       const batchGetRequest = new BatchGetRequest(dynamoDB)
       expect(batchGetRequest.dynamoDB).toBe(dynamoDB)
 
-      const batchGetRequest2 = new BatchGetRequest()
+      const batchGetRequest2 = new BatchGetRequest(new DynamoDB.DynamoDB({}))
       expect(batchGetRequest2.dynamoDB).not.toBe(dynamoDB)
     })
   })
 
   describe('params', () => {
-    beforeEach(() => (request = new BatchGetRequest()))
+    beforeEach(() => (request = new BatchGetRequest(new DynamoDB.DynamoDB({}))))
 
     it('base params', () => {
       const params = request.params
@@ -48,13 +49,13 @@ describe('batch get', () => {
     })
 
     it('returnConsumedCapacity', () => {
-      request.returnConsumedCapacity('TOTAL')
+      request.returnConsumedCapacity(ReturnConsumedCapacity.TOTAL)
       expect(request.params.ReturnConsumedCapacity).toBe('TOTAL')
     })
   })
 
   describe('forModel', () => {
-    beforeEach(() => (request = new BatchGetRequest()))
+    beforeEach(() => (request = new BatchGetRequest(new DynamoDB.DynamoDB({}))))
 
     it('should throw when same table is used 2 times', () => {
       request.forModel(SimpleWithPartitionKeyModel, [{ id: 'idVal' }])
@@ -132,7 +133,7 @@ describe('batch get', () => {
     const generatorMock = () => <any>{ next: nextSpyFn }
 
     beforeEach(() => {
-      request = new BatchGetRequest()
+      request = new BatchGetRequest(new DynamoDB.DynamoDB({}))
       request.forModel(SimpleWithPartitionKeyModel, [jsItem1, jsItem2])
 
       batchGetItemsMock = jest
@@ -205,7 +206,7 @@ describe('batch get', () => {
     beforeEach(() => {
       batchGetItemsMock = jest.fn().mockReturnValueOnce(Promise.resolve(sampleResponse))
       const dynamoDBWrapper: DynamoDbWrapper = <any>{ batchGetItems: batchGetItemsMock }
-      request = new BatchGetRequest()
+      request = new BatchGetRequest(new DynamoDB.DynamoDB({}))
       Object.assign(request, { dynamoDBWrapper })
       request.forModel(SimpleWithPartitionKeyModel, [{ id: 'idVal' }])
     })

src/dynamo/batchwrite/batch-write.request.spec.ts

@@ -1,4 +1,5 @@
 import * as DynamoDB from '@aws-sdk/client-dynamodb'
+import { ReturnConsumedCapacity, ReturnItemCollectionMetrics } from '@aws-sdk/client-dynamodb'
 import { ComplexModel, SimpleWithPartitionKeyModel } from '../../../test/models'
 import { getTableName } from '../get-table-name.function'
 import { BatchWriteRequest } from './batch-write.request'
@@ -8,31 +9,33 @@ describe('batchWriteRequest', () => {
 
   describe('constructor', () => {
     it('should initialize params', () => {
-      req = new BatchWriteRequest()
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({}))
       expect(req.params.RequestItems).toBeDefined()
       expect(req.params.RequestItems).toEqual({})
     })
 
     describe('use provided DynamoDB instance', () => {
-      const dynamoDB = new DynamoDB.default()
+      const dynamoDB = new DynamoDB.DynamoDB({})
       const batchWriteRequest = new BatchWriteRequest(dynamoDB)
       expect(batchWriteRequest.dynamoDB).toBe(dynamoDB)
 
-      const batchWriteRequest2 = new BatchWriteRequest()
+      const batchWriteRequest2 = new BatchWriteRequest(new DynamoDB.DynamoDB({}))
       expect(batchWriteRequest2.dynamoDB).not.toBe(dynamoDB)
     })
   })
 
   describe('returnConsumedCapacity', () => {
     it('should set params', () => {
-      req = new BatchWriteRequest().returnConsumedCapacity('TOTAL')
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({})).returnConsumedCapacity(ReturnConsumedCapacity.TOTAL)
       expect(req.params.ReturnConsumedCapacity).toBe('TOTAL')
     })
   })
 
   describe('returnItemCollectionMetrics', () => {
     it('should set params', () => {
-      req = new BatchWriteRequest().returnItemCollectionMetrics('SIZE')
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({})).returnItemCollectionMetrics(
+        ReturnItemCollectionMetrics.SIZE,
+      )
       expect(req.params.ReturnItemCollectionMetrics).toBe('SIZE')
     })
   })
@@ -41,7 +44,7 @@ describe('batchWriteRequest', () => {
     const now = new Date()
 
     it('should set params', () => {
-      req = new BatchWriteRequest()
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({}))
         .delete(SimpleWithPartitionKeyModel, [{ id: 'myId1' }])
         .delete(ComplexModel, [{ id: 'myId2', creationDate: now }])
 
@@ -69,15 +72,17 @@ describe('batchWriteRequest', () => {
       const items: Array<Partial<SimpleWithPartitionKeyModel>> = [...new Array(30)].map((_, ix) => ({
         id: `mydId-${ix}`,
       }))
-      expect(() => new BatchWriteRequest().delete(SimpleWithPartitionKeyModel, items)).toThrow()
+      expect(() =>
+        new BatchWriteRequest(new DynamoDB.DynamoDB({})).delete(SimpleWithPartitionKeyModel, items),
+      ).toThrow()
     })
   })
 
   describe('put', () => {
     const now = new Date()
 
     it('should set params', () => {
-      req = new BatchWriteRequest()
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({}))
         .put(SimpleWithPartitionKeyModel, [<any>{ id: 'myId1' }])
         .put(ComplexModel, [<any>{ id: 'myId2', creationDate: now }])
 
@@ -98,7 +103,7 @@ describe('batchWriteRequest', () => {
 
     it('should throw when too many items', () => {
       const items: SimpleWithPartitionKeyModel[] = [...new Array(30)].map((_, ix) => ({ id: `mydId-${ix}`, age: ix }))
-      expect(() => new BatchWriteRequest().put(SimpleWithPartitionKeyModel, items)).toThrow()
+      expect(() => new BatchWriteRequest(new DynamoDB.DynamoDB({})).put(SimpleWithPartitionKeyModel, items)).toThrow()
     })
   })
 
@@ -116,7 +121,7 @@ describe('batchWriteRequest', () => {
       (_, ix) => <ComplexModel>{ id: `myId-${ix}`, creationDate: now },
     )
 
-    beforeEach(() => (req = new BatchWriteRequest()))
+    beforeEach(() => (req = new BatchWriteRequest(new DynamoDB.DynamoDB({}))))
 
     it('should add correct request items', () => {
       req.put(ComplexModel, complexItems).delete(SimpleWithPartitionKeyModel, [simpleItem])
@@ -144,7 +149,7 @@ describe('batchWriteRequest', () => {
       }
       batchWriteItemMock = jest.fn().mockReturnValueOnce(Promise.resolve(output))
       const dynamoDBWrapper = <any>{ batchWriteItem: batchWriteItemMock }
-      req = new BatchWriteRequest()
+      req = new BatchWriteRequest(new DynamoDB.DynamoDB({}))
       Object.assign(req, { dynamoDBWrapper })
     })
 

src/dynamo/dynamo-db-wrapper.spec.ts

@@ -17,7 +17,7 @@ describe('dynamo rx', () => {
       pseudoParams = { TableName: 'tableName', KeyConditionExpression: 'blub' }
       sessionValidityEnsurerMock = jest.fn().mockReturnValueOnce(Promise.resolve())
       updateDynamoEasyConfig({ sessionValidityEnsurer: sessionValidityEnsurerMock })
-      dynamoDBWrapper = new DynamoDbWrapper()
+      dynamoDBWrapper = new DynamoDbWrapper(new DynamoDB.DynamoDB({}))
     })
 
     afterEach(() => {
@@ -98,55 +98,48 @@ describe('dynamo rx', () => {
     })
   })
 
-  describe('makeRequest', () => {
-    let dynamoDBWrapper: DynamoDbWrapper
-    let sessionValidityEnsurerMock: jest.Mock
-    let dynamoDBMock: jest.SpyInstance
-    let pseudoParams: any
-
-    beforeEach(() => {
-      pseudoParams = { TableName: 'tableName', KeyConditionExpression: 'blub' }
-      sessionValidityEnsurerMock = jest.fn().mockReturnValueOnce(Promise.resolve(true))
-      updateDynamoEasyConfig({ sessionValidityEnsurer: sessionValidityEnsurerMock })
-      dynamoDBWrapper = new DynamoDbWrapper()
-    })
-
-    it('should call the validity ensurer before each call and call the correct dynamoDB method', async () => {
-      dynamoDBMock = jest
-        .spyOn(dynamoDBWrapper.dynamoDB, 'makeRequest')
-        .mockReturnValueOnce(<any>{ promise: () => Promise.resolve() })
-      await dynamoDBWrapper.makeRequest('pseudoOperation', pseudoParams)
-      expect(sessionValidityEnsurerMock).toHaveBeenCalled()
-      expect(dynamoDBMock).toHaveBeenCalledTimes(1)
-      expect(dynamoDBMock).toHaveBeenCalledWith('pseudoOperation', pseudoParams)
-    })
-  })
+  // TODO v3: remove when decision is made if DynamoDbWrapper.makeRequest comes back or not
+  // describe('makeRequest', () => {
+  //   let dynamoDBWrapper: DynamoDbWrapper
+  //   let sessionValidityEnsurerMock: jest.Mock
+  //   let dynamoDBMock: jest.SpyInstance
+  //   let pseudoParams: any
+  //
+  //   beforeEach(() => {
+  //     pseudoParams = { TableName: 'tableName', KeyConditionExpression: 'blub' }
+  //     sessionValidityEnsurerMock = jest.fn().mockReturnValueOnce(Promise.resolve(true))
+  //     updateDynamoEasyConfig({ sessionValidityEnsurer: sessionValidityEnsurerMock })
+  //     dynamoDBWrapper = new DynamoDbWrapper(new DynamoDB.DynamoDB({}))
+  //   })
+  //
+  //   it('should call the validity ensurer before each call and call the correct dynamoDB method', async () => {
+  //     dynamoDBMock = jest
+  //       .spyOn(dynamoDBWrapper.dynamoDB, 'makeRequest')
+  //       .mockReturnValueOnce(<any>{ promise: () => Promise.resolve() })
+  //     await dynamoDBWrapper.makeRequest('pseudoOperation', pseudoParams)
+  //     expect(sessionValidityEnsurerMock).toHaveBeenCalled()
+  //     expect(dynamoDBMock).toHaveBeenCalledTimes(1)
+  //     expect(dynamoDBMock).toHaveBeenCalledWith('pseudoOperation', pseudoParams)
+  //   })
+  // })
 
   describe('query', () => {
     beforeEach(() => {})
     it('should throw when no KeyConditionExpression was given', () => {
-      const dynamoDBWrapper = new DynamoDbWrapper()
+      const dynamoDBWrapper = new DynamoDbWrapper(new DynamoDB.DynamoDB({}))
       updateDynamoEasyConfig({ sessionValidityEnsurer: jest.fn().mockReturnValue(Promise.resolve()) })
       expect(() => dynamoDBWrapper.query({ TableName: 'tableName' })).toThrow()
     })
   })
 
-  it('should call makeRequest with the given params', async () => {
-    const dynamoDBWrapper = new DynamoDbWrapper()
-    const makeRequestMock = jest.fn().mockReturnValue({ promise: (args: any) => Promise.resolve(args) })
-    Object.assign(dynamoDBWrapper, { dynamoDB: { makeRequest: makeRequestMock } })
-
-    await dynamoDBWrapper.makeRequest(<any>{ ok: true })
-    expect(makeRequestMock).toHaveBeenCalled()
-    expect(makeRequestMock.mock.calls.slice(-1)[0][0]).toEqual({ ok: true })
-  })
-
-  it('should use given dynamoDB client', () => {
-    const dynamoDB = new DynamoDB.default()
-    const dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
-    expect(dynamoDBWrapper.dynamoDB).toBe(dynamoDB)
-
-    const dynamoDBWrapper2 = new DynamoDbWrapper()
-    expect(dynamoDBWrapper2.dynamoDB).not.toBe(dynamoDB)
-  })
+  // TODO v3: remove when decision is made if DynamoDbWrapper.makeRequest comes back or not
+  // it('should call makeRequest with the given params', async () => {
+  //   const dynamoDBWrapper = new DynamoDbWrapper(new DynamoDB.DynamoDB({}))
+  //   const makeRequestMock = jest.fn().mockReturnValue({ promise: (args: any) => Promise.resolve(args) })
+  //   Object.assign(dynamoDBWrapper, { dynamoDB: { makeRequest: makeRequestMock } })
+  //
+  //   await dynamoDBWrapper.makeRequest(<any>{ ok: true })
+  //   expect(makeRequestMock).toHaveBeenCalled()
+  //   expect(makeRequestMock.mock.calls.slice(-1)[0][0]).toEqual({ ok: true })
+  // })
 })

src/dynamo/dynamo-store.spec.ts

@@ -24,9 +24,15 @@ class DynamoStoreModel {}
 class DynamoStoreModel2 {}
 
 describe('dynamo store', () => {
+  let dynamoDB: DynamoDB.DynamoDB
+
+  beforeEach(() => {
+    dynamoDB = new DynamoDB.DynamoDB({})
+  })
+
   describe('table name', () => {
     it('correct table name', () => {
-      const store = new DynamoStore(DynamoStoreModel2)
+      const store = new DynamoStore(DynamoStoreModel2, dynamoDB)
       expect(store.tableName).toBe('myTableName')
     })
   })
@@ -43,7 +49,7 @@ describe('dynamo store', () => {
     afterEach(resetDynamoEasyConfig)
 
     it('custom session validity ensurer is used', async () => {
-      const store = new DynamoStore(DynamoStoreModel)
+      const store = new DynamoStore(DynamoStoreModel, dynamoDB)
       try {
         await store.scan().exec()
       } catch (error) {
@@ -60,7 +66,7 @@ describe('dynamo store', () => {
       updateDynamoEasyConfig({ logReceiver: logReceiverMock })
     })
     it('logs when instance was created', () => {
-      new DynamoStore(DynamoStoreModel)
+      new DynamoStore(DynamoStoreModel, dynamoDB)
       expect(logReceiverMock).toHaveBeenCalled()
     })
   })
@@ -69,7 +75,7 @@ describe('dynamo store', () => {
     let store: DynamoStore<SimpleWithPartitionKeyModel>
 
     beforeEach(() => {
-      store = new DynamoStore(SimpleWithPartitionKeyModel)
+      store = new DynamoStore(SimpleWithPartitionKeyModel, dynamoDB)
     })
 
     it('put', () => expect(store.put({ id: 'id', age: 0 }) instanceof PutRequest).toBeTruthy())
@@ -84,25 +90,17 @@ describe('dynamo store', () => {
       expect(store.transactGet([{ id: 'myId' }]) instanceof TransactGetSingleTableRequest).toBeTruthy())
   })
 
-  describe('should enable custom requests', () => {
-    const makeRequestSpy = jest.fn().mockReturnValue(Promise.resolve())
-    const store = new DynamoStore(SimpleWithPartitionKeyModel)
-    Object.assign(store, { dynamoDBWrapper: { makeRequest: makeRequestSpy } })
-    store.makeRequest('updateTimeToLive', {})
-    expect(makeRequestSpy).toBeCalled()
-  })
+  // TODO v3: possibly remove when we decided on how to proceed with DynamoDbWrapper.makeRequest
+  // xdescribe('should enable custom requests', () => {
+  //   const makeRequestSpy = jest.fn().mockReturnValue(Promise.resolve())
+  //   const store = new DynamoStore(SimpleWithPartitionKeyModel, dynamoDB)
+  //   Object.assign(store, { dynamoDBWrapper: { makeRequest: makeRequestSpy } })
+  //   store.makeRequest('updateTimeToLive', {})
+  //   expect(makeRequestSpy).toBeCalled()
+  // })
 
   describe('allow to get dynamoDB instance', () => {
-    const store = new DynamoStore(SimpleWithPartitionKeyModel)
+    const store = new DynamoStore(SimpleWithPartitionKeyModel, new DynamoDB.DynamoDB({}))
     expect(store.dynamoDB).toBeDefined()
   })
-
-  describe('use provided dynamoDB instance', () => {
-    const dynamoDB = new DynamoDB.default()
-    const store = new DynamoStore(SimpleWithPartitionKeyModel, dynamoDB)
-    expect(store.dynamoDB).toBe(dynamoDB)
-
-    const store2 = new DynamoStore(SimpleWithPartitionKeyModel)
-    expect(store2.dynamoDB).not.toBe(dynamoDB)
-  })
 })

src/dynamo/request/base.request.spec.ts

@@ -1,4 +1,5 @@
 // tslint:disable:max-classes-per-file
+import { ReturnConsumedCapacity } from '@aws-sdk/client-dynamodb'
 import { SimpleWithPartitionKeyModel } from '../../../test/models'
 import { ModelConstructor } from '../../model/model-constructor'
 import { BaseRequest } from './base.request'
@@ -57,11 +58,11 @@ describe('base request', () => {
       request = new TestRequest(SimpleWithPartitionKeyModel)
     })
     it('should set param', () => {
-      request.returnConsumedCapacity('TOTAL')
+      request.returnConsumedCapacity(ReturnConsumedCapacity.TOTAL)
       expect(request.params.ReturnConsumedCapacity).toBe('TOTAL')
     })
     it('should return request instance', () => {
-      expect(request.returnConsumedCapacity('TOTAL')).toBe(request)
+      expect(request.returnConsumedCapacity(ReturnConsumedCapacity.TOTAL)).toBe(request)
     })
   })
 })