Elisa/7492 public device endpoint #8341

emyl3 · 2024-12-03T22:10:29Z

BACKEND PULL REQUEST

Related Issue

Part II of Demo/Training: Update Device List to Match Production #7492

Changes Proposed

Add a public endpoint /devices that returns all DeviceTypes (without any internal ids)
- leverage @JsonView annotation to return certain fields
- protect the endpoint by ensuring the request to that endpoint has a custom header Sr-Prod-Devices-Token with the valid token (See Add prod device sync related secrets to tf configs #8323 for how to get the token value)

Additional Information

co-authored by @DanielSass
created a new DeviceTypeProdSyncService for logic related to the device sync from prod
- TBD I may or may not combine this with the existing DeviceTypeSyncService or just rename this service to make it clear it is for the LIVD sync will depend on how the sync is implemented in part III

Testing

deployed on dev4
use an API testing tool of your choice to fetch the device list from dev4
e.g.
```
curl --header "Sr-Prod-Devices-Token: REPLACE_TOKEN_HERE" https://dev4.simplereport.gov/api/devices
```
- you should see the entire list without any InternalIds
use an API testing tool of your choice to hit that same endpoint without the Sr-Prod-Devices-Token header
e.g.
```
curl -v  https://dev4.simplereport.gov/api/devices
```
- you should see no devices and see that the request is Unauthorized

sonarqubecloud · 2024-12-04T21:34:01Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

bobbywells52

Tested and the end point works as expected with and without authorization + paired with Elisa and talked through all of my questions -- LGTM! Thanks for all of you work on this Elisa!!

mpbrown

Tested the endpoint and everything looks good!

With the current configuration it looks like the lower environments will also end up having this endpoint active right? Just want to check whether that is desired or whether we should have a configuration setting so that by default the endpoint is disabled in the lowers but could be turned on for testing if needed similar to the sendgrid config setting?

DanielSass · 2024-12-10T18:27:49Z

backend/src/main/java/gov/cdc/usds/simplereport/db/model/DeviceType.java

  private int testLength;

-  @JsonIgnore


@emyl3 Have you looked into our concerns that removing these ignore tags will cause an issue?

And I apologize because I just now realized I never added that detail to the ticket:

#7492 (comment)

I had previously deployed this branch both with and without the @JsonIgnore -- is this what you were thinking in terms of adding a timer and logging to see if there's a difference with and without the @JsonIgnore

This is with the JsonIgnore tag

This is without

Let me know if this is not what you had in mind and I can adjust the testing plan and retest 😅

Part of me thinks that the issue is no longer relevant because the audit log was moved out of our db table. The other part of me thinks if it is somehow still an issue, we aren't going to see it until we send this to prod.

I talked to @mehansen about this a bit and I loved her idea of just trying to replicate the original issue as a means of confirming that its no longer a concern. But again, the lack of an audit log in the db might make that a futile effort.

After discussing with @DanielSass @mehansen and @mpbrown after standup, we will deploy this after the cert renewal.

Once merged in, I will keep an eye on the following:

prod Azure dashboard

app insights page

DB request avg times

If there are any slowdowns noticeable from Azure following the deploy, we will revert this PR and see if there are ways we can investigate this further.

In the meantime, I will look into if there's a way to view DB request times in Azure or check-in with Shanice after cert renewal.

I'm seeing the our "Azure Database for PostgreSQL - Flexible Server" view for our prod DB and there is a way to view both the Read and Write Throughput Bytes/Sec (Avg) -- Would this be sufficient? 🤔

@shanice-skylight Are you familiar with any Azure tools to monitor avg DB request times? I saw there's this but we don't seem to have that enabled. 🤔

emyl3 · 2024-12-16T19:10:56Z

⚠️ HOLD OFF ON MERGING!

mehansen · 2024-12-16T20:18:13Z

backend/src/main/java/gov/cdc/usds/simplereport/config/WebConfiguration.java

@@ -24,6 +24,8 @@ public class WebConfiguration implements WebMvcConfigurer {
  public static final String PATIENT_UPLOAD = "/upload/patients";
  public static final String RESULT_UPLOAD = "/upload/results";
  public static final String CONDITION_AGNOSTIC_RESULT_UPLOAD = "/upload/condition-agnostic";
+


formatting nit - extra newline?

Ahhh thank you! I'll update that in the part 3 PR 😅

ooo oops -- I'll remove this in my next PR 😅 Thank you for catching this 🎣

mehansen · 2024-12-16T20:24:43Z

backend/src/main/java/gov/cdc/usds/simplereport/api/devicetype/DeviceTypeController.java

  @Autowired private DeviceTypeSyncService deviceTypeSyncService;
+  @Autowired private DeviceTypeProdSyncService deviceTypeProdSyncService;
+  @Autowired private DeviceTypeService deviceTypeService;


TBD I may or may not combine this with the existing DeviceTypeSyncService or just rename this service to make it clear it is for the LIVD sync will depend on how the sync is implemented in part III

I like this idea! I got tripped up w/ these names

poc for using a json view for public device data

d587d5c

emyl3 force-pushed the elisa/7492-public-device-endpoint branch 2 times, most recently from 870dfba to 6fd0a9b Compare December 3, 2024 23:06

emyl3 mentioned this pull request Dec 3, 2024

Demo/Training: Update Device List to Match Production #7492

Open

emyl3 temporarily deployed to dev4 December 4, 2024 18:21 — with GitHub Actions Inactive

emyl3 temporarily deployed to dev4 December 4, 2024 18:28 — with GitHub Actions Inactive

emyl3 temporarily deployed to dev4 December 4, 2024 18:31 — with GitHub Actions Inactive

Add token validation and tests

42aaf8b

emyl3 force-pushed the elisa/7492-public-device-endpoint branch from 6fd0a9b to 42aaf8b Compare December 4, 2024 21:22

emyl3 temporarily deployed to dev4 December 4, 2024 21:36 — with GitHub Actions Inactive

emyl3 temporarily deployed to dev4 December 4, 2024 21:43 — with GitHub Actions Inactive

emyl3 temporarily deployed to dev4 December 4, 2024 21:46 — with GitHub Actions Inactive

emyl3 marked this pull request as ready for review December 4, 2024 22:43

emyl3 requested review from mehansen, DanielSass, mpbrown, DavidMcClatchey and bobbywells52 December 4, 2024 22:44

bobbywells52 approved these changes Dec 5, 2024

View reviewed changes

mpbrown approved these changes Dec 6, 2024

View reviewed changes

DanielSass reviewed Dec 10, 2024

View reviewed changes

emyl3 added the Blocked label Dec 16, 2024

mehansen approved these changes Dec 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Elisa/7492 public device endpoint #8341

Elisa/7492 public device endpoint #8341

emyl3 commented Dec 3, 2024 •

edited

Loading

sonarqubecloud bot commented Dec 4, 2024

bobbywells52 left a comment

mpbrown left a comment

DanielSass Dec 10, 2024

DanielSass Dec 10, 2024

emyl3 Dec 12, 2024

emyl3 Dec 12, 2024

DanielSass Dec 16, 2024

DanielSass Dec 16, 2024

emyl3 Dec 16, 2024

emyl3 Dec 17, 2024

emyl3 Dec 19, 2024

emyl3 commented Dec 16, 2024

mehansen Dec 16, 2024

emyl3 Dec 16, 2024

emyl3 Dec 16, 2024

mehansen Dec 16, 2024

Elisa/7492 public device endpoint #8341

Are you sure you want to change the base?

Elisa/7492 public device endpoint #8341

Conversation

emyl3 commented Dec 3, 2024 • edited Loading

BACKEND PULL REQUEST

Related Issue

Changes Proposed

Additional Information

Testing

sonarqubecloud bot commented Dec 4, 2024

Quality Gate passed

bobbywells52 left a comment

Choose a reason for hiding this comment

mpbrown 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

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

emyl3 commented Dec 16, 2024

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

emyl3 commented Dec 3, 2024 •

edited

Loading