refactor(dynamo-rx): rename to dynamo-promisified

and add some doc for promise-delay and promise-tap

Author: michaelwittwer

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

@@ -1,5 +1,5 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 import { batchGetItemsFetchAll, combineBatchGetResponses, hasUnprocessedKeys } from './batch-get-utils'
 
 describe('batch-get utils', () => {
@@ -51,7 +51,7 @@ describe('batch-get utils', () => {
 
   describe('batchGetItemsFetchAll', () => {
     let batchGetItemsSpy: jasmine.Spy
-    let dynamoRx: DynamoRx
+    let dynamoRx: DynamoPromisified
     let backoffTimerMock: { next: jasmine.Spy }
 
     const output1: DynamoDB.BatchGetItemOutput = {

src/dynamo/batchget/batch-get-utils.ts

@@ -1,6 +1,6 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { promiseDelay } from '../../helper'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 
 /**
  * Function which executes batchGetItem operations until all given items (as params) are processed (fetched).
@@ -11,7 +11,7 @@ import { DynamoRx } from '../dynamo-rx'
  * @param throttleTimeSlot used to calculate the effective wait time
  */
 export function batchGetItemsFetchAll(
-  dynamoRx: DynamoRx,
+  dynamoRx: DynamoPromisified,
   params: DynamoDB.BatchGetItemInput,
   backoffTimer: IterableIterator<number>,
   throttleTimeSlot: number,

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

@@ -2,7 +2,7 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { Organization, SimpleWithCompositePartitionKeyModel, SimpleWithPartitionKeyModel } from '../../../test/models'
 import { Attributes, toDb } from '../../mapper'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 import { getTableName } from '../get-table-name.function'
 import { BatchGetRequest } from './batch-get.request'
 
@@ -117,7 +117,7 @@ describe('batch get', () => {
       request.forModel(SimpleWithPartitionKeyModel, [jsItem1, jsItem2])
 
       batchGetItemsSpy = jasmine.createSpy().and.returnValues(Promise.resolve(output1), Promise.resolve(output2))
-      const dynamoRx: DynamoRx = <any>{ batchGetItems: batchGetItemsSpy }
+      const dynamoRx: DynamoPromisified = <any>{ batchGetItems: batchGetItemsSpy }
 
       Object.assign(request, { dynamoRx })
 
@@ -182,7 +182,7 @@ describe('batch get', () => {
 
     beforeEach(() => {
       batchGetItemsSpy = jasmine.createSpy().and.returnValue(Promise.resolve(sampleResponse))
-      const dynamoRx: DynamoRx = <any>{ batchGetItems: batchGetItemsSpy }
+      const dynamoRx: DynamoPromisified = <any>{ batchGetItems: batchGetItemsSpy }
       request = new BatchGetRequest()
       Object.assign(request, { dynamoRx })
       request.forModel(SimpleWithPartitionKeyModel, [{ id: 'idVal' }])

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

@@ -4,7 +4,7 @@ import { randomExponentialBackoffTimer } from '../../helper'
 import { createToKeyFn, fromDb } from '../../mapper'
 import { Attributes } from '../../mapper/type/attribute.type'
 import { ModelConstructor } from '../../model/model-constructor'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 import { getTableName } from '../get-table-name.function'
 import { BatchGetFullResponse } from './batch-get-full.response'
 import { batchGetItemsFetchAll } from './batch-get-utils'
@@ -13,12 +13,12 @@ import { BatchGetResponse } from './batch-get.response'
 
 export class BatchGetRequest {
   readonly params: DynamoDB.BatchGetItemInput
-  private readonly dynamoRx: DynamoRx
+  private readonly dynamoRx: DynamoPromisified
   private readonly tables: Map<string, ModelConstructor<any>> = new Map()
   private itemCounter = 0
 
   constructor() {
-    this.dynamoRx = new DynamoRx()
+    this.dynamoRx = new DynamoPromisified()
     this.params = {
       RequestItems: {},
     }

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

@@ -1,11 +1,11 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 import { batchWriteItemsWriteAll, hasUnprocessedItems } from './batch-write-utils'
 
 describe('batch-write-utils', () => {
   describe('batchWriteItemsWriteAll', () => {
     let batchWriteItemSpy: jasmine.Spy
-    let dynamoRx: DynamoRx
+    let dynamoRx: DynamoPromisified
     let backoffTimerMock: { next: jasmine.Spy }
 
     const output1: DynamoDB.BatchWriteItemOutput = {

src/dynamo/batchwrite/batch-write-utils.ts

@@ -1,6 +1,6 @@
 import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { promiseDelay } from '../../helper'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 
 /**
  * Function which executes batchWriteItem operations until all given items (as params) are processed (written).
@@ -11,7 +11,7 @@ import { DynamoRx } from '../dynamo-rx'
  * @param throttleTimeSlot used to calculate the effective wait time
  */
 export function batchWriteItemsWriteAll(
-  dynamoRx: DynamoRx,
+  dynamoRx: DynamoPromisified,
   params: DynamoDB.BatchWriteItemInput,
   backoffTimer: IterableIterator<number>,
   throttleTimeSlot: number,

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

@@ -2,18 +2,18 @@ import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { randomExponentialBackoffTimer } from '../../helper'
 import { createToKeyFn, toDb } from '../../mapper'
 import { ModelConstructor } from '../../model'
-import { DynamoRx } from '../dynamo-rx'
+import { DynamoPromisified } from '../dynamo-promisified'
 import { getTableName } from '../get-table-name.function'
 import { batchWriteItemsWriteAll } from './batch-write-utils'
 import { BATCH_WRITE_DEFAULT_TIME_SLOT, BATCH_WRITE_MAX_REQUEST_ITEM_COUNT } from './batch-write.const'
 
 export class BatchWriteRequest {
   readonly params: DynamoDB.BatchWriteItemInput
-  private readonly dynamoRx: DynamoRx
+  private readonly dynamoRx: DynamoPromisified
   private itemCount = 0
 
   constructor() {
-    this.dynamoRx = new DynamoRx()
+    this.dynamoRx = new DynamoPromisified()
     this.params = {
       RequestItems: {},
     }

src/dynamo/dynamo-rx.spec.ts renamed to src/dynamo/dynamo-promisified.spec.ts

@@ -4,11 +4,11 @@
 import { Config, Credentials } from 'aws-sdk/global'
 import { resetDynamoEasyConfig } from '../../test/helper/resetDynamoEasyConfig.function'
 import { updateDynamoEasyConfig } from '../config'
-import { DynamoRx } from './dynamo-rx'
+import { DynamoPromisified } from './dynamo-promisified'
 
 describe('dynamo rx', () => {
   describe('should call the validity ensurer before each call and call the correct dynamoDB method', () => {
-    let dynamoRx: DynamoRx
+    let dynamoRx: DynamoPromisified
     let sessionValidityEnsurerSpy: jasmine.Spy
     let dynamoDBSpy: jasmine.Spy
     let pseudoParams: any
@@ -17,7 +17,7 @@ describe('dynamo rx', () => {
       pseudoParams = { TableName: 'tableName', KeyConditionExpression: 'blub' }
       sessionValidityEnsurerSpy = jasmine.createSpy().and.returnValue(Promise.resolve())
       updateDynamoEasyConfig({ sessionValidityEnsurer: sessionValidityEnsurerSpy })
-      dynamoRx = new DynamoRx()
+      dynamoRx = new DynamoPromisified()
     })
 
     afterEach(() => {
@@ -79,7 +79,7 @@ describe('dynamo rx', () => {
   })
 
   describe('makeRequest', async () => {
-    let dynamoRx: DynamoRx
+    let dynamoRx: DynamoPromisified
     let sessionValidityEnsurerSpy: jasmine.Spy
     let dynamoDBSpy: jasmine.Spy
     let pseudoParams: any
@@ -88,7 +88,7 @@ describe('dynamo rx', () => {
       pseudoParams = { TableName: 'tableName', KeyConditionExpression: 'blub' }
       sessionValidityEnsurerSpy = jasmine.createSpy().and.returnValue(Promise.resolve(true))
       updateDynamoEasyConfig({ sessionValidityEnsurer: sessionValidityEnsurerSpy })
-      dynamoRx = new DynamoRx()
+      dynamoRx = new DynamoPromisified()
     })
 
     afterEach(() => {
@@ -107,13 +107,13 @@ describe('dynamo rx', () => {
   describe('query', () => {
     beforeEach(() => {})
     it('should throw when no KeyConditionExpression was given', () => {
-      const dynamoRx = new DynamoRx()
+      const dynamoRx = new DynamoPromisified()
       expect(() => dynamoRx.query({ TableName: 'tableName' })).toThrow()
     })
   })
 
   it('should call makeRequest with the given params', async () => {
-    const dynamoRx = new DynamoRx()
+    const dynamoRx = new DynamoPromisified()
     const makeRequest = jasmine.createSpy().and.returnValue({ promise: () => Promise.resolve(null) })
     Object.assign(dynamoRx, { dynamoDB: { makeRequest } })
 
@@ -123,7 +123,7 @@ describe('dynamo rx', () => {
   })
 
   it('should update the credentials', () => {
-    const dynamoRx = new DynamoRx()
+    const dynamoRx = new DynamoPromisified()
     const credentials = new Credentials({ secretAccessKey: '', sessionToken: '', accessKeyId: '' })
     dynamoRx.updateAwsConfigCredentials(new Config({ credentials }))
     expect(dynamoRx.dynamoDB.config.credentials).toBe(credentials)

src/dynamo/dynamo-rx.ts renamed to src/dynamo/dynamo-promisified.ts

@@ -3,10 +3,10 @@ import { Config } from 'aws-sdk/global'
 import { dynamoEasyConfig } from '../config/dynamo-easy-config'
 
 /**
- * Simply brings calls the sessionValidityEnsurer before each standard dynamoDB operations
+ * Simply calls the sessionValidityEnsurer before each standard dynamoDB operations and returns a promise for each
+ * request
  */
-// todo: rename
-export class DynamoRx {
+export class DynamoPromisified {
   readonly dynamoDB: DynamoDB
 
   constructor() {

src/dynamo/dynamo-store.ts

@@ -3,7 +3,7 @@ import { promiseTap } from '../helper'
 import { createLogger, Logger } from '../logger/logger'
 import { ModelConstructor } from '../model'
 import { DynamoApiOperations } from './dynamo-api-operations.type'
-import { DynamoRx } from './dynamo-rx'
+import { DynamoPromisified } from './dynamo-promisified'
 import { getTableName } from './get-table-name.function'
 import {
   BatchGetSingleTableRequest,
@@ -24,11 +24,11 @@ export class DynamoStore<T> {
 
   readonly tableName: string
   private readonly logger: Logger
-  private readonly dynamoRx: DynamoRx
+  private readonly dynamoRx: DynamoPromisified
 
   constructor(private modelClazz: ModelConstructor<T>) {
     this.logger = createLogger('dynamo.DynamoStore', modelClazz)
-    this.dynamoRx = new DynamoRx()
+    this.dynamoRx = new DynamoPromisified()
     this.tableName = getTableName(modelClazz)
     this.logger.debug('instance created')
   }