Add serialization-control enum for RPC Options #27676

CriesofCarrots · 2022-09-08T19:59:15Z

Problem

As per #27601 (comment), it would be helpful to have complete control over the serialization of optional fields for JSON-RPC responses.

Summary of Changes

Add OptionSerializer enum and custom Serialize implementation to support skipping, serializing the type default, and serializing None for the same field in different contexts.

CriesofCarrots · 2022-09-08T20:02:56Z

@jstarry can you please take a look? Interested in feedback on direction and the api interface, as well as any bikeshedding. I used the new enum for a couple fields in UiTransactionStatusMeta to demonstrate the api, but can flesh out that whole struct before merge.

transaction-status/src/option_serializer.rs

transaction-status/src/lib.rs

transaction-status/src/option_serializer.rs

transaction-status/src/lib.rs

transaction-status/src/option_serializer.rs

transaction-status/src/lib.rs

transaction-status/src/option_serializer.rs

jstarry

Can you please add tests which enforce the expected json responses of relevant rpc responses?

…ctors

CriesofCarrots · 2022-09-14T19:10:55Z

Can you please add tests which enforce the expected json responses of relevant rpc responses?

Please see first two commits. The tests pass both before and after the other commits in this PR.

* Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07) # Conflicts: # cli-output/src/display.rs # client/src/mock_sender.rs # transaction-status/src/lib.rs

* Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07)

* Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07) # Conflicts: # cli-output/src/display.rs # client/src/mock_sender.rs # transaction-status/src/lib.rs

) * Add serialization-control enum for RPC Options (#27676) * Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07) * Appease incorrect nightly lint Co-authored-by: Tyera Eulberg <[email protected]>

) * Add serialization-control enum for RPC Options (#27676) * Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07) # Conflicts: # cli-output/src/display.rs # client/src/mock_sender.rs # transaction-status/src/lib.rs * Fix conflicts Co-authored-by: Tyera Eulberg <[email protected]>

) * Add serialization-control enum for RPC Options (#27676) * Add test to verify output when deserializing/reserializing empty fields * Add test to verify serialization from UiTransactionStatusMeta constructors * Add OptionSerializer * Use OptionSerializer for inner_instructions * Use OptionSerializer for loaded_addresses * Remove Default variant, use into instead * Add as_ref implementation * Use OptionSerializer for log_messages and rewards * Use OptionSerializer for token_balances * Use OptionSerializer for return_data * Use OptionSerializer for compute_units_consumed (cherry picked from commit 360ca07) # Conflicts: # cli-output/src/display.rs # client/src/mock_sender.rs # transaction-status/src/lib.rs * Fix conflicts

CriesofCarrots force-pushed the tx-meta-serde branch from b14e2a2 to 70f6492 Compare September 8, 2022 19:59

CriesofCarrots force-pushed the tx-meta-serde branch 3 times, most recently from 1877241 to e655277 Compare September 8, 2022 23:48

jstarry reviewed Sep 12, 2022

View reviewed changes

transaction-status/src/option_serializer.rs Outdated Show resolved Hide resolved

transaction-status/src/option_serializer.rs Outdated Show resolved Hide resolved

transaction-status/src/lib.rs Show resolved Hide resolved

CriesofCarrots commented Sep 13, 2022

View reviewed changes

transaction-status/src/option_serializer.rs Outdated Show resolved Hide resolved

CriesofCarrots force-pushed the tx-meta-serde branch from fff8b45 to 5bbc93c Compare September 13, 2022 16:35

CriesofCarrots added v1.13 labels Sep 13, 2022

CriesofCarrots force-pushed the tx-meta-serde branch 4 times, most recently from 09d2174 to aeb16ee Compare September 14, 2022 01:36

CriesofCarrots marked this pull request as ready for review September 14, 2022 01:48

CriesofCarrots requested a review from jstarry September 14, 2022 01:48