@defra-fish/sales-api-service 1.58.0 → 1.59.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra-fish/sales-api-service",
-  "version": "1.58.0",
+  "version": "1.59.0-rc.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.58.0",
-    "@defra-fish/connectors-lib": "1.58.0",
-    "@defra-fish/dynamics-lib": "1.58.0",
+    "@defra-fish/business-rules-lib": "1.59.0-rc.0",
+    "@defra-fish/connectors-lib": "1.59.0-rc.0",
+    "@defra-fish/dynamics-lib": "1.59.0-rc.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": "4d2c2ef1bf3016fa38140a1bd78bf26ba5adb68d"
+  "gitHead": "01bc1d91c4f25234b008dafe06b0525760f9c752"
 }

package/src/schema/authenticate.schema.js

@@ -5,11 +5,10 @@ import { permitSchema } from './permit.schema.js'
 import { contactResponseSchema } from './contact.schema.js'
 import { finalisedPermissionSchemaContent } from './permission.schema.js'
 
+const REFERENCE_LENGTH = 6
+
 export const authenticateRenewalRequestParamsSchema = Joi.object({
-  referenceNumber: Joi.string()
-    .min(6)
-    .required()
-    .description('The permission reference number (supports partial)')
+  referenceNumber: Joi.string().min(REFERENCE_LENGTH).required().description('The permission reference number (supports partial)')
 }).label('authenticate-renewal-request-params')
 
 export const authenticateRenewalRequestQuerySchema = Joi.object({

package/src/server/routes/__tests__/authenticate-new.spec.js

@@ -1,4 +1,4 @@
-import { permissionForLicensee, executeQuery } from '@defra-fish/dynamics-lib'
+import { contactForLicenseeNoReference, executeQuery } from '@defra-fish/dynamics-lib'
 import db from 'debug'
 jest.mock('@defra-fish/dynamics-lib')
 jest.mock('debug')
@@ -10,7 +10,7 @@ describe('executeWithErrorLog', () => {
     executeQuery.mockImplementation(() => {
       throw new Error()
     })
-    permissionForLicensee.mockReturnValueOnce({ filter: 'query filter test' })
+    contactForLicenseeNoReference.mockReturnValueOnce({ filter: 'query filter test' })
     const authenticate = require('../authenticate.js').default
     const [
       {

package/src/server/routes/__tests__/authenticate.spec.js

@@ -1,5 +1,5 @@
 import initialiseServer from '../../server.js'
-import { executeQuery, permissionForLicensee } from '@defra-fish/dynamics-lib'
+import { contactForLicenseeNoReference, executeQuery, permissionForContacts } from '@defra-fish/dynamics-lib'
 import {
   MOCK_EXISTING_PERMISSION_ENTITY,
   MOCK_EXISTING_CONTACT_ENTITY,
@@ -10,8 +10,9 @@ import {
 
 jest.mock('@defra-fish/dynamics-lib', () => ({
   ...jest.requireActual('@defra-fish/dynamics-lib'),
-  permissionForLicensee: jest.fn(),
-  executeQuery: jest.fn()
+  contactForLicenseeNoReference: jest.fn(),
+  executeQuery: jest.fn(),
+  permissionForContacts: jest.fn()
 }))
 
 let server = null
@@ -27,6 +28,12 @@ describe('authenticate handler', () => {
 
   describe('authenticateRenewal', () => {
     it('authenticates a renewal request', async () => {
+      executeQuery.mockResolvedValueOnce([
+        {
+          entity: MOCK_EXISTING_CONTACT_ENTITY,
+          expanded: {}
+        }
+      ])
       executeQuery.mockResolvedValueOnce([
         {
           entity: MOCK_EXISTING_PERMISSION_ENTITY,
@@ -42,7 +49,6 @@ describe('authenticate handler', () => {
         method: 'GET',
         url: '/authenticate/renewal/CD379B?licenseeBirthDate=2000-01-01&licenseePostcode=AB12 3CD'
       })
-      expect(permissionForLicensee).toHaveBeenCalledWith('CD379B', '2000-01-01', 'AB12 3CD')
       expect(result.statusCode).toBe(200)
       expect(JSON.parse(result.payload)).toMatchObject({
         permission: expect.objectContaining({
@@ -61,6 +67,12 @@ describe('authenticate handler', () => {
 
     describe('if no concessions are returned', () => {
       beforeEach(() => {
+        executeQuery.mockResolvedValueOnce([
+          {
+            entity: MOCK_EXISTING_CONTACT_ENTITY,
+            expanded: {}
+          }
+        ])
         executeQuery.mockResolvedValueOnce([
           {
             entity: MOCK_EXISTING_PERMISSION_ENTITY,
@@ -73,12 +85,20 @@ describe('authenticate handler', () => {
         ])
       })
 
-      it('should call permissionForLicensee with the licence number, dob and postcode for a renewal request, ', async () => {
+      it('should call contactForLicenseeNoReference with dob and postcode for a renewal request', async () => {
+        await server.inject({
+          method: 'GET',
+          url: '/authenticate/renewal/CD379B?licenseeBirthDate=2000-01-01&licenseePostcode=AB12 3CD'
+        })
+        expect(contactForLicenseeNoReference).toHaveBeenCalledWith('2000-01-01', 'AB12 3CD')
+      })
+
+      it('should call permissionForContacts with contact ids from contactForLicenseeNoReference', async () => {
         await server.inject({
           method: 'GET',
           url: '/authenticate/renewal/CD379B?licenseeBirthDate=2000-01-01&licenseePostcode=AB12 3CD'
         })
-        expect(permissionForLicensee).toHaveBeenCalledWith('CD379B', '2000-01-01', 'AB12 3CD')
+        expect(permissionForContacts).toHaveBeenCalledWith([MOCK_EXISTING_CONTACT_ENTITY.id])
       })
 
       it('returns 200 from a renewal request', async () => {
@@ -105,7 +125,13 @@ describe('authenticate handler', () => {
     })
 
     it('throws 500 errors if more than one result was found for the query', async () => {
-      executeQuery.mockResolvedValueOnce([{}, {}])
+      executeQuery.mockResolvedValueOnce([
+        {
+          entity: MOCK_EXISTING_CONTACT_ENTITY,
+          expanded: {}
+        }
+      ])
+      executeQuery.mockResolvedValueOnce([{ entity: { referenceNumber: 'CD379B' } }, { entity: { referenceNumber: 'CD379B' } }])
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(jest.fn())
       const result = await server.inject({
         method: 'GET',
@@ -121,6 +147,26 @@ describe('authenticate handler', () => {
     })
 
     it('throws 401 errors if the renewal could not be authenticated', async () => {
+      executeQuery.mockResolvedValueOnce([
+        {
+          entity: MOCK_EXISTING_CONTACT_ENTITY,
+          expanded: {}
+        }
+      ])
+      executeQuery.mockResolvedValueOnce([])
+      const result = await server.inject({
+        method: 'GET',
+        url: '/authenticate/renewal/CD379B?licenseeBirthDate=2000-01-01&licenseePostcode=AB12 3CD'
+      })
+      expect(result.statusCode).toBe(401)
+      expect(JSON.parse(result.payload)).toMatchObject({
+        error: 'Unauthorized',
+        message: 'The licensee could not be authenticated',
+        statusCode: 401
+      })
+    })
+
+    it('throws 401 errors if no contact to be authenticated', async () => {
       executeQuery.mockResolvedValueOnce([])
       const result = await server.inject({
         method: 'GET',

package/src/server/routes/authenticate.js

@@ -5,8 +5,9 @@ import {
   authenticateRenewalResponseSchema
 } from '../../schema/authenticate.schema.js'
 import db from 'debug'
-import { permissionForLicensee, concessionsByIds, executeQuery } from '@defra-fish/dynamics-lib'
+import { permissionForContacts, concessionsByIds, executeQuery, contactForLicenseeNoReference } from '@defra-fish/dynamics-lib'
 const debug = db('sales:renewal-authentication')
+const failAuthenticate = 'The licensee could not be authenticated'
 
 const executeWithErrorLog = async query => {
   try {
@@ -24,33 +25,37 @@ export default [
     options: {
       handler: async (request, h) => {
         const { licenseeBirthDate, licenseePostcode } = request.query
-        const results = await executeWithErrorLog(
-          permissionForLicensee(request.params.referenceNumber, licenseeBirthDate, licenseePostcode)
-        )
-
-        if (results.length === 1) {
-          let concessionProofs = []
-          if (results[0].expanded.concessionProofs.length > 0) {
-            const ids = results[0].expanded.concessionProofs.map(f => f.entity.id)
-            concessionProofs = await executeWithErrorLog(concessionsByIds(ids))
+        const contacts = await executeWithErrorLog(contactForLicenseeNoReference(licenseeBirthDate, licenseePostcode))
+        if (contacts.length > 0) {
+          const contactIds = contacts.map(contact => contact.entity.id)
+          const permissions = await executeWithErrorLog(permissionForContacts(contactIds))
+          const results = permissions.filter(p => p.entity.referenceNumber.endsWith(request.params.referenceNumber))
+          if (results.length === 1) {
+            let concessionProofs = []
+            if (results[0].expanded.concessionProofs.length > 0) {
+              const ids = results[0].expanded.concessionProofs.map(f => f.entity.id)
+              concessionProofs = await executeWithErrorLog(concessionsByIds(ids))
+            }
+            return h
+              .response({
+                permission: {
+                  ...results[0].entity.toJSON(),
+                  licensee: results[0].expanded.licensee.entity.toJSON(),
+                  concessions: concessionProofs.map(c => ({
+                    id: c.expanded.concession.entity.id,
+                    proof: c.entity.toJSON()
+                  })),
+                  permit: results[0].expanded.permit.entity.toJSON()
+                }
+              })
+              .code(200)
+          } else if (results.length === 0) {
+            throw Boom.unauthorized(failAuthenticate)
+          } else {
+            throw new Error('Unable to authenticate, non-unique results for query')
           }
-          return h
-            .response({
-              permission: {
-                ...results[0].entity.toJSON(),
-                licensee: results[0].expanded.licensee.entity.toJSON(),
-                concessions: concessionProofs.map(c => ({
-                  id: c.expanded.concession.entity.id,
-                  proof: c.entity.toJSON()
-                })),
-                permit: results[0].expanded.permit.entity.toJSON()
-              }
-            })
-            .code(200)
-        } else if (results.length === 0) {
-          throw Boom.unauthorized('The licensee could not be authenticated')
         } else {
-          throw new Error('Unable to authenticate, non-unique results for query')
+          throw Boom.unauthorized(failAuthenticate)
         }
       },
       description: 'Authenticate a licensee by checking the licence number corresponds with the provided contact details',
@@ -66,7 +71,7 @@ export default [
         'hapi-swagger': {
           responses: {
             200: { description: 'The licensee was successfully authenticated', schema: authenticateRenewalResponseSchema },
-            401: { description: 'The licensee could not be authenticated' }
+            401: { description: failAuthenticate }
           },
           order: 1
         }