ruwuma/ruma-events-macros/src/event_content.rs

//! Implementations of the MessageEventContent and StateEventContent derive macro.

use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote};
use syn::{
    parse::{Parse, ParseStream},
    DeriveInput, Ident, LitStr, Token,
};

mod kw {
    // This `content` field is kept when the event is redacted.
    syn::custom_keyword!(skip_redaction);
    // Do not emit any redacted event code.
    syn::custom_keyword!(custom_redacted);
}

/// Parses attributes for `*EventContent` derives.
///
/// `#[ruma_event(type = "m.room.alias")]`
#[derive(Eq, PartialEq)]
enum EventMeta {
    /// Variant holds the "m.whatever" event type.
    Type(LitStr),

    /// Fields marked with `#[ruma_event(skip_redaction)]` are kept when the event is
    /// redacted.
    SkipRedacted,

    /// This attribute signals that the events redacted form is manually implemented and should
    /// not be generated.
    CustomRedacted,
}

impl EventMeta {
    fn get_event_type(&self) -> Option<&LitStr> {
        if let Self::Type(lit) = self {
            Some(lit)
        } else {
            None
        }
    }
}

impl Parse for EventMeta {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        if input.parse::<Token![type]>().is_ok() {
            input.parse::<Token![=]>()?;
            Ok(EventMeta::Type(input.parse::<LitStr>()?))
        } else if input.parse::<kw::skip_redaction>().is_ok() {
            Ok(EventMeta::SkipRedacted)
        } else if input.parse::<kw::custom_redacted>().is_ok() {
            Ok(EventMeta::CustomRedacted)
        } else {
            Err(syn::Error::new(input.span(), "not a recognized `ruma_event` attribute"))
        }
    }
}

struct MetaAttrs(Vec<EventMeta>);

impl MetaAttrs {
    fn is_custom(&self) -> bool {
        self.0.iter().any(|a| a == &EventMeta::CustomRedacted)
    }

    fn get_event_type(&self) -> Option<&LitStr> {
        self.0.iter().find_map(|a| a.get_event_type())
    }
}

impl Parse for MetaAttrs {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let attrs = syn::punctuated::Punctuated::<EventMeta, Token![,]>::parse_terminated(input)?;
        Ok(Self(attrs.into_iter().collect()))
    }
}

/// Create an `EventContent` implementation for a struct.
pub fn expand_event_content(
    input: &DeriveInput,
    emit_redacted: bool,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = &input.ident;

    let content_attr = input
        .attrs
        .iter()
        .filter(|attr| attr.path.is_ident("ruma_event"))
        .map(|attr| attr.parse_args::<MetaAttrs>())
        .collect::<syn::Result<Vec<_>>>()?;

    let event_type = content_attr.iter().find_map(|a| a.get_event_type()).ok_or_else(|| {
        let msg = "no event type attribute found, \
            add `#[ruma_event(type = \"any.room.event\")]` \
            below the event content derive";

        syn::Error::new(Span::call_site(), msg)
    })?;

    let redacted = if emit_redacted && needs_redacted(&content_attr) {
        let doc = format!("The payload for a redacted `{}`", ident);
        let redacted_ident = format_ident!("Redacted{}", ident);
        let kept_redacted_fields = if let syn::Data::Struct(syn::DataStruct {
            fields: syn::Fields::Named(syn::FieldsNamed { named, .. }),
            ..
        }) = &input.data
        {
            // this is to validate the `#[ruma_event(skip_redaction)]` attribute
            named
                .iter()
                .flat_map(|f| &f.attrs)
                .filter(|a| a.path.is_ident("ruma_event"))
                .find_map(|a| {
                    if let Err(e) = a.parse_args::<EventMeta>() {
                        Some(Err(e))
                    } else {
                        None
                    }
                })
                .unwrap_or(Ok(()))?;

            let mut fields = named
                .iter()
                .filter(|f| {
                    f.attrs.iter().find_map(|a| a.parse_args::<EventMeta>().ok())
                        == Some(EventMeta::SkipRedacted)
                })
                .cloned()
                .collect::<Vec<_>>();

            // don't re-emit our `ruma_event` attributes
            for f in &mut fields {
                f.attrs.retain(|a| !a.path.is_ident("ruma_event"));
            }
            fields
        } else {
            vec![]
        };
        let redaction_struct_fields = kept_redacted_fields.iter().flat_map(|f| &f.ident);

        // redacted_fields allows one to declare an empty redacted event without braces,
        // otherwise `RedactedWhateverEventContent {}` is needed.
        // The redacted_return is used in `EventContent::redacted` which only returns
        // zero sized types (unit structs).
        let (redacted_fields, redacted_return) = if kept_redacted_fields.is_empty() {
            (quote! { ; }, quote! { Ok(#redacted_ident {}) })
        } else {
            (
                quote! {
                    { #( #kept_redacted_fields, )* }
                },
                quote! {
                    Err(#import_path::exports::serde::de::Error::custom(
                        format!("this redacted event has fields that cannot be constructed")
                    ))
                },
            )
        };

        let has_deserialize_fields = if kept_redacted_fields.is_empty() {
            quote! { #import_path::HasDeserializeFields::False }
        } else {
            quote! { #import_path::HasDeserializeFields::True }
        };

        let has_serialize_fields = if kept_redacted_fields.is_empty() {
            quote! { false }
        } else {
            quote! { true }
        };

        let redacted_event_content =
            generate_event_content_impl(&redacted_ident, event_type, import_path);

        quote! {
            // this is the non redacted event content's impl
            impl #ident {
                /// Transforms the full event content into a redacted content according to spec.
                pub fn redact(self, version: #import_path::exports::ruma_identifiers::RoomVersionId) -> #redacted_ident {
                    #redacted_ident { #( #redaction_struct_fields: self.#redaction_struct_fields, )* }
                }
            }

            #[doc = #doc]
            #[derive(
                Clone,
                Debug,
                #import_path::exports::serde::Deserialize,
                #import_path::exports::serde::Serialize
            )]
            pub struct #redacted_ident #redacted_fields

            #redacted_event_content

            impl #import_path::RedactedEventContent for #redacted_ident {
                fn empty(ev_type: &str) -> Result<Self, #import_path::exports::serde_json::Error> {
                    if ev_type != #event_type {
                        return Err(#import_path::exports::serde::de::Error::custom(
                            format!("expected event type `{}`, found `{}`", #event_type, ev_type)
                        ));
                    }

                    #redacted_return
                }

                fn has_serialize_fields(&self) -> bool {
                    #has_serialize_fields
                }

                fn has_deserialize_fields() -> #import_path::HasDeserializeFields {
                    #has_deserialize_fields
                }
            }
        }
    } else {
        TokenStream::new()
    };

    let event_content = generate_event_content_impl(ident, event_type, import_path);

    Ok(quote! {
        #event_content

        #redacted
    })
}

/// Create a `BasicEventContent` implementation for a struct
pub fn expand_basic_event_content(
    input: &DeriveInput,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = input.ident.clone();
    let event_content_impl = expand_event_content(input, false, import_path)?;

    Ok(quote! {
        #event_content_impl

        impl #import_path::BasicEventContent for #ident { }
    })
}

/// Create a `EphemeralRoomEventContent` implementation for a struct
pub fn expand_ephemeral_room_event_content(
    input: &DeriveInput,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = input.ident.clone();
    let event_content_impl = expand_event_content(input, false, import_path)?;

    Ok(quote! {
        #event_content_impl

        impl #import_path::EphemeralRoomEventContent for #ident { }
    })
}

/// Create a `RoomEventContent` implementation for a struct.
pub fn expand_room_event_content(
    input: &DeriveInput,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = input.ident.clone();
    let event_content_impl = expand_event_content(input, true, import_path)?;

    Ok(quote! {
        #event_content_impl

        impl #import_path::RoomEventContent for #ident { }
    })
}

/// Create a `MessageEventContent` implementation for a struct
pub fn expand_message_event_content(
    input: &DeriveInput,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = input.ident.clone();
    let room_ev_content = expand_room_event_content(input, import_path)?;

    let redacted_marker_trait = if needs_redacted_from_input(input) {
        let ident = format_ident!("Redacted{}", &ident);
        quote! {
            impl #import_path::RedactedMessageEventContent for #ident { }
        }
    } else {
        TokenStream::new()
    };

    Ok(quote! {
        #room_ev_content

        impl #import_path::MessageEventContent for #ident { }

        #redacted_marker_trait
    })
}

/// Create a `StateEventContent` implementation for a struct
pub fn expand_state_event_content(
    input: &DeriveInput,
    import_path: &TokenStream,
) -> syn::Result<TokenStream> {
    let ident = input.ident.clone();
    let room_ev_content = expand_room_event_content(input, import_path)?;

    let redacted_marker_trait = if needs_redacted_from_input(input) {
        let ident = format_ident!("Redacted{}", input.ident);
        quote! {
            impl #import_path::RedactedStateEventContent for #ident { }
        }
    } else {
        TokenStream::new()
    };

    Ok(quote! {
        #room_ev_content

        impl #import_path::StateEventContent for #ident { }

        #redacted_marker_trait
    })
}

fn generate_event_content_impl(
    ident: &Ident,
    event_type: &LitStr,
    import_path: &TokenStream,
) -> TokenStream {
    quote! {
        impl #import_path::EventContent for #ident {
            fn event_type(&self) -> &str {
                #event_type
            }

            fn from_parts(
                ev_type: &str,
                content: Box<#import_path::exports::serde_json::value::RawValue>
            ) -> Result<Self, #import_path::exports::serde_json::Error> {
                if ev_type != #event_type {
                    return Err(#import_path::exports::serde::de::Error::custom(
                        format!("expected event type `{}`, found `{}`", #event_type, ev_type)
                    ));
                }

                #import_path::exports::serde_json::from_str(content.get())
            }
        }
    }
}

fn needs_redacted(input: &[MetaAttrs]) -> bool {
    // `is_custom` means that the content struct does not need a generated
    // redacted struct also. If no `custom_redacted` attrs are found the content
    // needs a redacted struct generated.
    !input.iter().any(|a| a.is_custom())
}

fn needs_redacted_from_input(input: &DeriveInput) -> bool {
    !input.attrs.iter().flat_map(|a| a.parse_args::<MetaAttrs>().ok()).any(|a| a.is_custom())
}