@defra-fish/sales-api-service 1.30.0-rc.8 → 1.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.30.0-rc.8",
+  "version": "1.30.0",
   "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.30.0-rc.8",
-    "@defra-fish/connectors-lib": "1.30.0-rc.8",
-    "@defra-fish/dynamics-lib": "1.30.0-rc.8",
+    "@defra-fish/business-rules-lib": "1.30.0",
+    "@defra-fish/connectors-lib": "1.30.0",
+    "@defra-fish/dynamics-lib": "1.30.0",
     "@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": "e0fc61290939c323445d45b20f56e17416bb0b08"
+  "gitHead": "f5dacdf20e2841487fa641de4eed2bae64e6c205"
 }

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

@@ -7,23 +7,28 @@ import {
 } from '../../../__mocks__/test-data.js'
 import { TRANSACTION_STAGING_TABLE } from '../../../config.js'
 import AwsMock from 'aws-sdk'
+import { getPermissionCost } from '@defra-fish/business-rules-lib'
+import { getReferenceDataForEntityAndId } from '../../reference-data.service.js'
 
+jest.mock('@defra-fish/business-rules-lib')
 jest.mock('../../reference-data.service.js', () => ({
   ...jest.requireActual('../../reference-data.service.js'),
-  getReferenceDataForEntityAndId: async (entityType, id) => {
+  getReferenceDataForEntityAndId: jest.fn(async (entityType, id) => {
     let item = null
     if (entityType === MOCK_12MONTH_SENIOR_PERMIT.constructor) {
       item = [MOCK_12MONTH_SENIOR_PERMIT, MOCK_12MONTH_DISABLED_PERMIT, MOCK_1DAY_SENIOR_PERMIT_ENTITY].find(p => p.id === id)
     }
     return item
-  }
+  })
 }))
 
 describe('transaction service', () => {
   beforeAll(() => {
     TRANSACTION_STAGING_TABLE.TableName = 'TestTable'
+    getPermissionCost.mockReturnValue(54)
   })
   beforeEach(AwsMock.__resetAll)
+  beforeEach(jest.clearAllMocks)
 
   describe('createTransaction', () => {
     it('accepts a new transaction', async () => {
@@ -46,6 +51,28 @@ describe('transaction service', () => {
       )
     })
 
+    it.each([99, 115, 22, 87.99])('uses business rules lib to calculate price (%d)', async permitPrice => {
+      getPermissionCost.mockReturnValueOnce(permitPrice)
+      const mockPayload = mockTransactionPayload()
+      const { cost } = await createTransaction(mockPayload)
+      expect(cost).toBe(permitPrice)
+    })
+
+    it('passes startDate and permit to getPermissionCost', async () => {
+      getReferenceDataForEntityAndId.mockReturnValueOnce(MOCK_12MONTH_SENIOR_PERMIT)
+      const mockPayload = mockTransactionPayload()
+      const {
+        permissions: [{ startDate }]
+      } = mockPayload
+      await createTransaction(mockPayload)
+      expect(getPermissionCost).toHaveBeenCalledWith(
+        expect.objectContaining({
+          startDate,
+          permit: MOCK_12MONTH_SENIOR_PERMIT
+        })
+      )
+    })
+
     it('throws exceptions back up the stack', async () => {
       AwsMock.DynamoDB.DocumentClient.__throwWithErrorOn('put')
       await expect(createTransaction(mockTransactionPayload())).rejects.toThrow('Test error')

package/src/services/transactions/__tests__/process-transaction-queue.spec.js

@@ -24,7 +24,8 @@ import {
 } from '../../../__mocks__/test-data.js'
 import { TRANSACTION_STAGING_TABLE, TRANSACTION_STAGING_HISTORY_TABLE } from '../../../config.js'
 import AwsMock from 'aws-sdk'
-import { POCL_DATA_SOURCE, DDE_DATA_SOURCE } from '@defra-fish/business-rules-lib'
+import { POCL_DATA_SOURCE, DDE_DATA_SOURCE, getPermissionCost } from '@defra-fish/business-rules-lib'
+import { getReferenceDataForEntityAndId } from '../../reference-data.service.js'
 
 jest.mock('../../reference-data.service.js', () => ({
   ...jest.requireActual('../../reference-data.service.js'),
@@ -34,7 +35,7 @@ jest.mock('../../reference-data.service.js', () => ({
     }
     return []
   },
-  getReferenceDataForEntityAndId: async (entityType, id) => {
+  getReferenceDataForEntityAndId: jest.fn(async (entityType, id) => {
     let item = null
     if (entityType === MOCK_12MONTH_SENIOR_PERMIT.constructor) {
       item = [MOCK_12MONTH_SENIOR_PERMIT, MOCK_12MONTH_DISABLED_PERMIT, MOCK_1DAY_SENIOR_PERMIT_ENTITY].find(p => p.id === id)
@@ -42,7 +43,7 @@ jest.mock('../../reference-data.service.js', () => ({
       item = MOCK_CONCESSION
     }
     return item
-  }
+  })
 }))
 
 jest.mock('@defra-fish/dynamics-lib', () => ({
@@ -60,7 +61,8 @@ jest.mock('@defra-fish/business-rules-lib', () => ({
   POCL_DATA_SOURCE: 'POCL_DATA_SOURCE',
   DDE_DATA_SOURCE: 'DDE_DATA_SOURCE',
   POCL_TRANSACTION_SOURCES: ['POCL_DATA_SOURCE', 'DDE_DATA_SOURCE'],
-  START_AFTER_PAYMENT_MINUTES: 30
+  START_AFTER_PAYMENT_MINUTES: 30,
+  getPermissionCost: jest.fn(() => 1)
 }))
 
 describe('transaction service', () => {
@@ -244,6 +246,52 @@ describe('transaction service', () => {
         expect(e.output.statusCode).toEqual(404)
       }
     })
+
+    describe.each([20, 38.46, 287])('uses getPermissionCost (%d) value ', cost => {
+      const setup = async () => {
+        getPermissionCost.mockReturnValueOnce(cost)
+        const mockRecord = mockFinalisedTransactionRecord()
+        AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
+        await processQueue({ id: mockRecord.id })
+        const {
+          mock: {
+            calls: [[[transaction, chargeJournal, paymentJournal]]]
+          }
+        } = persist
+        return { transaction, chargeJournal, paymentJournal }
+      }
+
+      it('for calculating transaction value', async () => {
+        const { transaction } = await setup()
+        expect(transaction.total).toBe(cost)
+      })
+
+      it('for calculating chargeJournal value', async () => {
+        const { chargeJournal } = await setup()
+        expect(chargeJournal.total).toBe(cost * -1)
+      })
+
+      it('for calculating paymentJournal value', async () => {
+        const { paymentJournal } = await setup()
+        expect(paymentJournal.total).toBe(cost)
+      })
+    })
+  })
+
+  it('passes start date and permit to getPermissionCost', async () => {
+    const mockRecord = mockFinalisedTransactionRecord()
+    const {
+      permissions: [permission]
+    } = mockRecord
+    getReferenceDataForEntityAndId.mockReturnValueOnce(MOCK_12MONTH_SENIOR_PERMIT)
+    AwsMock.DynamoDB.DocumentClient.__setResponse('get', { Item: mockRecord })
+    await processQueue({ id: mockRecord.id })
+    expect(getPermissionCost).toHaveBeenCalledWith(
+      expect.objectContaining({
+        startDate: permission.startDate,
+        permit: MOCK_12MONTH_SENIOR_PERMIT
+      })
+    )
   })
 
   describe('.getTransactionJournalRefNumber', () => {

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

@@ -5,6 +5,7 @@ import { v4 as uuidv4 } from 'uuid'
 import { AWS } from '@defra-fish/connectors-lib'
 import db from 'debug'
 import { Permit } from '@defra-fish/dynamics-lib'
+import { getPermissionCost } from '@defra-fish/business-rules-lib'
 const { docClient } = AWS()
 const debug = db('sales:transactions')
 
@@ -61,10 +62,13 @@ async function createTransactionRecord (payload) {
   }
 
   // Generate derived fields
-  for (const permission of record.permissions) {
-    const permit = await getReferenceDataForEntityAndId(Permit, permission.permitId)
+  for (const { permitId, startDate } of record.permissions) {
+    const permit = await getReferenceDataForEntityAndId(Permit, permitId)
     record.isRecurringPaymentSupported = record.isRecurringPaymentSupported && permit.isRecurringPaymentSupported
-    record.cost += permit.cost
+    record.cost += getPermissionCost({
+      startDate,
+      permit
+    })
   }
   return record
 }

package/src/services/transactions/process-transaction-queue.js

@@ -11,7 +11,7 @@ import {
   RecurringPayment,
   RecurringPaymentInstruction
 } from '@defra-fish/dynamics-lib'
-import { DDE_DATA_SOURCE, POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
+import { DDE_DATA_SOURCE, getPermissionCost, POCL_TRANSACTION_SOURCES } from '@defra-fish/business-rules-lib'
 import { getReferenceDataForEntityAndId, getGlobalOptionSetValue, getReferenceDataForEntity } from '../reference-data.service.js'
 import { resolveContactPayload } from '../contacts.service.js'
 import { retrieveStagedTransaction } from './retrieve-transaction.js'
@@ -57,8 +57,6 @@ export async function processQueue ({ id }) {
     const contact = await resolveContactPayload(licensee)
     const permit = await getReferenceDataForEntityAndId(Permit, permitId)
 
-    totalTransactionValue += permit.cost
-
     const permission = await mapToPermission(
       referenceNumber,
       transactionRecord,
@@ -70,6 +68,11 @@ export async function processQueue ({ id }) {
       isRenewal
     )
 
+    totalTransactionValue += getPermissionCost({
+      startDate,
+      permit
+    })
+
     permission.bindToEntity(Permission.definition.relationships.licensee, contact)
     permission.bindToEntity(Permission.definition.relationships.permit, permit)
     permission.bindToEntity(Permission.definition.relationships.transaction, transaction)