Merge pull request #659 from guillaumeduboc/feat/optionnal-doc-client

feat : make document client optional in tables
jeremydaly · Mar 22, 2024 · 6cd0366 · 6cd0366
2 parents d133829 + 77420a3
commit 6cd0366
Show file tree

Hide file tree

Showing 24 changed files with 63 additions and 151 deletions.
diff --git a/src/v1/operations/batch/batchWrite.ts b/src/v1/operations/batch/batchWrite.ts
@@ -28,7 +28,7 @@ export const batchWrite = async (
   } = {}
 ): Promise<BatchWriteCommandOutput> => {
   const documentClient =
-    options?.dynamoDBDocumentClient ?? requests[0][$entity].table.documentClient
+    options?.dynamoDBDocumentClient ?? requests[0][$entity].table.getDocumentClient()
 
   const commandInput = getBatchWriteCommandInput(requests, options?.batchWriteOptions)
 

diff --git a/src/v1/operations/batch/batchWrite.unit.test.ts b/src/v1/operations/batch/batchWrite.unit.test.ts
@@ -1,15 +1,8 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-
 import { DynamoDBToolboxError, EntityV2, TableV2, schema, string } from 'v1'
 import { BatchPutItemRequest } from './putItem/operation'
 import { BatchDeleteItemRequest } from './deleteItem/operation'
 import { getBatchWriteCommandInput } from './batchWrite'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -19,8 +12,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 const TestTable2 = new TableV2({
   name: 'test-table2',
@@ -38,8 +30,7 @@ const TestTable2 = new TableV2({
       sortKey: { name: 'GSIsk1', type: 'string' },
       type: 'global'
     }
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({

diff --git a/src/v1/operations/batch/deleteItem/BatchDeleteItemParams.unit.test.ts b/src/v1/operations/batch/deleteItem/BatchDeleteItemParams.unit.test.ts
@@ -1,13 +1,6 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-
 import { DynamoDBToolboxError, EntityV2, TableV2, schema, string } from 'v1'
 import { BatchDeleteItemRequest } from './operation'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -17,8 +10,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({

diff --git a/src/v1/operations/batch/putItem/BatchPutItemParams.unit.test.ts b/src/v1/operations/batch/putItem/BatchPutItemParams.unit.test.ts
@@ -1,13 +1,6 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-
 import { DynamoDBToolboxError, EntityV2, TableV2, schema, string } from 'v1'
 import { BatchPutItemRequest } from './operation'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -17,8 +10,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({

diff --git a/src/v1/operations/deleteItem/command.ts b/src/v1/operations/deleteItem/command.ts
@@ -79,9 +79,9 @@ export class DeleteItemCommand<
   async send(): Promise<DeleteItemResponse<ENTITY, OPTIONS>> {
     const deleteItemParams = this.params()
 
-    const commandOutput = await this[$entity].table.documentClient.send(
-      new DeleteCommand(deleteItemParams)
-    )
+    const commandOutput = await this[$entity].table
+      .getDocumentClient()
+      .send(new DeleteCommand(deleteItemParams))
 
     const { Attributes: attributes, ...restCommandOutput } = commandOutput
 

diff --git a/src/v1/operations/deleteItem/deleteItemParams/deleteItemParams.unit.test.ts b/src/v1/operations/deleteItem/deleteItemParams/deleteItemParams.unit.test.ts
@@ -1,6 +1,3 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-
 import {
   TableV2,
   EntityV2,
@@ -11,10 +8,6 @@ import {
   prefix
 } from 'v1'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -24,8 +17,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({

diff --git a/src/v1/operations/errors.ts b/src/v1/operations/errors.ts
@@ -71,6 +71,12 @@ type UnknownOptionErrorBlueprint = ErrorBlueprint<{
   payload: { option: unknown }
 }>
 
+type MissingDocumentClientErrorBlueprint = ErrorBlueprint<{
+  code: 'operations.missingDocumentClient'
+  hasPath: false
+  payload: undefined
+}>
+
 export type OperationsErrorBlueprints =
   | ScanCommandErrorBlueprints
   | QueryCommandErrorBlueprints
@@ -87,3 +93,4 @@ export type OperationsErrorBlueprints =
   | InvalidSelectOptionErrorBlueprint
   | UnknownOptionErrorBlueprint
   | ExpressionParsersErrorBlueprints
+  | MissingDocumentClientErrorBlueprint
diff --git a/src/v1/operations/getItem/command.ts b/src/v1/operations/getItem/command.ts
@@ -72,9 +72,9 @@ export class GetItemCommand<
   async send(): Promise<GetItemResponse<ENTITY, OPTIONS>> {
     const getItemParams = this.params()
 
-    const commandOutput = await this[$entity].table.documentClient.send(
-      new GetCommand(getItemParams)
-    )
+    const commandOutput = await this[$entity].table
+      .getDocumentClient()
+      .send(new GetCommand(getItemParams))
 
     const { Item: item, ...restCommandOutput } = commandOutput
 

diff --git a/src/v1/operations/getItem/getItemParams/getItemParams.unit.test.ts b/src/v1/operations/getItem/getItemParams/getItemParams.unit.test.ts
@@ -1,12 +1,5 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-
 import { TableV2, EntityV2, schema, string, DynamoDBToolboxError, GetItemCommand, prefix } from 'v1'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -16,8 +9,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({
@@ -33,8 +25,7 @@ const TestEntity = new EntityV2({
 const TestTable2 = new TableV2({
   name: 'test-table',
   partitionKey: { type: 'string', name: 'pk' },
-  sortKey: { type: 'string', name: 'sk' },
-  documentClient
+  sortKey: { type: 'string', name: 'sk' }
 })
 
 const TestEntity2 = new EntityV2({

diff --git a/src/v1/operations/putItem/command.ts b/src/v1/operations/putItem/command.ts
@@ -94,9 +94,9 @@ export class PutItemCommand<
   async send(): Promise<PutItemResponse<ENTITY, OPTIONS>> {
     const putItemParams = this.params()
 
-    const commandOutput = await this[$entity].table.documentClient.send(
-      new PutCommand(putItemParams)
-    )
+    const commandOutput = await this[$entity].table
+      .getDocumentClient()
+      .send(new PutCommand(putItemParams))
 
     const { Attributes: attributes, ...restCommandOutput } = commandOutput
 

diff --git a/src/v1/operations/putItem/putItemParams/putItemParams.unit.test.ts b/src/v1/operations/putItem/putItemParams/putItemParams.unit.test.ts
@@ -1,6 +1,3 @@
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-
 import {
   TableV2,
   EntityV2,
@@ -19,10 +16,6 @@ import {
   prefix
 } from 'v1'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -32,8 +25,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({
@@ -62,8 +54,7 @@ const TestEntity = new EntityV2({
 
 const TestTable2 = new TableV2({
   name: 'test-table',
-  partitionKey: { type: 'string', name: 'pk' },
-  documentClient
+  partitionKey: { type: 'string', name: 'pk' }
 })
 
 const TestEntity2 = new EntityV2({
@@ -97,8 +88,7 @@ const TestEntity3 = new EntityV2({
 const TestTable3 = new TableV2({
   name: 'TestTable3',
   partitionKey: { type: 'string', name: 'pk' },
-  sortKey: { type: 'string', name: 'sk' },
-  documentClient
+  sortKey: { type: 'string', name: 'sk' }
 })
 
 const TestEntity4 = new EntityV2({

diff --git a/src/v1/operations/query/command.ts b/src/v1/operations/query/command.ts
@@ -169,7 +169,7 @@ export class QueryCommand<
         ScannedCount: pageScannedCount,
         ConsumedCapacity: pageConsumedCapacity,
         $metadata: pageMetadata
-      } = await this[$table].documentClient.send(new _QueryCommand(pageQueryParams))
+      } = await this[$table].getDocumentClient().send(new _QueryCommand(pageQueryParams))
 
       for (const item of items) {
         const itemEntityName = item[this[$table].entityAttributeSavedAs]

diff --git a/src/v1/operations/query/queryParams/queryParams.unit.test.ts b/src/v1/operations/query/queryParams/queryParams.unit.test.ts
@@ -1,5 +1,3 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
 import type { A } from 'ts-toolbelt'
 
 import {
@@ -14,10 +12,6 @@ import {
   prefix
 } from 'v1'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -47,8 +41,7 @@ const TestTable = new TableV2({
         type: 'string'
       }
     }
-  },
-  documentClient
+  }
 })
 
 const Entity1 = new EntityV2({

diff --git a/src/v1/operations/scan/command.ts b/src/v1/operations/scan/command.ts
@@ -128,7 +128,7 @@ export class ScanCommand<
         ScannedCount: pageScannedCount,
         ConsumedCapacity: pageConsumedCapacity,
         $metadata: pageMetadata
-      } = await this[$table].documentClient.send(new _ScanCommand(pageScanParams))
+      } = await this[$table].getDocumentClient().send(new _ScanCommand(pageScanParams))
 
       for (const item of items) {
         const itemEntityName = item[this[$table].entityAttributeSavedAs]

diff --git a/src/v1/operations/scan/scanParams/scanParams.unit.test.ts b/src/v1/operations/scan/scanParams/scanParams.unit.test.ts
@@ -1,5 +1,3 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
 import type { A } from 'ts-toolbelt'
 
 import {
@@ -14,10 +12,6 @@ import {
   prefix
 } from 'v1'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -40,8 +34,7 @@ const TestTable = new TableV2({
         type: 'string'
       }
     }
-  },
-  documentClient
+  }
 })
 
 const Entity1 = new EntityV2({

diff --git a/src/v1/operations/transactions/deleteItem/operation.ts b/src/v1/operations/transactions/deleteItem/operation.ts
@@ -58,7 +58,7 @@ export class DeleteItemTransaction<
     params: TransactDeleteItemParams
   } {
     return {
-      documentClient: this[$entity].table.documentClient,
+      documentClient: this[$entity].table.getDocumentClient(),
       type: 'Delete',
       params: this.params()
     }

diff --git a/...ns/transactions/deleteItem/transactDeleteItemParams/transactDeleteItemParams.unit.test.ts b/...ns/transactions/deleteItem/transactDeleteItemParams/transactDeleteItemParams.unit.test.ts
@@ -1,13 +1,6 @@
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb'
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb'
-
 import { TableV2, EntityV2, schema, string, DynamoDBToolboxError } from 'v1'
 import { DeleteItemTransaction } from '../operation'
 
-const dynamoDbClient = new DynamoDBClient({})
-
-const documentClient = DynamoDBDocumentClient.from(dynamoDbClient)
-
 const TestTable = new TableV2({
   name: 'test-table',
   partitionKey: {
@@ -17,8 +10,7 @@ const TestTable = new TableV2({
   sortKey: {
     type: 'string',
     name: 'sk'
-  },
-  documentClient
+  }
 })
 
 const TestEntity = new EntityV2({

diff --git a/src/v1/operations/transactions/putItem/operation.ts b/src/v1/operations/transactions/putItem/operation.ts
@@ -58,7 +58,7 @@ export class PutItemTransaction<
     params: TransactPutItemParams
   } {
     return {
-      documentClient: this[$entity].table.documentClient,
+      documentClient: this[$entity].table.getDocumentClient(),
       type: 'Put',
       params: this.params()
     }