@defra-fish/fulfilment-job 1.61.0-rc.9 → 1.62.0-rc.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@defra-fish/fulfilment-job",
-  "version": "1.61.0-rc.9",
+  "version": "1.62.0-rc.0",
   "description": "Rod Licensing Sales Fulfilment Job",
   "type": "module",
   "engines": {
-    "node": ">=18.17"
+    "node": ">=20"
   },
   "keywords": [
     "rod",
@@ -35,8 +35,8 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/connectors-lib": "1.61.0-rc.9",
-    "@defra-fish/dynamics-lib": "1.61.0-rc.9",
+    "@defra-fish/connectors-lib": "1.62.0-rc.0",
+    "@defra-fish/dynamics-lib": "1.62.0-rc.0",
     "commander": "^7.2.0",
     "debug": "^4.3.3",
     "merge2": "^1.4.1",
@@ -44,5 +44,5 @@
     "openpgp": "^5.0.0-1",
     "pluralize": "^8.0.0"
   },
-  "gitHead": "b9c65c7827bb974c94056bf5e387d80564d3ddc6"
+  "gitHead": "d56e1a0d0f4b22f1dded800c0ed511b737cb91a7"
 }

package/src/__tests__/config.spec.js

@@ -1,7 +1,14 @@
-import AwsMock from 'aws-sdk'
 import config from '../config.js'
 import { AWS } from '@defra-fish/connectors-lib'
-const { secretsManager } = AWS()
+const { secretsManager } = AWS.mock.results[0].value
+
+jest.mock('@defra-fish/connectors-lib', () => ({
+  AWS: jest.fn(() => ({
+    secretsManager: {
+      getSecretValue: jest.fn(() => ({ SecretString: 'test-ssh-key' }))
+    }
+  }))
+}))
 
 const setEnvVars = () => {
   for (const envVar in envVars) {
@@ -24,9 +31,6 @@ const envVars = Object.freeze({
 
 describe('config', () => {
   beforeAll(async () => {
-    AwsMock.SecretsManager.__setResponse('getSecretValue', {
-      SecretString: 'test-ssh-key'
-    })
     setEnvVars()
     await config.initialise()
   })
@@ -48,7 +52,7 @@ describe('config', () => {
 
 describe('pgp config', () => {
   const init = async (samplePublicKey = 'sample-pgp-key') => {
-    AwsMock.SecretsManager.__setNextResponses('getSecretValue', { SecretString: samplePublicKey })
+    secretsManager.getSecretValue.mockResolvedValueOnce({ SecretString: samplePublicKey })
     await config.initialise()
   }
   beforeAll(setEnvVars)

package/src/config.js

@@ -32,8 +32,7 @@ class Config {
       bucket: process.env.FULFILMENT_S3_BUCKET
     }
     this._pgp = {
-      publicKey: (await secretsManager.getSecretValue({ SecretId: process.env.FULFILMENT_PGP_PUBLIC_KEY_SECRET_ID }).promise())
-        .SecretString,
+      publicKey: (await secretsManager.getSecretValue({ SecretId: process.env.FULFILMENT_PGP_PUBLIC_KEY_SECRET_ID })).SecretString,
       sendUnencryptedFile: toBoolean(process.env.FULFILMENT_SEND_UNENCRYPTED_FILE)
     }
   }

package/src/transport/__tests__/s3.spec.js

@@ -1,28 +1,40 @@
 import { writeS3PartFile, readS3PartFiles, createS3WriteStream } from '../s3.js'
 import stream from 'stream'
-import AwsMock from 'aws-sdk'
 import { FulfilmentRequestFile } from '@defra-fish/dynamics-lib'
 import { fulfilmentDataTransformer } from '../../transform/fulfilment-transform.js'
+import { AWS } from '@defra-fish/connectors-lib'
+const { s3 } = AWS.mock.results[0].value
 
-jest.mock('fs')
 jest.mock('stream')
 jest.mock('../../config.js', () => ({
   s3: {
     bucket: 'testbucket'
   }
 }))
+jest.mock('@defra-fish/connectors-lib', () => ({
+  AWS: jest.fn(() => ({
+    s3: {
+      getObject: jest.fn(() => ({
+        createReadStream: jest.fn(() => ({
+          setEncoding: jest.fn()
+        }))
+      })),
+      listObjectsV2: jest.fn(async () => ({ Contents: [] })),
+      upload: jest.fn(async () => ({ Location: 'The subterranean server room' }))
+    }
+  }))
+}))
 
 describe('s3', () => {
   beforeEach(() => {
     jest.clearAllMocks()
-    AwsMock.__resetAll()
   })
 
   describe('writeS3PartFile', () => {
     it('writes a part file to S3', async () => {
       const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
       const mockDataArray = []
-      AwsMock.S3.mockedMethods.upload.mockImplementationOnce(() => ({ promise: jest.fn(async () => ({ Location: 'example.json/part0' })) }))
+      s3.upload.mockResolvedValueOnce({ Location: 'example.json/part0' })
       stream.pipeline.mockImplementation(
         jest.fn((streams, callback) => {
           expect(streams[0]).toStrictEqual(mockDataArray)
@@ -33,7 +45,7 @@ describe('s3', () => {
       )
       await writeS3PartFile(testFile, 0, [])
       expect(stream.pipeline).toHaveBeenCalled()
-      expect(AwsMock.S3.mockedMethods.upload).toHaveBeenCalledWith({
+      expect(s3.upload).toHaveBeenCalledWith({
         Bucket: 'testbucket',
         Key: 'example.json/part0',
         Body: expect.any(stream.PassThrough)
@@ -42,47 +54,56 @@ describe('s3', () => {
   })
 
   describe('readS3PartFiles', () => {
-    it('reads all part files for a given file and returns a stream for each', async () => {
-      const mockCreateReadStream = createMockReadStream()
-      AwsMock.S3.__setResponse('listObjectsV2', {
-        Contents: [{ Key: '/example.json/part0' }, { Key: '/example.json/part1' }]
+    describe('reads all part files for a given file and returns a stream for each', () => {
+      beforeEach(() => {
+        s3.listObjectsV2.mockResolvedValueOnce({
+          Contents: [{ Key: '/example.json/part0' }, { Key: '/example.json/part1' }]
+        })
       })
-      AwsMock.S3.mockedMethods.getObject.mockImplementation(() => ({ createReadStream: mockCreateReadStream }))
 
-      const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
-      const [stream1, stream2] = await readS3PartFiles(testFile)
+      it('first stream matches createReadStream result from s3 object', async () => {
+        const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
+        const [stream1] = await readS3PartFiles(testFile)
+        expect(s3.getObject.mock.results[0].value.createReadStream.mock.results[0].value).toBe(stream1)
+      })
+
+      it('second stream matches createReadStream result from s3 object', async () => {
+        const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
+        const stream2 = (await readS3PartFiles(testFile))[1]
+        expect(s3.getObject.mock.results[1].value.createReadStream.mock.results[0].value).toBe(stream2)
+      })
 
-      expect(mockCreateReadStream.mock.results[0].value).toBe(stream1)
-      expect(mockCreateReadStream.mock.results[1].value).toBe(stream2)
-      expect(AwsMock.S3.mockedMethods.getObject).toHaveBeenNthCalledWith(1, { Bucket: 'testbucket', Key: '/example.json/part0' })
-      expect(AwsMock.S3.mockedMethods.getObject).toHaveBeenNthCalledWith(2, { Bucket: 'testbucket', Key: '/example.json/part1' })
+      it('makes first call to s3.getObject with bucket details and first part file details', async () => {
+        const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
+        await readS3PartFiles(testFile)
+        expect(s3.getObject).toHaveBeenNthCalledWith(1, { Bucket: 'testbucket', Key: '/example.json/part0' })
+      })
+
+      it('makes second call to s3.getObject with bucket details and second part file details', async () => {
+        const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
+        await readS3PartFiles(testFile)
+        expect(s3.getObject).toHaveBeenNthCalledWith(2, { Bucket: 'testbucket', Key: '/example.json/part1' })
+      })
     })
 
     it('sets encoding on readable stream', async () => {
-      const mockCreateReadStream = createMockReadStream()
-      AwsMock.S3.__setResponse('listObjectsV2', {
+      s3.listObjectsV2.mockResolvedValueOnce({
         Contents: [{ Key: '/example.json/part0' }]
       })
-      AwsMock.S3.mockedMethods.getObject.mockImplementation(() => ({ createReadStream: mockCreateReadStream }))
       const testFile = Object.assign(new FulfilmentRequestFile(), { fileName: 'example.json' })
       const [readStream] = await readS3PartFiles(testFile)
       expect(readStream.setEncoding).toHaveBeenCalledWith('utf8')
     })
-
-    const createMockReadStream = () =>
-      jest.fn(() => ({
-        setEncoding: jest.fn()
-      }))
   })
 
   describe('createS3WriteStream', () => {
     it('creates a writable stream to an object in S3', async () => {
-      AwsMock.S3.mockedMethods.upload.mockImplementationOnce(() => ({ promise: jest.fn(async () => ({ Location: 'example/key' })) }))
+      s3.upload.mockResolvedValueOnce({ Location: 'example/key' })
       const passThroughEmitSpy = jest.spyOn(stream.PassThrough.prototype, 'emit')
       const { s3WriteStream, managedUpload } = createS3WriteStream('example/key')
       await expect(managedUpload).resolves.toBeUndefined()
 
-      expect(AwsMock.S3.mockedMethods.upload).toHaveBeenCalledWith({
+      expect(s3.upload).toHaveBeenCalledWith({
         Bucket: 'testbucket',
         Key: 'example/key',
         Body: expect.any(stream.PassThrough)
@@ -92,14 +113,10 @@ describe('s3', () => {
     })
 
     it('rejects the managed upload promise if an error occurs uploading', async () => {
-      AwsMock.S3.mockedMethods.upload.mockImplementationOnce(() => ({
-        promise: jest.fn(async () => {
-          throw new Error('Test error')
-        })
-      }))
+      s3.upload.mockRejectedValueOnce(new Error('Test error'))
       const { s3WriteStream, managedUpload } = createS3WriteStream('example/key')
       await expect(managedUpload).rejects.toThrow('Test error')
-      expect(AwsMock.S3.mockedMethods.upload).toHaveBeenCalledWith({
+      expect(s3.upload).toHaveBeenCalledWith({
         Bucket: 'testbucket',
         Key: 'example/key',
         Body: s3WriteStream

package/src/transport/s3.js

@@ -30,7 +30,7 @@ export const writeS3PartFile = async (fulfilmentRequestFile, partNumber, data) =
  * @returns {Array<stream.Readable>} Readable streams for each of the part files
  */
 export async function readS3PartFiles (fulfilmentRequestFile) {
-  const { Contents: files } = await s3.listObjectsV2({ Bucket: config.s3.bucket, Prefix: `${fulfilmentRequestFile.fileName}/` }).promise()
+  const { Contents: files } = await s3.listObjectsV2({ Bucket: config.s3.bucket, Prefix: `${fulfilmentRequestFile.fileName}/` })
   return files
     .filter(f => /part\d+$/.test(f.Key))
     .map(f => {
@@ -51,7 +51,6 @@ export const createS3WriteStream = key => {
     s3WriteStream: passThrough,
     managedUpload: s3
       .upload({ Bucket: config.s3.bucket, Key: key, Body: passThrough })
-      .promise()
       .then(data => debug(`File successfully uploaded to S3 at ${data.Location}`))
   }
 }