GPP serving TCF strings #4433

allisonking · 2023-11-15T18:24:36Z

Closes https://ethyca.atlassian.net/browse/PROD-1285

Description Of Changes

https://www.loom.com/share/ce626a97f570422389e9b0116a3f5bde

Code Changes

Initialize the GPP CMP object
Subscribe to Fides events in the GPP extension
Follow example spec flow from https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Core/CMP%20API%20Specification.md
Tests: added a follow up ticket since it's hard to write Cypress tests for this when it's not integrated yet https://ethyca.atlassian.net/browse/PROD-1420

Steps to Confirm

Watch the loom video—there are a few small changes in the code needed to get this working. This feature isn't "enabled" yet, and can only be done manually this way.
Try out the various gpp functions
Opt in/out of consents and check the gpp string. you can decode it here https://iabgpp.com/#

Pre-Merge Checklist

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

…trings

vercel · 2023-11-15T18:24:41Z

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		Nov 22, 2023 4:40pm

cypress · 2023-11-15T18:35:33Z

Passing run #5342 ↗︎

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

Details:

Merge `6588867` into `5790645`...
Project: fides	Commit: `8cbe23853c ℹ️`
Status: Passed	Duration: 00:33 💡
Started: Nov 22, 2023 4:51 PM	Ended: Nov 22, 2023 4:52 PM

Review all test suite changes for PR #4433 ↗︎

…trings

allisonking · 2023-11-17T20:11:56Z

clients/fides-js/src/extensions/gpp.ts

 import { makeStub } from "../lib/gpp/stub";
+import { fidesEventToTcString } from "../lib/tcf/events";
+
+const CMP_ID = 407; // TODO: is this supposed to be the same as TCF, or is this separate?


Rachel will confirm this on Monday! https://ethyca.slack.com/archives/C05E74TR0BB/p1700245618221449

she has confirmed! We can just use our TCF CMP ID, so let's remove this comment

allisonking · 2023-11-17T20:14:35Z

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

@@ -368,7 +368,7 @@ export const initialize = async ({
    identity: cookie.identity,
    fides_string: cookie.fides_string,
    tcf_consent: cookie.tcf_consent,
-    experience,
+    experience: effectiveExperience,


this is a potentially consequential change—before, if the experience was not server side provided, then window.Fides.experience would be undefined. I don't think there was a reason for this, and I didn't see why we shouldn't always have the effective experience here. but let me know if I'm missing something!

This basically makes it possible for the "FidesInitialized" listener in gpp.ts to grab the experience easily, without it having to come through the event object.

This looks good. The return obj built here is only used to update the window.Fides obj, which we don't rely on to make any functional decisions within or outside of Fides. Regardless, we should absolutely return the most up-to-date experience here. Thanks!

allisonking · 2023-11-17T20:14:51Z

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

@@ -149,25 +149,6 @@ export const generateFidesString = async ({
  return Promise.resolve(encodedString);
 };

-/**


moved to a separate file so gpp can also use this function

allisonking · 2023-11-17T22:09:37Z

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

-  }, [cookie, options.debug]);
+  const dispatchCloseEvent = useCallback(
+    ({ saved = false }: { saved?: boolean }) => {
+      dispatchFidesEvent("FidesModalClosed", cookie, options.debug, { saved });


we need to know if the modal was closed without saving. gpp signals that it is not ready when the modal opens. once it saves, it signals it is ready again. but if you close the modal without saving, we'd be stuck in a "not ready" state

eastandwestwind

Great work on this @allisonking !

Do we have a separate ticket to add e2e tests, once we actually start making calls to the GPP lib?

Thumbs up from me, just need to remove an unneeded code comment 👍

eastandwestwind · 2023-11-21T21:23:54Z

clients/fides-js/src/extensions/gpp.ts

 import { makeStub } from "../lib/gpp/stub";
+import { fidesEventToTcString } from "../lib/tcf/events";
+
+const CMP_ID = 407; // TODO: is this supposed to be the same as TCF, or is this separate?


she has confirmed! We can just use our TCF CMP ID, so let's remove this comment

eastandwestwind · 2023-11-21T21:36:24Z

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

@@ -368,7 +368,7 @@ export const initialize = async ({
    identity: cookie.identity,
    fides_string: cookie.fides_string,
    tcf_consent: cookie.tcf_consent,
-    experience,
+    experience: effectiveExperience,


This looks good. The return obj built here is only used to update the window.Fides obj, which we don't rely on to make any functional decisions within or outside of Fides. Regardless, we should absolutely return the most up-to-date experience here. Thanks!

allisonking · 2023-11-22T16:36:20Z

Thanks for the review @eastandwestwind ! I'll clean that comment up.

Do we have a separate ticket to add e2e tests, once we actually start making calls to the GPP lib?

Yes! It is here: https://ethyca.atlassian.net/browse/PROD-1420

allisonking added 11 commits November 10, 2023 16:03

wip gpp

d346943

Refactor stub files

f733f8c

Add gpp library and update types

32e89e8

Firm up types

93b9a98

Move files around

c92520b

Add gpp stub unit tests

bdfcb04

Subscribe GPP to TCF calls

34605e7

Add success check to ping test

0af8335

Merge branch 'main' into aking/prod-1284/gpp-poc

379e37a

Update changelog

79646f3

Merge branch 'aking/prod-1284/gpp-poc' into aking/prod-1285/gpp-tcf-s…

7170378

…trings

allisonking changed the base branch from main to aking/prod-1284/gpp-poc November 15, 2023 18:36

allisonking added 4 commits November 15, 2023 17:38

Set up GPP listeners from FidesUI events instead of TCF

c1463dc

Merge branch 'main' into aking/prod-1284/gpp-poc

319955f

Merge branch 'aking/prod-1284/gpp-poc' into aking/prod-1285/gpp-tcf-s…

a70f69e

…trings

Update changelog

94ebc99

vercel bot deployed to Preview November 17, 2023 18:15 View deployment

Check for resurface for initial signal status

9af64df

allisonking commented Nov 17, 2023

View reviewed changes

Add if the user saved to FidesModalClosed event

31ae240

allisonking marked this pull request as ready for review November 17, 2023 22:08

allisonking commented Nov 17, 2023

View reviewed changes

allisonking requested a review from eastandwestwind November 17, 2023 22:09

Base automatically changed from aking/prod-1284/gpp-poc to main November 20, 2023 17:41

eastandwestwind approved these changes Nov 21, 2023

View reviewed changes

allisonking added 2 commits November 22, 2023 11:38

Merge branch 'main' into aking/prod-1285/gpp-tcf-strings

8d96a72

Extract CMP ID to a constant shared by TCF and GPP

6588867

allisonking merged commit e40b6aa into main Nov 22, 2023
13 checks passed

allisonking deleted the aking/prod-1285/gpp-tcf-strings branch November 22, 2023 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GPP serving TCF strings #4433

GPP serving TCF strings #4433

allisonking commented Nov 15, 2023 •

edited

Loading

vercel bot commented Nov 15, 2023 •

edited

Loading

cypress bot commented Nov 15, 2023 •

edited

Loading

allisonking Nov 17, 2023

eastandwestwind Nov 21, 2023

allisonking Nov 17, 2023 •

edited

Loading

eastandwestwind Nov 21, 2023

allisonking Nov 17, 2023

allisonking Nov 17, 2023

eastandwestwind left a comment

eastandwestwind Nov 21, 2023

eastandwestwind Nov 21, 2023

allisonking commented Nov 22, 2023

GPP serving TCF strings #4433

GPP serving TCF strings #4433

Conversation

allisonking commented Nov 15, 2023 • edited Loading

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

vercel bot commented Nov 15, 2023 • edited Loading

cypress bot commented Nov 15, 2023 • edited Loading

Passing run #5342 ↗︎

Review all test suite changes for PR #4433 ↗︎

allisonking Nov 17, 2023

Choose a reason for hiding this comment

eastandwestwind Nov 21, 2023

Choose a reason for hiding this comment

allisonking Nov 17, 2023 • edited Loading

Choose a reason for hiding this comment

eastandwestwind Nov 21, 2023

Choose a reason for hiding this comment

allisonking Nov 17, 2023

Choose a reason for hiding this comment

allisonking Nov 17, 2023

Choose a reason for hiding this comment

eastandwestwind left a comment

Choose a reason for hiding this comment

eastandwestwind Nov 21, 2023

Choose a reason for hiding this comment

eastandwestwind Nov 21, 2023

Choose a reason for hiding this comment

allisonking commented Nov 22, 2023

allisonking commented Nov 15, 2023 •

edited

Loading

vercel bot commented Nov 15, 2023 •

edited

Loading

cypress bot commented Nov 15, 2023 •

edited

Loading

allisonking Nov 17, 2023 •

edited

Loading