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

terryttsai · 2022-11-30T22:02:57Z

Description of the change

Create new AgencyDataStore that fetches and stores from the agency published_data endpoint.

In this PR, this store is being used to properly propagate metric names (no more seeing metric keys instead of metric names if no data is published for a metric!)

The store also completely replaces the old agency dashboard datapointsStore, so I am removing it in this PR!

Type of change

All pull requests must have at least one of the following labels applied (otherwise the PR will fail):

Label	Description
Type: Bug	non-breaking change that fixes an issue
Type: Feature	non-breaking change that adds functionality
Type: Breaking Change	fix or feature that would cause existing functionality to not work as expected
Type: Non-breaking refactor	change addresses some tech debt item or prepares for a later change, but does not change functionality
Type: Configuration Change	adjusts configuration to achieve some end related to functionality, development, performance, or security
Type: Dependency Upgrade	upgrades a project dependency - these changes are not included in release notes

Related issues

Closes #188

Checklists

Development

This box MUST be checked by the submitter prior to merging:

Double- and triple-checked that there is no Personally Identifiable Information (PII) being mistakenly added in this pull request

These boxes should be checked by the submitter prior to merging:

Tests have been written to cover the code changed/added as part of this pull request

Code review

These boxes should be checked by reviewers prior to merging:

This pull request has a descriptive title and information useful to a reviewer
This pull request has been moved out of a Draft state, has no "Work In Progress" label, and has assigned reviewers
Potential security implications or infrastructural changes have been considered, if relevant

terryttsai · 2022-11-30T22:15:07Z

agency-dashboard/src/stores/DatapointsStore.ts

-   * containing start_date, end_date and key value pairs for each dimension and their values.
-   * See the DatapointsByMetric type for details.
-   */
-  get datapointsByMetric(): DatapointsByMetric {


This is already inherited from BaseDatapointsStore, wonder how this got here

terryttsai · 2022-11-30T22:15:32Z

common/stores/BaseDatapointsStore.ts

@@ -53,14 +52,6 @@ abstract class DatapointsStore {
    this.loading = true;
  }

-  get metricKeyToDisplayName(): { [metricKey: string]: string | null } {


use agency data store's instead

terryttsai · 2022-11-30T22:19:16Z

agency-dashboard/src/stores/AgencyDataStore.ts

+
+import { request } from "../utils/networking";
+
+class AgencyDataStore {


I'm calling it AgencyDataStore because in the future this will include not just an agency's published metric datapoints and metric information but also agency metadata such as name, description etc

Oh I love that! Good thinking

terryttsai · 2022-12-01T00:03:55Z

agency-dashboard/src/stores/AgencyDataStore.ts

+   * containing start_date, end_date and key value pairs for each dimension and their values.
+   * See the DatapointsByMetric type for details.
+   */
+  get datapointsByMetric(): DatapointsByMetric {


This is similar to datapointsByMetric in the BaseDatapointsStore class, in that it transforms the data in the same way

terryttsai · 2022-12-01T06:53:31Z

We could, either in this PR or a follow-up, delete the shared BaseDatapointsStore class + delete the published_datapoints endpoint

mxosman · 2022-12-01T21:24:33Z

agency-dashboard/src/AgencyOverview.test.tsx

@@ -87,12 +55,10 @@ test("renders list of metrics", async () => {
    /Click on a metric to view chart:/i
  );
  expect(textElement1).toBeInTheDocument();
-  const textElement2 = await screen.findByText(/LAW_ENFORCEMENT_ARRESTS/i);
+  const textElement2 = await screen.findByText(/Total Arrests/i);


nit: might be more helpful to have the variable names closely match the text its locating?

like textElementTotalArrests? textElementClickOnAMetricToViewChart?

Yeah, something like that - only if it feels helpful!

mxosman · 2022-12-01T21:24:38Z

agency-dashboard/src/DashboardView.tsx

+    } catch (error) {
+      showToast("Error fetching data.", false, "red", 4000);
+    }
+  };


I think you can define and use this as is inside the useEffect unless you're using it elsewhere in this component.

mxosman · 2022-12-01T21:24:42Z

agency-dashboard/src/DashboardView.tsx

-            navigate(`/agency/${agencyId}/dashboard?metric=${metric}`)
-          }
+          onMetricsSelect={(selectedMetricName) => {
+            const mKey =


nit: maybe selectedMetricKey?

agency-dashboard/src/stores/AgencyDataStore.ts

mxosman · 2022-12-01T21:28:18Z

Terry this looks good to me! Just had a question and some suggestions. I'll let @lilidworkin take a pass as well.

lilidworkin

This looks great @terryttsai !

Just to make sure I'm understanding properly, so we are no longer inheriting from BaseDatapointStore in Agency Dashboard, correct? If so, is there still a concern about having to duplicate logic, or is that not relevant anymore?

lilidworkin · 2022-12-02T15:57:53Z

agency-dashboard/src/stores/AgencyDataStore.ts

+
+import { request } from "../utils/networking";
+
+class AgencyDataStore {


Oh I love that! Good thinking

lilidworkin · 2022-12-02T16:00:30Z

publisher/src/stores/DatapointsStore.ts

@@ -37,12 +33,6 @@ class DatapointsStore extends BaseDatapointsStore {

  api: API;

-  rawDatapoints: RawDatapoint[];


Just curious, why is it safe to get rid of these fields now?

They're already inherited from the BaseDatapointsStore! I'm not sure how those got in there if either I missed them or they got added back in

lilidworkin · 2022-12-02T16:02:49Z

We could, either in this PR or a follow-up, delete the shared BaseDatapointsStore class + delete the published_datapoints endpoint

I don't feel strongly about deleting BaseDatapointsStore -- seems safe enough to keep that. But I do think the published_datapoints endpoint should be deleted! I always find it confusing to have deprecated endpoints / APIs in the codebase. Don't feel strongly about whether it happens in this PR or a followup.

terryttsai · 2022-12-02T18:05:16Z

Just to make sure I'm understanding properly, so we are no longer inheriting from BaseDatapointStore in Agency Dashboard, correct? If so, is there still a concern about having to duplicate logic, or is that not relevant anymore?

We don't need to share this logic between the two apps anymore, so there's not really a need for a BaseDatapointsStore since only publisher is using it now

terryttsai · 2022-12-02T19:09:34Z

I'll remove the endpoint in a followup!

…diviz-data#17026) ## Description of the change Remove no-longer-used `published_datapoints` endpoint. NOTE: must merge Recidiviz/justice-counts#189 before this ## Type of change > All pull requests must have at least one of the following labels applied (otherwise the PR will fail): | Label | Description | |----------------------------- |----------------------------------------------------------------------------------------------------------- | | Type: Bug | non-breaking change that fixes an issue | | Type: Feature | non-breaking change that adds functionality | | Type: Breaking Change | fix or feature that would cause existing functionality to not work as expected | | Type: Non-breaking refactor | change addresses some tech debt item or prepares for a later change, but does not change functionality | | Type: Configuration Change | adjusts configuration to achieve some end related to functionality, development, performance, or security | | Type: Dependency Upgrade | upgrades a project dependency - these changes are not included in release notes | ## Related issues Closes #XXXX ## Checklists ### Development **This box MUST be checked by the submitter prior to merging**: - [x] **Double- and triple-checked that there is no Personally Identifiable Information (PII) being mistakenly added in this pull request** These boxes should be checked by the submitter prior to merging: - [ ] Tests have been written to cover the code changed/added as part of this pull request ### Code review These boxes should be checked by reviewers prior to merging: - [ ] This pull request has a descriptive title and information useful to a reviewer - [ ] This pull request has been moved out of a Draft state, has no "Work In Progress" label, and has assigned reviewers - [ ] Potential security implications or infrastructural changes have been considered, if relevant GitOrigin-RevId: 525dab46c78b745f59df4c19d2cb9fac7e00162b

…diviz-data#17026) ## Description of the change Remove no-longer-used `published_datapoints` endpoint. NOTE: must merge Recidiviz/justice-counts#189 before this ## Type of change > All pull requests must have at least one of the following labels applied (otherwise the PR will fail): | Label | Description | |----------------------------- |----------------------------------------------------------------------------------------------------------- | | Type: Bug | non-breaking change that fixes an issue | | Type: Feature | non-breaking change that adds functionality | | Type: Breaking Change | fix or feature that would cause existing functionality to not work as expected | | Type: Non-breaking refactor | change addresses some tech debt item or prepares for a later change, but does not change functionality | | Type: Configuration Change | adjusts configuration to achieve some end related to functionality, development, performance, or security | | Type: Dependency Upgrade | upgrades a project dependency - these changes are not included in release notes | ## Related issues Closes #XXXX ## Checklists ### Development **This box MUST be checked by the submitter prior to merging**: - [x] **Double- and triple-checked that there is no Personally Identifiable Information (PII) being mistakenly added in this pull request** These boxes should be checked by the submitter prior to merging: - [ ] Tests have been written to cover the code changed/added as part of this pull request ### Code review These boxes should be checked by reviewers prior to merging: - [ ] This pull request has a descriptive title and information useful to a reviewer - [ ] This pull request has been moved out of a Draft state, has no "Work In Progress" label, and has assigned reviewers - [ ] Potential security implications or infrastructural changes have been considered, if relevant GitOrigin-RevId: 9fa42847c594e621d7fdd744d360e43ef3c8848c

create agency data store and fetch published data

5239e8e

terryttsai added the Type: Feature label Nov 30, 2022

terryttsai requested a review from a team November 30, 2022 22:02

Remove null type

0b20ee7

terryttsai commented Nov 30, 2022

View reviewed changes

terryttsai marked this pull request as ready for review November 30, 2022 22:15

lint

909bba6

terryttsai commented Nov 30, 2022

View reviewed changes

terryttsai added 2 commits November 30, 2022 14:46

fix tests

e5f2dde

replace datapointsStore with agencyDataStore

0454c4a

terryttsai commented Dec 1, 2022

View reviewed changes

terryttsai added 3 commits November 30, 2022 16:04

remove cast

4ea8f76

remove unused import

6e7d853

fix tests

aa498c3

mxosman reviewed Dec 1, 2022

View reviewed changes

agency-dashboard/src/stores/AgencyDataStore.ts Show resolved Hide resolved

lilidworkin reviewed Dec 2, 2022

View reviewed changes

PR

804ac03

terryttsai requested review from mxosman and lilidworkin December 2, 2022 19:09

mxosman approved these changes Dec 2, 2022

View reviewed changes

terryttsai merged commit 092566f into main Dec 2, 2022

terryttsai deleted the ttt/published_data_api branch December 2, 2022 19:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

terryttsai commented Nov 30, 2022 •

edited

terryttsai Nov 30, 2022

terryttsai Nov 30, 2022

terryttsai Nov 30, 2022 •

edited

lilidworkin Dec 2, 2022

terryttsai Dec 1, 2022

terryttsai commented Dec 1, 2022

mxosman Dec 1, 2022

terryttsai Dec 2, 2022

mxosman Dec 2, 2022

mxosman Dec 1, 2022

terryttsai Dec 2, 2022

mxosman Dec 1, 2022

mxosman commented Dec 1, 2022

lilidworkin left a comment

lilidworkin Dec 2, 2022

lilidworkin Dec 2, 2022

terryttsai Dec 2, 2022

lilidworkin commented Dec 2, 2022

terryttsai commented Dec 2, 2022

terryttsai commented Dec 2, 2022


		import { request } from "../utils/networking";

		class AgencyDataStore {

		@@ -37,12 +33,6 @@ class DatapointsStore extends BaseDatapointsStore {

		api: API;

		rawDatapoints: RawDatapoint[];

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

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

Conversation

terryttsai commented Nov 30, 2022 • edited

Description of the change

Type of change

Related issues

Checklists

Development

Code review

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terryttsai Nov 30, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terryttsai commented Dec 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mxosman commented Dec 1, 2022

lilidworkin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lilidworkin commented Dec 2, 2022

terryttsai commented Dec 2, 2022

terryttsai commented Dec 2, 2022

terryttsai commented Nov 30, 2022 •

edited

terryttsai Nov 30, 2022 •

edited