skip serializing struct fields that are None

Right now it writes something like: {"foobar": null} which might work with the actual Python API code, but is unnecessarily verbose, and doesn't work with our own deserializer, and round-tripping is a desirable feature. We could change the deserializers to accept `null` as a value for `Option` types (maybe even in addition to this change) but the API doesn't send JSON that way and IMO it's unnecessary to be able to read that in.

Author: wfraser

RELEASE_NOTES.md

@@ -5,6 +5,8 @@ xxxx-yy-zz
  * 2021-06-30: (breaking change) remove deprecated sharing::change_file_member_access
  function and associated structs
  * 2021-07-08: sharing namespace additions
+* Changed struct serialization to not emit fields at all where the value is `None`.
+ * (previously it emitted `null` into the JSON as the value of the fields)
 
 # v0.11.3
 2021-05-08

generator/rust.stoneg.py

@@ -428,13 +428,13 @@ def _impl_serde_for_struct(self, struct):
  u'Result<(), S::Error>',
  access=u'pub(crate)'):
  self.emit(u'use serde::ser::SerializeStruct;')
- self.generate_multiline_list(
- list(u's.serialize_field("{}", &self.{})'
-  .format(field.name, self.field_name(field))
- for field in struct.all_fields),
- delim=(u'', u''),
- sep='?;',
-  skip_last_sep=True)
+ for field in struct.all_fields:
+ if ir.is_nullable_type(field.data_type):
+ with self.block(u'if let Some(val) = &self.{}'.format(self.field_name(field))):
+  self.emit(u's.serialize_field("{}", val)?;'.format(field.name))
+ else:
+  self.emit(u's.serialize_field("{}", &self.{})?;'.format(field.name, self.field_name(field)))
+ self.emit(u'Ok(())')
  self.emit()
  with self._impl_deserialize(self.struct_name(struct)):
  self.emit(u'// struct deserializer')

src/generated/account.rs

@@ -141,7 +141,8 @@ impl SetProfilePhotoArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("photo", &self.photo)
+ s.serialize_field("photo", &self.photo)?;
+ Ok(())
  }
 }
 
@@ -342,7 +343,8 @@ impl SetProfilePhotoResult {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("profile_photo_url", &self.profile_photo_url)
+ s.serialize_field("profile_photo_url", &self.profile_photo_url)?;
+ Ok(())
  }
 }
 

src/generated/auth.rs

@@ -504,7 +504,8 @@ impl RateLimitError {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("reason", &self.reason)?;
- s.serialize_field("retry_after", &self.retry_after)
+ s.serialize_field("retry_after", &self.retry_after)?;
+ Ok(())
  }
 }
 
@@ -672,7 +673,8 @@ impl TokenFromOAuth1Arg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("oauth1_token", &self.oauth1_token)?;
- s.serialize_field("oauth1_token_secret", &self.oauth1_token_secret)
+ s.serialize_field("oauth1_token_secret", &self.oauth1_token_secret)?;
+ Ok(())
  }
 }
 
@@ -840,7 +842,8 @@ impl TokenFromOAuth1Result {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("oauth2_token", &self.oauth2_token)
+ s.serialize_field("oauth2_token", &self.oauth2_token)?;
+ Ok(())
  }
 }
 
@@ -930,7 +933,8 @@ impl TokenScopeError {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("required_scope", &self.required_scope)
+ s.serialize_field("required_scope", &self.required_scope)?;
+ Ok(())
  }
 }
 

src/generated/check.rs

@@ -97,7 +97,8 @@ impl EchoArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("query", &self.query)
+ s.serialize_field("query", &self.query)?;
+ Ok(())
  }
 }
 
@@ -184,7 +185,8 @@ impl EchoResult {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("result", &self.result)
+ s.serialize_field("result", &self.result)?;
+ Ok(())
  }
 }
 

src/generated/common.rs

@@ -357,7 +357,8 @@ impl TeamRootInfo {
  use serde::ser::SerializeStruct;
  s.serialize_field("root_namespace_id", &self.root_namespace_id)?;
  s.serialize_field("home_namespace_id", &self.home_namespace_id)?;
- s.serialize_field("home_path", &self.home_path)
+ s.serialize_field("home_path", &self.home_path)?;
+ Ok(())
  }
 }
 
@@ -464,7 +465,8 @@ impl UserRootInfo {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("root_namespace_id", &self.root_namespace_id)?;
- s.serialize_field("home_namespace_id", &self.home_namespace_id)
+ s.serialize_field("home_namespace_id", &self.home_namespace_id)?;
+ Ok(())
  }
 }
 

src/generated/contacts.rs

@@ -93,7 +93,8 @@ impl DeleteManualContactsArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("email_addresses", &self.email_addresses)
+ s.serialize_field("email_addresses", &self.email_addresses)?;
+ Ok(())
  }
 }
 

src/generated/dbx_async.rs

@@ -199,7 +199,8 @@ impl PollArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("async_job_id", &self.async_job_id)
+ s.serialize_field("async_job_id", &self.async_job_id)?;
+ Ok(())
  }
 }
 

src/generated/file_properties.rs

@@ -367,7 +367,8 @@ impl AddPropertiesArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("path", &self.path)?;
- s.serialize_field("property_groups", &self.property_groups)
+ s.serialize_field("property_groups", &self.property_groups)?;
+ Ok(())
  }
 }
 
@@ -647,7 +648,8 @@ impl AddTemplateArg {
  use serde::ser::SerializeStruct;
  s.serialize_field("name", &self.name)?;
  s.serialize_field("description", &self.description)?;
- s.serialize_field("fields", &self.fields)
+ s.serialize_field("fields", &self.fields)?;
+ Ok(())
  }
 }
 
@@ -739,7 +741,8 @@ impl AddTemplateResult {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("template_id", &self.template_id)
+ s.serialize_field("template_id", &self.template_id)?;
+ Ok(())
  }
 }
 
@@ -831,7 +834,8 @@ impl GetTemplateArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("template_id", &self.template_id)
+ s.serialize_field("template_id", &self.template_id)?;
+ Ok(())
  }
 }
 
@@ -948,7 +952,8 @@ impl GetTemplateResult {
  use serde::ser::SerializeStruct;
  s.serialize_field("name", &self.name)?;
  s.serialize_field("description", &self.description)?;
- s.serialize_field("fields", &self.fields)
+ s.serialize_field("fields", &self.fields)?;
+ Ok(())
  }
 }
 
@@ -1192,7 +1197,8 @@ impl ListTemplateResult {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("template_ids", &self.template_ids)
+ s.serialize_field("template_ids", &self.template_ids)?;
+ Ok(())
  }
 }
 
@@ -1667,7 +1673,8 @@ impl OverwritePropertyGroupArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("path", &self.path)?;
- s.serialize_field("property_groups", &self.property_groups)
+ s.serialize_field("property_groups", &self.property_groups)?;
+ Ok(())
  }
 }
 
@@ -1894,7 +1901,8 @@ impl PropertiesSearchArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("queries", &self.queries)?;
- s.serialize_field("template_filter", &self.template_filter)
+ s.serialize_field("template_filter", &self.template_filter)?;
+ Ok(())
  }
 }
 
@@ -1985,7 +1993,8 @@ impl PropertiesSearchContinueArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("cursor", &self.cursor)
+ s.serialize_field("cursor", &self.cursor)?;
+ Ok(())
  }
 }
 
@@ -2263,7 +2272,8 @@ impl PropertiesSearchMatch {
  s.serialize_field("id", &self.id)?;
  s.serialize_field("path", &self.path)?;
  s.serialize_field("is_deleted", &self.is_deleted)?;
- s.serialize_field("property_groups", &self.property_groups)
+ s.serialize_field("property_groups", &self.property_groups)?;
+ Ok(())
  }
 }
 
@@ -2446,7 +2456,8 @@ impl PropertiesSearchQuery {
  use serde::ser::SerializeStruct;
  s.serialize_field("query", &self.query)?;
  s.serialize_field("mode", &self.mode)?;
- s.serialize_field("logical_operator", &self.logical_operator)
+ s.serialize_field("logical_operator", &self.logical_operator)?;
+ Ok(())
  }
 }
 
@@ -2555,7 +2566,10 @@ impl PropertiesSearchResult {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("matches", &self.matches)?;
- s.serialize_field("cursor", &self.cursor)
+ if let Some(val) = &self.cursor {
+ s.serialize_field("cursor", val)?;
+ }
+ Ok(())
  }
 }
 
@@ -2661,7 +2675,8 @@ impl PropertyField {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("name", &self.name)?;
- s.serialize_field("value", &self.value)
+ s.serialize_field("value", &self.value)?;
+ Ok(())
  }
 }
 
@@ -2780,7 +2795,8 @@ impl PropertyFieldTemplate {
  use serde::ser::SerializeStruct;
  s.serialize_field("name", &self.name)?;
  s.serialize_field("description", &self.description)?;
- s.serialize_field("type", &self.type_field)
+ s.serialize_field("type", &self.type_field)?;
+ Ok(())
  }
 }
 
@@ -2888,7 +2904,8 @@ impl PropertyGroup {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("template_id", &self.template_id)?;
- s.serialize_field("fields", &self.fields)
+ s.serialize_field("fields", &self.fields)?;
+ Ok(())
  }
 }
 
@@ -3006,7 +3023,8 @@ impl PropertyGroupTemplate {
  use serde::ser::SerializeStruct;
  s.serialize_field("name", &self.name)?;
  s.serialize_field("description", &self.description)?;
- s.serialize_field("fields", &self.fields)
+ s.serialize_field("fields", &self.fields)?;
+ Ok(())
  }
 }
 
@@ -3132,8 +3150,13 @@ impl PropertyGroupUpdate {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("template_id", &self.template_id)?;
- s.serialize_field("add_or_update_fields", &self.add_or_update_fields)?;
- s.serialize_field("remove_fields", &self.remove_fields)
+ if let Some(val) = &self.add_or_update_fields {
+ s.serialize_field("add_or_update_fields", val)?;
+ }
+ if let Some(val) = &self.remove_fields {
+ s.serialize_field("remove_fields", val)?;
+ }
+ Ok(())
  }
 }
 
@@ -3294,7 +3317,8 @@ impl RemovePropertiesArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("path", &self.path)?;
- s.serialize_field("property_template_ids", &self.property_template_ids)
+ s.serialize_field("property_template_ids", &self.property_template_ids)?;
+ Ok(())
  }
 }
 
@@ -3522,7 +3546,8 @@ impl RemoveTemplateArg {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("template_id", &self.template_id)
+ s.serialize_field("template_id", &self.template_id)?;
+ Ok(())
  }
 }
 
@@ -3911,7 +3936,8 @@ impl UpdatePropertiesArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("path", &self.path)?;
- s.serialize_field("update_property_groups", &self.update_property_groups)
+ s.serialize_field("update_property_groups", &self.update_property_groups)?;
+ Ok(())
  }
 }
 
@@ -4226,9 +4252,16 @@ impl UpdateTemplateArg {
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
  s.serialize_field("template_id", &self.template_id)?;
- s.serialize_field("name", &self.name)?;
- s.serialize_field("description", &self.description)?;
- s.serialize_field("add_fields", &self.add_fields)
+ if let Some(val) = &self.name {
+ s.serialize_field("name", val)?;
+ }
+ if let Some(val) = &self.description {
+ s.serialize_field("description", val)?;
+ }
+ if let Some(val) = &self.add_fields {
+ s.serialize_field("add_fields", val)?;
+ }
+ Ok(())
  }
 }
 
@@ -4320,7 +4353,8 @@ impl UpdateTemplateResult {
  s: &mut S::SerializeStruct,
  ) -> Result<(), S::Error> {
  use serde::ser::SerializeStruct;
- s.serialize_field("template_id", &self.template_id)
+ s.serialize_field("template_id", &self.template_id)?;
+ Ok(())
  }
 }