feat(projection-expression): extract function to add param

extract the function to add the projection expression param into own function with tests

Author: michaelwittwer

src/dynamo/request/batchgetsingletable/batch-get-single-table.request.spec.ts

@@ -3,11 +3,7 @@ import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 // tslint:disable:no-unused-expression
 // tslint:disable:no-non-null-assertion
 import { resetDynamoEasyConfig } from '../../../../test/helper/resetDynamoEasyConfig.function'
-import {
-  ComplexModel,
-  SimpleWithCompositePartitionKeyModel,
-  SimpleWithPartitionKeyModel,
-} from '../../../../test/models'
+import { SimpleWithCompositePartitionKeyModel, SimpleWithPartitionKeyModel } from '../../../../test/models'
 import { updateDynamoEasyConfig } from '../../../config/update-config.function'
 import { getTableName } from '../../get-table-name.function'
 import { BatchGetSingleTableRequest } from './batch-get-single-table.request'
@@ -74,25 +70,13 @@ describe('batch get', () => {
 
     it('projection expression', () => {
       const request = new BatchGetSingleTableRequest<any>(<any>null, SimpleWithPartitionKeyModel, [{ id: 'myId' }])
-      request.projectionExpression('name')
+      request.projectionExpression('age')
       expect(request.params.RequestItems).toBeDefined()
-      expect(request.params.RequestItems[getTableName(SimpleWithPartitionKeyModel)]).toBeDefined()
-      expect(request.params.RequestItems[getTableName(SimpleWithPartitionKeyModel)].ProjectionExpression).toBe('#name')
-      expect(request.params.RequestItems[getTableName(SimpleWithPartitionKeyModel)].ExpressionAttributeNames).toEqual({
-        '#name': 'name',
-      })
-    })
-
-    it('projection expression (custom db attribute name)', () => {
-      const request = new BatchGetSingleTableRequest<ComplexModel>(<any>null, ComplexModel, [
-        { id: 'myId', creationDate: new Date() },
-      ])
-      request.projectionExpression('active')
-      expect(request.params.RequestItems).toBeDefined()
-      expect(request.params.RequestItems[getTableName(ComplexModel)]).toBeDefined()
-      expect(request.params.RequestItems[getTableName(ComplexModel)].ProjectionExpression).toBe('#active')
-      expect(request.params.RequestItems[getTableName(ComplexModel)].ExpressionAttributeNames).toEqual({
-        '#active': 'isActive',
+      const params = request.params.RequestItems[getTableName(SimpleWithPartitionKeyModel)]
+      expect(params).toBeDefined()
+      expect(params.ProjectionExpression).toBe('#age')
+      expect(params.ExpressionAttributeNames).toEqual({
+        '#age': 'age',
       })
     })
   })

src/dynamo/request/get/get.request.spec.ts

@@ -1,10 +1,6 @@
 // tslint:disable:no-unused-expression
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
-import {
-  ComplexModel,
-  SimpleWithCompositePartitionKeyModel,
-  SimpleWithPartitionKeyModel,
-} from '../../../../test/models'
+import { SimpleWithCompositePartitionKeyModel, SimpleWithPartitionKeyModel } from '../../../../test/models'
 import { updateDynamoEasyConfig } from '../../../config/update-config.function'
 import { Attributes } from '../../../mapper/type/attribute.type'
 import { getTableName } from '../../get-table-name.function'
@@ -38,11 +34,11 @@ describe('GetRequest', () => {
     })
 
     it('projection expression', () => {
-      request.projectionExpression('name')
+      request.projectionExpression('age')
 
       const params = request.params
-      expect(params.ProjectionExpression).toBe('#name')
-      expect(params.ExpressionAttributeNames).toEqual({ '#name': 'name' })
+      expect(params.ProjectionExpression).toBe('#age')
+      expect(params.ExpressionAttributeNames).toEqual({ '#age': 'age' })
       expect(Object.keys(params).length).toBe(4)
     })
 
@@ -57,23 +53,6 @@ describe('GetRequest', () => {
     })
   })
 
-  describe('correct params (complex model)', () => {
-    let request: GetRequest<ComplexModel>
-
-    beforeEach(() => {
-      request = new GetRequest(<any>null, ComplexModel, 'partitionKeyValue', new Date())
-    })
-
-    it('projection expression', () => {
-      request.projectionExpression('active')
-
-      const params = request.params
-      expect(params.ProjectionExpression).toBe('#active')
-      expect(params.ExpressionAttributeNames).toEqual({ '#active': 'isActive' })
-      expect(Object.keys(params).length).toBe(4)
-    })
-  })
-
   describe('maps response item', () => {
     const jsItem: SimpleWithPartitionKeyModel = { age: 20, id: 'my-id' }
     const dbItem: Attributes<SimpleWithPartitionKeyModel> = { age: { N: '20' }, id: { S: 'my-id' } }

src/dynamo/request/helper/add-projection-expression-param.function.spec.ts

@@ -0,0 +1,33 @@
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
+import { ComplexModel, SimpleWithPartitionKeyModel } from '../../../../test/models'
+import { metadataForModel } from '../../../decorator/metadata/metadata-for-model.function'
+import { addProjectionExpressionParam } from './add-projection-expression-param.function'
+
+describe('add projection expression param function', () => {
+  let params: DynamoDB.KeysAndAttributes
+
+  beforeEach(() => {
+    params = <DynamoDB.KeysAndAttributes>{}
+  })
+
+  it('add single projection attribute to params', () => {
+    addProjectionExpressionParam<SimpleWithPartitionKeyModel>(['age'], params)
+    expect(params.ProjectionExpression).toBeDefined()
+    expect(params.ProjectionExpression).toBe('#age')
+    expect(params.ExpressionAttributeNames).toEqual({ '#age': 'age' })
+  })
+
+  it('add multiple projection attribute to params', () => {
+    addProjectionExpressionParam<SimpleWithPartitionKeyModel>(['age', 'id'], params)
+    expect(params.ProjectionExpression).toBeDefined()
+    expect(params.ProjectionExpression).toBe('#age, #id')
+    expect(params.ExpressionAttributeNames).toEqual({ '#age': 'age', '#id': 'id' })
+  })
+
+  it('add multiple projection attribute respecting given metadata to params', () => {
+    addProjectionExpressionParam<ComplexModel>(['active', 'simpleProperty'], params, metadataForModel(ComplexModel))
+    expect(params.ProjectionExpression).toBeDefined()
+    expect(params.ProjectionExpression).toBe('#active, #simpleProperty')
+    expect(params.ExpressionAttributeNames).toEqual({ '#active': 'isActive', '#simpleProperty': 'simpleProperty' })
+  })
+})

src/dynamo/request/read-many.request.spec.ts

@@ -1,6 +1,5 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import {
-  ComplexModel,
   ModelWithABunchOfIndexes,
   SimpleWithCompositePartitionKeyModel,
   SimpleWithPartitionKeyModel,
@@ -125,19 +124,19 @@ describe('ReadManyRequest', () => {
     })
   })
 
-  describe('projectionExpression', () => {
+  describe('projection expression', () => {
     beforeEach(() => {
-      request = new TestRequest(ComplexModel)
+      request = new TestRequest(SimpleWithPartitionKeyModel)
     })
 
     it('should set param for projection expression', () => {
-      request.projectionExpression('active', 'lastUpdated')
-      expect(request.params.ProjectionExpression).toBe('#active, #lastUpdated')
-      expect(request.params.ExpressionAttributeNames).toEqual({ '#active': 'isActive', '#lastUpdated': 'lastUpdated' })
+      ;(request as TestRequest<SimpleWithPartitionKeyModel>).projectionExpression('age')
+      expect(request.params.ProjectionExpression).toBe('#age')
+      expect(request.params.ExpressionAttributeNames).toEqual({ '#age': 'age' })
     })
 
     it('should return instance', () => {
-      const r = request.projectionExpression('active')
+      const r = request.projectionExpression('age')
       expect(r).toBe(request)
     })
   })