Include function parameters in error messages

For debugging purposes, it's important that error messages include as much relevant information as possible. It's much easier to help a user if they can pass on an accurate error message that they received. But precisely because the messages should be in a form where the user can share it without worrying about leaking secrets (and because such errors may end up in logs that could leak), the messages must not include any confidential data. They should also not be unnecessarily verbose. To implement this, we add the "debug" serialization of the functions' input values to the error message that's returned if the call fails. We use the 'derivative' crate to "redact" fields containing secret or verbose data (i.e. they render as "...").
Concordium · Apr 29, 2024 · 388bcb7 · 388bcb7
1 parent 33eb749
commit 388bcb7
Show file tree

Hide file tree

Showing 4 changed files with 310 additions and 32 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,6 +7,7 @@ edition = "2021"
 crate-type = ["staticlib", "lib"]
 
 [dependencies]
+derivative = "2.2.0"
 thiserror = "1"
 uniffi = { version = "0.26", features = ["cli"] }
 serde = "1.0"