Merge pull request #998 from cmu-delphi/sgratzl/fix_invalid_signal

feat: allow lazy evaluation of sensor param for generic pages

Author: sgratzl

src/modes/dashboard/DashboardParameters.svelte

@@ -3,9 +3,9 @@
   import SensorDatePicker2 from '../../components/SensorDatePicker2.svelte';
   import SensorSearch from '../../components/SensorSearch.svelte';
   import { formatAPITime } from '../../data';
-  import { nameInfos } from '../../data/regions';
   import { metaDataManager } from '../../stores';
   import { trackEvent } from '../../stores/ga';
+  import { sortedNameInfos } from './utils';
 
   /**
    * @type {import("../../stores/params").SensorParam}
@@ -57,7 +57,7 @@
   <RegionSearch
     className="grid-5-9"
     modern
-    items={nameInfos}
+    items={sortedNameInfos}
     selectedItem={region.value}
     on:change={(e) => setRegion(e.detail && e.detail.level === 'nation' ? null : e.detail)}
   />

src/modes/dashboard/config/RegionPicker.svelte

@@ -1,6 +1,7 @@
 <script>
   import RegionSearch from '../../../components/RegionSearch.svelte';
-  import { countyInfo, getInfoByName, hhsInfo, hrrInfo, msaInfo, nationInfo, stateInfo } from '../../../data/regions';
+  import { getInfoByName } from '../../../data/regions';
+  import { sortedNameInfos } from '../utils';
 
   /**
    * @type {import("../../../stores/params").RegionParam}
@@ -15,7 +16,7 @@
     id: '',
     displayName: `Use Configured: ${region.displayName}`,
   };
-  $: allItems = [defaultRegion, nationInfo, ...stateInfo, ...msaInfo, ...countyInfo, ...hrrInfo, ...hhsInfo];
+  $: allItems = [defaultRegion, ...sortedNameInfos];
 </script>
 
 <div>

src/modes/dashboard/utils.ts

@@ -1,3 +1,5 @@
+import { countyInfo, hhsInfo, hrrInfo, msaInfo, nationInfo, stateInfo } from '../../data/regions';
+
 export function formToConfig(formData: FormData): Record<string, unknown> {
   const config: Record<string, unknown> = {};
 
@@ -30,3 +32,5 @@ export function formToConfig(formData: FormData): Record<string, unknown> {
   });
   return config;
 }
+
+export const sortedNameInfos = [nationInfo, ...stateInfo, ...msaInfo, ...countyInfo, ...hrrInfo, ...hhsInfo];

src/modes/index.ts

@@ -8,6 +8,7 @@ export interface Mode {
   component: () => Promise<any>;
   anchor?: string;
   waitForReady?: boolean;
+  isGeneric?: boolean;
 }
 
 export default modes;

src/modes/modes.js

@@ -33,11 +33,13 @@ export const modes = [
   {
     id: 'export',
     label: 'Export Data',
+    isGeneric: true,
     component: () => import(/* webpackChunkName: 'm-export' */ './exportdata/ExportData.svelte').then((r) => r.default),
   },
   {
     id: 'indicator-status',
     label: 'Indicator Status Overview',
+    isGeneric: true,
     component: () =>
       import(/* webpackChunkName: 'm-indicator-status' */ './indicator-status/IndicatorStatusOverview.svelte').then(
         (r) => r.default,
@@ -47,6 +49,7 @@ export const modes = [
   {
     id: 'indicator-source',
     label: 'Indicator Source',
+    isGeneric: true,
     component: () =>
       import(/* webpackChunkName: 'm-indicator-source' */ './indicator-status/IndicatorSource.svelte').then(
         (r) => r.default,
@@ -56,6 +59,7 @@ export const modes = [
   {
     id: 'indicator-signal',
     label: 'Indicator Signal',
+    isGeneric: true,
     component: () =>
       import(/* webpackChunkName: 'm-indicator-signal' */ './indicator-status/IndicatorSignal.svelte').then(
         (r) => r.default,
@@ -65,6 +69,7 @@ export const modes = [
   {
     id: 'dashboard',
     label: 'Dashboard Builder',
+    isGeneric: true,
     component: () =>
       import(/* webpackChunkName: 'm-dashboard' */ './dashboard/Dashboard.svelte').then((r) => r.default),
     waitForReady: true,

src/stores/index.ts

@@ -50,16 +50,26 @@ function deriveFromPath(url: Location) {
   const mode = urlParams.get('mode') || modeFromPath();
 
   const modeObj = modes.find((d) => d.id === mode) || DEFAULT_MODE;
+  const isGenericPage = modeObj.isGeneric === true;
+  // if a generic page, try to resolve but fall back to the given one, since it might be a not configured one
   const resolveSensor = resolveSensorWithAliases(
     sensor,
-    modeObj === modeByID['survey-results'] ? DEFAULT_SURVEY_SENSOR : DEFAULT_SENSOR,
+    isGenericPage
+      ? sensor || DEFAULT_SENSOR
+      : modeObj === modeByID['survey-results']
+      ? DEFAULT_SURVEY_SENSOR
+      : DEFAULT_SENSOR,
   );
   return {
     mode: modeObj,
     sensor: resolveSensor,
     sensor2: resolveSensorWithAliases(
       sensor2,
-      DEFAULT_CORRELATION_SENSOR === sensor2 ? DEFAULT_SENSOR : DEFAULT_CORRELATION_SENSOR,
+      isGenericPage
+        ? sensor2 || DEFAULT_CORRELATION_SENSOR
+        : DEFAULT_CORRELATION_SENSOR === sensor2
+        ? DEFAULT_SENSOR
+        : DEFAULT_CORRELATION_SENSOR,
     ),
     lag: lag ? Number.parseInt(lag, 10) : 0,
     date: /\d{8}/.test(date) ? date : MAGIC_START_DATE,
@@ -77,10 +87,28 @@ const defaultValues = deriveFromPath(window.location);
 export const currentMode = writable(defaultValues.mode);
 
 export const currentSensor = writable(defaultValues.sensor);
-export const currentSensorEntry = derived([currentSensor], ([$currentSensor]) => sensorMap.get($currentSensor));
+
+function resolveSensor(sensor: string, defaultKey: string) {
+  if (!sensor) {
+    return null;
+  }
+  const r = sensorMap.get(sensor);
+  if (r) {
+    return r;
+  }
+  return sensorMap.get(defaultKey);
+}
+
+export const currentSensorEntry = derived(
+  [currentSensor],
+  // lookup the value, if not found maybe a generic one, if it is set, then return the default, else return the empty one
+  ([$currentSensor]) => resolveSensor($currentSensor, DEFAULT_SENSOR),
+);
 
 export const currentSensor2 = writable(defaultValues.sensor2);
-export const currentSensorEntry2 = derived([currentSensor2], ([$currentSensor]) => sensorMap.get($currentSensor));
+export const currentSensorEntry2 = derived([currentSensor2], ([$currentSensor]) =>
+  resolveSensor($currentSensor, DEFAULT_CORRELATION_SENSOR),
+);
 
 export const currentLag = writable(defaultValues.lag);