Merge pull request #34 from DFE-Digital/add-webhook-for-frameworks

Add webhook service for published frameworks

api/adaptors/mongodoc/model.js

@@ -113,8 +113,6 @@ const structureModelSchema = new Schema({
 
 const structure =  async options => {
   const { connectionString, collectionName } = options
-  mongoose.set('useCreateIndex', true)
-  mongoose.set('useFindAndModify', false)
   const db = await mongoose.connect(connectionString, { useNewUrlParser: true }, err => {
     if (err) {
       throw new Error(errors.CONNECTION_ERROR)

api/controllers/framework.js

@@ -1,7 +1,7 @@
 
 const shared = require('./shared')
 
-const frameworkController = (dataSource) => { 
+const frameworkController = (dataSource) => {
   return {
     list: (req, res) => {
       dataSource.framework.list()

api/controllers/structure.js

@@ -1,8 +1,23 @@
 const shared = require('./shared')
-
-
+const webhookService = require('../services/webhookService')
 
 const structureController = (dataSource) => {
+  const populateFrameworkReferences = (frameworks, categories, providers) => {
+    const populatedFrameworks = frameworks.map(f => {
+      if (f.cat) {
+        f.cat = JSON.parse(JSON.stringify(categories.filter(c => c._id.toString() === f.cat.toString())[0]))
+        delete f.cat._id
+      }
+      if (f.provider) {
+        f.provider = JSON.parse(JSON.stringify(providers.filter(p => p._id.toString() === f.provider.toString())[0]))
+        delete f.provider._id
+      }
+      delete f._id
+      return f
+    })
+    return populatedFrameworks
+  }
+
   const me = {
     list: (req, res) => {
       dataSource.structure.list()
@@ -21,14 +36,24 @@ const structureController = (dataSource) => {
     },
     put: (req, res) => {
       dataSource.structure.put(req.params.structureId, req.body)
-      .then(results => res.send(results))
+      .then(results => {
+        res.send(results)
+        if (results.status === 'LIVE') {
+          const frameworks = results.framework.map(f => f.toJSON())
+          const categories = results.category.map(c => c.toJSON())
+          const providers = results.provider.map(p => p.toJSON())
+          const populatedFrameworks = populateFrameworkReferences(frameworks, categories, providers)
+          webhookService.send(populatedFrameworks)
+        }
+      })
       .catch(err => shared.stdErrorResponse(res, err))
     },
     remove: (req, res) => {
       dataSource.structure.remove(req.params.structureId)
       .then(results => res.send(results))
       .catch(err => shared.stdErrorResponse(res, err))
-    }
+    },
+    populateFrameworkReferences: populateFrameworkReferences
   }
 
   return me

api/services/webhookService.js

@@ -0,0 +1,27 @@
+const send = async (payload) => {
+  const https = require('https')
+
+  const data = JSON.stringify(payload)
+
+  const options = {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      'Content-Length': Buffer.byteLength(data),
+      'Authorization': `Token ${process.env.GHBS_WEBHOOK_SECRET}`
+    }
+  }
+
+  const req = https.request(process.env.GHBS_WEBHOOK_ENDPOINT, options, res => {
+    console.log(`statusCode: ${res.statusCode}`)
+  })
+
+  req.on('error', error => {
+    console.error(error)
+  })
+
+  req.write(data)
+  req.end()
+}
+
+module.exports = { send }

api/test/api.structure.populateFrameworkReferences.test.js

@@ -0,0 +1,44 @@
+const mongoose = require('mongoose')
+const chai = require('chai')
+
+const testData = require('./testdata/frameworks.json')
+const testProviderData = require('./testdata/providers.json')
+const testCategoryData = require('./testdata/categories.json')
+
+const expect = chai.expect
+const setup = require('./setup')
+
+describe('structureController', () => {
+  let structureController = require('../controllers/structure')
+  let testProviders = []
+  let testCategories = []
+  let testFrameworks = []
+
+  before(async () => {
+    const setupDone = await setup()
+    await setupDone.helpers.removeAllRecords('framework')
+    await setupDone.helpers.removeAllRecords('provider')
+    testProviders.push(await setupDone.helpers.createRecord('provider', testProviderData.spectre))
+    await setupDone.helpers.removeAllRecords('category')
+    testCategories.push(await setupDone.helpers.createRecord('category', testCategoryData.construction))
+    structureController = structureController(setupDone.dataSource)
+
+    const framework = JSON.parse(JSON.stringify(testData.builders))
+    framework.cat = mongoose.Types.ObjectId(testCategories[0].id)
+    framework.provider = mongoose.Types.ObjectId(testProviders[0].id)
+    testFrameworks.push(await setupDone.helpers.createRecord('framework', framework))
+  })
+
+  describe('populateFrameworkReferences', () => {
+    it('should return referenced objects and remove ids', done => {
+      let result = structureController.populateFrameworkReferences(testFrameworks.map(f => f.toJSON()), testCategories.map(c => c.toJSON()), testProviders.map(p => p.toJSON()))
+      expect(result.length).to.equal(1)
+      expect(result[0]).to.not.have.property('_id')
+      expect(result[0].cat).to.be.an('object')
+      expect(result[0].cat).to.not.have.property('_id')
+      expect(result[0].provider).to.be.an('object')
+      expect(result[0].provider).to.not.have.property('_id')
+      done()
+    })
+  })
+})

api/test/services.webhookService.test.js

@@ -0,0 +1,49 @@
+const sinon = require('sinon')
+
+const testData = require('./testdata/frameworks.json')
+
+describe('webhookService', () => {
+  let https
+  let webhookService
+  let testFramework
+  let stub
+  let env
+
+  before(() => {
+    https = require('https')
+    stub = sinon.stub(https, 'request').returns({
+      on() {},
+      write() {},
+      end() {}
+    })
+    webhookService = require('../services/webhookService')
+    testFramework = testData.builders
+    env = process.env
+    process.env = {
+      GHBS_WEBHOOK_SECRET: 'secret',
+      GHBS_WEBHOOK_ENDPOINT: 'endpoint'
+    }
+  })
+
+  describe('send', () => {
+    it('sends a post request to the webhook endpoint', () => {
+      webhookService.send(testFramework)
+
+      const options = {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'Content-Length': 664,
+          'Authorization': 'Token secret'
+        }
+      }
+
+      sinon.assert.calledOnce(https.request)
+      sinon.assert.calledWith(stub, 'endpoint', options, sinon.match.any)
+    })
+  })
+
+  after(() => {
+    process.env = env
+  })
+})

package.json

@@ -18,6 +18,7 @@
   "dependencies": {
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
+    "eslint": "^6.1.0",
     "express": "^4.17.1",
     "express-basic-auth": "^1.2.0",
     "govuk-frontend": "^2.13.0",
@@ -26,16 +27,16 @@
     "lodash.template": ">=4.5.0",
     "md5": "^2.2.1",
     "moment": "^2.24.0",
-    "mongoose": "^5.5.13",
-    "node-sass": "^4.12.0",
+    "mongoose": "^5.13.14",
     "query-string": "^6.8.1",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",
     "react-redux": "^7.1.0",
     "react-router-dom": "^5.0.1",
-    "react-scripts": "3.0.1",
+    "react-scripts": "3.1.1",
     "redux": "^4.0.1",
     "redux-thunk": "^2.3.0",
+    "sass": "^1.52.3",
     "serve-static": "^1.14.1",
     "url-join": "^4.0.1"
   },
@@ -76,6 +77,7 @@
     "node-env-run": "^3.0.2",
     "nodemon": "^1.19.1",
     "puppeteer": "^1.19.0",
+    "sinon": "^14.0.0",
     "superagent": "^5.1.0"
   }
 }