[Backend] Surface Current Preference under Privacy Experience List endpoint

[pattisdr]

❗ Depends on #3193
❗ Note, this endpoint is not yet "public" that will be a follow-up ticket

Closes #3237

Description Of Changes

Add a ?fides_user_device_id query param to the GET Privacy Experience List/Detail endpoint. This endpoint already embeds related privacy notices in the response. Add the current preferences of the user to each notice if they exist. Also add the default preferences for that endpoint.

Code Changes

• Update the PrivacyExperience.get_related_privacy_notices method to temporarily cache the "current_preference" or an "outdated_preference" to each privacy notice for the given user if applicable. I only add one or the other, or neither, not both. This lasts for the current session.
• Add a separate PrivacyNotice.default_preference property that always returns whatever the default preference is for that notice, regardless of whether a fides user device id is involved in the query
• Add fides_user_device_id query param to both the privacy experience list and detail endpoints to additionally attach current preferences to embedded notices if they exist

Steps to Confirm

In postman collection:

• Create privacy notices
• Save a preference for one of the notices with a certain fides_user_device_id passed in in the request body
• View the PrivacyExperienceList endpoint, note the default_preference field exists on the new notices
• Add a fides_user_device_id query param and note that the user's current preference is returned
• Update the notice itself
• Query PrivacyExperienceList again with the fides user device id and note that this preference is now returned as an "outdated preference"

Pre-Merge Checklist

• All CI Pipelines Succeeded
• Documentation:
  • documentation complete, PR opened in fidesdocs
  • documentation issue created in fidesdocs
• Issue Requirements are Met
• Relevant Follow-Up Issues Created
• Update CHANGELOG.md
• For API changes, the Postman collection has been updated

[cypress]

Passing run #2043 ↗︎

0	4	0	0	0
⚠️ You've recorded test results over your free plan limit. Upgrade your plan to view test results.

Details:

Merge 088df1b into 1290bf1...
Project: fides	Commit: 7d1be8ef7a ℹ️
Status: Passed	Duration: 01:10 💡
Started: May 18, 2023 1:14 AM	Ended: May 18, 2023 1:15 AM

_{This comment has been generated by cypress-bot as a result of this project's GitHub integration settings.}

[codecov]

Codecov Report

Patch coverage: 96.66% and no project coverage change.

Comparison is base (1290bf1) 87.06% compared to head (088df1b) 87.06%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3302   +/-   ##
=======================================
  Coverage   87.06%   87.06%           
=======================================
  Files         309      309           
  Lines       18821    18847   +26     
  Branches     2461     2467    +6     
=======================================
+ Hits        16386    16410   +24     
- Misses       1995     1996    +1     
- Partials      440      441    +1     

Impacted Files	Coverage Δ
src/fides/api/ops/models/privacy_notice.py	98.96% <86.66%> (-1.04%)	⬇️
...s/api/v1/endpoints/privacy_experience_endpoints.py	100.00% <100.00%> (ø)
...s/api/v1/endpoints/privacy_preference_endpoints.py	100.00% <100.00%> (+0.76%)	⬆️
src/fides/api/ops/models/privacy_experience.py	100.00% <100.00%> (ø)
src/fides/api/ops/models/privacy_preference.py	100.00% <100.00%> (ø)
src/fides/api/ops/schemas/privacy_experience.py	100.00% <100.00%> (ø)
src/fides/api/ops/schemas/privacy_notice.py	100.00% <100.00%> (ø)
src/fides/api/ops/schemas/privacy_preference.py	100.00% <100.00%> (ø)
.../ops/service/connectors/consent_email_connector.py	97.14% <100.00%> (ø)
src/fides/api/ops/util/consent_util.py	98.11% <100.00%> (-1.89%)	⬇️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[allisonking]

nice, this makes sense to me!

[pattisdr]

Thanks so much for looking this over @allisonking!