Update privacy center patch call for new API response #4235

allisonking · 2023-10-06T16:57:52Z

Description Of Changes

The privacy center uses the response of patching notices with user preferences in order to create/update its cookie. The response payload format changed in #4201 to nest preferences under an object. This PR allows the FE to handle this new expected payload type.

Code Changes

Update privacy center types
Minor code updates to handle new response type
Update cypress fixtures

Steps to Confirm

Everything should work as before! The main thing that changed is the API returns a new type, so now the FE handles that. To prove it's working, you'll want to observe that your cookie updates according to your saved preferences. This is for notices only, not TCF.

Enable "Data sales and sharing" for privacy notices in admin-ui
VPN to california
Visit the privacy center and click "Manage your consent"
Take a look at your cookie, if one exists. Data sales and sharing is default opt-in, but that might not be reflected in your cookie yet (esp if you don't have a cookie yet!)
Opt out of data sales and sharing
Your cookie value should now say {"consent":{"data_sales_and_sharing":false}}

Pre-Merge Checklist

All CI Pipelines Succeeded
Issue Requirements are Met
Update CHANGELOG.md

allisonking · 2023-10-06T17:56:30Z

clients/privacy-center/components/consent/NoticeDrivenConsent.tsx

@@ -171,7 +171,7 @@ const NoticeDrivenConsent = () => {
          (n) => n.privacy_notice_history_id === historyKey
        );
        const servedNotice = servedNotices?.find(
-          (sn) => sn.privacy_notice_history.id === historyKey
+          (sn) => sn.privacy_notice_history?.id === historyKey


this file is the only one with "actual" changes. there were two API changes we account for here:

served notices now return optional privacy_notice_history (since TCF doesn't have those)

the preferences patch now returns the data we expect nested under preferences (so that tcf data can be nested in its own subsections)

every other change in this PR is pretty much type wrangling

Nice, it looks like a lot of good type updates on the privacy center side made it into this PR

yes, the privacy center types were a bit out of date 😓

cypress · 2023-10-06T18:08:55Z

Passing run #4507 ↗︎

0	4	0	0	0

Details:

Merge `fad6a78` into `e730838`...
Project: fides	Commit: `7b8a069981 ℹ️`
Status: Passed	Duration: 00:52 💡
Started: Oct 6, 2023 8:30 PM	Ended: Oct 6, 2023 8:31 PM

Review all test suite changes for PR #4235 ↗︎

pattisdr

Did a lot of testing and looked closely at this file: clients/privacy-center/components/consent/NoticeDrivenConsent.tsx

I just have one question really!

pattisdr · 2023-10-06T19:36:28Z

clients/privacy-center/cypress/e2e/consent-banner.cy.ts

@@ -1565,7 +1565,7 @@ describe("Consent banner", () => {
        cy.wait("@patchPrivacyPreference").then((preferenceInterception) => {
          const { preferences } = preferenceInterception.request.body;
          const expected = interception.response?.body.map(
-            (s: LastServedNoticeSchema) => s.served_notice_history_id
+            (s: LastServedConsentSchema) => s.served_notice_history_id


There's a similar LastServedNoticeSchema still being imported into clients/privacy-center/cypress/e2e/consent-notices.cy.ts - does that also need to be updated?

ahh good eye!! fixed: fad6a78

pattisdr · 2023-10-06T19:41:47Z

clients/privacy-center/types/api/models/PrivacyExperienceResponse.ts

+  tcf_purpose_consents?: Array<TCFPurposeConsentRecord>;
+  tcf_purpose_legitimate_interests?: Array<TCFPurposeLegitimateInterestsRecord>;
+  tcf_special_purposes?: Array<TCFSpecialPurposeRecord>;
+  tcf_features?: Array<TCFFeatureRecord>;
+  tcf_special_features?: Array<TCFSpecialFeatureRecord>;
+  tcf_vendor_consents?: Array<TCFVendorConsentRecord>;
+  tcf_vendor_legitimate_interests?: Array<TCFVendorLegitimateInterestsRecord>;
+  tcf_vendor_relationships?: Array<TCFVendorRelationships>;
+  tcf_system_consents?: Array<TCFVendorConsentRecord>;
+  tcf_system_legitimate_interests?: Array<TCFVendorLegitimateInterestsRecord>;
+  tcf_system_relationships?: Array<TCFVendorRelationships>;


How do you generate these?

I typically:

tag fides

Use that version in fidesplus

in admin-ui, run npm run openapi:generate, then npm run format. This will autogenerate all the TS types based off of the backend's openapi.json file. we run it off of fidesplus since fidesplus has a superset of fides types

that sets admin-ui up nicely for TS types (which I did in the branch this PR is based off of)

unfortunately for apps other than admin-ui, we manually copy and paste the relevant files over 🥲 there should be a way to share types one day, but that's been an open issue for a while now

ahh thank you, I'll save this somewhere 👍

pattisdr · 2023-10-06T19:44:45Z

clients/privacy-center/types/api/models/SavePrivacyPreferencesResponse.ts

+export type SavePrivacyPreferencesResponse = {
+  preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  purpose_consent_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  purpose_legitimate_interests_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  special_purpose_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  vendor_consent_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  vendor_legitimate_interests_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  feature_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  special_feature_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  system_consent_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+  system_legitimate_interests_preferences?: Array<CurrentPrivacyPreferenceSchema>;
+};


pattisdr · 2023-10-06T19:48:52Z

clients/privacy-center/components/consent/NoticeDrivenConsent.tsx

@@ -171,7 +171,7 @@ const NoticeDrivenConsent = () => {
          (n) => n.privacy_notice_history_id === historyKey
        );
        const servedNotice = servedNotices?.find(
-          (sn) => sn.privacy_notice_history.id === historyKey
+          (sn) => sn.privacy_notice_history?.id === historyKey


Nice, it looks like a lot of good type updates on the privacy center side made it into this PR

allisonking added 5 commits October 6, 2023 12:24

Update privacy center types

6670b05

Update privacy center's handling of updated API response body

b9a7f58

Update cypress fixtures to follow new API payload format

e5f018a

Update changelog

f65b61c

Fix missing types

69ae7e5

allisonking commented Oct 6, 2023

View reviewed changes

Revert fixture to match test

e77881a

allisonking marked this pull request as ready for review October 6, 2023 18:50

allisonking requested review from eastandwestwind, TheAndrewJackson and galvana October 6, 2023 18:50

pattisdr approved these changes Oct 6, 2023

View reviewed changes

Fix type

fad6a78

allisonking merged commit 5f614aa into aking/4209/integrate-vendor-legal-basis Oct 6, 2023
7 checks passed

allisonking deleted the aking/4225/update-pc-call branch October 6, 2023 20:38

allisonking mentioned this pull request Oct 6, 2023

Update privacy center call to patch privacy preferences due to new API response #4225

Closed

pattisdr mentioned this pull request Nov 6, 2023

Backend System-Level Cookie Support #4383

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update privacy center patch call for new API response #4235

Update privacy center patch call for new API response #4235

allisonking commented Oct 6, 2023 •

edited

Loading

allisonking Oct 6, 2023

pattisdr Oct 6, 2023

allisonking Oct 6, 2023

cypress bot commented Oct 6, 2023 •

edited

Loading

pattisdr left a comment

pattisdr Oct 6, 2023

allisonking Oct 6, 2023

pattisdr Oct 6, 2023

allisonking Oct 6, 2023

pattisdr Oct 6, 2023

pattisdr Oct 6, 2023

pattisdr Oct 6, 2023

Update privacy center patch call for new API response #4235

Update privacy center patch call for new API response #4235

Conversation

allisonking commented Oct 6, 2023 • edited Loading

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cypress bot commented Oct 6, 2023 • edited Loading

Passing run #4507 ↗︎

Review all test suite changes for PR #4235 ↗︎

pattisdr 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

allisonking commented Oct 6, 2023 •

edited

Loading

cypress bot commented Oct 6, 2023 •

edited

Loading