support ignoring alias fields from trace registry #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ibalajiarun
force-pushed
the
balaji/trace-alias
branch
from
aefa285
to
f2b5fb6
Compare
ibalajiarun
changed the title
ibalajiarun
force-pushed
the
balaji/trace-alias
branch
from
f2b5fb6
to
856e860
Compare
ibalajiarun
force-pushed
the
balaji/trace-alias
branch
from
856e860
to
aa6c8cf
Compare
banool
approved these changes
Dec 8, 2023
| @@ -243,7 +243,7 @@ where | |||
| Option(format) => format!("Option<{}>", Self::quote_type(format, known_sizes)), | |||
| Seq(format) => format!("Vec<{}>", Self::quote_type(format, None)), | |||
| Map { key, value } => format!( | |||
| "Map<{}, {}>", | |||
There was a problem hiding this comment.
What was this Map type, I can't see any type imported with that name. I suppose it's a serde specific thing?
There was a problem hiding this comment.
Not sure either. It was failing a unit test, so I fixed it. It was failing earlier too, but I guess nobody noticed.
| @@ -243,7 +243,7 @@ where | |||
| Option(format) => format!("Option<{}>", Self::quote_type(format, known_sizes)), | |||
| Seq(format) => format!("Vec<{}>", Self::quote_type(format, None)), | |||
| Map { key, value } => format!( | |||
| "Map<{}, {}>", | |||
| "std::collections::BTreeMap<{}, {}>", | |||
There was a problem hiding this comment.
Will changing to BTreeMap change any behavior?
There was a problem hiding this comment.
Hopefully, its deterministic.
|
|
||
| if alias_formats.len() != aliases.len() { | ||
| return Err(Error::Custom(format!( | ||
| "cannot ignore alias. not all aliases are found in container: {:?}", |
There was a problem hiding this comment.
So if the user says "ignore alias x" but x isn't found, this will throw an error, is that right?
| @@ -457,3 +457,42 @@ fn test_repeated_tracing() { | |||
| )))))) | |||
| ); | |||
| } | |||
|
|
|||
| #[test] | |||
| fn test_trace_deserialization_with_alias_types() { | |||
yes, it produced the same format spec as before. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes aptos-labs/aptos-core#10424
This PR adds support for ignoring aliases of fields from the trace registry via a new API. In serde-rs/serde#2387, serde allowed both field names and aliases to be considered as field names during deserialization. This breaks the serde-reflection tracer, because it can only trace one field while it expects to trace multiple fields denoted by the field names and aliases. Also, serde doesn't currently denote whether a field is an alias or not in the Deserializer trait.
To work around this issue, this PR adds a new API
ignore_aliasesthat can be called to manually ignore the aliases in a struct container from the resource registry.This change maintains backwards compatibility in terms of generated format spec file.
Test Plan
Added unit test to reproduce the issue and use
ignore_aliasesto fix the issue.