holochain / holochain

The current, performant & industrial strength version of Holochain on Rust.
https://holochain.org
Other
1.14k stars 139 forks source link

Add FAQs for debugging msgpack serialization issues #3596

Open ThetaSinner opened 2 months ago

ThetaSinner commented 2 months ago

We often get questions about how to debug serialization issues. The first few times you face them it can be challenging to figure out what the problem is. With msgpack being a binary protocol, it's a bit more tricky to figure out than something like JSON would be. At this point though, we (core team) have a pretty well-established process for debugging these issues. We should write these steps up as an FAQ page to help people figure these problems out.

ThetaSinner commented 2 months ago

I also got a suggestion recently from @alastairong that we make error serialization messages more readable or easier to debug. At the moment we dump the msgpack binary which you do need but it isn't readable. Perhaps we could consider dumping a readable representation, as long as that doesn't introduce more confusion with ambiguous encodings to another format like JSON. Something to think about and maybe split into another ticket at some point

github-actions[bot] commented 1 month ago

This item has been open for 30 days with no activity.

ThetaSinner commented 3 weeks ago

Depends on https://github.com/holochain/holochain/issues/3597