@squiz/db-lib 1.76.0 → 1.77.1

package/lib/s3/S3ExternalStorage.spec.d.ts

@@ -0,0 +1,12 @@
+type S3MockSet = {
+    sendMock: jest.Mock;
+    putObjectCommandMock: jest.Mock;
+    getObjectCommandMock: jest.Mock;
+    deleteObjectCommandMock: jest.Mock;
+    headBucketCommandMock: jest.Mock;
+};
+declare global {
+    var __s3MockSet: S3MockSet | undefined;
+}
+export {};
+//# sourceMappingURL=S3ExternalStorage.spec.d.ts.map

package/lib/s3/S3ExternalStorage.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3ExternalStorage.spec.d.ts","sourceRoot":"","sources":["../../src/s3/S3ExternalStorage.spec.ts"],"names":[],"mappings":"AAMA,KAAK,SAAS,GAAG;IACf,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC;IACpB,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC;IAChC,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC;IAChC,uBAAuB,EAAE,IAAI,CAAC,IAAI,CAAC;IACnC,qBAAqB,EAAE,IAAI,CAAC,IAAI,CAAC;CAClC,CAAC;AAEF,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,WAAW,EAAE,SAAS,GAAG,SAAS,CAAC;CACxC"}

package/lib/s3/S3ExternalStorage.spec.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const S3ExternalStorage_1 = require("./S3ExternalStorage");
+const client_s3_1 = require("@aws-sdk/client-s3");
+const TEST_TENANT_ID = 'test-tenant';
+const TEST_BUCKET = 'dx-test-us-db-fallback';
+jest.mock('@aws-sdk/client-s3', () => {
+    const buildCommandMock = (name) => jest.fn().mockImplementation((input) => ({
+        name,
+        input,
+    }));
+    const state = {
+        sendMock: jest.fn(),
+        putObjectCommandMock: buildCommandMock('PutObjectCommand'),
+        getObjectCommandMock: buildCommandMock('GetObjectCommand'),
+        deleteObjectCommandMock: buildCommandMock('DeleteObjectCommand'),
+        headBucketCommandMock: buildCommandMock('HeadBucketCommand'),
+    };
+    global.__s3MockSet = state;
+    return {
+        S3Client: jest.fn().mockImplementation(() => ({
+            send: state.sendMock,
+        })),
+        PutObjectCommand: state.putObjectCommandMock,
+        GetObjectCommand: state.getObjectCommandMock,
+        DeleteObjectCommand: state.deleteObjectCommandMock,
+        HeadBucketCommand: state.headBucketCommandMock,
+    };
+});
+const { sendMock, putObjectCommandMock, getObjectCommandMock, deleteObjectCommandMock, headBucketCommandMock } = global.__s3MockSet;
+jest.mock('crypto', () => ({
+    randomUUID: jest.fn(() => 'fixed-uuid'),
+}));
+describe('S3ExternalStorage', () => {
+    beforeEach(() => {
+        sendMock.mockReset();
+        putObjectCommandMock.mockClear();
+        getObjectCommandMock.mockClear();
+        deleteObjectCommandMock.mockClear();
+        headBucketCommandMock.mockClear();
+    });
+    const createStorage = () => new S3ExternalStorage_1.S3ExternalStorage(TEST_TENANT_ID, new client_s3_1.S3Client({ region: 'us-west-2' }), TEST_BUCKET);
+    it('saves payloads to S3 and returns location metadata', async () => {
+        const storage = createStorage();
+        const payload = { foo: 'bar' };
+        sendMock.mockResolvedValueOnce({}); // put object
+        const result = await storage.save('test_entity', 'abc', payload);
+        expect(putObjectCommandMock).toHaveBeenCalledWith(expect.objectContaining({
+            Bucket: 'dx-test-us-db-fallback',
+            Body: JSON.stringify(payload),
+            ContentType: 'application/json',
+            Key: result.location.key,
+        }));
+        expect(result.location).toMatchObject({
+            type: 's3',
+        });
+        expect(result.location.key).toBe('test-tenant/test_entity/abc.json');
+        expect(result.size).toBe(JSON.stringify(payload).length);
+    });
+    it('loads payloads from S3 and parses JSON', async () => {
+        const storage = createStorage();
+        const storedPayload = { baz: 'qux' };
+        const transformer = jest.fn().mockResolvedValue(JSON.stringify(storedPayload));
+        sendMock.mockResolvedValueOnce({
+            Body: {
+                transformToString: transformer,
+            },
+        });
+        const location = { type: 's3', key: 'items/foo/bar.json' };
+        const result = await storage.load(location);
+        expect(getObjectCommandMock).toHaveBeenCalledWith({
+            Bucket: 'dx-test-us-db-fallback',
+            Key: 'items/foo/bar.json',
+        });
+        expect(transformer).toHaveBeenCalled();
+        expect(result).toEqual(storedPayload);
+    });
+    it('deletes payloads from S3 when a location is provided', async () => {
+        const storage = createStorage();
+        const location = { type: 's3', key: 'items/foo.json' };
+        sendMock.mockResolvedValueOnce({}); // delete
+        await storage.delete(location);
+        expect(deleteObjectCommandMock).toHaveBeenCalledWith({
+            Bucket: 'dx-test-us-db-fallback',
+            Key: 'items/foo.json',
+        });
+    });
+    it('handles S3 errors when saving', async () => {
+        const storage = createStorage();
+        const payload = { foo: 'bar' };
+        const s3Error = Object.assign(new Error('AccessDenied'), {
+            name: 'AccessDenied',
+            $metadata: { httpStatusCode: 403 },
+        });
+        sendMock.mockRejectedValueOnce(s3Error);
+        await expect(storage.save('test_entity', 'first', payload)).rejects.toThrow('AccessDenied');
+    });
+    it('does not delete when location is undefined', async () => {
+        const storage = createStorage();
+        await storage.delete(undefined);
+        expect(deleteObjectCommandMock).not.toHaveBeenCalled();
+    });
+    it('generates unique S3 keys for different entity types', async () => {
+        const storage = createStorage();
+        sendMock.mockResolvedValue({});
+        const result1 = await storage.save('entity_type_a', 'id-1', { data: 'test' });
+        const result2 = await storage.save('entity_type_b', 'id-2', { data: 'test' });
+        expect(result1.location.key).toContain('entity_type_a/id-1');
+        expect(result2.location.key).toContain('entity_type_b/id-2');
+    });
+    it('throws error when S3 response has no body', async () => {
+        const storage = createStorage();
+        sendMock.mockResolvedValueOnce({ Body: undefined });
+        const location = { type: 's3', key: 'items/foo/bar.json' };
+        await expect(storage.load(location)).rejects.toThrow('Failed to load externalised items from S3 object items/foo/bar.json');
+    });
+    it('handles S3 errors gracefully when loading', async () => {
+        const storage = createStorage();
+        sendMock.mockRejectedValueOnce(new Error('S3 GetObject failed'));
+        const location = { type: 's3', key: 'items/foo/bar.json' };
+        await expect(storage.load(location)).rejects.toThrow('S3 GetObject failed');
+    });
+    it('handles S3 errors gracefully when deleting', async () => {
+        const storage = createStorage();
+        sendMock.mockRejectedValueOnce(new Error('S3 DeleteObject failed'));
+        const location = { type: 's3', key: 'items/foo.json' };
+        await expect(storage.delete(location)).rejects.toThrow('S3 DeleteObject failed');
+    });
+});
+//# sourceMappingURL=S3ExternalStorage.spec.js.map

package/lib/s3/S3ExternalStorage.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3ExternalStorage.spec.js","sourceRoot":"","sources":["../../src/s3/S3ExternalStorage.spec.ts"],"names":[],"mappings":";;AAAA,2DAA2E;AAC3E,kDAA8C;AAE9C,MAAM,cAAc,GAAG,aAAa,CAAC;AACrC,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAe7C,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;IACnC,MAAM,gBAAgB,GAAG,CAAC,IAAY,EAAE,EAAE,CACxC,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACvC,IAAI;QACJ,KAAK;KACN,CAAC,CAAC,CAAC;IACN,MAAM,KAAK,GAAc;QACvB,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;QACnB,oBAAoB,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;QAC1D,oBAAoB,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;QAC1D,uBAAuB,EAAE,gBAAgB,CAAC,qBAAqB,CAAC;QAChE,qBAAqB,EAAE,gBAAgB,CAAC,mBAAmB,CAAC;KAC7D,CAAC;IACD,MAAc,CAAC,WAAW,GAAG,KAAK,CAAC;IAEpC,OAAO;QACL,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,CAAC;YAC5C,IAAI,EAAE,KAAK,CAAC,QAAQ;SACrB,CAAC,CAAC;QACH,gBAAgB,EAAE,KAAK,CAAC,oBAAoB;QAC5C,gBAAgB,EAAE,KAAK,CAAC,oBAAoB;QAC5C,mBAAmB,EAAE,KAAK,CAAC,uBAAuB;QAClD,iBAAiB,EAAE,KAAK,CAAC,qBAAqB;KAC/C,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,GAC5G,MACD,CAAC,WAAwB,CAAC;AAE3B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;IACzB,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;CACxC,CAAC,CAAC,CAAC;AAEJ,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,UAAU,CAAC,GAAG,EAAE;QACd,QAAQ,CAAC,SAAS,EAAE,CAAC;QACrB,oBAAoB,CAAC,SAAS,EAAE,CAAC;QACjC,oBAAoB,CAAC,SAAS,EAAE,CAAC;QACjC,uBAAuB,CAAC,SAAS,EAAE,CAAC;QACpC,qBAAqB,CAAC,SAAS,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,IAAI,qCAAiB,CAAC,cAAc,EAAE,IAAI,oBAAQ,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC;IAEtH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC/B,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa;QAEjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAEjE,MAAM,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAC/C,MAAM,CAAC,gBAAgB,CAAC;YACtB,MAAM,EAAE,wBAAwB;YAChC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,WAAW,EAAE,kBAAkB;YAC/B,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG;SACzB,CAAC,CACH,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC;YACpC,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,MAAM,aAAa,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QACrC,MAAM,WAAW,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;QAC/E,QAAQ,CAAC,qBAAqB,CAAC;YAC7B,IAAI,EAAE;gBACJ,iBAAiB,EAAE,WAAW;aAC/B;SACF,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAsB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC;QAC9E,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE5C,MAAM,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAAC;YAChD,MAAM,EAAE,wBAAwB;YAChC,GAAG,EAAE,oBAAoB;SAC1B,CAAC,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAsB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC;QAC1E,QAAQ,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;QAE7C,MAAM,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAE/B,MAAM,CAAC,uBAAuB,CAAC,CAAC,oBAAoB,CAAC;YACnD,MAAM,EAAE,wBAAwB;YAChC,GAAG,EAAE,gBAAgB;SACtB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC7C,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,EAAE;YACvD,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,EAAE,cAAc,EAAE,GAAG,EAAE;SACnC,CAAC,CAAC;QAEH,QAAQ,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAExC,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAEhC,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,CAAC,uBAAuB,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QAE/B,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9E,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAE9E,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAsB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC;QAE9E,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAClD,qEAAqE,CACtE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAEjE,MAAM,QAAQ,GAAsB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,oBAAoB,EAAE,CAAC;QAE9E,MAAM,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;QAChC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAEpE,MAAM,QAAQ,GAAsB,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC;QAE1E,MAAM,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/db-lib",
-  "version": "1.76.0",
+  "version": "1.77.1",
   "description": "",
   "main": "lib/index.js",
   "private": false,
@@ -19,19 +19,20 @@
     "@types/node": "22.10.5",
     "@types/pg": "^8.11.8",
     "aws-sdk-client-mock": "^4.0.0",
-    "aws-sdk-client-mock-jest": "4.0.0",
+    "aws-sdk-client-mock-jest": "4.1.0",
     "jest": "29.4.1",
     "ts-jest": "29.0.5",
     "typescript": "^5.7.2"
   },
   "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.651.1",
-    "@aws-sdk/client-secrets-manager": "3.651.1",
-    "@aws-sdk/lib-dynamodb": "^3.651.1",
+    "@aws-sdk/client-dynamodb": "^3.946.0",
+    "@aws-sdk/client-s3": "^3.946.0",
+    "@aws-sdk/client-secrets-manager": "^3.946.0",
+    "@aws-sdk/lib-dynamodb": "^3.946.0",
     "@opentelemetry/api": "^1.6.0",
     "@squiz/dx-common-lib": "^1.69.1",
     "@squiz/dx-logger-lib": "^1.65.1",
-    "dotenv": "16.0.3",
+    "dotenv": "16.6.1",
     "pg": "^8.12.0"
   }
 }

package/src/dynamodb/AbstractDynamoDbRepository.spec.ts

@@ -21,7 +21,8 @@ import {
 } from '@aws-sdk/lib-dynamodb';
 import { ConditionalCheckFailedException } from '@aws-sdk/client-dynamodb';
 import { DynamoDbManager, Transaction } from './DynamoDbManager';
-import { MissingKeyValuesError, InvalidDbSchemaError } from '..';
+import { MissingKeyValuesError } from '../error/MissingKeyValuesError';
+import { InvalidDbSchemaError } from '../error/InvalidDbSchemaError';
 
 import { mockClient } from 'aws-sdk-client-mock';
 import 'aws-sdk-client-mock-jest';

package/src/dynamodb/AbstractDynamoDbRepository.ts

@@ -10,7 +10,9 @@ import {
   BatchGetCommandOutput,
 } from '@aws-sdk/lib-dynamodb';
 
-import { Transaction, DynamoDbManager, MissingKeyValuesError, InvalidDbSchemaError } from '..';
+import { Transaction, DynamoDbManager } from './DynamoDbManager';
+import { MissingKeyValuesError } from '../error/MissingKeyValuesError';
+import { InvalidDbSchemaError } from '../error/InvalidDbSchemaError';
 import { InvalidDataFormatError } from '../error/InvalidDataFormatError';
 import { UnknownKeyAttributeError } from '../error/UnknownKeyAttributeError';