fix(putRequest): add support for composite partition key when using the ifNotExists

Author: michaelwittwer

src/dynamo/request/delete/delete.request.spec.ts

@@ -1,7 +1,7 @@
 import moment from 'moment-es6'
 import { getTableName } from '../../../../test/helper/get-table-name.function'
 import { ComplexModel } from '../../../../test/models/complex.model'
-import { SimpleWithIdModel } from '../../../../test/models/simple-with-id.model'
+import { SimpleWithPartitionKeyModel } from '../../../../test/models/simple-with-partition-key.model'
 import { MetadataHelper } from '../../../decorator/metadata/metadata-helper'
 import { ModelConstructor } from '../../../model/model-constructor'
 import { DeleteRequest } from './delete.request'
@@ -26,7 +26,12 @@ describe('delete request', () => {
   })
 
   it('should create request with key (simple) expression', () => {
-    const request = new DeleteRequest(<any>null, SimpleWithIdModel, getTableName(SimpleWithIdModel), 'myId')
+    const request = new DeleteRequest(
+      <any>null,
+      SimpleWithPartitionKeyModel,
+      getTableName(SimpleWithPartitionKeyModel),
+      'myId'
+    )
     const key = request.params.Key
     expect(key).toBeDefined()
     expect(Object.keys(key).length).toBe(1)

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

@@ -1,18 +1,23 @@
 import { GetItemInput } from 'aws-sdk/clients/dynamodb'
 import { getTableName } from '../../../../test/helper/get-table-name.function'
-import { SimpleWithIdModel } from '../../../../test/models/simple-with-id.model'
+import { SimpleWithPartitionKeyModel } from '../../../../test/models/simple-with-partition-key.model'
 import { GetRequest } from './get.request'
 
 describe('get requst', () => {
-  let request: GetRequest<SimpleWithIdModel>
+  let request: GetRequest<SimpleWithPartitionKeyModel>
 
   beforeEach(() => {
-    request = new GetRequest(null, SimpleWithIdModel, getTableName(SimpleWithIdModel), 'partitionKeyValue')
+    request = new GetRequest(
+      null,
+      SimpleWithPartitionKeyModel,
+      getTableName(SimpleWithPartitionKeyModel),
+      'partitionKeyValue'
+    )
   })
 
   it('default params', () => {
     const params: GetItemInput = request.params
-    expect(params.TableName).toBe('simple-with-id-models')
+    expect(params.TableName).toBe('simple-with-partition-key-models')
     expect(params.Key).toEqual({ id: { S: 'partitionKeyValue' } })
     expect(Object.keys(params).length).toBe(2)
   })

src/dynamo/request/put/put.request.spec.ts

@@ -1,34 +1,53 @@
 import { PutItemInput } from 'aws-sdk/clients/dynamodb'
+import moment from 'moment-es6'
 import { getTableName } from '../../../../test/helper/get-table-name.function'
-import { SimpleWithIdModel } from '../../../../test/models/simple-with-id.model'
+import { SimpleWithCompositePartitionKeyModel } from '../../../../test/models/simple-with-composite-partition-key.model'
+import { SimpleWithPartitionKeyModel } from '../../../../test/models/simple-with-partition-key.model'
 import { PutRequest } from './put.request'
 
 describe('put request', () => {
   it('default params', () => {
-    const item: SimpleWithIdModel = { id: 'myId', age: 45 }
-    const request = new PutRequest(null, SimpleWithIdModel, getTableName(SimpleWithIdModel), item)
+    const item: SimpleWithPartitionKeyModel = { id: 'myId', age: 45 }
+    const request = new PutRequest(null, SimpleWithPartitionKeyModel, getTableName(SimpleWithPartitionKeyModel), item)
     const params: PutItemInput = request.params
 
-    expect(params.TableName).toBe('simple-with-id-models')
+    expect(params.TableName).toBe('simple-with-partition-key-models')
     expect(params.Item).toEqual({ id: { S: 'myId' }, age: { N: '45' } })
     expect(Object.keys(params).length).toBe(2)
   })
 
   describe('if exists condition', () => {
-    it('simple', () => {
-      const item: SimpleWithIdModel = { id: 'myId', age: 45 }
-      const request = new PutRequest(null, SimpleWithIdModel, getTableName(SimpleWithIdModel), item)
+    it('simple partition key', () => {
+      const item: SimpleWithPartitionKeyModel = { id: 'myId', age: 45 }
+      const request = new PutRequest(null, SimpleWithPartitionKeyModel, getTableName(SimpleWithPartitionKeyModel), item)
       request.ifNotExists()
 
       const params: PutItemInput = request.params
-      expect(params.ConditionExpression).toBe('attribute_not_exists (#id)')
+      expect(params.ConditionExpression).toBe('(attribute_not_exists (#id))')
       expect(params.ExpressionAttributeNames).toEqual({ '#id': 'id' })
       expect(params.ExpressionAttributeValues).toBeUndefined()
     })
 
+    it('composite partition key', () => {
+      const now = moment()
+      const item: SimpleWithCompositePartitionKeyModel = { id: 'myId', creationDate: now, age: 45 }
+      const request = new PutRequest(
+        null,
+        SimpleWithCompositePartitionKeyModel,
+        getTableName(SimpleWithCompositePartitionKeyModel),
+        item
+      )
+      request.ifNotExists()
+
+      const params: PutItemInput = request.params
+      expect(params.ConditionExpression).toBe('(attribute_not_exists (#id) AND attribute_not_exists (#creationDate))')
+      expect(params.ExpressionAttributeNames).toEqual({ '#id': 'id', '#creationDate': 'creationDate' })
+      expect(params.ExpressionAttributeValues).toBeUndefined()
+    })
+
     it('predicate', () => {
-      const item: SimpleWithIdModel = { id: 'myId', age: 45 }
-      const request = new PutRequest(null, SimpleWithIdModel, getTableName(SimpleWithIdModel), item)
+      const item: SimpleWithPartitionKeyModel = { id: 'myId', age: 45 }
+      const request = new PutRequest(null, SimpleWithPartitionKeyModel, getTableName(SimpleWithPartitionKeyModel), item)
       request.ifNotExists(25 + 20 === 40)
 
       const params: PutItemInput = request.params

src/dynamo/request/put/put.request.ts

@@ -4,10 +4,10 @@ import { Mapper } from '../../../mapper/mapper'
 import { ModelConstructor } from '../../../model/model-constructor'
 import { DynamoRx } from '../../dynamo-rx'
 import { and } from '../../expression/logical-operator/and.function'
+import { attribute } from '../../expression/logical-operator/attribute.function'
 import { ParamUtil } from '../../expression/param-util'
 import { RequestExpressionBuilder } from '../../expression/request-expression-builder'
 import { ConditionExpressionDefinitionFunction } from '../../expression/type/condition-expression-definition-function'
-import { Expression } from '../../expression/type/expression.type'
 import { RequestConditionFunction } from '../../expression/type/request-condition-function'
 import { BaseRequest } from '../base.request'
 
@@ -23,8 +23,16 @@ export class PutRequest<T> extends BaseRequest<T, any> {
    */
   ifNotExists(predicate?: boolean): PutRequest<T> {
     // FIXME should we check for sort key too?
+    const conditionDefFns = []
     if (predicate === undefined || (predicate !== undefined && predicate === true)) {
-      this.whereAttribute(this.metaData.getPartitionKey()).null()
+      conditionDefFns.push(attribute<T>(this.metaData.getPartitionKey()).null())
+
+      const sortKey = this.metaData.getSortKey()
+      if (sortKey !== null) {
+        conditionDefFns.push(attribute<T>(sortKey).null())
+      }
+
+      this.where(...conditionDefFns)
     }
 
     return this

test/models/simple-with-composite-partition-key.model.ts

@@ -0,0 +1,13 @@
+import * as moment from 'moment-es6'
+import { PartitionKey } from '../../src/decorator/impl/key/partition-key.decorator'
+import { SortKey } from '../../src/decorator/impl/key/sort-key.decorator'
+import { Model } from '../../src/decorator/impl/model/model.decorator'
+
+@Model()
+export class SimpleWithCompositePartitionKeyModel {
+  @PartitionKey() id: string
+
+  @SortKey() creationDate: moment.Moment
+
+  age: number
+}

test/models/simple-with-id.model.ts renamed to test/models/simple-with-partition-key.model.ts

@@ -2,7 +2,7 @@ import { PartitionKey } from '../../src/decorator/impl/key/partition-key.decorat
 import { Model } from '../../src/decorator/impl/model/model.decorator'
 
 @Model()
-export class SimpleWithIdModel {
+export class SimpleWithPartitionKeyModel {
   @PartitionKey() id: string
 
   age: number