From e387abda81fe4515fd8f9edad031150ad6927c30 Mon Sep 17 00:00:00 2001
From: Jonas Platte <jplatte+git@posteo.de>
Date: Mon, 17 Jan 2022 00:43:00 +0100
Subject: [PATCH] events: Raise an error when trying to serialize _Custom
 variant of event content enum

---
 crates/ruma-events-macros/src/event_enum.rs |  5 ++++-
 crates/ruma-events/src/lib.rs               | 15 ++++++++++++++-
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/crates/ruma-events-macros/src/event_enum.rs b/crates/ruma-events-macros/src/event_enum.rs
index 9656014b..45051019 100644
--- a/crates/ruma-events-macros/src/event_enum.rs
+++ b/crates/ruma-events-macros/src/event_enum.rs
@@ -303,6 +303,9 @@ fn expand_content_enum(
     let marker_trait_impl = expand_marker_trait_impl(kind, ruma_events);
     let from_impl = expand_from_impl(&ident, &content, variants);
 
+    let serialize_custom_event_error_path =
+        quote! { #ruma_events::serialize_custom_event_error }.to_string();
+
     quote! {
         #( #attrs )*
         #[derive(Clone, Debug, #serde::Serialize)]
@@ -315,8 +318,8 @@ fn expand_content_enum(
                 #variant_decls(#content),
             )*
             #[doc(hidden)]
+            #[serde(serialize_with = #serialize_custom_event_error_path)]
             _Custom {
-                #[serde(skip)]
                 event_type: ::std::string::String,
             },
         }
diff --git a/crates/ruma-events/src/lib.rs b/crates/ruma-events/src/lib.rs
index 3c90d3f4..c00737ae 100644
--- a/crates/ruma-events/src/lib.rs
+++ b/crates/ruma-events/src/lib.rs
@@ -121,7 +121,7 @@ use ruma_identifiers::{EventEncryptionAlgorithm, RoomVersionId};
 use ruma_serde::Raw;
 use serde::{
     de::{self, IgnoredAny},
-    Deserialize, Serialize,
+    Deserialize, Serialize, Serializer,
 };
 use serde_json::value::RawValue as RawJsonValue;
 
@@ -406,3 +406,16 @@ where
 #[doc(hidden)]
 #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct PrivOwnedStr(Box<str>);
+
+/// Helper function for erroring when trying to serialize an event enum _Custom
+/// variant that can only be created by deserializing from an unknown event
+/// type.
+#[doc(hidden)]
+#[allow(clippy::ptr_arg)]
+fn serialize_custom_event_error<S: Serializer>(_: &String, _: S) -> Result<S::Ok, S::Error> {
+    Err(serde::ser::Error::custom(
+        "Failed to serialize event [content] enum: Unknown event type.\n\
+         To send custom events, turn them into `Raw<EnumType>` by going through
+         `serde_json::value::to_raw_value` and `Raw::from_json`.",
+    ))
+}