ffc-pay-schemes 1.0.12 → 1.0.13

package/README.md

@@ -17,8 +17,10 @@ const {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getBatchSequenceFromFileName,
   getReportingDataFilter,
   getSchemeBatchProperties,
+  getSchemeFromBatchFileName,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,
@@ -39,8 +41,10 @@ const {
 - `createInvoiceNumber(paymentRequest)` creates an invoice number for a given `paymentRequest`.
 - `createSplitInvoiceNumber(paymentRequest)` creates a split invoice number for a given `paymentRequest`.
 - `getAccountCodeMap(schemeId)` returns the account code mapping used for a given `schemeId`.
+- `getBatchSequenceFromFileName(schemeId, fileName)` returns the sequence as identified in the supplied `fileName`, checking the correct position using the `schemeId`.
 - `getReportingDataFilter(schemeId)` returns the fields which should be added to any data filters applied in reporting checks, for a given `schemeId`.
 - `getSchemeBatchProperties(schemeId)` returns the batch processing properties for a given `schemeId`.
+- `getSchemeFromBatchFileName(fileName)` returns the supported scheme details based on the expected file mask matching the supplied `fileName`.
 - `getSchemeIdFromPillar(pillar)` returns the scheme ID for a given `pillar`.
 - `getSchemeIdFromSourceSystem(sourceSystem)` returns the scheme ID for a given `sourceSystem`.
 - `getSchemeIds()` returns all supported scheme IDs.

package/app/constants/file-masks.js

@@ -0,0 +1,14 @@
+module.exports = {
+  SFI: /^SITISFI\d{4}_AP_\d*.dat$/,
+  SFI_PILOT: /^SITIELM\d{4}_AP_\d*.dat$/,
+  LUMP_SUMS: /^SITILSES\d{4}_AP_\d*.dat$/,
+  CS: /^SITICS\d{4}_AP_\d*.dat$/,
+  BPS: /^SITI_\d{4}_AP_\d*.dat$/,
+  ES: /^GENESISPayReq_\d{8}_\d{4}.gne$/,
+  FC: /^FCAP_\d{4}_\d*\.dat$/,
+  IMPS: /^FIN_IMPS_A[P|R]_\d*.INT$/,
+  SFI23: /^SITISFIA\d{4}_AP_\d*.dat$/,
+  DELINKED: /^SITIDP\d{4}_AP_\d*.dat$/,
+  SFI_EXPANDED: /^ESFIO\d{4}_AP_\d*.dat$/,
+  COHT_CAPITAL: /^SITICOHTC\d{4}_AP_\d*.dat$/
+}

package/app/constants/schemes.js

@@ -1,6 +1,7 @@
+const fileMasks = require('./file-masks')
+const pillars = require('./pillars')
 const schemeIds = require('./scheme-ids')
 const sourceSystems = require('./source-systems')
-const pillars = require('./pillars')
 const { RP00, NE00, FC00, RP10 } = require('./delivery-bodies')
 const { DRD10, DOM10, ERD14, EGF00, EXQ00, DOM00 } = require('./fund-codes')
 
@@ -10,21 +11,24 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.SFI,
     pillar: pillars.SFI,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI
   },
   {
     schemeId: schemeIds.SFI_PILOT,
     sourceSystem: sourceSystems.SFI_PILOT,
     pillar: pillars.SFI_PILOT,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI_PILOT
   },
   {
     schemeId: schemeIds.LUMP_SUMS,
     sourceSystem: sourceSystems.LUMP_SUMS,
     pillar: pillars.LUMP_SUMS,
     deliveryBody: RP00,
-    fundCode: DOM10
+    fundCode: DOM10,
+    fileMask: fileMasks.LUMP_SUMS
   },
   {
     schemeId: schemeIds.VET_VISITS,
@@ -38,14 +42,16 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.CS,
     pillar: pillars.CS,
     deliveryBody: NE00,
-    fundCode: ERD14
+    fundCode: ERD14,
+    fileMask: fileMasks.CS
   },
   {
     schemeId: schemeIds.BPS,
     sourceSystem: sourceSystems.BPS,
     pillar: pillars.BPS,
     deliveryBody: RP00,
-    fundCode: EGF00
+    fundCode: EGF00,
+    fileMask: fileMasks.BPS
   },
   {
     schemeId: schemeIds.MANUAL,
@@ -59,42 +65,48 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.ES,
     pillar: pillars.ES,
     deliveryBody: NE00,
-    fundCode: EXQ00
+    fundCode: EXQ00,
+    fileMask: fileMasks.ES
   },
   {
     schemeId: schemeIds.FC,
     sourceSystem: sourceSystems.FC,
     pillar: pillars.FC,
     deliveryBody: FC00,
-    fundCode: DOM00
+    fundCode: DOM00,
+    fileMask: fileMasks.FC
   },
   {
     schemeId: schemeIds.IMPS,
     sourceSystem: sourceSystems.IMPS,
     pillar: pillars.IMPS,
     deliveryBody: RP00,
-    fundCode: DOM00
+    fundCode: DOM00,
+    fileMask: fileMasks.IMPS
   },
   {
     schemeId: schemeIds.SFI23,
     sourceSystem: sourceSystems.SFI23,
     pillar: pillars.SFI23,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI23
   },
   {
     schemeId: schemeIds.DELINKED,
     sourceSystem: sourceSystems.DELINKED,
     pillar: pillars.DELINKED,
     deliveryBody: RP00,
-    fundCode: DOM10
+    fundCode: DOM10,
+    fileMask: fileMasks.DELINKED
   },
   {
     schemeId: schemeIds.SFI_EXPANDED,
     sourceSystem: sourceSystems.SFI_EXPANDED,
     pillar: pillars.SFI_EXPANDED,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.SFI_EXPANDED
   },
   {
     schemeId: schemeIds.COHT_REVENUE,
@@ -108,7 +120,8 @@ module.exports = Object.freeze([
     sourceSystem: sourceSystems.COHT_CAPITAL,
     pillar: pillars.COHT_CAPITAL,
     deliveryBody: RP00,
-    fundCode: DRD10
+    fundCode: DRD10,
+    fileMask: fileMasks.COHT_CAPITAL
   },
   {
     schemeId: schemeIds.FPTT,

package/app/constants/sequence-positions.js

@@ -0,0 +1,13 @@
+module.exports = {
+  SFI: 7,
+  SFI_PILOT: 7,
+  LUMP_SUMS: 8,
+  CS: 6,
+  BPS: 5,
+  ES: 23,
+  FC: 5,
+  SFI23: 8,
+  DELINKED: 6,
+  SFI_EXPANDED: 5,
+  COHT_CAPITAL: 9
+}

package/app/helpers/get-batch-sequence-from-file-name.js

@@ -0,0 +1,34 @@
+const schemeIds = require('../constants/scheme-ids')
+const sequencePositions = require('../constants/sequence-positions')
+
+const SEQUENCE_LENGTH = 4
+const IMPS_OFFSET = 1
+
+const getBatchSequenceFromFileName = (schemeId, fileName) => {
+  if (schemeId === schemeIds.IMPS) {
+    return Number(fileName.substring(
+      fileName.lastIndexOf('_') + IMPS_OFFSET,
+      fileName.lastIndexOf('.')
+    ))
+  }
+
+  const schemeEntry = Object.entries(schemeIds)
+    .find(([, id]) => id === schemeId)
+
+  if (!schemeEntry) {
+    throw new Error(`Unknown schemeId: ${schemeId}`)
+  }
+
+  const [schemeName] = schemeEntry
+  const sequenceStart = sequencePositions[schemeName]
+
+  if (sequenceStart === undefined) {
+    throw new Error(`No sequence position found for schemeId: ${schemeId}`)
+  }
+
+  return Number(fileName.substr(sequenceStart, SEQUENCE_LENGTH))
+}
+
+module.exports = {
+  getBatchSequenceFromFileName
+}

package/app/scheme-properties/get-scheme-from-batch-file-name.js

@@ -0,0 +1,11 @@
+const schemes = require('../constants/schemes')
+
+const getSchemeFromBatchFileName = (fileName) => {
+  return schemes.find(scheme =>
+    scheme.fileMask?.test(fileName)
+  )
+}
+
+module.exports = {
+  getSchemeFromBatchFileName
+}

package/index.js

@@ -1,8 +1,10 @@
 const { createInvoiceNumber } = require('./app/create-invoice-number')
 const { createSplitInvoiceNumber } = require('./app/create-split-invoice-number')
 const { getAccountCodeMap } = require('./app/get-account-code-map')
+const { getBatchSequenceFromFileName } = require('./app/helpers/get-batch-sequence-from-file-name')
 const { getReportingDataFilter } = require('./app/helpers/get-reporting-data-filter')
 const { getSchemeBatchProperties } = require('./app/scheme-properties/get-scheme-batch-properties')
+const { getSchemeFromBatchFileName } = require('./app/scheme-properties/get-scheme-from-batch-file-name')
 const { getSchemeIdFromPillar } = require('./app/scheme-id/get-scheme-id-from-pillar')
 const { getSchemeIdFromSourceSystem } = require('./app/scheme-id/get-scheme-id-from-source-system')
 const { getSchemeIds } = require('./app/scheme-id/get-scheme-ids')
@@ -22,8 +24,10 @@ module.exports = {
   createInvoiceNumber,
   createSplitInvoiceNumber,
   getAccountCodeMap,
+  getBatchSequenceFromFileName,
   getReportingDataFilter,
   getSchemeBatchProperties,
+  getSchemeFromBatchFileName,
   getSchemeIdFromPillar,
   getSchemeIdFromSourceSystem,
   getSchemeIds,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ffc-pay-schemes",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "Module for defining and providing details for the payment schemes supported by the Payment Hub.",
   "main": "index.js",
   "scripts": {

package/test/unit/helpers/get-batch-sequence-from-file-name.test.js

@@ -0,0 +1,55 @@
+jest.mock('../../../app/constants/scheme-ids', () => ({
+  SFI: 1,
+  IMPS: 11,
+  FPTT: 18
+}))
+
+jest.mock('../../../app/constants/sequence-positions', () => ({
+  SFI: 6
+}))
+
+const {
+  getBatchSequenceFromFileName
+} = require('../../../app/helpers/get-batch-sequence-from-file-name')
+
+const schemeIds = require('../../../app/constants/scheme-ids')
+
+describe('getBatchSequenceFromFileName', () => {
+  test('returns the sequence using the scheme sequence position', () => {
+    const fileName = 'prefix12345678.csv'
+
+    expect(
+      getBatchSequenceFromFileName(schemeIds.SFI, fileName)
+    ).toBe(1234)
+  })
+
+  test('returns the IMPS sequence between the final underscore and dot', () => {
+    expect(
+      getBatchSequenceFromFileName(schemeIds.IMPS, 'IMPS_batch_5678.csv')
+    ).toBe(5678)
+  })
+
+  test('uses the final underscore for IMPS filenames', () => {
+    expect(
+      getBatchSequenceFromFileName(
+        schemeIds.IMPS,
+        'IMPS_batch_previous_4321.csv'
+      )
+    ).toBe(4321)
+  })
+
+  test('throws when the scheme ID is unknown', () => {
+    expect(() =>
+      getBatchSequenceFromFileName(1000, 'filename.csv')
+    ).toThrow('Unknown schemeId: 1000')
+  })
+
+  test('throws when the scheme has no sequence position', () => {
+    expect(() =>
+      getBatchSequenceFromFileName(
+        schemeIds.FPTT,
+        'filename.csv'
+      )
+    ).toThrow(`No sequence position found for schemeId: ${schemeIds.FPTT}`)
+  })
+})

package/test/unit/scheme-properties/get-scheme-from-batch-file-name.test.js

@@ -0,0 +1,51 @@
+jest.mock('../../../app/constants/schemes', () => [
+  {
+    schemeId: 1,
+    fileMask: {
+      test: jest.fn((fileName) => fileName === 'sfi-batch.csv')
+    }
+  },
+  {
+    schemeId: 2,
+    fileMask: {
+      test: jest.fn((fileName) => fileName === 'pilot-batch.csv')
+    }
+  },
+  {
+    schemeId: 3
+  }
+])
+
+const schemes = require('../../../app/constants/schemes')
+const {
+  getSchemeFromBatchFileName
+} = require('../../../app/scheme-properties/get-scheme-from-batch-file-name')
+
+describe('getSchemeFromBatchFileName', () => {
+  test('returns the first matching scheme', () => {
+    expect(
+      getSchemeFromBatchFileName('pilot-batch.csv')
+    ).toBe(schemes[1])
+  })
+
+  test('skips schemes without a file mask', () => {
+    expect(
+      getSchemeFromBatchFileName('unknown-batch.csv')
+    ).toBeUndefined()
+
+    expect(schemes[0].fileMask.test).toHaveBeenCalledWith('unknown-batch.csv')
+    expect(schemes[1].fileMask.test).toHaveBeenCalledWith('unknown-batch.csv')
+  })
+
+  test('returns undefined when no file mask matches', () => {
+    expect(
+      getSchemeFromBatchFileName('unknown-batch.csv')
+    ).toBeUndefined()
+  })
+
+  test('stops checking after finding a match', () => {
+    getSchemeFromBatchFileName('sfi-batch.csv')
+
+    expect(schemes[1].fileMask.test).not.toHaveBeenCalledWith('sfi-batch.csv')
+  })
+})

package/test-output/cobertura-coverage.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" ?>
 <!DOCTYPE coverage SYSTEM "http://cobertura.sourceforge.net/xml/coverage-04.dtd">
-<coverage lines-valid="269" lines-covered="250" line-rate="0.9293" branches-valid="55" branches-covered="55" branch-rate="1" timestamp="1788777087732" complexity="0" version="0.1">
+<coverage lines-valid="303" lines-covered="280" line-rate="0.924" branches-valid="61" branches-covered="61" branch-rate="1" timestamp="1788866911565" complexity="0" version="0.1">
   <sources>
     <source>/home/samplackett/ffc-pay-schemes</source>
   </sources>
@@ -29,12 +29,15 @@
             <line number="16" hits="0" branch="false"/>
             <line number="17" hits="0" branch="false"/>
             <line number="18" hits="0" branch="false"/>
+            <line number="19" hits="0" branch="false"/>
             <line number="20" hits="0" branch="false"/>
+            <line number="21" hits="0" branch="false"/>
+            <line number="23" hits="0" branch="false"/>
           </lines>
         </class>
       </classes>
     </package>
-    <package name="ffc-pay-schemes.app.constants" line-rate="1" branch-rate="1">
+    <package name="ffc-pay-schemes.app.constants" line-rate="0.9629000000000001" branch-rate="1">
       <classes>
         <class name="delivery-bodies.js" filename="app/constants/delivery-bodies.js" line-rate="1" branch-rate="1">
           <methods>
@@ -50,6 +53,13 @@
             <line number="1" hits="9" branch="false"/>
           </lines>
         </class>
+        <class name="file-masks.js" filename="app/constants/file-masks.js" line-rate="1" branch-rate="1">
+          <methods>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="frps-schemes.js" filename="app/constants/frps-schemes.js" line-rate="1" branch-rate="1">
           <methods>
           </methods>
@@ -84,7 +94,7 @@
           <methods>
           </methods>
           <lines>
-            <line number="1" hits="11" branch="false"/>
+            <line number="1" hits="12" branch="false"/>
           </lines>
         </class>
         <class name="scheme-names.js" filename="app/constants/scheme-names.js" line-rate="1" branch-rate="1">
@@ -119,7 +129,23 @@
             <line number="3" hits="1" branch="false"/>
             <line number="4" hits="1" branch="false"/>
             <line number="5" hits="1" branch="false"/>
-            <line number="7" hits="1" branch="false"/>
+            <line number="6" hits="1" branch="false"/>
+            <line number="8" hits="1" branch="false"/>
+          </lines>
+        </class>
+        <class name="sequence-positions.js" filename="app/constants/sequence-positions.js" line-rate="0" branch-rate="1">
+          <methods>
+          </methods>
+          <lines>
+            <line number="1" hits="0" branch="false"/>
+          </lines>
+        </class>
+        <class name="siti-agri-schemes.js" filename="app/constants/siti-agri-schemes.js" line-rate="1" branch-rate="1">
+          <methods>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
           </lines>
         </class>
         <class name="source-systems.js" filename="app/constants/source-systems.js" line-rate="1" branch-rate="1">
@@ -484,6 +510,39 @@
     </package>
     <package name="ffc-pay-schemes.app.helpers" line-rate="1" branch-rate="1">
       <classes>
+        <class name="get-batch-sequence-from-file-name.js" filename="app/helpers/get-batch-sequence-from-file-name.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="5" signature="()V">
+              <lines>
+                <line number="7" hits="5"/>
+              </lines>
+            </method>
+            <method name="(anonymous_1)" hits="7" signature="()V">
+              <lines>
+                <line number="16" hits="7"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="2" hits="1" branch="false"/>
+            <line number="4" hits="1" branch="false"/>
+            <line number="5" hits="1" branch="false"/>
+            <line number="7" hits="1" branch="false"/>
+            <line number="8" hits="5" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="9" hits="2" branch="false"/>
+            <line number="15" hits="3" branch="false"/>
+            <line number="16" hits="7" branch="false"/>
+            <line number="18" hits="3" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="19" hits="1" branch="false"/>
+            <line number="22" hits="2" branch="false"/>
+            <line number="23" hits="2" branch="false"/>
+            <line number="25" hits="2" branch="true" condition-coverage="100% (2/2)"/>
+            <line number="26" hits="1" branch="false"/>
+            <line number="29" hits="1" branch="false"/>
+            <line number="32" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="get-reporting-data-filter.js" filename="app/helpers/get-reporting-data-filter.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="5" signature="()V">
@@ -521,6 +580,21 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="is-siti-agri.js" filename="app/helpers/is-siti-agri.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="14" signature="()V">
+              <lines>
+                <line number="3" hits="14"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="14" branch="false"/>
+            <line number="7" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="is-valid-scheme-id.js" filename="app/helpers/is-valid-scheme-id.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="19" signature="()V">
@@ -693,6 +767,27 @@
             <line number="7" hits="1" branch="false"/>
           </lines>
         </class>
+        <class name="get-scheme-from-batch-file-name.js" filename="app/scheme-properties/get-scheme-from-batch-file-name.js" line-rate="1" branch-rate="1">
+          <methods>
+            <method name="(anonymous_0)" hits="4" signature="()V">
+              <lines>
+                <line number="3" hits="4"/>
+              </lines>
+            </method>
+            <method name="(anonymous_1)" hits="9" signature="()V">
+              <lines>
+                <line number="4" hits="9"/>
+              </lines>
+            </method>
+          </methods>
+          <lines>
+            <line number="1" hits="1" branch="false"/>
+            <line number="3" hits="1" branch="false"/>
+            <line number="4" hits="4" branch="false"/>
+            <line number="5" hits="9" branch="false"/>
+            <line number="9" hits="1" branch="false"/>
+          </lines>
+        </class>
         <class name="get-scheme-properties.js" filename="app/scheme-properties/get-scheme-properties.js" line-rate="1" branch-rate="1">
           <methods>
             <method name="(anonymous_0)" hits="54" signature="()V">