@defra-fish/sales-api-service 1.50.0 → 1.51.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.50.0",
+  "version": "1.51.0-rc.1",
   "description": "Rod Licensing Sales API",
   "type": "module",
   "engines": {
@@ -35,9 +35,9 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "@defra-fish/business-rules-lib": "1.50.0",
-    "@defra-fish/connectors-lib": "1.50.0",
-    "@defra-fish/dynamics-lib": "1.50.0",
+    "@defra-fish/business-rules-lib": "1.51.0-rc.1",
+    "@defra-fish/connectors-lib": "1.51.0-rc.1",
+    "@defra-fish/dynamics-lib": "1.51.0-rc.1",
     "@hapi/boom": "^9.1.2",
     "@hapi/hapi": "^20.1.3",
     "@hapi/inert": "^6.0.3",
@@ -52,5 +52,5 @@
     "moment-timezone": "^0.5.34",
     "uuid": "^8.3.2"
   },
-  "gitHead": "0c8e398672b3e85316a93115385d40c2412048b9"
+  "gitHead": "94d567772c93817f97bdd6226f9f845e093a4e03"
 }

package/src/schema/__tests__/transaction.schema.spec.js

@@ -18,7 +18,7 @@ describe('createTransactionSchema', () => {
 
   it('validates successfully when issueDate and startDate are null', async () => {
     const mockPayload = mockTransactionPayload()
-    mockPayload.permissions.map(p => ({ ...p, issueDate: null, startDate: null }))
+    mockPayload.permissions = mockPayload.permissions.map(p => ({ ...p, issueDate: null, startDate: null }))
     const result = await createTransactionSchema.validateAsync(mockPayload)
     expect(result).toBeInstanceOf(Object)
   })
@@ -70,6 +70,31 @@ describe('createTransactionSchema', () => {
     mockPayload.permissions[0].isLicenceForYou = 'test'
     await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow('"permissions[0].isLicenceForYou" must be a boolean')
   })
+
+  it('validates successfully when a uuid v4 transaction id is supplied', async () => {
+    const mockPayload = mockTransactionPayload()
+    mockPayload.transactionId = '25fa0126-55da-4309-9bce-9957990d141e'
+    await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
+  })
+
+  it('validates successfully when transactionId is omitted', async () => {
+    const mockPayload = mockTransactionPayload()
+    await expect(createTransactionSchema.validateAsync(mockPayload)).resolves.not.toThrow()
+  })
+
+  it.each([
+    ['uuid1 string', '5a429f62-871b-11ef-b864-0242ac120002'],
+    ['uuid2 string', '000003e8-871b-21ef-8000-325096b39f47'],
+    ['uuid3 string', 'a3bb189e-8bf9-3888-9912-ace4e6543002'],
+    ['uuid5 string', 'a6edc906-2f9f-5fb2-a373-efac406f0ef2'],
+    ['uuid6 string', 'a3bb189e-8bf9-3888-9912-ace4e6543002'],
+    ['uuid7 string', '01927705-ffac-77b5-89af-c97451b1bbe2'],
+    ['numeric', 4567]
+  ])('fails validation when provided with a %s', async (_d, transactionId) => {
+    const mockPayload = mockTransactionPayload()
+    mockPayload.transactionId = transactionId
+    await expect(createTransactionSchema.validateAsync(mockPayload)).rejects.toThrow()
+  })
 })
 
 describe('createTransactionResponseSchema', () => {

package/src/schema/transaction.schema.js

@@ -32,7 +32,8 @@ const createTransactionRequestSchemaContent = {
     then: Joi.string().trim().min(1).required()
   }),
   createdBy: Joi.string().optional(),
-  journalId: Joi.string().optional()
+  journalId: Joi.string().optional(),
+  transactionId: Joi.string().guid({ version: 'uuidv4' })
 }
 
 /**

package/src/services/transactions/__tests__/create-transaction.spec.js

@@ -77,6 +77,13 @@ describe('transaction service', () => {
       AwsMock.DynamoDB.DocumentClient.__throwWithErrorOn('put')
       await expect(createTransaction(mockTransactionPayload())).rejects.toThrow('Test error')
     })
+
+    it('uses transaction id if supplied in payload', async () => {
+      const mockPayload = mockTransactionPayload()
+      mockPayload.transactionId = 'abc-123-def-456'
+      const result = await createTransaction(mockPayload)
+      expect(result.id).toBe(mockPayload.transactionId)
+    })
   })
 
   describe('createTransactions', () => {

package/src/services/transactions/create-transaction.js

@@ -48,7 +48,7 @@ export async function createTransactions (payload) {
  * @returns {Promise<*>}
  */
 async function createTransactionRecord (payload) {
-  const transactionId = uuidv4()
+  const transactionId = payload.transactionId || uuidv4()
   debug('Creating new transaction %s for %s', transactionId, payload.dataSource)
   const record = {
     id: transactionId,