Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Minor improvements to Error Handling docs #137

Merged
merged 1 commit into from
Oct 13, 2023
Merged

doc: Minor improvements to Error Handling docs #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 7 additions & 14 deletions Mediator-Error_Handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,17 @@ This table defines the expected behavior of the mediator in different scenarios
- **G2** - Receive a message for an unsupported protocol
https://input-output.atlassian.net/browse/ATL-5840
- G2A - ignore (no effect/output)
- G2B - Send a problem report "e.p.msg.unsupported"
- G2B - Send a problem report `e.p.msg.unsupported`

- **G3** - Receive a message for an unsupported unsupported version of the protocol.
- **G3** - Receive a message for an unsupported version of the protocol.
- G2B - Fallback to G2
- G3B - Send `e.p.msg.unsupported` and say what version(s) its supported
- G3B - Send a problem report `e.p.msg.unsupported` and say what version(s) its supported

- **G4** - When an internal error or any unexpected error happens.
- G4A - ignore (no effect/output)
- G4B - Send a problem report "e.p.error"

- **G5** - If the message is tampered (or it throws any crypto errors).
- **G5** - If the message is tampered or got any crypto errors when decoding.
- G5A - ignore (no effect/output)
- G5B - (sync!) Send a problem report "e.p.crypto"

Expand All @@ -66,13 +66,8 @@ This table defines the expected behavior of the mediator in different scenarios

- **G8** - When a parsing error from the decrypted message.
- G8A - ignore (no effect/output)
- G8B - (sync!) Send an `e.p.msg` If the plaintext message is malformed
- G8C - Send an `e.p.msg.<PIURI>` If the plaintext message is malformed or if parsing into a specific protocol's data model fails.


- Receive a problem report (1w):
- in case of Warnings Reply `w.p` -> log warnings and escalate to an error `e.p` on the reply
- in case of Error `e.p` -> log error
- G8B - (sync!) Send a problem report `e.p.msg` if the plaintext message is malformed
- G8C - Send a problem report `e.p.msg.<PIURI>` if the plaintext message is malformed or if parsing into a specific protocol's data model fails.

#### Mediator especific Scenarios:

Expand All @@ -99,8 +94,6 @@ This table defines the expected behavior of the mediator in different scenarios
- M5A - If the connection supports live delivery respond with a [`status`](https://didcomm.org/messagepickup/3.0/status) message.
- M5B - If the connection is incapable of live delivery send a problem report `e.m.live-mode-not-supported`



### Considerations

In the Atala PRISM Mediator, when an issue arises, we undertake the following steps:
Expand Down Expand Up @@ -226,4 +219,4 @@ stateDiagram-v2
request_processing -->Sender: Problem report Signed message reply sync (4)
forward_message_stored --> [*]
class request_processing processing
```
```