Fix #1008 Add validation for unknown metric types (#1010)

CHANGELOG.md

@@ -12,6 +12,8 @@
   ([#980](https://github.com/mozilla/glam/pull/980))
 - Add `scalar` to list of known metric types for desktop
   ([#1007](https://github.com/mozilla/glam/issues/1007))
+- Add validation for unknown metric types
+  ([#1008](https://github.com/mozilla/glam/issues/1008))
 
 ## [2020.10.3](https://github.com/mozilla/glam/compare/2020.10.2...2020.10.3) (2020-10-20)
 

src/config/fenix.js

@@ -1,7 +1,11 @@
 import { transformAPIResponse } from '../utils/transform-data';
 import { extractBucketMetadata } from './shared';
 import { getProbeData } from '../state/api';
-import { validate, noResponse } from '../utils/data-validation';
+import {
+  validate,
+  noResponse,
+  noUnknownMetrics,
+} from '../utils/data-validation';
 
 export default {
   label: 'Fenix',
@@ -92,7 +96,10 @@ export default {
       const { aggregationLevel } = appStore.getState().productDimensions;
 
       const metricType = payload.response[0].metric_type;
-      validate(payload, (p) => noResponse(p));
+      validate(payload, (p) => {
+        noResponse(p);
+        noUnknownMetrics(p, Object.keys(this.probeView));
+      });
       const viewType =
         this.probeView[metricType] === 'categorical'
           ? 'proportion'

src/config/firefox-desktop.js

@@ -3,7 +3,11 @@ import { extractBucketMetadata } from './shared';
 import { transformAPIResponse } from '../utils/transform-data';
 import { isSelectedProcessValid } from '../utils/probe-utils';
 import { getProbeData } from '../state/api';
-import { validate, noResponse } from '../utils/data-validation';
+import {
+  validate,
+  noResponse,
+  noUnknownMetrics,
+} from '../utils/data-validation';
 
 export default {
   label: 'Firefox',
@@ -112,7 +116,10 @@ export default {
       const { aggregationLevel } = appStore.getState().productDimensions;
 
       const metricType = payload.response[0].metric_type;
-      validate(payload, (p) => noResponse(p));
+      validate(payload, (p) => {
+        noResponse(p);
+        noUnknownMetrics(p, Object.keys(this.probeView));
+      });
       const viewType =
         this.probeView[metricType] === 'categorical'
           ? 'proportion'

src/utils/data-validation.js

@@ -1,14 +1,13 @@
-export const noDuplicates = (payload, aggregationMethod = 'build_id') => {
-  // go through ever data
-  // look at data[...].metadata[aggregationMethod]. There should be no duplicates.
-  const allBuildIDs = payload.response.map((di) => di[aggregationMethod]);
-  const uniques = new Set(allBuildIDs);
-  if (allBuildIDs.length !== uniques.size) {
-    throw new Error(
-      `Duplicate ${
-        aggregationMethod === 'build_id' ? 'Build IDs' : 'Versions'
-      } found.`
-    );
+export const noUnknownMetrics = (payload, probeViews = []) => {
+  // Ensure the probe metric type is in our list of `probeView`s.
+  const metricType = payload.response[0].metric_type;
+  if (!(metricType in probeViews)) {
+    const er = new Error('This metric type is currently unsupported.');
+    er.moreInformation =
+      `GLAM doesn't yet know how to aggregate "${metricType}" type metrics. ` +
+      'If you seeing aggregations of metrics of this type would be valuable for you, ' +
+      'or if you believe this is an error, please let us know.';
+    throw er;
   }
 };