ffc-pay-event-publisher 1.0.0-alpha.1

package/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+- repo: https://github.com/Yelp/detect-secrets
+  rev: v0.14.2
+  hooks:
+  - id: detect-secrets
+    args: ['--baseline', '.secrets.baseline']

package/.secrets.baseline

@@ -0,0 +1,67 @@
+{
+  "custom_plugin_paths": [],
+  "exclude": {
+    "files": "package-lock.json",
+    "lines": null
+  },
+  "generated_at": "2020-08-16T12:22:01Z",
+  "plugins_used": [
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "base64_limit": 4.5,
+      "name": "Base64HighEntropyString"
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "hex_limit": 3,
+      "name": "HexHighEntropyString"
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "keyword_exclude": null,
+      "name": "KeywordDetector"
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "results": {},
+  "version": "0.14.2",
+  "word_list": {
+    "file": null,
+    "hash": null
+  }
+}

package/Jenkinsfile

@@ -0,0 +1,3 @@
+@Library('defra-library@v-9') _
+
+buildNpm()

package/LICENCE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2020 Defra
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

package/README.md

@@ -0,0 +1,55 @@
+# ffc-pay-event-publisher
+NPM module for publishing events
+
+## Usage
+
+### Installation
+
+```
+npm install --save ffc-pay-event-publisher
+
+```
+
+### Configuration
+
+
+#### Example usage
+
+```
+const { PublishEvent } = require('ffc-protective-monitoring')
+
+const protectiveMonitoring = new PublishEvent(PROTECTIVE_MONITORING_URL)
+
+await protectiveMonitoring.sendEvent({
+  sessionid: 'e66d78f5-a58d-46f6-a9b4-f8c90e99b6dc',
+  datetime: '2020-10-09T12:51:41.381Z',
+  version: '1.1',
+  application: 'FI001',
+  component: '<internal app name>',
+  ip: '127.0.0.1',
+  pmccode: '0703',
+  priority: '0',
+  details: {
+    transactioncode: '2306',
+    message: 'User successfully downloaded a stored document',
+    additionalinfo: '<details or obfuscated location of document, etc.>'
+  }
+})
+
+```
+
+## Licence
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+<http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3>
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the licence
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

package/app/app-insights/index.js

@@ -0,0 +1,5 @@
+const trackEvent = require('./track-event')
+
+module.exports = {
+  trackEvent
+}

package/app/app-insights/track-event.js

@@ -0,0 +1,5 @@
+module.exports = (appInsights, eventMessage) => {
+  if (appInsights !== undefined && appInsights.defaultClient !== undefined) {
+    appInsights.defaultClient.trackEvent(eventMessage)
+  }
+}

package/app/event-publisher/event-schema.js

@@ -0,0 +1,29 @@
+const joi = require('joi')
+
+const eventSchema = joi.object({
+  name: joi.string().required(),
+  properties: joi.object({
+    id: joi.string().required(),
+    checkpoint: joi.string().required(),
+    status: joi.string().required(),
+    action: joi.object({
+      type: joi.string().required(),
+      message: joi.string().required(),
+      timestamp: joi.date().required(),
+      data: joi.object()
+    })
+  })
+})
+
+const validateEvent = (event) => {
+  const validate = eventSchema.validate(event)
+
+  if (validate.error) {
+    console.log('Event validation error', validate.error)
+    return false
+  }
+
+  return true
+}
+
+module.exports = validateEvent

package/app/event-publisher/index.js

@@ -0,0 +1,5 @@
+const PublishEvent = require('./publish-event')
+
+module.exports = {
+  PublishEvent
+}

package/app/event-publisher/publish-event.js

@@ -0,0 +1,19 @@
+const validateEvent = require('./event-schema')
+const { trackEvent } = require('../app-insights')
+const { publishEventRequest } = require('../event-publisher/messaging')
+
+class PublishEvent {
+  constructor (config) {
+    this.appInsights = config.appInsights
+    this.config = config
+  }
+
+  async sendEvent (eventMessage) {
+    if (validateEvent(eventMessage)) {
+      await publishEventRequest(eventMessage, this.config)
+      trackEvent(eventMessage)
+    }
+  }
+}
+
+module.exports = PublishEvent

package/app/messaging/create-message.js

@@ -0,0 +1,10 @@
+const createMessage = (body, type, options) => {
+  return {
+    body,
+    type,
+    source: 'ffc-pay-event-publisher',
+    ...options
+  }
+}
+
+module.exports = createMessage

package/app/messaging/index.js

@@ -0,0 +1,5 @@
+const publishEventRequest = require('./publish-event-request')
+
+module.exports = {
+  publishEventRequest
+}

package/app/messaging/publish-event-request.js

@@ -0,0 +1,10 @@
+const { MessageSender } = require('ffc-messaging')
+const createMessage = require('./create-message')
+
+const publishEventRequest = async (eventMessage, config) => {
+  const eventSender = new MessageSender(config)
+  const message = createMessage(eventMessage, 'uk.gov.pay.event.publisher')
+  await eventSender.sendMessage(message)
+}
+
+module.exports = publishEventRequest

package/app/messaging/send-message.js

@@ -0,0 +1,11 @@
+const { MessageSender } = require('ffc-messaging')
+const createMessage = require('./create-message')
+
+const sendMessage = async (body, type, config, options) => {
+  const message = createMessage(body, type, options)
+  const sender = new MessageSender(config)
+  await sender.sendMessage(message)
+  await sender.closeConnection()
+}
+
+module.exports = sendMessage

package/index.js

@@ -0,0 +1,5 @@
+const { PublishEvent } = require('./app/event-publisher')
+
+module.exports = {
+  PublishEvent
+}

package/jest.config.js

@@ -0,0 +1,35 @@
+module.exports = {
+  collectCoverage: true,
+  collectCoverageFrom: [
+    '**/*.js',
+    '!**/*.test.js'
+  ],
+  coverageDirectory: 'test-output',
+  coverageReporters: [
+    'text-summary',
+    'lcov'
+  ],
+  coveragePathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/test-output/',
+    '<rootDir>/test/',
+    '<rootDir>/jest.config.js'
+  ],
+  modulePathIgnorePatterns: [
+    'node_modules'
+  ],
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        suiteName: 'jest tests',
+        outputDirectory: 'test-output',
+        outputName: 'junit.xml'
+      }
+    ]
+  ],
+  testEnvironment: 'node',
+  testPathIgnorePatterns: [],
+  verbose: true
+}

package/jsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "module": "commonjs"
+  },
+  "exclude": ["node_modules"]
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "ffc-pay-event-publisher",
+  "version": "1.0.0-alpha.1",
+  "description": "Publish events",
+  "homepage": "https://github.com/DEFRA/ffc-protective-monitoring",
+  "main": "app/index.js",
+  "scripts": {
+    "test": "jest --runInBand",
+    "test:watch": "jest --coverage=false --onlyChanged --watch --runInBand",
+    "start:watch": "nodemon --inspect=0.0.0.0 --ext js --legacy-watch app/index.js",
+    "test:debug": "node --inspect-brk=0.0.0.0 ./node_modules/jest/bin/jest.js --runInBand"
+  },
+  "author": "Defra",
+  "contributors": [
+    "Steve Dickinson steve.dickinson@defra.gov.uk",
+    "Simon Dunn simon.dunn1@defra.gov.uk"
+  ],
+  "license": "OGL-UK-3.0",
+  "dependencies": {
+    "@hapi/hapi": "^20.0.0",
+    "joi": "^17.4.0"
+  },
+  "devDependencies": {
+    "jest": "^26.6.3",
+    "jest-junit": "^11.1.0",
+    "nodemon": "^2.0.4",
+    "standard": "^14.3.4"
+  },
+  "standard": {
+    "globals": [
+      "describe",
+      "beforeEach",
+      "expect",
+      "test",
+      "afterEach",
+      "jest",
+      "beforeAll",
+      "afterAll"
+    ]
+  },
+  "nodemonConfig": {
+    "ignore": [
+      "**/test-output/**"
+    ]
+  }
+}

package/sonar-project.properties

@@ -0,0 +1,3 @@
+sonar.javascript.exclusions=**/jest.config.js,**/__mocks__/**,**/node_modules/**,**/test/**,**/test-output/**
+sonar.javascript.lcov.reportPaths=test-output/lcov.info
+sonar.exclusions=/test/**,**/*.test.js,*snyk_report.html