feat: more audit events (#364)

* added headers to close settlement window function call * fixed headers to settlement close for eventsdk and added more audit events
mojaloop · Jul 16, 2021 · acf5d5b · acf5d5b
1 parent 3771515
commit acf5d5b
Show file tree

Hide file tree

Showing 10 changed files with 155 additions and 11 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "central-settlement",
     "description": "Central settlements hosted by a scheme to record and make settlements.",
-    "version": "13.3.2",
+    "version": "13.4.0",
     "license": "Apache-2.0",
     "private": false,
     "author": "ModusBox",

diff --git a/src/api/handlers/settlementWindows.js b/src/api/handlers/settlementWindows.js
@@ -34,6 +34,9 @@
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const settlementWindows = require('../../domain/settlementWindow/index')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlementWindows
@@ -48,6 +51,17 @@ module.exports = {
      */
   get: async function getSettlementWindowsByParams (request, h) {
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT_WINDOW,
+        Enum.Events.Event.Action.GET,
+        undefined,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
+
       const Enums = await request.server.methods.enums('settlementWindowStates')
       const settlementWindowResult = await settlementWindows.getByParams({ query: request.query }, Enums)
       return h.response(settlementWindowResult)

diff --git a/src/api/handlers/settlementWindows/{id}.js b/src/api/handlers/settlementWindows/{id}.js
@@ -33,6 +33,9 @@
 
 const settlementWindow = require('../../../domain/settlementWindow/index')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlementWindows/{id}
@@ -48,6 +51,16 @@ module.exports = {
   get: async function getSettlementWindowById (request, h) {
     const settlementWindowId = request.params.id
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT_WINDOW,
+        Enum.Events.Event.Action.GET,
+        `settlementWindowId=${settlementWindowId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const Enums = await request.server.methods.enums('settlementWindowStates')
       const settlementWindowResult = await settlementWindow.getById({ settlementWindowId }, Enums, request.server.log)
       return h.response(settlementWindowResult)
@@ -67,8 +80,18 @@ module.exports = {
     const { reason } = request.payload
     const settlementWindowId = request.params.id
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT_WINDOW,
+        Enum.Events.Event.Action.POST,
+        `settlementWindowId=${settlementWindowId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const Enums = await request.server.methods.enums('settlementWindowStates')
-      return await settlementWindow.process({ settlementWindowId, reason, request }, Enums)
+      return await settlementWindow.process({ settlementWindowId, reason, headers: request.raw.req.headers }, Enums)
     } catch (err) {
       request.server.log('error', err)
       return ErrorHandler.Factory.reformatFSPIOPError(err)

diff --git a/src/api/handlers/settlements.js b/src/api/handlers/settlements.js
@@ -34,6 +34,9 @@
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Settlements = require('../../domain/settlement/index')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlements
@@ -48,6 +51,17 @@ module.exports = {
      */
   get: async function getSettlementsByParams (request, h) {
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.GET,
+        undefined,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
+
       const Enums = await request.server.methods.enums('settlementStates')
       const settlementResult = await Settlements.getSettlementsByParams({ query: request.query }, Enums)
       return h.response(settlementResult)
@@ -63,8 +77,20 @@ module.exports = {
      * produces: application/json
      * responses: 200, 400, 401, 404, 415, default
      */
+
   post: async function createSettlementEvent (request, h) {
     try {
+      const { span, payload, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.POST,
+        payload.settlementWindows.map(id => id.id).join(''),
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
+
       const Enums = {
         ledgerEntryTypes: await request.server.methods.enums('ledgerEntryTypes'),
         settlementDelay: await request.server.methods.enums('settlementDelay'),

diff --git a/src/api/handlers/settlements/{id}.js b/src/api/handlers/settlements/{id}.js
@@ -35,6 +35,9 @@
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Logger = require('@mojaloop/central-services-logger')
 const Settlements = require('../../../domain/settlement/index')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlements/{id}
@@ -50,6 +53,17 @@ module.exports = {
   get: async function getSettlementById (request, h) {
     const settlementId = request.params.id
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.GET,
+        `sid=${settlementId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
+
       const Enums = await request.server.methods.enums('settlementStates')
       request.server.log('info', `get settlement by Id requested with id ${settlementId}`)
       const settlementResult = await Settlements.getById({ settlementId }, Enums)
@@ -70,6 +84,17 @@ module.exports = {
   put: async function updateSettlementById (request) {
     const settlementId = request.params.id
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.PUT,
+        `sid=${settlementId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
+
       const p = request.payload
       if (p.participants && (p.state || p.reason || p.externalReference)) {
         throw ErrorHandler.Factory.createFSPIOPError(ErrorHandler.Enums.FSPIOPErrorCodes.VALIDATION_ERROR, 'No other properties are allowed when participants is provided')

diff --git a/src/api/handlers/settlements/{sid}/participants/{pid}.js b/src/api/handlers/settlements/{sid}/participants/{pid}.js
@@ -34,6 +34,9 @@
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Settlements = require('../../../../../domain/settlement/index')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlements/{settlementId}/participants/{participantId}
@@ -49,12 +52,22 @@ module.exports = {
 
   get: async function getSettlementBySettlementParticipantAccount (request, h) {
     try {
+      const settlementId = request.params.sid
+      const participantId = request.params.pid
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.GET,
+        `sid=${settlementId};pid=${participantId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const Enums = {
         settlementWindowStates: await request.server.methods.enums('settlementWindowStates'),
         ledgerAccountTypes: await request.server.methods.enums('ledgerAccountTypes')
       }
-      const settlementId = request.params.sid
-      const participantId = request.params.pid
       const result = await Settlements.getByIdParticipantAccount({ settlementId, participantId }, Enums)
       return h.response(result)
     } catch (err) {
@@ -74,6 +87,16 @@ module.exports = {
     const settlementId = request.params.sid
     const participantId = request.params.pid
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.PUT,
+        `sid=${settlementId};pid=${participantId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const p = request.payload
       const universalPayload = {
         participants: [

diff --git a/src/api/handlers/settlements/{sid}/participants/{pid}/accounts/{aid}.js b/src/api/handlers/settlements/{sid}/participants/{pid}/accounts/{aid}.js
@@ -28,6 +28,9 @@
 
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
 const Settlements = require('../../../../../../../domain/settlement/index')
+const Utility = require('@mojaloop/central-services-shared').Util
+const Enum = require('@mojaloop/central-services-shared').Enum
+const EventSdk = require('@mojaloop/event-sdk')
 
 /**
  * Operations on /settlements/{settlementId}/participants/{participantId}/accounts/{accountId}
@@ -43,13 +46,23 @@ module.exports = {
 
   get: async function getSettlementBySettlementParticipantAccount (request, h) {
     try {
+      const settlementId = request.params.sid
+      const participantId = request.params.pid
+      const accountId = request.params.aid
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.GET,
+        `sid=${settlementId};pid=${participantId};aid=${accountId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const Enums = {
         settlementWindowStates: await request.server.methods.enums('settlementWindowStates'),
         ledgerAccountTypes: await request.server.methods.enums('ledgerAccountTypes')
       }
-      const settlementId = request.params.sid
-      const participantId = request.params.pid
-      const accountId = request.params.aid
       const result = await Settlements.getByIdParticipantAccount({ settlementId, participantId, accountId }, Enums)
       return h.response(result)
     } catch (err) {
@@ -70,6 +83,16 @@ module.exports = {
     const participantId = request.params.pid
     const accountId = request.params.aid
     try {
+      const { span, headers } = request
+      const spanTags = Utility.EventFramework.getSpanTags(
+        Enum.Events.Event.Type.SETTLEMENT,
+        Enum.Events.Event.Action.PUT,
+        `sid=${settlementId};pid=${participantId};aid=${accountId}`,
+        headers[Enum.Http.Headers.FSPIOP.SOURCE],
+        headers[Enum.Http.Headers.FSPIOP.DESTINATION]
+      )
+      span.setTags(spanTags)
+      await span.audit(request.payload, EventSdk.AuditEventAction.ingress)
       const accounts = [Object.assign({}, request.payload, { id: accountId })]
       const universalPayload = {
         participants: [

diff --git a/src/domain/settlementWindow/index.js b/src/domain/settlementWindow/index.js
@@ -92,13 +92,12 @@ module.exports = {
 
   process: async function (params, enums) {
     const settlementWindowId = await SettlementWindowModel.process(params, enums)
-
     const messageId = Uuid()
     const eventId = Uuid()
     const state = StreamingProtocol.createEventState(Enum.Events.EventStatus.SUCCESS.status, Enum.Events.EventStatus.SUCCESS.code, Enum.Events.EventStatus.SUCCESS.description)
     const event = StreamingProtocol.createEventMetadata(Enum.Events.Event.Type.DEFERRED_SETTLEMENT, Enum.Events.Event.Action.CLOSE, state)
     const metadata = StreamingProtocol.createMetadata(eventId, event)
-    const messageProtocol = StreamingProtocol.createMessage(messageId, Enum.Http.Headers.FSPIOP.SWITCH.value, Enum.Http.Headers.FSPIOP.SWITCH.value, metadata, params.request.headers, params)
+    const messageProtocol = StreamingProtocol.createMessage(messageId, Enum.Http.Headers.FSPIOP.SWITCH.value, Enum.Http.Headers.FSPIOP.SWITCH.value, metadata, params.headers, params)
     const topicConfig = KafkaUtil.createGeneralTopicConf(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.DEFERRED_SETTLEMENT, Enum.Events.Event.Action.CLOSE)
     const kafkaConfig = KafkaUtil.getKafkaConfig(Config.KAFKA_CONFIG, Enum.Kafka.Config.PRODUCER, Enum.Events.Event.Type.DEFERRED_SETTLEMENT.toUpperCase(), Enum.Events.Event.Action.CLOSE.toUpperCase())
     await Producer.produceMessage(messageProtocol, topicConfig, kafkaConfig)

diff --git a/src/interface/swagger.json b/src/interface/swagger.json
@@ -52,7 +52,8 @@
                     }
                 ],
                 "tags": [
-                    "getSettlementWindowById"
+                    "getSettlementWindowById",
+                    "sampled"
                 ],
                 "responses": {
                     "200": {
@@ -122,6 +123,7 @@
                     }
                 ],
                 "tags": [
+  "sampled",
                     "closeSettlementWindow"
                 ],
                 "responses": {
@@ -221,6 +223,7 @@
 
                 ],
                 "tags": [
+                    "sampled",
                     "getSettlementWindowsByParams"
                 ],
                 "responses": {
@@ -351,6 +354,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "getSettlementsByParams"
                 ],
                 "responses": {
@@ -415,6 +419,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "createSettlement"
                 ],
                 "responses": {
@@ -476,6 +481,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "getSettlementById"
                 ],
                 "responses": {
@@ -547,6 +553,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "updateSettlementById"
                 ],
                 "responses": {
@@ -615,6 +622,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "getSettlementBySettlementParticipant"
                 ],
                 "responses": {
@@ -693,6 +701,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "updateSettlementBySettlementParticipant"
                 ],
                 "responses": {
@@ -768,6 +777,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "getSettlementBySettlementParticipantAccount"
                 ],
                 "responses": {
@@ -853,6 +863,7 @@
                     }
                 ],
                 "tags": [
+                    "sampled",
                     "updateSettlementBySettlementParticipantAccount"
                 ],
                 "responses": {