amethyst / amethyst/serde-diff

Derived "apply" implementation for enums is broken

Open
#35 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Rust
Stars
127
Forks
21
PR merge metrics
No merged PRs in 30d

Description

When diffing an enum like:
```rust
#[derive(SerdeDiff, Serialize, Deserialize, Debug, PartialEq, Clone)]
enum Value {
Str(String),
Int(i32),
}
```

Let's say we have the diff `Value::Str("A") -> Value::Str("B")`.

The diff implementation will produce the following sequence of commands:
```rust
[{"Enter":{"EnumVariant":"Str"}},{"Enter":{"FieldIndex":0}},{"Value":"B"},"Exit"]
```

However, the apply implementation does not consume the final `Exit` command, causing the rest of the command stream to get out of sync.

This is because of this code:
https://github.com/amethyst/serde-diff/blob/e461da41c9339af3ecadf9f4aa61ae91c1f79e97/serde-diff-derive/src/serde_diff/mod.rs#L362-L379

Specifically it's because `next_path_element` is only called once, instead of being called until it finds an `Exit` command. It makes sense to only call it once because an enum can only have one variant, but since the variant still counts as a path segment, an additional Exit should be consumed.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.