telemtry api follow up issue

Author: GabrielXia

engine/src/main/java/org/terasology/config/facade/TelemetryConfiguration.java

@@ -32,5 +32,5 @@ public interface TelemetryConfiguration {
 
     Boolean get(String telemetryField);
 
-    boolean containField(String telemetryField);
+    boolean containsField(String telemetryField);
 }

engine/src/main/java/org/terasology/config/facade/TelemetryConfigurationImpl.java

@@ -49,7 +49,7 @@ public Boolean get(String telemetryField) {
         return bindingMap.get(telemetryField);
     }
 
-    public boolean containField(String telemetryField) {
+    public boolean containsField(String telemetryField) {
         Map<String, Boolean> bindingMap = telemetryConfig.getMetricsUserPermissionConfig().getBindingMap();
         return bindingMap.containsKey(telemetryField);
     }

engine/src/main/java/org/terasology/telemetry/TelemetryUtils.java

@@ -49,26 +49,28 @@ private TelemetryUtils() {
     }
 
     /**
-     * Fetch metric in {@link org.terasology.telemetry.Metrics} and send to the server.
-     * This method could be used in the method.
-     * @param metrics Metrics instance in the game context.
-     * @param metricClass The class of metric.
-     * @param context the game context
+     * Fetch metric in {@link org.terasology.context.Context} and send to the server.
+     * This method could be used in the modules.
+     * @param context The game context
+     * @param metricClass The class of the metric which we want to track
      * @param nameSpace The name the class tracking this metric.
-     * @param telemetryConfiguration the telemetryConfiguration adapter which could be used in modules.
      */
-    public static void fetchMetricAndSend(Metrics metrics, Class metricClass, Context context, String nameSpace, TelemetryConfiguration telemetryConfiguration) {
+    public static void fetchMetricAndSend(Context context, Class metricClass, String nameSpace) {
         Emitter emitter = context.get(Emitter.class);
-        if (emitter != null) {
-            Optional<Metric> optional = metrics.getMetric(metricClass);
-            if (optional.isPresent()) {
-                Metric metric = optional.get();
-                Optional<Unstructured> optionalUnstructure = metric.getUnstructuredMetric();
-                if (optionalUnstructure.isPresent()) {
-                    Unstructured unstructured = optionalUnstructure.get();
+        Metrics metrics = context.get(Metrics.class);
+        TelemetryConfiguration telemetryConfiguration = context.get(TelemetryConfiguration.class);
+        if (emitter != null && metrics != null && telemetryConfiguration != null) {
+            Optional<Metric> metricOptional = metrics.getMetric(metricClass);
+            if (metricOptional.isPresent()) {
+                Metric metric = metricOptional.get();
+                Optional<Unstructured> unstructuredOptional = metric.getUnstructuredMetric();
+                if (unstructuredOptional.isPresent()) {
+                    Unstructured unstructured = unstructuredOptional.get();
                     trackMetric(emitter, nameSpace, unstructured, metric, telemetryConfiguration);
                 }
             }
+        } else {
+            logger.error("Emitter or metrics or telemetryConfiguration is not in context");
         }
     }
 
@@ -109,7 +111,7 @@ public static void trackMetric(Emitter emitter, String nameSpace, Unstructured e
             } else if (telemetryConfiguration.fetchBindingSize() != 0) {
                 TelemetryCategory telemetryCategory = metric.getClass().getAnnotation(TelemetryCategory.class);
                 if (telemetryCategory != null) {
-                    if (telemetryConfiguration.containField(telemetryCategory.id())) {
+                    if (telemetryConfiguration.containsField(telemetryCategory.id())) {
                         if ((telemetryConfiguration.get(telemetryCategory.id()))) {
                             trackMetric(emitter, nameSpace, event);
                         }

engine/src/main/java/org/terasology/telemetry/metrics/BlockPlacedMetric.java

@@ -16,7 +16,6 @@
 package org.terasology.telemetry.metrics;
 
 import com.snowplowanalytics.snowplow.tracker.events.Unstructured;
-import com.snowplowanalytics.snowplow.tracker.payload.SelfDescribingJson;
 import org.terasology.entitySystem.entity.EntityRef;
 import org.terasology.logic.players.LocalPlayer;
 import org.terasology.registry.CoreRegistry;

engine/src/main/java/org/terasology/telemetry/metrics/Metric.java

@@ -20,6 +20,7 @@
 import org.reflections.ReflectionUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.terasology.config.facade.TelemetryConfiguration;
 import org.terasology.context.Context;
 import org.terasology.engine.subsystem.DisplayDevice;
 import org.terasology.module.sandbox.API;
@@ -119,15 +120,14 @@ protected Map<String, Object> filterMetricMap(Map<String, Boolean> bindingMap) {
         TelemetryCategory telemetryCategory = this.getClass().getAnnotation(TelemetryCategory.class);
         Context context = CoreRegistry.get(Context.class);
         DisplayDevice display = context.get(DisplayDevice.class);
-        if (display.isHeadless()) {
+        if (display.isHeadless() || telemetryCategory.isOneMapMetric()) {
             return telemetryFieldToValue;
         }
         Map<String, Object> metricMapAfterPermission = new HashMap<>();
-        for (Object key : telemetryFieldToValue.keySet()) {
-            String fieldName = key.toString();
-            String fieldNamewithID = telemetryCategory.id() + ":" + key.toString();
-            if (bindingMap.containsKey(fieldNamewithID)) {
-                if (bindingMap.get(fieldNamewithID)) {
+        for (String fieldName : telemetryFieldToValue.keySet()) {
+            String fieldNameWithID = telemetryCategory.id() + ":" + fieldName;
+            if (bindingMap.containsKey(fieldNameWithID)) {
+                if (bindingMap.get(fieldNameWithID)) {
                     metricMapAfterPermission.put(fieldName, telemetryFieldToValue.get(fieldName));
                 } else {
                     metricMapAfterPermission.put(fieldName, "Disabled Field");
@@ -138,6 +138,34 @@ protected Map<String, Object> filterMetricMap(Map<String, Boolean> bindingMap) {
         return metricMapAfterPermission;
     }
 
+    /**
+     * Filter the metric map by the binding map.
+     * If the user doesn't want the field to be sent, its value will be covered by "Disabled Field".
+     * This method could be used in module since {@link org.terasology.config.facade.TelemetryConfiguration} is exposed to modules
+     * @param telemetryConfiguration the telemetry configuration exposed modules
+     * @return a new metric map that covers the field that the user doesn't want to send by "Disabled Field".
+     */
+    protected Map<String, Object> filterMetricMap(TelemetryConfiguration telemetryConfiguration) {
+        TelemetryCategory telemetryCategory = this.getClass().getAnnotation(TelemetryCategory.class);
+        Context context = CoreRegistry.get(Context.class);
+        DisplayDevice display = context.get(DisplayDevice.class);
+        if (display.isHeadless() || telemetryCategory.isOneMapMetric()) {
+            return telemetryFieldToValue;
+        }
+        Map<String, Object> metricMapAfterPermission = new HashMap<>();
+        for (String fieldName : telemetryFieldToValue.keySet()) {
+            String fieldNameWithID = telemetryCategory.id() + ":" + fieldName;
+            if (telemetryConfiguration.containsField(fieldNameWithID)) {
+                if (telemetryConfiguration.get(fieldNameWithID)) {
+                    metricMapAfterPermission.put(fieldName, telemetryFieldToValue.get(fieldName));
+                } else {
+                    metricMapAfterPermission.put(fieldName, "Disabled Field");
+                }
+            }
+        }
+        return metricMapAfterPermission;
+    }
+
     /**
      * Add the new metric to {@link org.terasology.telemetry.Metrics} instance.
      * This method will only be used when a metric constructor needs some specific arguments other than {@link org.terasology.context.Context}.