New 'import' job to trigger return log and supplementary flag checks

app/controllers/jobs.controller.js

@@ -6,13 +6,14 @@
  */
 
 const ExportService = require('../services/jobs/export/export.service.js')
+const ImportLicence = require('../services/jobs/import/import-licence.service.js')
 const ProcessLicenceUpdates = require('../services/jobs/licence-updates/process-licence-updates.js')
+const ProcessReturnLogsService = require('../services/jobs/return-logs/process-return-logs.service.js')
 const ProcessSessionStorageCleanupService = require('../services/jobs/session-cleanup/process-session-storage-cleanup.service.js')
 const ProcessTimeLimitedLicencesService = require('../services/jobs/time-limited/process-time-limited-licences.service.js')
-const ProcessReturnLogsService = require('../services/jobs/return-logs/process-return-logs.service.js')
 
-const redirectStatusCode = 204
-const notFoundStatusCode = 404
+const NO_CONTENT_STATUS_CODE = 204
+const NOT_FOUND_STATUS_CODE = 404
 
 /**
  * Triggers export of all relevant tables to CSV and then uploads them to S3
@@ -26,32 +27,32 @@ const notFoundStatusCode = 404
 async function exportDb (_request, h) {
   ExportService.go()
 
-  return h.response().code(redirectStatusCode)
+  return h.response().code(NO_CONTENT_STATUS_CODE)
 }
 
 async function licenceUpdates (_request, h) {
   ProcessLicenceUpdates.go()
 
-  return h.response().code(redirectStatusCode)
+  return h.response().code(NO_CONTENT_STATUS_CODE)
 }
 
 async function sessionCleanup (_request, h) {
   ProcessSessionStorageCleanupService.go()
 
-  return h.response().code(redirectStatusCode)
+  return h.response().code(NO_CONTENT_STATUS_CODE)
 }
 
 async function timeLimited (_request, h) {
   ProcessTimeLimitedLicencesService.go()
 
-  return h.response().code(redirectStatusCode)
+  return h.response().code(NO_CONTENT_STATUS_CODE)
 }
 
 async function returnLogs (request, h) {
   const { cycle } = request.params
 
   if (!['summer', 'all-year'].includes(cycle)) {
-    return h.response().code(notFoundStatusCode)
+    return h.response().code(NOT_FOUND_STATUS_CODE)
   }
 
   let licenceReference
@@ -62,13 +63,20 @@ async function returnLogs (request, h) {
 
   ProcessReturnLogsService.go(cycle, licenceReference)
 
-  return h.response().code(redirectStatusCode)
+  return h.response().code(NO_CONTENT_STATUS_CODE)
+}
+
+async function importLicence (_request, h) {
+  ImportLicence.go()
+
+  return h.response().code(NO_CONTENT_STATUS_CODE)
 }
 
 module.exports = {
   exportDb,
   licenceUpdates,
   returnLogs,
   sessionCleanup,
-  timeLimited
+  timeLimited,
+  importLicence
 }

app/routes/jobs.routes.js

@@ -17,6 +17,20 @@ const routes = [
       }
     }
   },
+  {
+    method: 'POST',
+    path: '/jobs/import-licence',
+    options: {
+      handler: JobsController.importLicence,
+      app: {
+        plainOutput: true
+      },
+      auth: false,
+      plugins: {
+        crumb: false
+      }
+    }
+  },
   {
     method: 'POST',
     path: '/jobs/licence-updates',

app/services/jobs/import/fetch-licences.service.js

@@ -0,0 +1,40 @@
+'use strict'
+
+/**
+ * Fetches all licences that are in NALD and WRLS
+ * @module FetchLicences
+ */
+
+const { db } = require('../../../../db/db.js')
+
+/**
+ * Fetches all licences that are in NALD and WRLS
+ *
+ * A licence is valid if at least one licence version is not in draft
+ *
+ * @returns {Promise<object[]>} - An array of licences
+ */
+async function go () {
+  const query = `
+    SELECT DISTINCT ON (nal."LIC_NO")
+      l.id as id,
+      TO_DATE(NULLIF(nal."EXPIRY_DATE", 'null'), 'DD/MM/YYYY') AS expired_date,
+      TO_DATE(NULLIF(nal."LAPSED_DATE", 'null'), 'DD/MM/YYYY') AS lapsed_date,
+      TO_DATE(NULLIF(nal."EXPIRY_DATE", 'null'), 'DD/MM/YYYY') AS revoked_date
+    FROM import."NALD_ABS_LIC_VERSIONS" nalv
+      INNER JOIN import."NALD_ABS_LICENCES" nal
+        ON nal."ID" = nalv."AABL_ID"
+        AND nal."FGAC_REGION_CODE" = nalv."FGAC_REGION_CODE"
+      INNER JOIN
+        public.licences l ON l.licence_ref = nal."LIC_NO"
+    WHERE nalv."STATUS" <> 'DRAFT'
+  `
+
+  const { rows } = await db.raw(query)
+
+  return rows
+}
+
+module.exports = {
+  go
+}

app/services/jobs/import/import-licence.service.js

@@ -0,0 +1,35 @@
+'use strict'
+
+/**
+ * Extracts and imports licence from NALD
+ * @module ImportLicence
+ */
+
+const FetchLicences = require('./fetch-licences.service.js')
+const ProcessImportLicence = require('./process-import-licence.service.js')
+const { calculateAndLogTimeTaken, currentTimeInNanoseconds } = require('../../../lib/general.lib.js')
+
+/**
+ * Extracts and imports licence from NALD
+ *
+ * If a licence in NALD does not have a status of DRAFT, and at least one non-draft licence version
+ * then it will be extracted
+ *
+ */
+async function go () {
+  try {
+    const startTime = currentTimeInNanoseconds()
+
+    const licences = await FetchLicences.go()
+
+    ProcessImportLicence.go(licences)
+
+    calculateAndLogTimeTaken(startTime, `Importing ${licences.length} licences from NALD`)
+  } catch (error) {
+    global.GlobalNotifier.omfg('Importing Licence job failed', null, error)
+  }
+}
+
+module.exports = {
+  go
+}

app/services/jobs/import/process-import-licence.service.js

@@ -0,0 +1,50 @@
+'use strict'
+
+/**
+ * Process import licence
+ * @module ProcessImportLicence
+ */
+
+const DetermineSupplementaryBillingFlagsService = require('../../import/determine-supplementary-billing-flags.service.js')
+const ProcessLicenceReturnLogsService = require('../return-logs/process-licence-return-logs.service.js')
+const { currentTimeInNanoseconds, calculateAndLogTimeTaken } = require('../../../lib/general.lib.js')
+
+/**
+ * Process import licence
+ *
+ * Batches the licences process into small chunks to reduce strain on the system
+ *
+ * @param {object[]} licences - an array of licences
+ */
+async function go (licences) {
+  const batchSize = 10
+
+  const startTime = currentTimeInNanoseconds()
+
+  for (let i = 0; i < licences.length; i += batchSize) {
+    const batch = licences.slice(i, i + batchSize)
+
+    await _processBatch(batch)
+  }
+
+  calculateAndLogTimeTaken(startTime, `Finished importing ${licences.length} licences from NALD`)
+}
+
+async function _processBatch (batch) {
+  await Promise.all(
+    batch.map(async (
+      licence) => {
+      await DetermineSupplementaryBillingFlagsService.go(
+        {
+          expiredDate: licence.expired_date,
+          lapsedDate: licence.lapsed_date,
+          revokedDate: licence.revoked_date
+        }, licence.id)
+      await ProcessLicenceReturnLogsService.go(licence.id)
+    })
+  )
+}
+
+module.exports = {
+  go
+}

test/controllers/jobs.controller.test.js

@@ -10,10 +10,11 @@ const { expect } = Code
 
 // Things we need to stub
 const ExportService = require('../../app/services/jobs/export/export.service.js')
+const ImportLicence = require('../../app/services/jobs/import/import-licence.service.js')
 const ProcessLicenceUpdatesService = require('../../app/services/jobs/licence-updates/process-licence-updates.js')
+const ProcessReturnLogsService = require('../../app/services/jobs/return-logs/process-return-logs.service.js')
 const ProcessSessionStorageCleanupService = require('../../app/services/jobs/session-cleanup/process-session-storage-cleanup.service.js')
 const ProcessTimeLimitedLicencesService = require('../../app/services/jobs/time-limited/process-time-limited-licences.service.js')
-const ProcessReturnLogsService = require('../../app/services/jobs/return-logs/process-return-logs.service.js')
 
 // For running our service
 const { init } = require('../../app/server.js')
@@ -58,6 +59,26 @@ describe('Jobs controller', () => {
     })
   })
 
+  describe('/jobs/import-licence', () => {
+    describe('POST', () => {
+      beforeEach(() => {
+        options = { method: 'POST', url: '/jobs/import-licence' }
+      })
+
+      describe('when the request succeeds', () => {
+        beforeEach(async () => {
+          Sinon.stub(ImportLicence, 'go').resolves()
+        })
+
+        it('returns a 204 response', async () => {
+          const response = await server.inject(options)
+
+          expect(response.statusCode).to.equal(204)
+        })
+      })
+    })
+  })
+
   describe('/jobs/licence-updates', () => {
     describe('POST', () => {
       beforeEach(() => {

test/services/jobs/import/import-licence.service.test.js

@@ -0,0 +1,55 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+const Sinon = require('sinon')
+
+const { describe, it, beforeEach, afterEach } = exports.lab = Lab.script()
+const { expect } = Code
+
+// Things we need to stub
+const FetchLicences = require('../../../../app/services/jobs/import/fetch-licences.service.js')
+const ProcessImportLicence = require('../../../../app/services/jobs/import/process-import-licence.service.js')
+const { generateUUID } = require('../../../../app/lib/general.lib.js')
+
+// Thing under test
+const ImportLicence = require('../../../../app/services/jobs/import/import-licence.service.js')
+
+describe('Import Licence Service', () => {
+  let stubFetchLicences
+  let stubProcessImportLicence
+  let notifierStub
+  let licences
+
+  beforeEach(async () => {
+    licences = [[{ id: generateUUID(), expired_date: null, lapsed_date: null, revoked_date: null }]]
+
+    stubFetchLicences = Sinon.stub(FetchLicences, 'go').resolves(licences)
+    stubProcessImportLicence = Sinon.stub(ProcessImportLicence, 'go').resolves()
+
+    notifierStub = { omg: Sinon.stub(), omfg: Sinon.stub() }
+    global.GlobalNotifier = notifierStub
+  })
+
+  afterEach(() => {
+    Sinon.restore()
+    delete global.GlobalNotifier
+  })
+
+  it('fetches the nald licence data and starts the process to import the licences', async () => {
+    await ImportLicence.go()
+
+    expect(stubFetchLicences.calledOnce).to.be.true()
+    expect(stubProcessImportLicence.calledWith(licences)).to.be.true()
+  })
+
+  it('logs to highlight the amount of licences being imported', async () => {
+    await ImportLicence.go()
+
+    const args = notifierStub.omg.firstCall.args
+
+    expect(args[0]).to.equal('Importing 1 licences from NALD')
+    expect(args[1].timeTakenMs).to.exist()
+  })
+})