rorpc-parse 0.1.8

AST parsing utilities and code generation internals for rorpc proc macros
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

//! Code generation for the `#[rorpc::namespace("/prefix")]` attribute macro.
//!
//! Registers a namespace prefix for a module. All handlers within the module
//! will have their paths prefixed with this namespace at runtime (during router
//! construction and contract generation).

use proc_macro2::TokenStream;
use quote::quote;
use syn::{
    parse::{Parse, ParseStream},
    Item, LitStr,
};

use crate::errors::Result;

/// Parsed arguments for the `#[rorpc::namespace("/prefix")]` attribute.
#[derive(Debug)]
pub struct NamespaceArgs {
    pub prefix: String,
}

impl Parse for NamespaceArgs {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let lit: LitStr = input.parse()?;
        let prefix = lit.value();

        // Validate prefix
        if !prefix.starts_with('/') {
            return Err(syn::Error::new(
                lit.span(),
                "namespace prefix must start with '/'",
            ));
        }

        if prefix.contains("..") {
            return Err(syn::Error::new(
                lit.span(),
                "namespace prefix cannot contain '..' path traversal",
            ));
        }

        if prefix.ends_with('/') && prefix.len() > 1 {
            return Err(syn::Error::new(
                lit.span(),
                "namespace prefix should not end with '/' (except for root)",
            ));
        }

        Ok(NamespaceArgs { prefix })
    }
}

/// Expand the `#[rorpc::namespace("/prefix")]` attribute.
///
/// Returns the original item unchanged plus an `inventory::submit!` registration
/// for `NamespaceMetadata`.
pub fn expand_namespace(args: NamespaceArgs, item: Item) -> Result<TokenStream> {
    let prefix = &args.prefix;

    Ok(quote! {
        #item

        ::rorpc::inventory::submit! {
            ::rorpc::NamespaceMetadata {
                module_path: ::std::module_path!(),
                prefix: #prefix,
            }
        }
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_valid_prefix() {
        let args: NamespaceArgs = syn::parse_str("\"/planet\"").unwrap();
        assert_eq!(args.prefix, "/planet");
    }

    #[test]
    fn parse_root_prefix() {
        let args: NamespaceArgs = syn::parse_str("\"/\"").unwrap();
        assert_eq!(args.prefix, "/");
    }

    #[test]
    fn reject_missing_leading_slash() {
        let result: syn::Result<NamespaceArgs> = syn::parse_str("\"planet\"");
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("must start with '/'"));
    }

    #[test]
    fn reject_path_traversal() {
        let result: syn::Result<NamespaceArgs> = syn::parse_str("\"/planet/../admin\"");
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains(".."));
    }

    #[test]
    fn reject_trailing_slash() {
        let result: syn::Result<NamespaceArgs> = syn::parse_str("\"/planet/\"");
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("should not end with '/'"));
    }
}