rename MetaData to Metadata (#237)

Author: richardelms

.buildkite/pipeline.yml

@@ -31,6 +31,7 @@ steps:
           run: java17-mazerunner
       - artifacts#v1.9.0:
           download: "maven-repository.zip"
+          upload: "maze_output/maze_output.zip"
     command:
       - 'features/scripts/assemble-fixtures.sh'
       - 'bundle exec maze-runner --exclude=features/[^a-m].*.feature'
@@ -44,6 +45,7 @@ steps:
           run: java17-mazerunner
       - artifacts#v1.9.0:
           download: "maven-repository.zip"
+          upload: "maze_output/maze_output.zip"
     command:
       - 'features/scripts/assemble-fixtures.sh'
       - 'bundle exec maze-runner --exclude=features/[^n-z].*.feature'

bugsnag-spring/src/test/java/com/bugsnag/SpringMvcTest.java

@@ -136,7 +136,7 @@ public void requestMetadataSetCorrectly() {
 
         // Check that the request metadata is set as expected
         @SuppressWarnings(value = "unchecked") Map<String, Object> requestMetadata =
-                (Map<String, Object>) report.getMetaData().get("request");
+                (Map<String, Object>) report.getMetadata().get("request");
         assertEquals("http://localhost:" + randomServerPort + "/throw-runtime-exception",
                 requestMetadata.get("url"));
         assertEquals("GET", requestMetadata.get("method"));

bugsnag/src/main/java/com/bugsnag/Bugsnag.java

@@ -58,10 +58,10 @@ public void rejectedExecution(Runnable runnable, ThreadPoolExecutor executor) {
     private Configuration config;
     private final SessionTracker sessionTracker;
 
-    private static final ThreadLocal<MetaData> THREAD_METADATA = new ThreadLocal<MetaData>() {
+    private static final ThreadLocal<Metadata> THREAD_METADATA = new ThreadLocal<Metadata>() {
         @Override
-        public MetaData initialValue() {
-            return new MetaData();
+        public Metadata initialValue() {
+            return new Metadata();
         }
     };
 
@@ -228,13 +228,13 @@ public void setEndpoint(String endpoint) {
     }
 
     /**
-     * Set which keys should be redacted when sending metaData to Bugsnag.
+     * Set which keys should be redacted when sending metadata to Bugsnag.
      * Use this when you want to ensure sensitive information, such as passwords
-     * or credit card information is stripped from metaData you send to Bugsnag.
-     * Any keys in metaData which contain these strings will be marked as
+     * or credit card information is stripped from metadata you send to Bugsnag.
+     * Any keys in metadata which contain these strings will be marked as
      * [REDACTED] when send to Bugsnag.
      *
-     * @param redactedKeys a list of String keys to redact from metaData
+     * @param redactedKeys a list of String keys to redact from metadata
      */
     public void setRedactedKeys(String... redactedKeys) {
         config.redactedKeys = redactedKeys;
@@ -465,7 +465,7 @@ public boolean notify(Report report, Callback reportCallback) {
         }
 
         // Add thread metadata to the report
-        report.mergeMetaData(THREAD_METADATA.get());
+        report.mergeMetadata(THREAD_METADATA.get());
 
         // Run the report-specific beforeNotify callback, if given
         if (reportCallback != null) {
@@ -618,14 +618,14 @@ public void close() {
      * @param key     the key of the metadata to add
      * @param value   the metadata value to add
      */
-    public static void addThreadMetaData(String tabName, String key, Object value) {
+    public static void addThreadMetadata(String tabName, String key, Object value) {
         THREAD_METADATA.get().addToTab(tabName, key, value);
     }
 
     /**
      * Clears all metadata added to the current thread
      */
-    public static void clearThreadMetaData() {
+    public static void clearThreadMetadata() {
         THREAD_METADATA.get().clear();
     }
 
@@ -634,7 +634,7 @@ public static void clearThreadMetaData() {
      *
      * @param tabName the name of the tab to remove
      */
-    public static void clearThreadMetaData(String tabName) {
+    public static void clearThreadMetadata(String tabName) {
         THREAD_METADATA.get().clearTab(tabName);
     }
 
@@ -644,7 +644,7 @@ public static void clearThreadMetaData(String tabName) {
      * @param tabName the name of the tab to that the metadata is in
      * @param key     the key of the metadata to remove
      */
-    public static void clearThreadMetaData(String tabName, String key) {
+    public static void clearThreadMetadata(String tabName, String key) {
         THREAD_METADATA.get().clearKey(tabName, key);
     }
 

bugsnag/src/main/java/com/bugsnag/BugsnagAppender.java

@@ -3,9 +3,9 @@
 import com.bugsnag.callbacks.Callback;
 import com.bugsnag.delivery.Delivery;
 import com.bugsnag.logback.BugsnagMarker;
-import com.bugsnag.logback.LogbackMetaData;
-import com.bugsnag.logback.LogbackMetaDataKey;
-import com.bugsnag.logback.LogbackMetaDataTab;
+import com.bugsnag.logback.LogbackMetadata;
+import com.bugsnag.logback.LogbackMetadataKey;
+import com.bugsnag.logback.LogbackMetadataTab;
 import com.bugsnag.logback.ProxyConfiguration;
 
 import ch.qos.logback.classic.Level;
@@ -75,7 +75,7 @@ public class BugsnagAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
     /** Application version. */
     private String appVersion;
 
-    private List<LogbackMetaData> globalMetaData = new ArrayList<LogbackMetaData>();
+    private List<LogbackMetadata> globalMetadata = new ArrayList<LogbackMetadata>();
 
     /** Bugsnag client. */
     private Bugsnag bugsnag = null;
@@ -272,9 +272,9 @@ private Bugsnag createBugsnag() {
             @Override
             public void beforeNotify(Report report) {
 
-                for (LogbackMetaData metaData : globalMetaData) {
-                    for (LogbackMetaDataTab tab : metaData.getTabs()) {
-                        for (LogbackMetaDataKey key : tab.getKeys()) {
+                for (LogbackMetadata metadata : globalMetadata) {
+                    for (LogbackMetadataTab tab : metadata.getTabs()) {
+                        for (LogbackMetadataKey key : tab.getKeys()) {
                             report.addToTab(tab.getName(),
                                     key.getName(),
                                     key.getValue());
@@ -524,10 +524,15 @@ public void setAppVersion(String appVersion) {
      * Internal use only
      * Should only be used via the logback.xml file
      *
-     * @param metaData Adds meta data to every report
+     * @param metadata Adds metadata to every report
      */
-    public void setMetaData(LogbackMetaData metaData) {
-        this.globalMetaData.add(metaData);
+    public void setMetadata(LogbackMetadata metadata) {
+        this.globalMetadata.add(metadata);
+    }
+
+    @Deprecated
+    public void setMetaData(LogbackMetadata metadata) {
+        setMetadata(metadata);
     }
 
     /**

bugsnag/src/main/java/com/bugsnag/Diagnostics.java

@@ -11,7 +11,7 @@ class Diagnostics {
     Map<String, Object> app;
     Map<String, Object> device;
     Map<String, String> user = new HashMap<String, String>();
-    MetaData metaData = new MetaData();
+    Metadata metadata = new Metadata();
 
     Diagnostics(Configuration configuration) {
         app = getDefaultAppInfo(configuration);

…/src/main/java/com/bugsnag/MetaData.java …/src/main/java/com/bugsnag/Metadata.javabugsnag/src/main/java/com/bugsnag/MetaData.java renamed to bugsnag/src/main/java/com/bugsnag/Metadata.java bugsnag/src/main/java/com/bugsnag/MetaData.java renamed to bugsnag/src/main/java/com/bugsnag/Metadata.java

@@ -3,7 +3,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
-class MetaData extends HashMap<String, Object> {
+class Metadata extends HashMap<String, Object> {
     private static final long serialVersionUID = 2530038179702722770L;
 
     public void addToTab(String tabName, String key, Object value) {
@@ -20,9 +20,9 @@ void clearKey(String tabName, String key) {
         tab.remove(key);
     }
 
-    void merge(MetaData metaData) {
-        for (String tabName : metaData.keySet()) {
-            getTab(tabName).putAll(metaData.getTab(tabName));
+    void merge(Metadata metadata) {
+        for (String tabName : metadata.keySet()) {
+            getTab(tabName).putAll(metadata.getTab(tabName));
         }
     }
 

bugsnag/src/main/java/com/bugsnag/Report.java

@@ -2,6 +2,8 @@
 
 import com.bugsnag.serialization.Expose;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -123,8 +125,9 @@ public Map<String, String> getUser() {
     }
 
     @Expose
-    public Map<String, Object> getMetaData() {
-        return new RedactedMap(diagnostics.metaData, Set.of(config.redactedKeys));
+    @JsonProperty("metaData")
+    public Map<String, Object> getMetadata() {
+        return new RedactedMap(diagnostics.metadata, Set.of(config.redactedKeys));
     }
 
     @Expose
@@ -186,7 +189,7 @@ public String getExceptionMessage() {
      * @return the modified report
      */
     public Report addToTab(String tabName, String key, Object value) {
-        diagnostics.metaData.addToTab(tabName, key, value);
+        diagnostics.metadata.addToTab(tabName, key, value);
         return this;
     }
 
@@ -197,7 +200,7 @@ public Report addToTab(String tabName, String key, Object value) {
      * @return The message from the exception contained in this error report.
      */
     public Report clearTab(String tabName) {
-        diagnostics.metaData.clearTab(tabName);
+        diagnostics.metadata.clearTab(tabName);
         return this;
     }
 
@@ -331,8 +334,8 @@ void setHandledState(HandledState handledState) {
         this.handledState = handledState;
     }
 
-    void mergeMetaData(MetaData metaData) {
-        diagnostics.metaData.merge(metaData);
+    void mergeMetadata(Metadata metadata) {
+        diagnostics.metadata.merge(metadata);
     }
 
     static class SeverityReason {

bugsnag/src/main/java/com/bugsnag/callbacks/JakartaServletCallback.java

@@ -33,7 +33,7 @@ public void beforeNotify(Report report) {
             return;
         }
 
-        // Add request information to metaData
+        // Add request information to metadata
         report
                 .addToTab("request", "url", request.getRequestURL().toString())
                 .addToTab("request", "method", request.getMethod())

bugsnag/src/main/java/com/bugsnag/logback/LogbackMetaData.java

@@ -0,0 +1,24 @@
+package com.bugsnag.logback;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/** Used to allow metadata to be added in the logback.xml file */
+public class LogbackMetadata {
+
+    private List<LogbackMetadataTab> tabs = new ArrayList<LogbackMetadataTab>();
+
+    /**
+     * @return The tabs in the metadata
+     */
+    public List<LogbackMetadataTab> getTabs() {
+        return tabs;
+    }
+
+    /**
+     * @param tab a new tab to add to the metadata
+     */
+    public void setTab(LogbackMetadataTab tab) {
+        this.tabs.add(tab);
+    }
+}