Merge pull request #142 from shiftcode/#97-unify-dynamodb-imports

#97 unify dynamodb imports

Author: michaelwittwer

package-lock.json

@@ -38,6 +38,8 @@
     "test": "jest",
     "test:ci": "jest --coverage --no-cache",
     "test:watch": "jest --watch",
+    "tslint:custom-rule:build": "tsc ./tools/tslint/noDynamoNamedImportRule.ts",
+    "tslint:custom-rule:test": "tslint --test ./tools/tslint/test",
     "prettier": "prettier --write --config ./.prettierrc.yml '{src,test}/**/*.ts'"
   },
   "devDependencies": {
@@ -69,6 +71,7 @@
     "tsc-watch": "^1.0.31",
     "tslint": "^5.12.0",
     "tslint-config-prettier": "^1.17.0",
+    "tsutils": "^3.6.0",
     "typedoc": "^0.13.0",
     "typescript": "^3.2.2",
     "uuid": "^3.3.2"

package.json

@@ -1,12 +1,12 @@
-import { KeyType } from 'aws-sdk/clients/dynamodb'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { PropertyMetadata } from '../../metadata/property-metadata.model'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'
 import { KEY_PROPERTY } from '../property/key-property.const'
 import { IndexType } from './index-type.enum'
 
 export interface IndexData {
   name: string
-  keyType: KeyType
+  keyType: DynamoDB.KeyType
 }
 
 export function initOrUpdateIndex(indexType: IndexType, indexData: IndexData, target: any, propertyKey: string): void {
@@ -34,7 +34,7 @@ export function initOrUpdateIndex(indexType: IndexType, indexData: IndexData, ta
   initOrUpdateProperty(propertyMetadata, target, propertyKey)
 }
 
-function initOrUpdateGSI(indexes: Record<string, KeyType>, indexData: IndexData): Partial<PropertyMetadata<any>> {
+function initOrUpdateGSI(indexes: Record<string, DynamoDB.KeyType>, indexData: IndexData): Partial<PropertyMetadata<any>> {
   if (indexes[indexData.name]) {
     // TODO LOW:INVESTIGATE when we throw an error we have a problem where multiple different classes extend one base class, this will be executed by multiple times
     // throw new Error(

src/decorator/impl/index/util.ts

@@ -1,4 +1,4 @@
-import { KeyType } from 'aws-sdk/clients/dynamodb'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { kebabCase } from 'lodash'
 import { ModelMetadata } from '../../metadata'
 import { PropertyMetadata } from '../../metadata/property-metadata.model'
@@ -57,7 +57,7 @@ export function Model(opts: ModelData = {}): ClassDecorator {
 
 function testForGSI<T>(
   property: PropertyMetadata<T>,
-): property is PropertyMetadata<T> & { keyForGSI: Record<string, KeyType> } {
+): property is PropertyMetadata<T> & { keyForGSI: Record<string, DynamoDB.KeyType> } {
   return !!(property.keyForGSI && Object.keys(property.keyForGSI).length)
 }
 

src/decorator/impl/model/model.decorator.ts

@@ -1,7 +1,7 @@
 import { MapperForType } from '../../mapper/for-type/base.mapper'
 
 // def good
-import { KeyType } from 'aws-sdk/clients/dynamodb'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { Attribute } from '../../mapper/type/attribute.type'
 import { ModelConstructor } from '../../model/model-constructor'
 
@@ -13,7 +13,7 @@ export interface TypeInfo {
 }
 
 export interface Key {
-  type: KeyType
+  type: DynamoDB.KeyType
   uuid?: boolean
 }
 
@@ -41,7 +41,7 @@ export interface PropertyMetadata<T, R extends Attribute = Attribute> {
   mapper?: () => MapperForType<any, R>
 
   // maps the index name to the key type to describe for which GSI this property describes a key attribute
-  keyForGSI?: Record<string, KeyType>
+  keyForGSI?: Record<string, DynamoDB.KeyType>
 
   // holds all the the index names for which this property describes the sort key attribute
   sortKeyForLSI?: string[]

src/decorator/metadata/property-metadata.model.ts

@@ -1,5 +1,5 @@
 // tslint:disable-next-line:interface-over-type-literal
-import { BatchGetRequestMap, ConsumedCapacityMultiple } from 'aws-sdk/clients/dynamodb'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { BatchGetResponse } from './batch-get.response'
 
 export interface BatchGetFullResponse {
@@ -10,9 +10,9 @@ export interface BatchGetFullResponse {
   /**
    * A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section. Each element consists of:    Keys - An array of primary key attribute values that define specific items in the table.    ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.    ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.   If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
    */
-  UnprocessedKeys?: BatchGetRequestMap
+  UnprocessedKeys?: DynamoDB.BatchGetRequestMap
   /**
    * The read capacity units consumed by the entire BatchGetItem operation. Each element consists of:    TableName - The table that consumed the provisioned throughput.    CapacityUnits - The total number of capacity units consumed.
    */
-  ConsumedCapacity?: ConsumedCapacityMultiple
+  ConsumedCapacity?: DynamoDB.ConsumedCapacityMultiple
 }

src/dynamo/batchget/batch-get-full.response.ts

@@ -1,29 +1,24 @@
-import { DynamoDB } from 'aws-sdk'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { of } from 'rxjs'
 import { DynamoRx } from '../dynamo-rx'
 import { batchGetItemsFetchAll, combineBatchGetResponses, hasUnprocessedKeys } from './batch-get-utils'
 
 describe('batch-get utils', () => {
-
   describe('hasUnprocessedKeys', () => {
     it('should return bool according to given object', () => {
       expect(hasUnprocessedKeys({})).toBeFalsy()
       expect(hasUnprocessedKeys({ Responses: {} })).toBeFalsy()
       expect(hasUnprocessedKeys({ UnprocessedKeys: {} })).toBeFalsy()
-      expect(hasUnprocessedKeys({ UnprocessedKeys: { 'aTableName': { Keys: [] } } })).toBeFalsy()
-      expect(hasUnprocessedKeys({ UnprocessedKeys: { 'aTableName': { Keys: [{ id: { S: 'id' } }] } } })).toBeTruthy()
+      expect(hasUnprocessedKeys({ UnprocessedKeys: { aTableName: { Keys: [] } } })).toBeFalsy()
+      expect(hasUnprocessedKeys({ UnprocessedKeys: { aTableName: { Keys: [{ id: { S: 'id' } }] } } })).toBeTruthy()
     })
   })
 
   describe('combineBatchGetResponses', () => {
     const resp1: DynamoDB.BatchGetItemOutput = {
       Responses: {
-        'tableA': [
-          { id: { S: 'id-a1' } },
-        ],
-        'tableB': [
-          { id: { S: 'id-b' } },
-        ],
+        tableA: [{ id: { S: 'id-a1' } }],
+        tableB: [{ id: { S: 'id-b' } }],
       },
       UnprocessedKeys: {
         'tableA:': { Keys: [{ id: { S: 'id-a2' } }] },
@@ -33,29 +28,18 @@ describe('batch-get utils', () => {
     }
     const resp2: DynamoDB.BatchGetItemOutput = {
       Responses: {
-        'tableA': [
-          { id: { S: 'id-a2' } },
-        ],
-        'tableC': [
-          { id: { S: 'id-c' } },
-        ],
+        tableA: [{ id: { S: 'id-a2' } }],
+        tableC: [{ id: { S: 'id-c' } }],
       },
       UnprocessedKeys: {
         'tableD:': { Keys: [{ id: { S: 'id-d' } }] },
       },
     }
     const expectedOutput: DynamoDB.BatchGetItemOutput = {
       Responses: {
-        'tableA': [
-          { id: { S: 'id-a1' } },
-          { id: { S: 'id-a2' } },
-        ],
-        'tableB': [
-          { id: { S: 'id-b' } },
-        ],
-        'tableC': [
-          { id: { S: 'id-c' } },
-        ],
+        tableA: [{ id: { S: 'id-a1' } }, { id: { S: 'id-a2' } }],
+        tableB: [{ id: { S: 'id-b' } }],
+        tableC: [{ id: { S: 'id-c' } }],
       },
       UnprocessedKeys: {
         'tableD:': { Keys: [{ id: { S: 'id-d' } }] },
@@ -64,7 +48,6 @@ describe('batch-get utils', () => {
     it('should combine correctly', () => {
       expect(combineBatchGetResponses(resp1)(resp2)).toEqual(expectedOutput)
     })
-
   })
 
   describe('batchGetItemsFetchAll', () => {
@@ -74,17 +57,17 @@ describe('batch-get utils', () => {
 
     const output1: DynamoDB.BatchGetItemOutput = {
       Responses: {
-        'tableA': [{ id: { S: 'id-A' } }],
+        tableA: [{ id: { S: 'id-A' } }],
       },
       UnprocessedKeys: {
-        'tableA': {
+        tableA: {
           Keys: [{ id: { S: 'id-A' } }],
         },
       },
     }
     const output2: DynamoDB.BatchGetItemOutput = {
       Responses: {
-        'tableA': [{ id: { S: 'id-A' } }],
+        tableA: [{ id: { S: 'id-A' } }],
       },
     }
 
@@ -93,15 +76,9 @@ describe('batch-get utils', () => {
       dynamoRx = <any>{ batchGetItems: batchGetItemsSpy }
       backoffTimerMock = { next: jasmine.createSpy().and.returnValue({ value: 0 }) }
 
-      await batchGetItemsFetchAll(
-        dynamoRx,
-        <any>{},
-        <IterableIterator<number>><any>backoffTimerMock,
-        0,
-      ).toPromise()
+      await batchGetItemsFetchAll(dynamoRx, <any>{}, <IterableIterator<number>>(<any>backoffTimerMock), 0).toPromise()
     })
 
-
     it('should use UnprocessedKeys for next request', () => {
       expect(batchGetItemsSpy).toHaveBeenCalledTimes(2)
       expect(batchGetItemsSpy.calls.mostRecent().args[0]).toBeDefined()
@@ -112,7 +89,5 @@ describe('batch-get utils', () => {
     it('should backoff when UnprocessedItems', () => {
       expect(backoffTimerMock.next).toHaveBeenCalledTimes(1)
     })
-
   })
-
 })

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

@@ -1,5 +1,4 @@
-import { DynamoDB } from 'aws-sdk'
-import { BatchGetRequestMap } from 'aws-sdk/clients/dynamodb'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { Observable, of } from 'rxjs'
 import { delay, map, mergeMap } from 'rxjs/operators'
 import { DynamoRx } from '../dynamo-rx'
@@ -44,7 +43,7 @@ export function batchGetItemsFetchAll(
 
 export type BatchGetItemOutputWithUnprocessedKeys =
   DynamoDB.BatchGetItemOutput
-  & { UnprocessedKeys: BatchGetRequestMap }
+  & { UnprocessedKeys: DynamoDB.BatchGetRequestMap }
 
 export function hasUnprocessedKeys(response: DynamoDB.BatchGetItemOutput): response is BatchGetItemOutputWithUnprocessedKeys {
   if (!response.UnprocessedKeys) {

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

@@ -1,4 +1,4 @@
-import { DynamoDB } from 'aws-sdk'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { Observable } from 'rxjs'
 import { map } from 'rxjs/operators'
 import { metadataForClass } from '../../decorator/metadata/metadata-helper'

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

@@ -1,4 +1,4 @@
-import { DynamoDB } from 'aws-sdk'
+import * as DynamoDB from 'aws-sdk/clients/dynamodb'
 import { of } from 'rxjs'
 import { DynamoRx } from '../dynamo-rx'
 import { batchWriteItemsWriteAll, hasUnprocessedItems } from './batch-write-utils'