Fix #1027: Remove default values from URLs (#1028)

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [unreleased](https://github.com/mozilla/glam/compare/2020.11.0...HEAD) (date TBD)
 
+- Remove default values from URLs so they aren't as unwieldy
+  ([#1027](https://github.com/mozilla/glam/issues/1027))
 - Default to "All" ping types for unknown ping types
   ([#1026](https://github.com/mozilla/glam/issues/1026))
 - Update labeled counters to use linear probe view

src/config/fenix.js

@@ -1,4 +1,5 @@
 import { transformAPIResponse } from '../utils/transform-data';
+import { stripDefaultValues } from '../utils/urls';
 import { extractBucketMetadata } from './shared';
 import { getProbeData } from '../state/api';
 import {
@@ -66,7 +67,7 @@ export default {
     // These parameters will map to a ${key}=${value}&... in the querystring,
     // which is used to convey the view state when the GLAM URL is shared with
     // others.
-    return {
+    const params = {
       app_id: storeValue.productDimensions.app_id,
       os: storeValue.productDimensions.os,
       ping_type: storeValue.productDimensions.ping_type,
@@ -77,6 +78,7 @@ export default {
       visiblePercentiles: storeValue.visiblePercentiles,
       reference: storeValue.reference,
     };
+    return stripDefaultValues(params);
   },
   getParamsForDataAPI(storeValue) {
     // These parameters are needed to request the data from the API itself

src/config/firefox-desktop.js

@@ -1,5 +1,6 @@
 import produce from 'immer';
 import { extractBucketMetadata } from './shared';
+import { stripDefaultValues } from '../utils/urls';
 import { transformAPIResponse } from '../utils/transform-data';
 import { isSelectedProcessValid } from '../utils/probe-utils';
 import { getProbeData } from '../state/api';
@@ -87,7 +88,7 @@ export default {
     // These parameters will map to a ${key}=${value}&... in the querystring,
     // which is used to convey the view state when the GLAM URL is shared with
     // others.
-    return {
+    const params = {
       channel: storeValue.productDimensions.channel,
       os: storeValue.productDimensions.os,
       aggregationLevel: storeValue.productDimensions.aggregationLevel,
@@ -98,6 +99,7 @@ export default {
       visiblePercentiles: storeValue.visiblePercentiles,
       reference: storeValue.reference,
     };
+    return stripDefaultValues(params);
   },
   getParamsForDataAPI(storeValue) {
     // These parameters are needed to request the data from the API itself

src/utils/urls.js

@@ -1,3 +1,6 @@
+import paramDefaults from '../config/shared';
+
+// Return a shortened URL for bugzilla and github URLs.
 export function extractBugId(url) {
   if (url.includes('bugzilla')) {
     const match = /id=(?<id>\d+)/.exec(url);
@@ -14,3 +17,32 @@ export function extractBugId(url) {
   }
   return url;
 }
+
+// Given an object of query params, return the object stripped of query
+// parameters that are set to their default values.
+export function stripDefaultValues(params) {
+  return Object.keys(params)
+    .filter((k) => {
+      if (Object.keys(paramDefaults).includes(k)) {
+        // If this param has a default value defined.
+        if (paramDefaults[k].isMulti) {
+          // If it has multiple values, use JSON.stringify for an easy
+          // equality check since these are arrays.
+          return (
+            JSON.stringify(params[k]) !==
+            JSON.stringify(paramDefaults[k].defaultValue)
+          );
+        }
+        // It's not `isMulti`, so just compare value to value.
+        return params[k] !== paramDefaults[k].defaultValue;
+      }
+      // If no default defined, return true to always include it in the URL.
+      return true;
+    })
+    .reduce((obj, k) => {
+      return {
+        ...obj,
+        [k]: params[k],
+      };
+    }, {});
+}