fix roundtrip serializing for eventsub

Emilgardis · Emilgardis · commit 26ccdf6a98af · 2021-02-15T20:47:06.000+01:00
it is broken for PubSub however
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -63,6 +63,8 @@ all = ["tmi", "helix", "surf_client", "reqwest_client", "client", "pubsub", "eve
 tokio = { version = "1.2.0", features = ["rt-multi-thread", "macros"] }
 dotenv = "0.15.0"
 futures = "0.3.12"
+serde_cbor = "0.11.1"
+
 
 [build-dependencies]
 version_check = "0.9.2"
diff --git a/src/eventsub/channel/ban.rs b/src/eventsub/channel/ban.rs
@@ -85,5 +85,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/channel_points_custom_reward/add.rs b/src/eventsub/channel/channel_points_custom_reward/add.rs
@@ -124,5 +124,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/channel_points_custom_reward/remove.rs b/src/eventsub/channel/channel_points_custom_reward/remove.rs
@@ -127,5 +127,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/channel_points_custom_reward/update.rs b/src/eventsub/channel/channel_points_custom_reward/update.rs
@@ -126,5 +126,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/channel_points_custom_reward_redemption/add.rs b/src/eventsub/channel/channel_points_custom_reward_redemption/add.rs
@@ -90,5 +90,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/channel_points_custom_reward_redemption/update.rs b/src/eventsub/channel/channel_points_custom_reward_redemption/update.rs
@@ -89,5 +89,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/cheer.rs b/src/eventsub/channel/cheer.rs
@@ -76,5 +76,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/follow.rs b/src/eventsub/channel/follow.rs
@@ -67,5 +67,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/hypetrain/begin.rs b/src/eventsub/channel/hypetrain/begin.rs
@@ -84,5 +84,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/hypetrain/end.rs b/src/eventsub/channel/hypetrain/end.rs
@@ -80,5 +80,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/hypetrain/progress.rs b/src/eventsub/channel/hypetrain/progress.rs
@@ -87,5 +87,6 @@ fn parse_payload() {
     }
     "##;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/raid.rs b/src/eventsub/channel/raid.rs
@@ -72,5 +72,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/subscribe.rs b/src/eventsub/channel/subscribe.rs
@@ -76,5 +76,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/unban.rs b/src/eventsub/channel/unban.rs
@@ -76,5 +76,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/channel/update.rs b/src/eventsub/channel/update.rs
@@ -71,5 +71,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/mod.rs b/src/eventsub/mod.rs
@@ -184,6 +184,15 @@ impl<'de> Deserialize<'de> for Payload {
                 }
             }
         }
+        macro_rules! corrected {
+            ($($module:ident::$event:ident);* $(;)?) => {
+                #[derive(Deserialize)]
+                #[serde(remote = "Payload")]
+                pub enum Corrected {
+                    $($event(NotificationPayload<$module::$event>),)*
+                }
+        }
+    }
 
         #[derive(Deserialize, Clone)]
         #[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
@@ -225,14 +234,39 @@ impl<'de> Deserialize<'de> for Payload {
         #[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
         #[serde(untagged)]
         enum InternalResponse {
+            #[serde(with = "Corrected")]
+            Valid(Payload),
             VerificationRequest(VerificationRequest),
             InternalPayloadResponse(InternalPayloadResponse),
         }
 
+        corrected!(
+            channel::ChannelUpdateV1;
+                channel::ChannelFollowV1;
+                channel::ChannelSubscribeV1;
+                channel::ChannelCheerV1;
+                channel::ChannelBanV1;
+                channel::ChannelUnbanV1;
+                channel::ChannelPointsCustomRewardAddV1;
+                channel::ChannelPointsCustomRewardUpdateV1;
+                channel::ChannelPointsCustomRewardRemoveV1;
+                channel::ChannelPointsCustomRewardRedemptionAddV1;
+                channel::ChannelPointsCustomRewardRedemptionUpdateV1;
+                channel::ChannelRaidBeta;
+                channel::ChannelHypeTrainBeginV1;
+                channel::ChannelHypeTrainProgressV1;
+                channel::ChannelHypeTrainEndV1;
+                stream::StreamOnlineV1;
+                stream::StreamOfflineV1;
+                user::UserUpdateV1;
+                user::UserAuthorizationRevokeV1;
+        );
+
         let response = InternalResponse::deserialize(deserializer).map_err(|e| {
             serde::de::Error::custom(format!("could not deserialize response: {}", e))
         })?;
         match response {
+            InternalResponse::Valid(p) => Ok(p),
             InternalResponse::VerificationRequest(verification) => {
                 Ok(Payload::VerificationRequest(verification))
             }
diff --git a/src/eventsub/stream/offline.rs b/src/eventsub/stream/offline.rs
@@ -58,5 +58,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/stream/online.rs b/src/eventsub/stream/online.rs
@@ -68,5 +68,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/user/authorization.rs b/src/eventsub/user/authorization.rs
@@ -59,5 +59,6 @@ fn parse_payload() {
     }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/eventsub/user/update.rs b/src/eventsub/user/update.rs
@@ -65,5 +65,6 @@ fn parse_payload() {
 }
     "#;
 
-    dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());
+    crate::tests::roundtrip(&val)
 }
diff --git a/src/lib.rs b/src/lib.rs
@@ -183,3 +183,16 @@ impl<'a, C: HttpClient<'a>> TwitchClient<'a, C> {
         }
     }
 }
+
+#[cfg(test)]
+pub mod tests {
+    #[track_caller]
+    pub fn roundtrip<T: serde::de::DeserializeOwned + serde::Serialize>(val: &T) {
+        serde_json::from_slice::<T>(&serde_json::to_vec(val).expect("could not make into json"))
+            .expect("could not convert back from json");
+        serde_cbor::from_slice::<T>(
+            &serde_cbor::to_vec(val).expect("could not make into cbor bytes"),
+        )
+        .expect("could not convert back from cbor");
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -85,5 +85,6 @@ fn parse_payload() {`
`85`	`85`	`}`
`86`	`86`	`"#;`
`87`	`87`
`88`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`88`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`89`	`+ crate::tests::roundtrip(&val)`
`89`	`90`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,5 +124,6 @@ fn parse_payload() {`
`124`	`124`	`}`
`125`	`125`	`"##;`
`126`	`126`
`127`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`127`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`128`	`+ crate::tests::roundtrip(&val)`
`128`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -127,5 +127,6 @@ fn parse_payload() {`
`127`	`127`	`}`
`128`	`128`	`"##;`
`129`	`129`
`130`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`130`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`131`	`+ crate::tests::roundtrip(&val)`
`131`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,5 +126,6 @@ fn parse_payload() {`
`126`	`126`	`}`
`127`	`127`	`"##;`
`128`	`128`
`129`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`129`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`130`	`+ crate::tests::roundtrip(&val)`
`130`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,5 +90,6 @@ fn parse_payload() {`
`90`	`90`	`}`
`91`	`91`	`"##;`
`92`	`92`
`93`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`93`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`94`	`+ crate::tests::roundtrip(&val)`
`94`	`95`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,6 @@ fn parse_payload() {`
`89`	`89`	`}`
`90`	`90`	`"##;`
`91`	`91`
`92`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`92`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`93`	`+ crate::tests::roundtrip(&val)`
`93`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,5 +76,6 @@ fn parse_payload() {`
`76`	`76`	`}`
`77`	`77`	`"#;`
`78`	`78`
`79`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`79`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`80`	`+ crate::tests::roundtrip(&val)`
`80`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,5 +67,6 @@ fn parse_payload() {`
`67`	`67`	`}`
`68`	`68`	`"#;`
`69`	`69`
`70`		`- dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`70`	`+ let val = dbg!(crate::eventsub::Payload::parse(payload).unwrap());`
	`71`	`+ crate::tests::roundtrip(&val)`
`71`	`72`	`}`