Save consent method ("accept", "reject", "save", etc.) to `fides_consent` cookie as extra metadata #4529

NevilleS · 2023-12-19T15:58:38Z

Description Of Changes

This updates both fides.js and fides-privacy-center to record the "consent method" to the local cookie when preferences are saved, in the same way that we record this information on the server-side preference that is recorded. This'll allow us to inspect this on the frontend, both for troubleshooting (helpful!) but more importantly because I'd like to treat consentMethod: "dismiss" differently in a future release so I want to be recording that metadata now 👍

Code Changes

Fix ConsentMethod enum definition across all client applications
Update fides.js unit tests to check that extra details can be saved to fides_meta on cookie
Update Privacy Center E2E tests to check for consentMethod to be stored on cookie
Update consent banner E2E tests to check for consentMethod to be stored on cookie
Refactor the banner dismissal tests to DRY them up (a bit!)
Fix Privacy Center consent page to no longer record deprecated button consent method
Update Privacy Center consent page to record consent method to cookie on save action
Update fides.js overlay to record consent method to cookie on save, accept, reject, and dismiss

Steps to Confirm

Run all E2E tests for Privacy Center & Overlay
Run local test environment and inspect the fides_consent cookie on the Cookie House after using the overlay

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

vercel · 2023-12-19T15:58:43Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
fides-plus-nightly	⬜️ Ignored (Inspect)	Visit Preview		Dec 20, 2023 4:53pm

cypress · 2023-12-19T16:09:58Z

Passing run #5713 ↗︎

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

Details:

Merge `1d0e7f4` into `6b66d42`...
Project: fides	Commit: `ef64cabeee ℹ️`
Status: Passed	Duration: 00:33 💡
Started: Dec 19, 2023 4:56 PM	Ended: Dec 19, 2023 4:56 PM

Review all test suite changes for PR #4529 ↗︎

allisonking

code looks good! will UAT a bit later, unless @galvana can get to it first!

clients/admin-ui/src/types/api/models/ConsentMethod.ts

clients/fides-js/src/lib/consent-types.ts

clients/privacy-center/cypress/e2e/banner-overlay-dismissal.cy.ts

NevilleS

My own notes, for review help!

NevilleS · 2023-12-19T16:26:37Z

clients/fides-js/__tests__/lib/cookie.test.ts

@@ -109,23 +111,47 @@ describe("getOrMakeFidesCookie", () => {
    const SAVED_CONSENT = { data_sales: false, performance: true };

    describe("in v0.9.0 format", () => {
-      const V090_COOKIE = JSON.stringify({
+      const V090_COOKIE_OBJECT: FidesCookie = {


Added the type here to ensure we're keeping this test accurate - and then updated it to include the required tcf_consent field 👍

Would it be a good idea to make this change to other places in this test file that still use const V090_COOKIE = JSON.stringify({...?

Good suggestion! Updated

clients/fides-js/__tests__/lib/cookie.test.ts

clients/fides-js/src/components/ConsentButtons.tsx

clients/fides-js/src/lib/consent-types.ts

clients/fides-js/src/lib/events.ts

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

clients/privacy-center/cypress/e2e/banner-overlay-dismissal.cy.ts

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

…ethod-to-cookie

galvana

Thanks for the test cleanup! I just made a small comment on the cookie.test.ts file but overall this looks good 👍

galvana · 2023-12-19T21:26:23Z

clients/fides-js/__tests__/lib/cookie.test.ts

@@ -109,23 +111,47 @@ describe("getOrMakeFidesCookie", () => {
    const SAVED_CONSENT = { data_sales: false, performance: true };

    describe("in v0.9.0 format", () => {
-      const V090_COOKIE = JSON.stringify({
+      const V090_COOKIE_OBJECT: FidesCookie = {


Would it be a good idea to make this change to other places in this test file that still use const V090_COOKIE = JSON.stringify({...?

clients/privacy-center/cypress/e2e/banner-overlay-dismissal.cy.ts

galvana · 2023-12-19T23:15:58Z

UAT

@NevilleS I verified locally that the Fides cookie contains "consentMethod":"dismiss" for the following scenarios:

TCF dismiss banner

{"consent":{"data_sales":true,"tracking":true,"analytics":true},"identity":{"fides_user_device_id":"64b142b1-e273-4c70-ad06-b162e556fef8"},"fides_meta":{"version":"0.9.0","createdAt":"2023-12-14T18:15:44.748Z","updatedAt":"2023-12-19T23:06:31.614Z","consentMethod":"dismiss"},"tcf_consent":{"system_consent_preferences":{},"system_legitimate_interests_preferences":{}},"fides_string":"CP3CKIAP3CKIAGXABBENAfEgAAAAAAAAAAAAAAAAAAAA.Ig1NX_H__bX9v-Xr36ft0eY1f99j77sQxBhfJs-4FyLvW_JwX32EyNE26tqYKmRIEu3ZBIQFtHJnURVihaogVrzHsYkGcgTNKJ-BkgHMRe2dYCF5vmYtj-QKZ5_p_d3f52T_9_dv-3dzzz9Vnv3e9fudlcIida59tH_n_bRKb-7Ie9_7-_4v09N_rk2_eTVv_9evv71-u_t____9_9__-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAE,1~","tcf_version_hash":"3bc0df5c0987"}

TCF dismiss modal

{"consent":{"data_sales":true,"tracking":true,"analytics":true},"identity":{"fides_user_device_id":"8398a987-e667-4348-a853-88c67a71bb82"},"fides_meta":{"version":"0.9.0","createdAt":"2023-12-19T23:08:40.270Z","updatedAt":"2023-12-19T23:08:56.453Z","consentMethod":"dismiss"},"tcf_consent":{"system_consent_preferences":{},"system_legitimate_interests_preferences":{}},"fides_string":"CP3CKIAP3CKIAGXABBENAfEgAAAAAEPgAAAAAABBqhpAAIgAUABcADgAPgAoACoAFwAOAAeABAACSAFwAZQA0ADUAHgAPwAiABHACYAFCAKQApgBVgC2ALoAYgAzABoADeAHoAPwAhABDQCIAIkARwAlgBNACcAFGAMAAYcAygDLAGaANEAbIA5ABzwDuAO8AewA-IB9gH7AP8BAICDgIQAREAikBFgEYAI1ARwBHQCRAElAJSATQAnYBPwCgwFQAVEAq4BYgC5gF1gLyAvQBfQDFAGiANeAbQA3ABxADjgHSAOoAdsA9oB9gD_gImAReAj2BIgEigJUASsAmKBMgEygJtATsAoeBR4FIgKTgU0BTYCnwFQwKkAqUBVQCrAFcgK7AWFAsQCxQFlALRAWpAtgC2YFuAW6AuABcgC6AF2gLvgXkBeYC-gF_gMEAYMAw0BiADFgGPAMhgZGBkkDJgMnAZUAywBmYDOQGeANEAaMA00BqYDVYGrgayA14BtADbIG3AbfA3MDdQHAAOCAcWA48BycDlgOXAc6A58B1gDxQHjwPJA8oB8UD5APlAfSA-uB9oH3QP2A_cB_YEAQICAQMAgeBBECCYEGAINgQhAhQBCuCFoIXAQzghyCHUEPAQ9Ah-BFMCMAEaQI1gRvAjiBHQCOwEewI-gR_AkIBIoCRsEkASSgkwCTMEqASpAlgBLOCW4JcQS6BLsCX0EwATBAmGBMWCZgJnATUAmxBNsE3IJvAm-BOGCcoJzATpCDUAAA.Ig1NX_H__bX9v-Xr36ft0eY1f99j77sQxBhfJs-4FyLvW_JwX32EyNE26tqYKmRIEu3ZBIQFtHJnURVihaogVrzHsYkGcgTNKJ-BkgHMRe2dYCF5vmYtj-QKZ5_p_d3f52T_9_dv-3dzzz9Vnv3e9fudlcIida59tH_n_bRKb-7Ie9_7-_4v09N_rk2_eTVv_9evv71-u_t____9_9__-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAAAE,1~","tcf_version_hash":"3bc0df5c0987"}

Consent dismiss banner

{"consent":{"data_sales_and_sharing":true},"identity":{"fides_user_device_id":"7a6e5a92-134d-4b69-a1a5-3a66de68c3b0"},"fides_meta":{"version":"0.9.0","createdAt":"2023-12-19T23:11:11.905Z","updatedAt":"2023-12-19T23:11:24.790Z","consentMethod":"dismiss"},"tcf_consent":{}}

Consent dismiss modal

{"consent":{"data_sales_and_sharing":true},"identity":{"fides_user_device_id":"3ce759a7-86d3-4991-a831-382a1ca68b27"},"fides_meta":{"version":"0.9.0","createdAt":"2023-12-19T23:12:04.850Z","updatedAt":"2023-12-19T23:12:16.378Z","consentMethod":"dismiss"},"tcf_consent":{}}

NevilleS added 11 commits December 18, 2023 18:17

Fix ConsentMethod type definitions

20f32bc

Update to use fixed ConsentMethod enum

b462209

Add failing test that Privacy Center stores consent method on cookie

9ae9269

Add unit tests that consentMethod can be saved in fides_meta on cookie

2f74369

Improve type definition for extraDetails

9e56930

Fix Privacy Center to not use legacy "button" consent method

32d07ba

Update ConsentMethod enum types

c146d94

Update Privacy Center to record consentMethod to cookie

126e460

Add failing tests for consentMethod to existing e2e suite

58f573f

Refactor banner dismissal tests and check for consentMethod too

5a7e150

Minor refactoring of banner dismissal tests

fd2b853

Format & lint

b5b6abc

NevilleS added 2 commits December 19, 2023 11:17

Save consentMethod to cookie in fides.js

abd9443

Format

d9d11ae

NevilleS marked this pull request as ready for review December 19, 2023 16:25

allisonking reviewed Dec 19, 2023

View reviewed changes

clients/admin-ui/src/types/api/models/ConsentMethod.ts Show resolved Hide resolved

clients/fides-js/src/lib/consent-types.ts Show resolved Hide resolved

clients/privacy-center/cypress/e2e/banner-overlay-dismissal.cy.ts Show resolved Hide resolved

NevilleS commented Dec 19, 2023

View reviewed changes

Merge branch 'main' of github.com:ethyca/fides into ns-save-consent-m…

fb144b4

…ethod-to-cookie

NevilleS changed the title ~~Save consentMethod to fides_consent cookie as extra metadata~~ Save consent method ("accept", "reject", "save", etc.) to fides_consent cookie as extra metadata Dec 19, 2023

Update CHANGELOG

1d0e7f4

NevilleS requested a review from galvana December 19, 2023 16:46

galvana reviewed Dec 19, 2023

View reviewed changes

galvana approved these changes Dec 20, 2023

View reviewed changes

Improve unit test types

e2960c9

NevilleS merged commit 3537d01 into main Dec 20, 2023
10 checks passed

NevilleS deleted the ns-save-consent-method-to-cookie branch December 20, 2023 16:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Save consent method ("accept", "reject", "save", etc.) to `fides_consent` cookie as extra metadata #4529

Save consent method ("accept", "reject", "save", etc.) to `fides_consent` cookie as extra metadata #4529

NevilleS commented Dec 19, 2023 •

edited

Loading

vercel bot commented Dec 19, 2023 •

edited

Loading

cypress bot commented Dec 19, 2023 •

edited

Loading

allisonking left a comment

NevilleS left a comment

NevilleS Dec 19, 2023

galvana Dec 19, 2023

NevilleS Dec 20, 2023

galvana left a comment

galvana Dec 19, 2023

galvana commented Dec 19, 2023

Save consent method ("accept", "reject", "save", etc.) to fides_consent cookie as extra metadata #4529

Save consent method ("accept", "reject", "save", etc.) to fides_consent cookie as extra metadata #4529

Conversation

NevilleS commented Dec 19, 2023 • edited Loading

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

vercel bot commented Dec 19, 2023 • edited Loading

cypress bot commented Dec 19, 2023 • edited Loading

Passing run #5713 ↗︎

Review all test suite changes for PR #4529 ↗︎

allisonking left a comment

Choose a reason for hiding this comment

NevilleS left a comment

Choose a reason for hiding this comment

NevilleS Dec 19, 2023

Choose a reason for hiding this comment

galvana Dec 19, 2023

Choose a reason for hiding this comment

NevilleS Dec 20, 2023

Choose a reason for hiding this comment

galvana left a comment

Choose a reason for hiding this comment

galvana Dec 19, 2023

Choose a reason for hiding this comment

galvana commented Dec 19, 2023

UAT

TCF dismiss banner

TCF dismiss modal

Consent dismiss banner

Consent dismiss modal

Save consent method ("accept", "reject", "save", etc.) to `fides_consent` cookie as extra metadata #4529

Save consent method ("accept", "reject", "save", etc.) to `fides_consent` cookie as extra metadata #4529

NevilleS commented Dec 19, 2023 •

edited

Loading

vercel bot commented Dec 19, 2023 •

edited

Loading

cypress bot commented Dec 19, 2023 •

edited

Loading