docs-pages icon indicating copy to clipboard operation
docs-pages copied to clipboard

Add FAQs for debugging msgpack serialization issues

Open ThetaSinner opened this issue 1 year ago • 5 comments

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 avatar Apr 10 '24 15:04 ThetaSinner

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

ThetaSinner avatar Apr 10 '24 15:04 ThetaSinner

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

github-actions[bot] avatar May 11 '24 02:05 github-actions[bot]

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

ThetaSinner avatar Jun 13 '24 15:06 ThetaSinner

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

github-actions[bot] avatar Jul 14 '24 02:07 github-actions[bot]

Essentially write a tutorial for how to convert message pack bytes into JSON to understand the error output.

jost-s avatar Nov 19 '24 15:11 jost-s