Create return logs for newly imported licences

app/controllers/check.controller.js

@@ -0,0 +1,36 @@
+'use strict'
+
+/**
+ * Controller for /check endpoints
+ * @module CheckController
+ */
+
+const ProcessLicenceReturnLogsService = require('../services/jobs/return-logs/process-licence-return-logs.service.js')
+
+const redirectStatusCode = 204
+
+/**
+ * A test end point to create return logs for a given licence reference
+ *
+ * @param _request - the hapi request object
+ * @param h - the hapi response object
+ *
+ * @returns {Promise<object>} - A promise that resolves to an HTTP response object with a 204 status code
+ */
+async function returnLogsForLicence (_request, h) {
+  let licenceReference
+
+  if (h.request.payload !== null && h.request.payload.licenceReference) {
+    licenceReference = h.request.payload.licenceReference
+  } else {
+    return h.response().code(404)
+  }
+
+  ProcessLicenceReturnLogsService.go(licenceReference)
+
+  return h.response().code(redirectStatusCode)
+}
+
+module.exports = {
+  returnLogsForLicence
+}

app/lib/dates.lib.js

@@ -5,10 +5,60 @@
  * @module DatesLib
  */
 
+const { returnCycleDates } = require('./static-lookups.lib.js')
+
 const february = 2
 const lastDayOfFebruary = 28
 const lastDayOfFebruaryLeapYear = 29
 
+/**
+ * Get the next summer return cycle due date.
+ *
+ * @returns {Date} the due date of the next summer return cycle
+ */
+function dueDateOfSummerCycle () {
+  return new Date(new Date().getFullYear() + 1,
+    returnCycleDates.summer.dueDate.month,
+    returnCycleDates.summer.dueDate.day
+  )
+}
+
+/**
+ * Get the next winter and all year cycle due date.
+ *
+ * @returns {Date} the due date of the next winter and all year return cycle
+ */
+function dueDateOfWinterAndAllYearCycle () {
+  return new Date(new Date().getFullYear() + 1,
+    returnCycleDates.allYear.dueDate.month,
+    returnCycleDates.allYear.dueDate.day
+  )
+}
+
+/**
+ * Get the next summer return cycle end date.
+ *
+ * @returns {Date} the end date of the next summer cycle
+ */
+function endOfSummerCycle () {
+  return new Date(new Date().getFullYear() + 1,
+    returnCycleDates.summer.endDate.month,
+    returnCycleDates.summer.endDate.day
+  )
+}
+
+/**
+ * Get the next winter and all year return cycle end date.
+ *
+ * @returns {Date} the end date of the next winter and all year cycle
+ */
+function endOfWinterAndAllYearCycle () {
+  return new Date(new Date().getFullYear() + 1,
+    returnCycleDates.allYear.endDate.month,
+    returnCycleDates.allYear.endDate.day
+  )
+}
+
 /**
  * Formats a string assumed to be a date in the format 01/01/2001
  *
@@ -35,6 +85,50 @@ function formatStandardDateToISO (date) {
   }
 }
 
+/**
+ * Formate the provided date in ISO format.
+ *
+ * @param {Date} date - a date object to be formatted
+ * @returns {Date} - the date formatted in YYYY-MM-DD.
+ */
+function formatDateObjectToISO (date) {
+  return date.toISOString().split('T')[0]
+}
+
+/**
+ * Get the due date of next provided cycle. Either summer or winter or all year.
+ *
+ * @param {boolean} summer - true for summer, false for winter and all year.
+ * @returns {Date} - the due date of the next cycle.
+ */
+function cycleDueDate (summer) {
+  return summer
+    ? formatDateObjectToISO(dueDateOfSummerCycle())
+    : formatDateObjectToISO(dueDateOfWinterAndAllYearCycle())
+}
+
+/**
+ * Get the end date of next provided cycle. Either summer or winter or all year.
+ *
+ * @param {boolean} summer - true for summer, false for winter and all year.
+ * @returns {Date} - the end date of the next cycle.
+ */
+function cycleEndDate (summer) {
+  return summer
+    ? formatDateObjectToISO(endOfSummerCycle())
+    : formatDateObjectToISO(endOfWinterAndAllYearCycle())
+}
+
+/**
+ * Get the start date of next provided cycle. Either summer or winter or all year.
+ *
+ * @param {boolean} summer - true for summer, false for winter and all year.
+ * @returns {Date} - the start date of the next cycle.
+ */
+function cycleStartDate (summer) {
+  return summer ? formatDateObjectToISO(startOfSummerCycle()) : formatDateObjectToISO(startOfWinterAndAllYearCycle())
+}
+
 /**
  * Check if a date is valid or not by creating a date and checking it gives the time
  *
@@ -103,8 +197,42 @@ function _isLeapYear (year) {
   return false
 }
 
+/**
+ * Get the next summer return cycle start date.
+ *
+ * @returns {Date} the start date of the next summer cycle
+ */
+function startOfSummerCycle () {
+  return new Date(new Date().getFullYear(),
+    returnCycleDates.summer.startDate.month,
+    returnCycleDates.summer.startDate.day
+  )
+}
+
+/**
+ * Get the next winter and all year return cycle start date.
+ *
+ * @returns {Date} the start date of the next winter and all year cycle
+ */
+function startOfWinterAndAllYearCycle () {
+  return new Date(new Date().getFullYear(),
+    returnCycleDates.allYear.startDate.month,
+    returnCycleDates.allYear.startDate.day
+  )
+}
+
 module.exports = {
+  dueDateOfSummerCycle,
+  dueDateOfWinterAndAllYearCycle,
+  endOfSummerCycle,
+  endOfWinterAndAllYearCycle,
+  formatDateObjectToISO,
   formatStandardDateToISO,
+  cycleDueDate,
+  cycleEndDate,
+  cycleStartDate,
   isISODateFormat,
-  isValidDate
+  isValidDate,
+  startOfSummerCycle,
+  startOfWinterAndAllYearCycle
 }

app/lib/static-lookups.lib.js

@@ -23,6 +23,19 @@ const organisationTypes = [
   'publicLimitedCompany'
 ]
 
+const returnCycleDates = {
+  allYear: {
+    dueDate: { day: 28, month: 3 },
+    endDate: { day: 31, month: 2 },
+    startDate: { day: 1, month: 3 }
+  },
+  summer: {
+    dueDate: { day: 28, month: 10 },
+    endDate: { day: 31, month: 9 },
+    startDate: { day: 1, month: 10 }
+  }
+}
+
 const returnRequirementFrequencies = {
   day: 'daily',
   week: 'weekly',
@@ -93,6 +106,7 @@ module.exports = {
   companyTypes,
   contactTypes,
   organisationTypes,
+  returnCycleDates,
   returnRequirementFrequencies,
   returnRequirementReasons,
   naldRegions,

app/plugins/router.plugin.js

@@ -17,6 +17,7 @@ const BillRoutes = require('../routes/bills.routes.js')
 const BillRunRoutes = require('../routes/bill-runs.routes.js')
 const BillRunSetupRoutes = require('../routes/bill-runs-setup.routes.js')
 const BillingAccountRoutes = require('../routes/billing-accounts.routes.js')
+const CheckRoutes = require('../routes/check.routes.js')
 const DataRoutes = require('../routes/data.routes.js')
 const FilterRoutesService = require('../services/plugins/filter-routes.service.js')
 const HealthRoutes = require('../routes/health.routes.js')
@@ -37,6 +38,7 @@ const routes = [
   ...BillRunRoutes,
   ...BillRunSetupRoutes,
   ...BillingAccountRoutes,
+  ...CheckRoutes,
   ...LicenceRoutes,
   ...JobRoutes,
   ...ReturnRequirementRoutes,

app/routes/check.routes.js

@@ -0,0 +1,23 @@
+'use strict'
+
+const CheckController = require('../controllers/check.controller.js')
+
+const routes = [
+  {
+    method: 'POST',
+    path: '/check/licence-return-logs',
+    options: {
+      handler: CheckController.returnLogsForLicence,
+      app: {
+        excludeFromProd: true,
+        plainOutput: true
+      },
+      auth: false,
+      plugins: {
+        crumb: false
+      }
+    }
+  }
+]
+
+module.exports = routes

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

@@ -7,6 +7,7 @@
 
 const LicenceStructureValidator = require('../../../validators/import/licence-structure.validator.js')
 const PersistLicenceService = require('../persist-licence.service.js')
+const ProcessLicenceReturnLogsService = require('../../jobs/return-logs/process-licence-return-logs.service.js')
 const TransformCompaniesService = require('./transform-companies.service.js')
 const TransformLicenceService = require('./transform-licence.service.js')
 const TransformLicenceVersionPurposeConditionsService = require('./transform-licence-version-purpose-conditions.service.js')
@@ -44,7 +45,7 @@ async function go (licenceRef) {
     const licenceId = await PersistLicenceService.go(transformedLicence, transformedCompanies)
 
     if (wrlsLicenceId) {
-      // Process mod logs
+      await ProcessLicenceReturnLogsService.go(wrlsLicenceId)
     }
 
     calculateAndLogTimeTaken(startTime, 'Legacy licence import complete', { licenceId, licenceRef })