Merge pull request #57 from shiftcode/query-request-fix-for-custom-mapper

Query request fix for custom mapper

Author: michaelwittwer

src/dynamo/request/query/query.request.spec.ts

@@ -1,16 +1,20 @@
 import { QueryInput, QueryOutput } from 'aws-sdk/clients/dynamodb'
 import * as moment from 'moment'
-import { Observable } from 'rxjs'
+import { Observable, of } from 'rxjs'
 import { getTableName } from '../../../../test/helper/get-table-name.function'
 import { ComplexModel } from '../../../../test/models/complex.model'
+import {
+  CustomId,
+  ModelWithCustomMapperForSortKeyModel,
+} from '../../../../test/models/model-with-custom-mapper-for-sort-key.model'
 import { INDEX_ACTIVE_CREATED_AT, ModelWithABunchOfIndexes } from '../../../../test/models/model-with-indexes.model'
 import { DynamoRx } from '../../dynamo-rx'
 import { attribute } from '../../expression/logical-operator/attribute.function'
 import { QueryRequest } from './query.request'
 
 export const DYNAMO_RX_MOCK: DynamoRx = <DynamoRx>{
   query(params: QueryInput): Observable<QueryOutput> {
-    return Observable.of({})
+    return of({})
   },
 }
 
@@ -88,6 +92,24 @@ describe('query request', () => {
     })
   })
 
+  describe('uses custom mapper for sortKey', () => {
+    const request = new QueryRequest(
+      <any>null,
+      ModelWithCustomMapperForSortKeyModel,
+      getTableName(ModelWithCustomMapperForSortKeyModel)
+    )
+
+    request.whereSortKey().between(new CustomId(moment('2018-01-01'), 0), new CustomId(moment('2018-12-31'), 99999))
+
+    it('correct mapping', () => {
+      expect(request.params.ExpressionAttributeValues).toBeDefined()
+      expect(request.params.ExpressionAttributeValues).toEqual({
+        ':customId': { N: '2018010100000' },
+        ':customId_2': { N: '2018123199999' },
+      })
+    })
+  })
+
   describe('calls endpoint with correct params', () => {
     const dynamoRx: DynamoRx = DYNAMO_RX_MOCK as DynamoRx
     let querySpy

src/dynamo/request/query/query.request.ts

@@ -67,7 +67,7 @@ export class QueryRequest<T> extends Request<T, QueryRequest<T>, QueryInput, Que
       throw new Error('There was no sort key defined for current schema')
     }
 
-    return RequestExpressionBuilder.addSortKeyCondition(sortKey, this)
+    return RequestExpressionBuilder.addSortKeyCondition(sortKey, this, this.metaData)
   }
 
   // TODO TYPING how can we improve the typing to define the accepted value for condition function (see

test/models/model-with-custom-mapper-for-sort-key.model.ts

@@ -0,0 +1,56 @@
+// tslint:disable:max-classes-per-file
+
+import { DynamoDB } from 'aws-sdk'
+import * as moment from 'moment'
+import { PropertyMetadata, SortKey } from '../../src/decorator'
+import { PartitionKey } from '../../src/decorator/impl/key/partition-key.decorator'
+import { CustomMapper } from '../../src/decorator/impl/mapper/custom-mapper.decorator'
+import { Model } from '../../src/decorator/impl/model/model.decorator'
+import { MapperForType } from '../../src/mapper/for-type/base.mapper'
+
+export class CustomId {
+  private static MULTIPLIER = Math.pow(10, 5)
+  private static FMT_DATE_NUM = 'YYYYMMDD'
+  date: moment.Moment
+  id: number
+
+  static parse(value: number): CustomId {
+    const date = Math.floor(value / CustomId.MULTIPLIER)
+    const id = value - date * CustomId.MULTIPLIER
+    return new CustomId(moment(date, CustomId.FMT_DATE_NUM), id)
+  }
+
+  static unparse(customId: CustomId): number {
+    return parseInt(customId.date.format(CustomId.FMT_DATE_NUM), 10) * CustomId.MULTIPLIER + customId.id
+  }
+
+  constructor(date: moment.Moment, id: number) {
+    this.date = date
+    this.id = id
+  }
+}
+
+export class CustomIdMapper implements MapperForType<CustomId> {
+  fromDb(attributeValue: DynamoDB.AttributeValue, propertyMetadata?: PropertyMetadata<CustomId>): CustomId {
+    return CustomId.parse(parseInt(attributeValue.N!, 10))
+  }
+
+  toDb(propertyValue: CustomId, propertyMetadata?: PropertyMetadata<CustomId>): DynamoDB.AttributeValue {
+    return { N: `${CustomId.unparse(propertyValue)}` }
+  }
+}
+
+@Model()
+export class ModelWithCustomMapperForSortKeyModel {
+  @PartitionKey()
+  name: string
+
+  @CustomMapper(CustomIdMapper)
+  @SortKey()
+  customId: CustomId
+
+  constructor(name: string, id: CustomId) {
+    this.name = name
+    this.customId = id
+  }
+}