Merge #82

82: make errors on unknown fields opt-in instead of opt-out r=Emilgardis a=Emilgardis



Co-authored-by: Emil Gardström <emil.gardstrom@gmail.com>

Author: bors[bot]

.github/workflows/ci.yml

@@ -1,6 +1,6 @@
 name: CI
 env:
-  CI_TWITCH_API2_FEATURES: "twitch_oauth2/all all unsupported"
+  CI_TWITCH_API2_FEATURES: "twitch_oauth2/all all unsupported deny_unknown_fields"
 on:
   pull_request:
     types: [opened, reopened, synchronize]

.github/workflows/gh-pages.yml

@@ -1,6 +1,6 @@
 name: github pages
 env:
-  CI_TWITCH_API2_FEATURES: "twitch_oauth2/all all unsupported"
+  CI_TWITCH_API2_FEATURES: "twitch_oauth2/all all unsupported deny_unknown_fields"
   RUSTDOCFLAGS: "-Z unstable-options --html-in-header=docs/pre-content.html"
 on:
   push:

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "rust-analyzer.checkOnSave.allTargets": false,
-    "rust-analyzer.checkOnSave.features": ["all", "unsupported", "twitch_oauth2/reqwest_client", "twitch_oauth2/surf_client"],
+    "rust-analyzer.checkOnSave.features": ["all", "unsupported", "twitch_oauth2/reqwest_client", "twitch_oauth2/surf_client", "deny_unknown_fields"],
     "rust-analyzer.checkOnSave.enable": true,
-    "rust-analyzer.cargo.features": ["all", "unsupported"],
+    "rust-analyzer.cargo.features": ["all", "unsupported", "deny_unknown_fields"],
 }

CHANGELOG.md

@@ -10,8 +10,8 @@
 
 * Made crate runtime agnostic with custom clients using feature `client`.
 * Added `unsupported` feature to enable experimental/undocumented APIs/endpoints/topics.
-* Made most fields deny unknown fields by default, specify feature `allow_unknown_fields` to ignore unknowns.
-* Added `all` feature to enable all feature sans `unsupported` and `allow_unknown_fields`.
+* Made most fields deny unknown fields by enabling feature `deny_unknown_fields`.
+* Added `all` feature to enable all feature sans `unsupported` and `deny_unknown_fields`.
 * Added most PubSub topics.
     - channel-bits-events-v2
     - channel-bits-badge-unlocks

Cargo.toml

@@ -35,7 +35,7 @@ default = []
 client = ["twitch_oauth2"]
 
 unsupported = []
-allow_unknown_fields = []
+deny_unknown_fields = []
 
 helix = [
     "url",

src/eventsub/channel/ban.rs

@@ -4,7 +4,7 @@ use super::*;
 
 /// [`channel.ban`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelban): a viewer is banned from the specified channel.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelBanV1 {
     /// The broadcaster user ID for the channel you want to get ban notifications for.
@@ -22,7 +22,7 @@ impl EventSubscription for ChannelBanV1 {
 
 /// [`channel.ban`](ChannelBanV1) response payload.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelBanV1Payload {
     /// The user ID for the user who was banned on the specified channel.

src/eventsub/channel/channel_points_custom_reward/add.rs

@@ -4,7 +4,7 @@
 use super::*;
 /// [`channel.channel_points_custom_reward.add`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardadd): a custom channel points reward has been created for the specified channel.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardAddV1 {
     /// The broadcaster user ID for the channel you want to receive channel points custom reward add notifications for.
@@ -23,7 +23,7 @@ impl EventSubscription for ChannelPointsCustomRewardAddV1 {
 // FIXME: Same as update
 /// [`channel.channel_points_custom_reward.add`](ChannelPointsCustomRewardAddV1) response payload.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardAddV1Payload {
     /// Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2.

src/eventsub/channel/channel_points_custom_reward/remove.rs

@@ -4,7 +4,7 @@
 use super::*;
 /// [`channel.channel_points_custom_reward.remove`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardremove): a custom channel points reward has been removed from the specified channel.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardRemoveV1 {
     /// The broadcaster user ID for the channel you want to receive channel points custom reward remove notifications for.
@@ -24,7 +24,7 @@ impl EventSubscription for ChannelPointsCustomRewardRemoveV1 {
 
 /// [`channel.channel_points_custom_reward.remove`](ChannelPointsCustomRewardRemoveV1) response payload.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardRemoveV1Payload {
     /// Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2.

src/eventsub/channel/channel_points_custom_reward/update.rs

@@ -4,7 +4,7 @@
 use super::*;
 /// [`channel.channel_points_custom_reward.update`](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardupdate): a custom channel points reward has been updated for the specified channel.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardUpdateV1 {
     /// The broadcaster user ID for the channel you want to receive channel points custom reward update notifications for.
@@ -24,7 +24,7 @@ impl EventSubscription for ChannelPointsCustomRewardUpdateV1 {
 
 /// [`channel.channel_points_custom_reward.update`](ChannelPointsCustomRewardUpdateV1) response payload.
 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct ChannelPointsCustomRewardUpdateV1Payload {
     /// Custom background color for the reward. Format: Hex with # prefix. Example: #FA1ED2.

src/eventsub/channel/channel_points_custom_reward_redemption.rs

@@ -19,7 +19,7 @@ pub use update::{
 
 /// Basic information about the reward that was redeemed, at the time it was redeemed.
 #[derive(Clone, Debug, PartialEq, PartialOrd, Eq, Ord, Hash, Serialize, Deserialize)]
-#[cfg_attr(not(feature = "allow_unknown_fields"), serde(deny_unknown_fields))]
+#[cfg_attr(feature = "deny_unknown_fields", serde(deny_unknown_fields))]
 #[non_exhaustive]
 pub struct Reward {
     /// The reward cost.