@squiz/db-lib 1.68.0 → 1.69.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/db-lib",
-  "version": "1.68.0",
+  "version": "1.69.0",
   "description": "",
   "main": "lib/index.js",
   "private": false,

package/src/dynamodb/AbstractDynamoDbRepository.spec.ts

@@ -23,6 +23,7 @@ import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';
 import { DynamoDB } from '@aws-sdk/client-dynamodb';
 import crypto from 'crypto';
+import { InvalidDataFormatError } from '../error/InvalidDataFormatError';
 
 const ddbClientMock = mockClient(DynamoDBDocumentClient);
 const ddbDoc = DynamoDBDocument.from(new DynamoDB({}));
@@ -32,6 +33,7 @@ interface ITestItem {
   age: number;
   country: string;
   data?: object;
+  data2?: object;
 }
 
 class TestItem implements ITestItem {
@@ -39,12 +41,14 @@ class TestItem implements ITestItem {
   public age: number;
   public country: string;
   public data: object;
+  public data2?: object;
 
   constructor(data: Partial<ITestItem> = {}) {
     this.name = data.name ?? 'default name';
     this.age = data.age ?? 0;
     this.country = data.country ?? 'default country';
     this.data = data.data ?? {};
+    this.data2 = data.data2 ?? {};
 
     if (typeof this.name !== 'string') {
       throw Error('Invalid "name"');
@@ -92,6 +96,8 @@ const TEST_ITEM_ENTITY_DEFINITION = {
       },
     },
   },
+  // field to be stored as JSON string
+  fieldsAsJsonString: ['data2'],
 };
 
 class TestItemRepository extends AbstractDynamoDbRepository<ITestItem, TestItem> {
@@ -134,6 +140,8 @@ describe('AbstractRepository', () => {
           age: 99,
           country: 'au',
           data: {},
+          // "data2" property is defined to be stored as JSON string
+          data2: '{"foo":"bar","num":123}',
         },
         ConditionExpression: `attribute_not_exists(pk)`,
       };
@@ -143,6 +151,10 @@ describe('AbstractRepository', () => {
         age: 99,
         country: 'au',
         data: {},
+        data2: {
+          foo: 'bar',
+          num: 123,
+        },
       };
       const result = await repository.createItem(item);
       expect(ddbClientMock).toHaveReceivedCommandWith(PutCommand, input);
@@ -152,6 +164,10 @@ describe('AbstractRepository', () => {
           age: 99,
           country: 'au',
           data: {},
+          data2: {
+            foo: 'bar',
+            num: 123,
+          },
         }),
       );
     });
@@ -367,6 +383,7 @@ describe('AbstractRepository', () => {
           age: 99,
           country: 'au',
           data: {},
+          data2: '{"foo":"bar","num":123}',
         },
       });
       const input: GetCommandInput = {
@@ -383,6 +400,10 @@ describe('AbstractRepository', () => {
           age: 99,
           country: 'au',
           data: {},
+          data2: {
+            foo: 'bar',
+            num: 123,
+          },
         }),
       );
     });
@@ -427,6 +448,29 @@ describe('AbstractRepository', () => {
         new MissingKeyValuesError('Key field "name" must be specified in the input item in entity test-item-entity'),
       );
     });
+
+    it('should throw error if JSON string field has non-string data', async () => {
+      ddbClientMock.on(GetCommand).resolves({
+        $metadata: {
+          httpStatusCode: 200,
+        },
+        Item: {
+          name: 'foo',
+          age: 99, // should be number
+          country: 'au',
+          data: {},
+          data2: {
+            foo: 'bar',
+            num: 123,
+          },
+        },
+      });
+
+      const partialItem = { name: 'foo' };
+      await expect(repository.getItem(partialItem)).rejects.toEqual(
+        new InvalidDataFormatError(`Field 'data2' defined as JSON String has a non-string data`),
+      );
+    });
   });
 
   describe('queryItems()', () => {

package/src/dynamodb/AbstractDynamoDbRepository.ts

@@ -7,6 +7,7 @@ import {
 } from '@aws-sdk/lib-dynamodb';
 
 import { Transaction, DynamoDbManager, MissingKeyValuesError, InvalidDbSchemaError } from '..';
+import { InvalidDataFormatError } from '../error/InvalidDataFormatError';
 
 interface Reader<T> {
   queryItems(partialItem: Partial<T>, useSortKey?: boolean, index?: keyof TableIndexes): Promise<T[]>;
@@ -41,6 +42,7 @@ export type KeysFormat = Record<keyof TableKeys | keyof TableIndexes, string>;
 export type EntityDefinition = {
   keys: TableKeys;
   indexes: TableIndexes;
+  fieldsAsJsonString: string[];
 };
 
 export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLASS extends SHAPE>
@@ -52,6 +54,9 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
   protected indexes: TableIndexes;
   protected keysFormat: KeysFormat;
 
+  // fields listed in this property are stored as a JSON string value in db
+  protected fieldsAsJsonString: string[];
+
   constructor(
     protected tableName: string,
     protected dbManager: DynamoDbManager<Repositories>,
@@ -63,6 +68,7 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
 
     this.keys = entityDefinition.keys;
     this.indexes = entityDefinition.indexes;
+    this.fieldsAsJsonString = entityDefinition.fieldsAsJsonString;
 
     this.keysFormat = {
       [this.keys.pk.attributeName]: this.keys.pk.format,
@@ -170,7 +176,10 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
       return undefined;
     }
 
-    this.assertValueMatchesModel({ ...oldValue, ...newValue });
+    const value = { ...oldValue, ...newValue };
+    this.assertValueMatchesModel(value);
+
+    this.convertSelectedValuesToJsonString(newValue);
 
     const updateExpression = [];
     const expressionAttributeNames: Record<string, string> = {};
@@ -203,7 +212,7 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
       this.dbManager.addWriteTransactionItem(transaction.id, {
         Update: updateCommandInput,
       });
-      return new this.classRef({ ...oldValue, ...newValue });
+      return new this.classRef(value);
     }
 
     let output: UpdateCommandOutput;
@@ -243,6 +252,7 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
     for (const modelProperty of Object.keys(value)) {
       columns[modelProperty] = value[modelProperty as keyof DATA_CLASS];
     }
+    this.convertSelectedValuesToJsonString(columns);
 
     const keyFields: Record<string, unknown> = {
       [this.keys.pk.attributeName]: this.getPk(value),
@@ -322,9 +332,26 @@ export abstract class AbstractDynamoDbRepository<SHAPE extends object, DATA_CLAS
    * @returns
    */
   protected hydrateItem(item: Record<string, unknown>): DATA_CLASS {
+    for (const fieldName of Object.keys(item)) {
+      if (this.fieldsAsJsonString.includes(fieldName)) {
+        if (typeof item[fieldName] === 'string') {
+          item[fieldName] = JSON.parse(item[fieldName] as string);
+        } else {
+          throw new InvalidDataFormatError(`Field '${fieldName}' defined as JSON String has a non-string data`);
+        }
+      }
+    }
     return new this.classRef(item);
   }
 
+  protected convertSelectedValuesToJsonString(item: Record<string, unknown>) {
+    for (const fieldName of Object.keys(item)) {
+      if (this.fieldsAsJsonString.includes(fieldName)) {
+        item[fieldName] = JSON.stringify(item[fieldName]);
+      }
+    }
+  }
+
   /**
    * Evaluate the partition key value from the partial item
    * @param item

package/src/error/InvalidDataFormatError.ts

@@ -0,0 +1,8 @@
+import { InternalServerError } from '@squiz/dx-common-lib';
+
+export class InvalidDataFormatError extends InternalServerError {
+  name = 'InvalidDataFormatError';
+  constructor(message: string) {
+    super(message);
+  }
+}