From 7d67fa73df7d20e8188ada6c1af5fe31dc665e16 Mon Sep 17 00:00:00 2001
From: Max Inden <mail@max-inden.de>
Date: Thu, 27 May 2021 23:05:23 +0200
Subject: [PATCH] derive-text-encode: Handle keyword identifiers aka raw
 identifiers

Field names like `r#type` are problematic as `r#` is not a valid
OpenMetrics label name but one needs to use keyword identifier syntax
(aka. raw identifiers) as `type` is a keyword.

Makes sure `r#type` is replaced by `type` in the OpenMetrics output.
---
 derive-text-encode/src/lib.rs   | 61 ++++++++++++++++++++++++++++++++-
 derive-text-encode/tests/lib.rs | 25 ++++++++++++++
 2 files changed, 85 insertions(+), 1 deletion(-)

diff --git a/derive-text-encode/src/lib.rs b/derive-text-encode/src/lib.rs
index 7d05854..8cc4e2a 100644
--- a/derive-text-encode/src/lib.rs
+++ b/derive-text-encode/src/lib.rs
@@ -17,6 +17,12 @@ pub fn derive_encode(input: TokenStream) -> TokenStream {
                 .enumerate()
                 .map(|(i, f)| {
                     let ident = f.ident.unwrap();
+                    let ident_string = KEYWORD_IDENTIFIERS
+                        .iter()
+                        .find(|pair| ident == pair.1)
+                        .map(|pair| pair.0.to_string())
+                        .unwrap_or_else(|| ident.to_string());
+
                     let maybe_comma = if i == 0 {
                         TokenStream2::default()
                     } else {
@@ -24,7 +30,7 @@ pub fn derive_encode(input: TokenStream) -> TokenStream {
                     };
                     quote! {
                         #maybe_comma
-                        writer.write_all(concat!(stringify!(#ident), "=\"").as_bytes())?;
+                        writer.write_all(concat!(#ident_string, "=\"").as_bytes())?;
                         open_metrics_client::encoding::text::Encode::encode(&self.#ident, writer)?;
                         writer.write_all(b"\"")?;
                     }
@@ -66,3 +72,56 @@ pub fn derive_encode(input: TokenStream) -> TokenStream {
     };
     gen.into()
 }
+
+// Copied from https://github.com/djc/askama (MIT and APACHE licensed) and
+// modified.
+static KEYWORD_IDENTIFIERS: [(&str, &str); 48] = [
+    ("as", "r#as"),
+    ("break", "r#break"),
+    ("const", "r#const"),
+    ("continue", "r#continue"),
+    ("crate", "r#crate"),
+    ("else", "r#else"),
+    ("enum", "r#enum"),
+    ("extern", "r#extern"),
+    ("false", "r#false"),
+    ("fn", "r#fn"),
+    ("for", "r#for"),
+    ("if", "r#if"),
+    ("impl", "r#impl"),
+    ("in", "r#in"),
+    ("let", "r#let"),
+    ("loop", "r#loop"),
+    ("match", "r#match"),
+    ("mod", "r#mod"),
+    ("move", "r#move"),
+    ("mut", "r#mut"),
+    ("pub", "r#pub"),
+    ("ref", "r#ref"),
+    ("return", "r#return"),
+    ("static", "r#static"),
+    ("struct", "r#struct"),
+    ("trait", "r#trait"),
+    ("true", "r#true"),
+    ("type", "r#type"),
+    ("unsafe", "r#unsafe"),
+    ("use", "r#use"),
+    ("where", "r#where"),
+    ("while", "r#while"),
+    ("async", "r#async"),
+    ("await", "r#await"),
+    ("dyn", "r#dyn"),
+    ("abstract", "r#abstract"),
+    ("become", "r#become"),
+    ("box", "r#box"),
+    ("do", "r#do"),
+    ("final", "r#final"),
+    ("macro", "r#macro"),
+    ("override", "r#override"),
+    ("priv", "r#priv"),
+    ("typeof", "r#typeof"),
+    ("unsized", "r#unsized"),
+    ("virtual", "r#virtual"),
+    ("yield", "r#yield"),
+    ("try", "r#try"),
+];
diff --git a/derive-text-encode/tests/lib.rs b/derive-text-encode/tests/lib.rs
index d5c76ab..d57c089 100644
--- a/derive-text-encode/tests/lib.rs
+++ b/derive-text-encode/tests/lib.rs
@@ -40,3 +40,28 @@ fn basic_flow() {
         + "# EOF\n";
     assert_eq!(expected, String::from_utf8(buffer).unwrap());
 }
+
+#[test]
+fn remap_keyword_identifiers() {
+    #[derive(Encode, Hash, Clone, Eq, PartialEq)]
+    struct Labels {
+        // `r#type` is problematic as `r#` is not a valid OpenMetrics label name
+        // but one needs to use keyword identifier syntax (aka. raw identifiers)
+        // as `type` is a keyword.
+        //
+        // Test makes sure `r#type` is replaced by `type` in the OpenMetrics
+        // output.
+        r#type: u64,
+    };
+
+    let labels = Labels { r#type: 42 };
+
+    let mut buffer = vec![];
+
+    labels.encode(&mut buffer);
+
+    assert_eq!(
+        "type=\"42\"".to_string(),
+        String::from_utf8(buffer).unwrap()
+    );
+}