[Agency Dashboard] Create agency data store to fetch published data

agency-dashboard/src/AgencyOverview.tsx

@@ -27,11 +27,12 @@ const AgencyOverview = () => {
   const navigate = useNavigate();
   const params = useParams();
   const agencyId = Number(params.id);
-  const { datapointsStore } = useStore();
+  const { agencyDataStore, datapointsStore } = useStore();
 
   const fetchDatapoints = async () => {
     try {
       await datapointsStore.getDatapoints(agencyId);
+      await agencyDataStore.fetchAgencyData(agencyId);
     } catch (error) {
       showToast("Error fetching data.", false, "red", 4000);
     }
@@ -61,7 +62,7 @@ const AgencyOverview = () => {
               navigate(`/agency/${agencyId}/dashboard?metric=${metricKey}`);
             }}
           >
-            {datapointsStore.metricKeyToDisplayName[metricKey] || metricKey}
+            {agencyDataStore.metricKeyToDisplayName[metricKey] || metricKey}
           </MetricCategory>
         )
       )}

agency-dashboard/src/DashboardView.tsx

@@ -93,7 +93,7 @@ const DashboardView = () => {
   const navigate = useNavigate();
   const params = useParams();
   const agencyId = Number(params.id);
-  const { datapointsStore, dataVizStore } = useStore();
+  const { agencyDataStore, datapointsStore, dataVizStore } = useStore();
 
   const {
     timeRange,
@@ -108,6 +108,7 @@ const DashboardView = () => {
   const query = new URLSearchParams(search);
   const metricKey = query.get("metric");
   useEffect(() => {
+    agencyDataStore.fetchAgencyData(agencyId);
     datapointsStore.getDatapoints(agencyId);
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
@@ -155,12 +156,12 @@ const DashboardView = () => {
     return <>Loading...</>;
   }
 
-  const metricNames = Object.keys(
-    datapointsStore.dimensionNamesByMetricAndDisaggregation
+  const metricNames = agencyDataStore.metrics.map(
+    (metric) => metric.display_name
   );
 
   const metricName =
-    datapointsStore.metricKeyToDisplayName[metricKey] || metricKey;
+    agencyDataStore.metricKeyToDisplayName[metricKey] || metricKey;
 
   const filteredAggregateData = transformDataForMetricInsights(
     datapointsStore.datapointsByMetric[metricKey]?.aggregate || [],
@@ -201,9 +202,13 @@ const DashboardView = () => {
           setDisaggregationName={setDisaggregationName}
           setCountOrPercentageView={setCountOrPercentageView}
           metricNames={metricNames}
-          onMetricsSelect={(metric) =>
-            navigate(`/agency/${agencyId}/dashboard?metric=${metric}`)
-          }
+          onMetricsSelect={(selectedMetricName) => {
+            const mKey =
+              agencyDataStore.metricDisplayNameToKey[selectedMetricName];
+            if (mKey) {
+              navigate(`/agency/${agencyId}/dashboard?metric=${mKey}`);
+            }
+          }}
           showBottomMetricInsights={!isDesktopWidth}
           resizeHeight={isDesktopWidth}
         />

agency-dashboard/src/stores/AgencyDataStore.ts

@@ -0,0 +1,85 @@
+// Recidiviz - a data platform for criminal justice reform
+// Copyright (C) 2022 Recidiviz, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+// =============================================================================
+
+import { Metric } from "@justice-counts/common/types";
+import { makeAutoObservable, runInAction } from "mobx";
+
+import { request } from "../utils/networking";
+
+class AgencyDataStore {
+  metrics: Metric[];
+
+  loading: boolean;
+
+  constructor() {
+    makeAutoObservable(this);
+    this.metrics = [];
+    this.loading = true;
+  }
+
+  get metricKeyToDisplayName(): { [metricKey: string]: string | null } {
+    const mapping: { [metricKey: string]: string | null } = {};
+    this.metrics.forEach((metric) => {
+      mapping[metric.key] = metric.display_name;
+    });
+    return mapping;
+  }
+
+  get metricDisplayNameToKey(): { [displayName: string]: string } {
+    const mapping: { [displayName: string]: string } = {};
+    this.metrics.forEach((metric) => {
+      mapping[metric.display_name] = metric.key;
+    });
+    return mapping;
+  }
+
+  async fetchAgencyData(agencyId: number): Promise<void | Error> {
+    try {
+      const response = (await request({
+        path: `/api/agencies/${agencyId}/published_data`,
+        method: "GET",
+      })) as Response;
+      if (response.status === 200) {
+        const result = await response.json();
+        runInAction(() => {
+          this.metrics = result;
+        });
+      } else {
+        const error = await response.json();
+        throw new Error(error.description);
+      }
+      runInAction(() => {
+        this.loading = false;
+      });
+    } catch (error) {
+      runInAction(() => {
+        this.loading = false;
+      });
+      throw error;
+    }
+  }
+
+  resetState() {
+    // reset the state
+    runInAction(() => {
+      this.metrics = [];
+      this.loading = true;
+    });
+  }
+}
+
+export default AgencyDataStore;

agency-dashboard/src/stores/DatapointsStore.ts

@@ -16,101 +16,16 @@
 // =============================================================================
 
 import BaseDatapointsStore from "@justice-counts/common/stores/BaseDatapointsStore";
-import {
-  DatapointsByMetric,
-  DataVizAggregateName,
-  DimensionNamesByMetricAndDisaggregation,
-  RawDatapoint,
-} from "@justice-counts/common/types";
-import { isPositiveNumber } from "@justice-counts/common/utils";
 import { makeObservable, override, runInAction } from "mobx";
 
 import { request } from "../utils/networking";
 
 class DatapointsStore extends BaseDatapointsStore {
-  rawDatapoints: RawDatapoint[];
-
-  dimensionNamesByMetricAndDisaggregation: DimensionNamesByMetricAndDisaggregation;
-
-  loading: boolean;
-
   constructor() {
     super();
     makeObservable(this, {
       getDatapoints: override,
     });
-    this.rawDatapoints = [];
-    this.dimensionNamesByMetricAndDisaggregation = {};
-    this.loading = true;
-  }
-
-  get metricKeyToDisplayName(): { [metricKey: string]: string | null } {
-    const mapping: { [metricKey: string]: string | null } = {};
-    this.rawDatapoints.forEach((dp) => {
-      mapping[dp.metric_definition_key] = dp.metric_display_name;
-    });
-    return mapping;
-  }
-
-  /**
-   * Transforms raw data from the server into Datapoints keyed by metric,
-   * grouped by aggregate values and disaggregations.
-   * Aggregate is an array of objects each containing start_date, end_date, and the aggregate value.
-   * Disaggregations are keyed by disaggregation name and each value is an object
-   * with the key being the start_date and the value being an object
-   * containing start_date, end_date and key value pairs for each dimension and their values.
-   * See the DatapointsByMetric type for details.
-   */
-  get datapointsByMetric(): DatapointsByMetric {
-    return this.rawDatapoints.reduce((res: DatapointsByMetric, dp) => {
-      if (!res[dp.metric_definition_key]) {
-        res[dp.metric_definition_key] = {
-          aggregate: [],
-          disaggregations: {},
-        };
-      }
-
-      const sanitizedValue =
-        dp.value !== null && isPositiveNumber(dp.value)
-          ? Number(dp.value)
-          : null;
-
-      if (
-        dp.disaggregation_display_name === null ||
-        dp.dimension_display_name === null
-      ) {
-        res[dp.metric_definition_key].aggregate.push({
-          [DataVizAggregateName]: sanitizedValue,
-          start_date: dp.start_date,
-          end_date: dp.end_date,
-          frequency: dp.frequency,
-          dataVizMissingData: 0,
-        });
-      } else {
-        if (
-          !res[dp.metric_definition_key].disaggregations[
-            dp.disaggregation_display_name
-          ]
-        ) {
-          res[dp.metric_definition_key].disaggregations[
-            dp.disaggregation_display_name
-          ] = {};
-        }
-        res[dp.metric_definition_key].disaggregations[
-          dp.disaggregation_display_name
-        ][dp.start_date] = {
-          ...res[dp.metric_definition_key].disaggregations[
-            dp.disaggregation_display_name
-          ][dp.start_date],
-          start_date: dp.start_date,
-          end_date: dp.end_date,
-          [dp.dimension_display_name]: sanitizedValue,
-          frequency: dp.frequency,
-          dataVizMissingData: 0,
-        };
-      }
-      return res;
-    }, {});
   }
 
   async getDatapoints(agencyId: number): Promise<void | Error> {

agency-dashboard/src/stores/RootStore.ts

@@ -17,14 +17,18 @@
 
 import DataVizStore from "@justice-counts/common/stores/DataVizStore";
 
+import AgencyDataStore from "./AgencyDataStore";
 import DatapointsStore from "./DatapointsStore";
 
 class RootStore {
+  agencyDataStore: AgencyDataStore;
+
   datapointsStore: DatapointsStore;
 
   dataVizStore: DataVizStore;
 
   constructor() {
+    this.agencyDataStore = new AgencyDataStore();
     this.datapointsStore = new DatapointsStore();
     this.dataVizStore = new DataVizStore();
   }

common/stores/BaseDatapointsStore.ts

@@ -43,7 +43,6 @@ abstract class DatapointsStore {
       rawDatapoints: observable,
       dimensionNamesByMetricAndDisaggregation: observable,
       loading: observable,
-      metricKeyToDisplayName: computed,
       datapointsByMetric: computed,
       getDatapoints: action,
       resetState: action,
@@ -53,14 +52,6 @@ abstract class DatapointsStore {
     this.loading = true;
   }
 
-  get metricKeyToDisplayName(): { [metricKey: string]: string | null } {
-    const mapping: { [metricKey: string]: string | null } = {};
-    this.rawDatapoints.forEach((dp) => {
-      mapping[dp.metric_definition_key] = dp.metric_display_name;
-    });
-    return mapping;
-  }
-
   /**
    * Transforms raw data from the server into Datapoints keyed by metric,
    * grouped by aggregate values and disaggregations.

common/types.ts

@@ -93,6 +93,8 @@ export type MetricConfigurationSettings = {
 export interface Metric {
   key: string;
   system: AgencySystems;
+  custom_frequency?: ReportFrequency;
+  datapoints?: RawDatapoint[];
   display_name: string;
   description: string;
   reporting_note: string;
@@ -105,8 +107,8 @@ export interface Metric {
   disaggregations: MetricDisaggregations[];
   enabled?: boolean;
   settings?: MetricConfigurationSettings[];
+  starting_month?: number;
   frequency?: ReportFrequency;
-  custom_frequency?: ReportFrequency;
 }
 
 export interface MetricDefinition {
@@ -131,6 +133,7 @@ export interface MetricDisaggregations {
   required: boolean;
   helper_text: string | null | undefined;
   enabled?: boolean;
+  should_sum_to_total: boolean;
 }
 
 export interface MetricDisaggregationDimensions {
@@ -143,6 +146,7 @@ export interface MetricDisaggregationDimensions {
   display_name?: string;
   race?: string;
   ethnicity?: string;
+  datapoints?: RawDatapoint[];
 }
 
 export interface CreateReportFormValuesType extends Record<string, unknown> {

publisher/src/components/Reports/DataEntryForm.test.tsx

@@ -130,6 +130,7 @@ describe("test data entry form", () => {
                 ],
                 required: false,
                 helper_text: "Break down the metric by NIBRS offense types.",
+                should_sum_to_total: false,
               },
             ],
           },

publisher/src/stores/DatapointsStore.ts

@@ -16,10 +16,6 @@
 // =============================================================================
 
 import BaseDatapointsStore from "@justice-counts/common/stores/BaseDatapointsStore";
-import {
-  DimensionNamesByMetricAndDisaggregation,
-  RawDatapoint,
-} from "@justice-counts/common/types";
 import {
   IReactionDisposer,
   makeObservable,
@@ -37,12 +33,6 @@ class DatapointsStore extends BaseDatapointsStore {
 
   api: API;
 
-  rawDatapoints: RawDatapoint[];
-
-  dimensionNamesByMetricAndDisaggregation: DimensionNamesByMetricAndDisaggregation;
-
-  loading: boolean;
-
   disposers: IReactionDisposer[] = [];
 
   constructor(userStore: UserStore, api: API) {
@@ -57,9 +47,6 @@ class DatapointsStore extends BaseDatapointsStore {
 
     this.api = api;
     this.userStore = userStore;
-    this.rawDatapoints = [];
-    this.dimensionNamesByMetricAndDisaggregation = {};
-    this.loading = true;
 
     this.disposers.push(
       reaction(

publisher/src/stores/FormStore.test.tsx

@@ -81,6 +81,7 @@ beforeEach(() => {
               ],
               required: false,
               helper_text: "Break down the metric by NIBRS offense types.",
+              should_sum_to_total: false,
             },
           ],
         },

publisher/src/stores/MetricConfigStore.tsx

@@ -188,7 +188,6 @@ class MetricConfigStore {
     }
 
     const metrics: Metric[] = await response.json();
-
     return metrics;
   };