api: Improve metadata! history errors

By accepting more errors in the macro syntax, and leaving those for
`VersionHistory::new()` which has nicer error messages.

Author: zecakeh

crates/ruma-common/src/api/metadata.rs

@@ -159,28 +159,24 @@ macro_rules! metadata {
 
     ( @field history: {
         $( unstable $(($unstable_feature:literal))? => $unstable_path:literal, )*
-        $( stable ($stable_feature_only:literal) => $stable_feature_path:literal, )?
-        $( $( $version:literal $(| stable ($stable_feature:literal))? => $rhs:tt, )+ )?
+        $( stable ($stable_feature_only:literal) => $stable_feature_path:literal, )*
+        $( $version:literal $(| stable ($stable_feature:literal))? => $stable_rhs:tt, )*
     } ) => {
         $crate::metadata! {
             @history_impl
-            [ $( $unstable_path $(= $unstable_feature)? ),* ]
-            $( stable ($stable_feature_only) => $stable_feature_path, )?
+            $( unstable $( ($unstable_feature) )? => $unstable_path, )*
+            $( stable ($stable_feature_only) => $stable_feature_path, )*
             // Flip left and right to avoid macro parsing ambiguities
-            $( $( $rhs = $version $(| stable ($stable_feature))? ),+ )?
+            $( $stable_rhs = $version $( | stable ($stable_feature) )?, )*
         }
     };
 
     ( @history_impl
-        [ $( $unstable_path:literal $(= $unstable_feature:literal)? ),* ]
-        $( stable ($stable_feature_only:literal) => $stable_feature_path:literal, )?
-        $(
-            $( $stable_path:literal = $version:literal $(| stable ($stable_feature:literal))? ),+
-            $(,
-                deprecated = $deprecated_version:literal
-                $(, removed = $removed_version:literal )?
-            )?
-        )?
+        $( unstable $(($unstable_feature:literal))? => $unstable_path:literal, )*
+        $( stable ($stable_feature_only:literal) => $stable_feature_path:literal, )*
+        $( $stable_path:literal = $version:literal $(| stable ($stable_feature:literal))?, )*
+        $( deprecated = $deprecated_version:literal, )?
+        $( removed = $removed_version:literal, )?
     ) => {
         type PathBuilder = $crate::api::path_builder::VersionHistory;
         const PATH_BUILDER: $crate::api::path_builder::VersionHistory = $crate::api::path_builder::VersionHistory::new(
@@ -189,14 +185,14 @@ macro_rules! metadata {
                 $((
                     $crate::metadata!(@stable_path_selector stable($stable_feature_only)),
                     $stable_feature_path
-                ),)?
-                $($((
-                    $crate::metadata!(@stable_path_selector $version $(| stable($stable_feature))?),
+                ),)*
+                $((
+                    $crate::metadata!(@stable_path_selector $version $( | stable($stable_feature) )?),
                     $stable_path
-                )),+)?
+                ),)*
             ],
-            $crate::metadata!(@optional_version $($( $deprecated_version )?)?),
-            $crate::metadata!(@optional_version $($($( $removed_version )?)?)?),
+            $crate::metadata!(@optional_version $( $deprecated_version )?),
+            $crate::metadata!(@optional_version $( $removed_version )?),
         );
     };
 

crates/ruma-common/tests/it/api/ruma_api.rs

@@ -6,9 +6,8 @@ fn ui() {
     t.pass("tests/it/api/ui/move-value.rs");
     t.pass("tests/it/api/ui/request-only.rs");
     t.pass("tests/it/api/ui/response-only.rs");
-    t.compile_fail("tests/it/api/ui/deprecated-without-added.rs");
-    t.compile_fail("tests/it/api/ui/removed-without-deprecated.rs");
     t.compile_fail("tests/it/api/ui/serde-flatten-request-body.rs");
     t.compile_fail("tests/it/api/ui/serde-flatten-response-body.rs");
     t.compile_fail("tests/it/api/ui/invalid-path.rs");
+    t.compile_fail("tests/it/api/ui/invalid-version-history.rs");
 }

crates/ruma-common/tests/it/api/ui/deprecated-without-added.rs

@@ -142,51 +142,6 @@ mod missing_variable_opening_version_history {
     pub struct Request;
 }
 
-mod no_paths_version_history {
-    use super::*;
-
-    metadata! {
-        method: GET,
-        rate_limited: false,
-        authentication: NoAuthentication,
-        history: {},
-    }
-
-    pub struct Request;
-}
-
-mod variable_count_mismatch_version_history {
-    use super::*;
-
-    metadata! {
-        method: GET,
-        rate_limited: false,
-        authentication: NoAuthentication,
-        history: {
-            unstable => "unstable/path/to/endpoint/{variable}/{other}",
-            1.1 => "path/to/endpoint/{variable}",
-        },
-    }
-
-    pub struct Request;
-}
-
-mod variable_name_mismatch_version_history {
-    use super::*;
-
-    metadata! {
-        method: GET,
-        rate_limited: false,
-        authentication: NoAuthentication,
-        history: {
-            unstable => "unstable/path/to/endpoint/{var}",
-            1.1 => "path/to/endpoint/{variable}",
-        },
-    }
-
-    pub struct Request;
-}
-
 fn main() {
     let _ = invalid_char_single_path::Request::PATH_BUILDER;
     let _ = invalid_char_version_history::Request::PATH_BUILDER;
@@ -202,8 +157,4 @@ fn main() {
 
     let _ = missing_variable_opening_single_path::Request::PATH_BUILDER;
     let _ = missing_variable_opening_version_history::Request::PATH_BUILDER;
-
-    let _ = no_paths_version_history::Request::PATH_BUILDER;
-    let _ = variable_count_mismatch_version_history::Request::PATH_BUILDER;
-    let _ = variable_name_mismatch_version_history::Request::PATH_BUILDER;
 }

crates/ruma-common/tests/it/api/ui/deprecated-without-added.stderr

@@ -21,9 +21,9 @@ note: inside `path_builder::check_path_is_valid`
    |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:191:13
+   --> tests/it/api/ui/invalid-path.rs:146:13
     |
-191 |     let _ = invalid_char_single_path::Request::PATH_BUILDER;
+146 |     let _ = invalid_char_single_path::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: path contains invalid (non-ascii or whitespace) characters
@@ -50,9 +50,9 @@ note: inside `path_builder::check_path_is_valid`
    |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:192:13
+   --> tests/it/api/ui/invalid-path.rs:147:13
     |
-192 |     let _ = invalid_char_version_history::Request::PATH_BUILDER;
+147 |     let _ = invalid_char_version_history::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: path contains invalid (non-ascii or whitespace) characters
@@ -78,9 +78,9 @@ note: inside `path_builder::check_path_is_valid`
    |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:194:13
+   --> tests/it/api/ui/invalid-path.rs:149:13
     |
-194 |     let _ = whitespace_single_path::Request::PATH_BUILDER;
+149 |     let _ = whitespace_single_path::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: path contains invalid (non-ascii or whitespace) characters
@@ -107,9 +107,9 @@ note: inside `path_builder::check_path_is_valid`
    |                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:195:13
+   --> tests/it/api/ui/invalid-path.rs:150:13
     |
-195 |     let _ = whitespace_version_history::Request::PATH_BUILDER;
+150 |     let _ = whitespace_version_history::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint paths syntax has changed and segment variables must be wrapped by `{}`
@@ -135,9 +135,9 @@ note: inside `extract_endpoint_path_segment_variable`
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:197:13
+   --> tests/it/api/ui/invalid-path.rs:152:13
     |
-197 |     let _ = old_variable_syntax_single_path::Request::PATH_BUILDER;
+152 |     let _ = old_variable_syntax_single_path::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint paths syntax has changed and segment variables must be wrapped by `{}`
@@ -169,9 +169,9 @@ note: inside `extract_endpoint_path_segment_variable`
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:198:13
+   --> tests/it/api/ui/invalid-path.rs:153:13
     |
-198 |     let _ = old_variable_syntax_version_history::Request::PATH_BUILDER;
+153 |     let _ = old_variable_syntax_version_history::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint path segment variable braces mismatch: missing ending `}`
@@ -200,9 +200,9 @@ note: inside `extract_endpoint_path_segment_variable`
    = note: this error originates in the macro `$crate::metadata` which comes from the expansion of the macro `metadata` (in Nightly builds, run with -Z macro-backtrace for more info)
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:200:13
+   --> tests/it/api/ui/invalid-path.rs:155:13
     |
-200 |     let _ = missing_variable_closing_single_path::Request::PATH_BUILDER;
+155 |     let _ = missing_variable_closing_single_path::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint path segment variable braces mismatch: missing ending `}`
@@ -237,9 +237,9 @@ note: inside `extract_endpoint_path_segment_variable`
     = note: this error originates in the macro `$crate::metadata` which comes from the expansion of the macro `metadata` (in Nightly builds, run with -Z macro-backtrace for more info)
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:201:13
+   --> tests/it/api/ui/invalid-path.rs:156:13
     |
-201 |     let _ = missing_variable_closing_version_history::Request::PATH_BUILDER;
+156 |     let _ = missing_variable_closing_version_history::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint path segment variable braces mismatch: missing starting `{`
@@ -265,9 +265,9 @@ note: inside `extract_endpoint_path_segment_variable`
     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:203:13
+   --> tests/it/api/ui/invalid-path.rs:158:13
     |
-203 |     let _ = missing_variable_opening_single_path::Request::PATH_BUILDER;
+158 |     let _ = missing_variable_opening_single_path::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 error[E0080]: evaluation panicked: endpoint path segment variable braces mismatch: missing starting `{`
@@ -299,88 +299,7 @@ note: inside `extract_endpoint_path_segment_variable`
     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
 
 note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:204:13
+   --> tests/it/api/ui/invalid-path.rs:159:13
     |
-204 |     let _ = missing_variable_opening_version_history::Request::PATH_BUILDER;
+159 |     let _ = missing_variable_opening_version_history::Request::PATH_BUILDER;
     |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-error[E0080]: evaluation panicked: no endpoint paths supplied
-   --> tests/it/api/ui/invalid-path.rs:148:5
-    |
-148 | /     metadata! {
-149 | |         method: GET,
-150 | |         rate_limited: false,
-151 | |         authentication: NoAuthentication,
-152 | |         history: {},
-153 | |     }
-    | |_____^ evaluation of `<no_paths_version_history::Request as ruma_common::api::Metadata>::PATH_BUILDER` failed inside this call
-    |
-note: inside `VersionHistory::new`
-   --> src/api/path_builder.rs
-    |
-    |             panic!("no endpoint paths supplied")
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
-
-note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:206:13
-    |
-206 |     let _ = no_paths_version_history::Request::PATH_BUILDER;
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-error[E0080]: evaluation panicked: counts of endpoint path segment variables do not match
-   --> tests/it/api/ui/invalid-path.rs:161:5
-    |
-161 | /     metadata! {
-162 | |         method: GET,
-163 | |         rate_limited: false,
-164 | |         authentication: NoAuthentication,
-...   |
-168 | |         },
-169 | |     }
-    | |_____^ evaluation of `<variable_count_mismatch_version_history::Request as ruma_common::api::Metadata>::PATH_BUILDER` failed inside this call
-    |
-note: inside `VersionHistory::new`
-   --> src/api/path_builder.rs
-    |
-    |             check_path_args_equal(ref_path, version_path.1);
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-note: inside `VersionHistory::new::check_path_args_equal`
-   --> src/api/path_builder.rs
-    |
-    |                         panic!("counts of endpoint path segment variables do not match");
-    |                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
-
-note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:207:13
-    |
-207 |     let _ = variable_count_mismatch_version_history::Request::PATH_BUILDER;
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-error[E0080]: evaluation panicked: names of endpoint path segment variables do not match
-   --> tests/it/api/ui/invalid-path.rs:177:5
-    |
-177 | /     metadata! {
-178 | |         method: GET,
-179 | |         rate_limited: false,
-180 | |         authentication: NoAuthentication,
-...   |
-184 | |         },
-185 | |     }
-    | |_____^ evaluation of `<variable_name_mismatch_version_history::Request as ruma_common::api::Metadata>::PATH_BUILDER` failed inside this call
-    |
-note: inside `VersionHistory::new`
-   --> src/api/path_builder.rs
-    |
-    |             check_path_args_equal(ref_path, version_path.1);
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-note: inside `VersionHistory::new::check_path_args_equal`
-   --> src/api/path_builder.rs
-    |
-    | ...                   panic!("names of endpoint path segment variables do not match");
-    |                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the failure occurred here
-
-note: erroneous constant encountered
-   --> tests/it/api/ui/invalid-path.rs:208:13
-    |
-208 |     let _ = variable_name_mismatch_version_history::Request::PATH_BUILDER;
-    |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^