chore(mojaloop#2882): update bulk transfer timeout seq diagrams (#386)

* chore: update bulk transfer timeout seq diagrams * chore: address comments
mojaloop · Aug 18, 2022 · 627ed1f · 627ed1f
1 parent 39491c0
commit 627ed1f
Show file tree

Hide file tree

Showing 4 changed files with 1,078 additions and 1,748 deletions.
diff --git a/.../central-bulk-transfers/assets/diagrams/sequence/seq-bulk-3.1.0-timeout-overview.plantuml b/.../central-bulk-transfers/assets/diagrams/sequence/seq-bulk-3.1.0-timeout-overview.plantuml
@@ -103,13 +103,123 @@ group Transfer Expiry
         |||
         TOPIC_NOTIFICATIONS <- NOTIFY_HANDLER: Consume message
         ref over DFSP1, TOPIC_NOTIFICATIONS : Send notification to Participant (Payer)\n
+        alt Timeout before any processing
+            note left of NOTIFY_HANDLER #yellow
+                PUT /bulkTransfers/<ID>
+                {
+                    headers: <bulkTransferHeaders>,
+                    body: {
+                        "bulkTransferState": "COMPLETED",
+                        "completedTimestamp": "2022-08-18T01:00:24.407Z",
+                        "individualTransferResults": [
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                        ]
+                    }
+                }
+            end note
+        else Timeout in middle of processing
+            note left of NOTIFY_HANDLER #yellow
+                PUT /bulkTransfers/<ID>
+                {
+                    headers: <bulkTransferHeaders>,
+                    body: {
+                        "bulkTransferState": "COMPLETED",
+                        "completedTimestamp": "2022-08-18T01:00:24.407Z",
+                        "individualTransferResults": [
+                            {
+                                "transferId": <ID>,
+                                "fulfilment": <fulfilment>
+                            },
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                        ]
+                    }
+                }
+            end note
+        end
         NOTIFY_HANDLER -> DFSP1: Send callback notification
     end
     |||
     opt action IN ['timeout-reserved', 'bulk-timeout-reserved']
         |||
         TOPIC_NOTIFICATIONS <- NOTIFY_HANDLER: Consume message
         ref over DFSP2, TOPIC_NOTIFICATIONS : Send notification to Participant (Payee)\n
+        alt Timeout before any processing
+            note left of NOTIFY_HANDLER #yellow
+                PUT /bulkTransfers/<ID>
+                {
+                    headers: <bulkTransferHeaders>,
+                    body: {
+                        "bulkTransferState": "COMPLETED",
+                        "completedTimestamp": "2022-08-18T01:00:24.407Z",
+                        "individualTransferResults": [
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                        ]
+                    }
+                }
+            end note
+        else Timeout in middle of processing
+            note left of NOTIFY_HANDLER #yellow
+                PUT /bulkTransfers/<ID>
+                {
+                    headers: <bulkTransferHeaders>,
+                    body: {
+                        "bulkTransferState": "COMPLETED",
+                        "completedTimestamp": "2022-08-18T01:00:24.407Z",
+                        "individualTransferResults": [
+                            {
+                                "transferId": <ID>,
+                                "fulfilment": <fulfilment>
+                            },
+                            {
+                                "errorInformation": {
+                                    "errorCode": "3303",
+                                    "errorDescription": "Transfer expired",
+                                    "extensionList": <transferMessage.extensionList>
+                                }
+                                "transferId": <ID>
+                            },
+                        ]
+                    }
+                }
+            end note
+        end
         NOTIFY_HANDLER -> DFSP2: Send callback notification
     end
 end