feat: introduce no-cid-as-bytes feature #23
Conversation
This commit changes the default behaviour of the deserializer. It's now possible to deserialize CIDs into bytes. This is needed in order to have the Serde derives for internally tagged and untagged enums working correctly. If you need the current behaviour of erroring at run-time in case a CID is tried to be deserialized as bytes, you can enable the `no-cid-as-bytes` feature. BREAKING CHANGE: CIDs may be deserialized into bytes. In order to restore the original behaviour, enable the `no-cid-as-bytes` feature.
I think if you want to go with this as the default and document it like this you're going to have to demonstrate how this might happen. It's still a little bit lost on me how this will happen, is it simply that I may have a #[derive(Debug, Deserialize, PartialEq)]
pub enum Boop {
Cid(Vec<u8>),
}And that receives the raw bytes? It seems like users might need guidance on the subtleties here since many are not going to be as familiar with the internals of serde that may this a problem. Perhaps even some test cases for both feature on and feature off that show how this can happen. |
Tests for both cases are part of this PR. |
tests/cid.rs
Outdated
| #[derive(Debug, Deserialize)] | ||
| struct NewType(ByteBuf); | ||
|
|
||
| #[derive(Debug, Deserialize)] | ||
| #[serde(untagged)] | ||
| enum BytesInEnum { | ||
| MyCid(NewType), | ||
| } |
There was a problem hiding this comment.
What I'm interested in is what happens when you do this without the feature. Can you add a test for that with these types and run the assertions as expected but also document that this behaviour may be undesirable? This is the key point of the issue right here, isn't it?
There was a problem hiding this comment.
@rvagg sorry for the delay, I've pushed a new commit which should address your concerns. If not, please let me know.
Co-authored-by: Rod Vagg <[email protected]>
This commit changes the default behaviour of the deserializer. It's now possible to deserialize CIDs into bytes. This is needed in order to have the Serde derives for internally tagged and untagged enums working correctly.
If you need the current behaviour of erroring at run-time in case a CID is tried to be deserialized as bytes, you can enable the
no-cid-as-bytesfeature.BREAKING CHANGE: CIDs may be deserialized into bytes. In order to restore the original behaviour, enable the
no-cid-as-bytesfeature.