Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during `fides deploy` via `.env` #2949

nicolas-ethyca · 2023-03-29T21:42:38Z

Closes #3347
Closes #29

Code Changes

Add Google Tag Manager script, configured via FIDES_SAMPLE_APP__GOOGLE_TAG_MANAGER_CONTAINER_ID
Configure Privacy Center URL via FIDES_SAMPLE_APP__PRIVACY_CENTER_URL
Pass .env values to fides-privacy-center and fides-sample-app images when running fides deploy
Add a README.md for fides-sample-app
Enable "Privacy Experiences" beta flag for local testing
Call Fides.gtm() to enable the Fides <> GTM integration

Steps to Confirm

Edit your .env file with FIDES_SAMPLE_APP__GOOGLE_TAG_MANAGER_CONTAINER_ID=GTM-MYGTMID
Run nox -s "fides_env(test)"
Open http://localhost:3000/
Check that GTM script is added (using the Developer Tools) and initialized with the GTM ID provided in the .env file

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

Description Of Changes

This adds an (optional) GTM container tag to the Cookie House sample app for testing, and then adds additional flexibility to the advanced usage of fides deploy by allowing the user to edit their local .env file and provide extra configuration for the various images.

This also adds a configurable option for FIDES_SAMPLE_APP__PRIVACY_CENTER_URL so that this isn't always hardcoded to http://localhost:3001 👍

cypress · 2023-03-29T22:00:58Z

Passing run #2250 ↗︎

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

Details:

Merge `76bce79` into `7bef710`...
Project: fides	Commit: `c4106f3584 ℹ️`
Status: Passed	Duration: 00:46 💡
Started: May 30, 2023 8:46 PM	Ended: May 30, 2023 8:47 PM

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

codecov · 2023-03-30T17:50:44Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (8d424d3) 87.13% compared to head (90188aa) 87.13%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2949   +/-   ##
=======================================
  Coverage   87.13%   87.13%           
=======================================
  Files         312      312           
  Lines       18659    18659           
  Branches     2377     2377           
=======================================
  Hits        16259    16259           
  Misses       1980     1980           
  Partials      420      420

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

NevilleS

Overall this looks pretty reasonable! I know it's just a "sample app" but I do want to investigate the potential XSS possibility

src/fides/data/sample_project/cookie_house/src/pages/index.tsx

NevilleS

Suggestion for XSS defense!

src/fides/data/sample_project/cookie_house/src/pages/index.tsx

NevilleS

This looks good now, just add an entry to CHANGELOG and this should be ready to go. Thanks!

Co-authored-by: Neville Samuell <[email protected]>

…fides deploy

clients/sample-app/src/lib/db.ts

-  database: DATABASE_DB || "postgres_example",
+  host: host || DATABASE_HOST || "localhost",
+  port: Number(port || DATABASE_PORT || 5432),
+  user: user || DATABASE_USER || "postgres",


clients/sample-app/src/lib/db.ts

+  host: host || DATABASE_HOST || "localhost",
+  port: Number(port || DATABASE_PORT || 5432),
+  user: user || DATABASE_USER || "postgres",
+  password: password || DATABASE_PASSWORD || "postgres",


NevilleS · 2023-05-29T20:16:00Z

Updated this branch to the latest main, and then added all the extra requirements to cover #3347 👍

To make those ENV vars easy to access when testing locally, this also passes the .env file from fides deploy --env-file along to the sample app & privacy center images.

NevilleS

To actually use this, we should also be calling Fides.gtm(), duh! 🙃

nicolas-ethyca · 2023-05-30T15:34:33Z

Tested and working

…ation

NevilleS

OK, LGTM now!

NevilleS

OK, LGTM now!

nicolas-ethyca added the enhancement label Mar 29, 2023

nicolas-ethyca self-assigned this Mar 29, 2023

nicolas-ethyca changed the title ~~draft: feature/GoogleTagManager CookieHouse~~ feature/GoogleTagManager CookieHouse Mar 30, 2023

nicolas-ethyca requested review from NevilleS and mfbrown March 30, 2023 17:23

NevilleS requested changes Apr 3, 2023

View reviewed changes

src/fides/data/sample_project/cookie_house/src/pages/index.tsx Outdated Show resolved Hide resolved

src/fides/data/sample_project/cookie_house/src/pages/index.tsx Outdated Show resolved Hide resolved

NevilleS requested changes Apr 3, 2023

View reviewed changes

src/fides/data/sample_project/cookie_house/src/pages/index.tsx Outdated Show resolved Hide resolved

NevilleS requested changes Apr 9, 2023

View reviewed changes

NevilleS mentioned this pull request May 22, 2023

Add optional environment variables to configure Privacy Center and Google Tag Manager container for the "Cookie House" sample app #3347

Closed

nicolas-ethyca and others added 5 commits May 29, 2023 15:09

feat: added GTM Tag manager checks using env vars

62e8f5c

Co-authored-by: Neville Samuell <[email protected]>

Reformat slightly for clarity

c92c967

Add FIDES_SAMPLE_APP__PRIVACY_CENTER_URL config var

a85dacd

Add README docs for sample app

bdaa5e6

Format & lint

8ee5e57

NevilleS force-pushed the feature/GTMIntegration branch from 40aadf6 to 8ee5e57 Compare May 29, 2023 20:04

NevilleS added 4 commits May 29, 2023 16:05

Update CHANGELOG

eb33d04

Allow using the privacy experiences UI with beta flag

bbbd485

Add ability to pass ENV vars to privacy center and sample app during …

e9365ef

…fides deploy

Update CHANGELOG

1fae42b

github-advanced-security bot found potential problems May 29, 2023

View reviewed changes

NevilleS changed the title ~~feature/GoogleTagManager CookieHouse~~ Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during fides deploy via .env May 29, 2023

NevilleS added 3 commits May 29, 2023 16:16

Update CHANGELOG

c615fa3

Use vanilla <script> tag instead of next/script to insert into <head>

4fe2bab

Move GTM script back into next/script (@nicolas-ethyca was right!)

90188aa

NevilleS requested changes May 30, 2023

View reviewed changes

NevilleS mentioned this pull request May 30, 2023

Render privacy center experience from privacy notices #3340

Merged

20 tasks

NevilleS added 2 commits May 30, 2023 16:25

Call Fides.gtm() in sample app when GTM is configured

4486d1b

Merge branch 'main' of github.com:ethyca/fides into feature/GTMIntegr…

76bce79

…ation

NevilleS approved these changes May 30, 2023

View reviewed changes

NevilleS removed the request for review from mfbrown May 30, 2023 20:31

NevilleS merged commit 58bea87 into main May 30, 2023

NevilleS deleted the feature/GTMIntegration branch May 30, 2023 20:53

NevilleS mentioned this pull request May 31, 2023

Fix sample app DATABASE_* ENV vars for backwards compatibility #3406

Merged

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during `fides deploy` via `.env` #2949

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during `fides deploy` via `.env` #2949

nicolas-ethyca commented Mar 29, 2023 •

edited by NevilleS

Loading

cypress bot commented Mar 29, 2023 •

edited

Loading

codecov bot commented Mar 30, 2023 •

edited

Loading

NevilleS left a comment

NevilleS left a comment

NevilleS left a comment

NevilleS commented May 29, 2023

NevilleS left a comment

nicolas-ethyca commented May 30, 2023

NevilleS left a comment

NevilleS left a comment

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during fides deploy via .env #2949

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during fides deploy via .env #2949

Conversation

nicolas-ethyca commented Mar 29, 2023 • edited by NevilleS Loading

Code Changes

Steps to Confirm

Pre-Merge Checklist

Description Of Changes

cypress bot commented Mar 29, 2023 • edited Loading

Passing run #2250 ↗︎

codecov bot commented Mar 30, 2023 • edited Loading

Codecov Report

NevilleS left a comment

Choose a reason for hiding this comment

NevilleS left a comment

Choose a reason for hiding this comment

NevilleS left a comment

Choose a reason for hiding this comment

NevilleS commented May 29, 2023

NevilleS left a comment

Choose a reason for hiding this comment

nicolas-ethyca commented May 30, 2023

NevilleS left a comment

Choose a reason for hiding this comment

NevilleS left a comment

Choose a reason for hiding this comment

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during `fides deploy` via `.env` #2949

Add Google Tag Manager and Privacy Center ENV vars to sample app, plus the ability to pass ENV vars to both privacy center and sample app during `fides deploy` via `.env` #2949

nicolas-ethyca commented Mar 29, 2023 •

edited by NevilleS

Loading

cypress bot commented Mar 29, 2023 •

edited

Loading

codecov bot commented Mar 30, 2023 •

edited

Loading