Merge pull request #342 from sam-berning/improve-metadata-error

apiserver: improve error message for invalid metadata

Author: sam-berning

sources/api/apiserver/src/server/controller.rs

@@ -408,8 +408,12 @@ pub(crate) fn get_metadata_for_data_keys<D: DataStore, S: AsRef<str>>(
             Err(_) => continue,
         };
         trace!("Deserializing scalar from metadata");
-        let value: Value = deserialize_scalar::<_, ScalarError>(&value_str)
-            .context(error::InvalidMetadataSnafu { key: md_key.name() })?;
+        let value: Value = deserialize_scalar::<_, ScalarError>(&value_str).context(
+            error::InvalidMetadataSnafu {
+                key: md_key.name(),
+                data_key: data_key.name(),
+            },
+        )?;
         result.insert(data_key.to_string(), value);
     }
 
@@ -436,6 +440,7 @@ pub(crate) fn get_metadata_for_all_data_keys<D: DataStore, S: AsRef<str>>(
             let value: Value = deserialize_scalar::<_, ScalarError>(&value_str).context(
                 error::InvalidMetadataSnafu {
                     key: meta_key.name(),
+                    data_key: data_key.name(),
                 },
             )?;
             result.insert(data_key.to_string(), value);

sources/api/apiserver/src/server/error.rs

@@ -136,9 +136,15 @@ pub enum Error {
         source: Box<datastore::Error>,
     },
 
-    #[snafu(display("Metadata '{}' is not valid JSON: {}", key, source))]
+    #[snafu(display(
+        "Metadata '{}' for key '{}' is not valid JSON: {}",
+        key,
+        data_key,
+        source
+    ))]
     InvalidMetadata {
         key: String,
+        data_key: String,
         source: serde_json::Error,
     },