feat: #1869 Design for reliable notifications on finalization of a transfer

.circleci/config.yml

@@ -217,39 +217,31 @@ workflows:
     jobs:
       - pr-tools/pr-title-check:
           context: org-global
+          filters:
+            tags:
+              ignore: /.*/
+            branches:
+              ignore:
+                - master
       - setup:
           context: org-global
           filters:
             tags:
               only: /.*/
-            branches:
-              ignore:
-                - /feature.*/
-                - /bugfix.*/
-                - gh-pages
       - test-svg:
           context: org-global
           requires:
             - setup
           filters:
             tags:
               only: /.*/
-            branches:
-              ignore:
-                - /feature*/
-                - /bugfix*/
       - build:
           context: org-global
           requires:
             - setup
           filters:
             tags:
               only: /.*/
-            branches:
-              ignore:
-                - /feature.*/
-                - /bugfix.*/
-                - gh-pages
       - deploy:
           context: org-global
           requires:

.gitignore

@@ -22,3 +22,6 @@ _book
 *.log
 
 *.jar
+
+# Ignore VSCode Plantuml Image exporter
+out/**/*.*

mojaloop-technical-overview/central-ledger/assets/diagrams/sequence/seq-prepare-1.1.4.a-v1.1.plantuml

@@ -76,23 +76,18 @@ group Send notification to Participants
     activate TOPIC_NOTIFICATIONS
     deactivate TOPIC_NOTIFICATIONS
 
-    group Persist Event Information
-        NOTIFY_HANDLER -> CSAPI: Request to persist event information - POST - /events
-        activate CSAPI
-        CSAPI -> TOPIC_EVENTS: Publish event information
-        activate TOPIC_EVENTS
-        |||
-        ref over TOPIC_EVENTS :  Event Handler Consume\n
-        |||
-        TOPIC_EVENTS --> CSAPI: Return success
-        deactivate TOPIC_EVENTS
-        CSAPI --> NOTIFY_HANDLER: Return success
-        deactivate CSAPI
-    end
-    note right of NOTIFY_HANDLER #lightgray
-        The endpoint details are cached, when the cache
-        expires, the details are fetched again
+    note right of OPERATOR #yellow
+        Message:
+        {
+            payload: {
+                endpoint: {
+                    type: <typeValue>,
+                    value: <endpointValue>
+               }
+            }
+        }
     end note
+
     NOTIFY_HANDLER -> CSAPI: Request Endpoint details for Participant - GET - /participants/{{fsp}}/endpoints\n<color #FF0000><b>Error code:</b> 2003</color>
 
     activate CSAPI

mojaloop-technical-overview/notifications/assets/examples/eventNotifyCmd.example-1.json

@@ -0,0 +1,49 @@
+{
+    "msgId": "18efb9ea-d29a-42b9-9b30-59e1e7cfe216",
+    "msgKey": "861b86e6-c3da-48b3-ba17-896710287d1f",
+    "msgName": "NotifyCmd",
+    "msgType": "Command",
+    "msgTopic": "NotificationCommands",
+    "msgPartition": null, 
+    "msgTimestamp": 1607677081837, 
+    "aggregateName": "Notifications",
+    "aggregateId": "861b86e6-c3da-48b3-ba17-896710287d1f", 
+    "notifyId": "3920382d-f78c-4023-adf9-0d7a4a2a3a2f", 
+    "transport": { 
+        "type": "HTTP",
+        "method": "GET",
+        "contentType": "application/vnd.interoperability.transfers+json;version=1.0",
+        "recipient": {
+            "endpoint": "http://fsp.com/parties/{{partyIdType}}/{{partyId}}}?key={{value}}", 
+            "params": { 
+                "partyIdType": "MSISDN",
+                "partyId": "12345",
+                "value": "ABCD"
+            }
+        },
+        "options": { 
+            "deliveryReport": true, 
+            "retry": {
+                "count": 3,
+                "type": "noDelay|exponentialDelay", 
+                "condition": "isNetworkError|isIdempotentRequestError|isNetworkOrIdempotentRequestError" 
+            }
+        }
+    },
+    "payload": {
+        "headers": {
+            "content-type": "application/vnd.interoperability.transfers+json;version=1.0",
+            "date": "2019-05-28T16:34:41.000Z",
+            "fspiop-source": "payerfsp",
+            "fspiop-destination": "payerfsp"
+        },
+        "body": "data:application/vnd.interoperability.transfers+json;version=1.0;base64,ewogICJmdWxmaWxtZW50IjogIlVObEo5OGhaVFlfZHN3MGNBcXc0aV9VTjN2NHV0dDdDWkZCNHlmTGJWRkEiLAogICJjb21wbGV0ZWRUaW1lc3RhbXAiOiAiMjAxOS0wNS0yOVQyMzoxODozMi44NTZaIiwKICAidHJhbnNmZXJTdGF0ZSI6ICJDT01NSVRURUQiCn0"
+    },
+    "traceInfo": { 
+        "traceParent": "00-8e540e87060d56a2d2e0be5d732791e7-d96a5971b7c5cac6-21",
+        "traceState": "acmevendor=eyJzcGFuSWQiOiJkOTZhNTk3MWI3YzVjYWM2IiwidGltZUFwaVByZXBhcmUiOiIxNjA3Njc3MDgxNzAwIiwidGltZUFwaUZ1bGZpbCI6IjE2MDc2NzcwODE4MTkifQ==",
+        "service": "notification-evt-handler",
+        "startTimestamp": 1607677081837,
+        "finishTimestamp": 2007677081838
+    }
+}

mojaloop-technical-overview/notifications/assets/examples/notifyDelivered.example-1.json

@@ -0,0 +1,39 @@
+{
+  "msgId": "18efb9ea-d29a-42b9-9b30-59e1e7cfe216",
+  "msgKey": "861b86e6-c3da-48b3-ba17-896710287d1f",
+  "msgName": "NotifyDelivered",
+  "msgType": "Domain",
+  "msgTopic": "NotificationCommands",
+  "msgPartition": null,
+  "msgTimestamp": 2007677081820,
+  "aggregateName": "Notifications",
+  "aggregateId": "861b86e6-c3da-48b3-ba17-896710287d1f",
+  "notifyId": "3920382d-f78c-4023-adf9-0d7a4a2a3a2f",
+  "report": {
+    "requestTimestamp": 1507677081120,
+    "deliveryTimestamp": 1607677081840,
+    "deliveryReqLatency": 100,
+    "retryAttempts": 1,
+    "response": {
+      "statusCode": "202",
+      "statusDescription": "Accepted",
+      "headers": {
+        "content-type": "application/vnd.interoperability.transfers+json;version=1.0",
+        "date": "2019-05-28T16:34:41.000Z"
+      },
+      "body": "{}"
+    },
+    "accepted": true,
+    "errorInformation": {
+      "errorCode": "408",
+      "errorDescription": "ECONNABORTED\ntimeout of 2ms exceeded\nError: timeout of 2ms exceeded\n    at createError (/node_modules/axios/lib/core/createError.js:16:15)\n    at Timeout.handleRequestTimeout (/node_modules/axios/lib/adapters/http.js:252:16)\n    at listOnTimeout (timers.js:324:15)\n    at processTimers (timers.js:268:5)"
+    }
+  },
+  "traceInfo": {
+      "traceParent": "00-8e540e87060d56a2d2e0be5d732791e7-d96a5971b7c5cac6-21",
+      "traceState": "acmevendor=eyJzcGFuSWQiOiJkOTZhNTk3MWI3YzVjYWM2IiwidGltZUFwaVByZXBhcmUiOiIxNjA3Njc3MDgxNzAwIiwidGltZUFwaUZ1bGZpbCI6IjE2MDc2NzcwODE4MTkifQ==",
+      "service": "notification-Cmd-handler",
+      "startTimestamp": 1607677081837,
+      "finishTimestamp": 2007677081838
+  }
+}