Add notice consent to Fides string #5895

gilluminate · 2025-03-15T00:55:51Z

Description Of Changes

Introduces Notice Consent String functionality to the FidesJS client, allowing programmatic control of notice consent preferences through a base64-encoded string. The changes include:

New encoding/decoding utilities for Notice Consent strings
Integration with the existing Fides string format in a new fourth slot
Automated application of Notice Consent preferences during initialization

Code Changes

Added encodeNoticeConsentString and decodeNoticeConsentString utility functions and exposed encodeNoticeConsentString to the Fides window object.
Updated DecodedFidesString interface to include noticeConsent field
Modified initialize to handle Notice Consent string application
Removed unused context parameter from resolveConsentValue
Added comprehensive tests for Notice Consent string encoding/decoding

Steps to Confirm

In Admin UI set up a Banner, a Banner/Modal, and a TCF experience with various consent notices.
Load the demo page and use the provided window.Fides.encodeNoticeConsentString() to get a Notice Consent String. Use the keys for the consent notices configured in step 1. Get the encoded string for various combinations of true/false values for those.
Revisit the demo page with the fides_string=... query string, and use each encoded Notice Consent string noted above as the value in the fourth slot of the comma separated Fides String (eg. fides_string=,,,eyJkYXRhX3NhbGVzX2FuZF9zaGFyaW5nIjowfQ==)
Ensure that

...the banner never shows when the fides_string is passed in for the banner/modal experience (Note: TCF banner should still show because TCF consent still needs to be asked for (only custom purposes have been set)
...the preferences are automatically set as expected. Open the modal using the modal link to ensure the same preferences were saved (toggle switches match)
...the cookie consent value is correct and the consentMethod should be "script"
...the payload of the api/v1/privacy-preferences endpoint is correct.

Pre-Merge Checklist

Issue requirements met
All CI pipelines succeeded
CHANGELOG.md updated
Followup issues:
- No followup issues
Database migrations:
- No migrations
Documentation:
- Documentation added for new Notice Consent string functionality

vercel · 2025-03-15T00:55:56Z

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

Name	Status	Preview	Comments	Updated (UTC)
fides-plus-nightly	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 20, 2025 7:41pm
fides-privacy-center	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 20, 2025 7:41pm

gilluminate · 2025-03-18T23:29:55Z

clients/fides-js/__tests__/lib/consent-utils.test.ts

+  });
+});
+
+describe("shouldResurfaceBanner", () => {


this method already existed, but I enhanced it quite a bit and used Cursor to write these tests.

gilluminate · 2025-03-18T23:31:38Z

clients/fides-js/docs/interfaces/Fides.md

-Note: The AC_STRING can only exist if TC_STRING exists, as it's derived from it.
-When GPP is enabled, the GPP_STRING portion is automatically initialized during
-FidesJS initialization, either preserving any existing GPP string or using a
-default value. The GPP_STRING is independent and can exist with or without the
-other strings.


moved a lot of the docs for setting the string to the FidesOptions docs since that's more appropriate. These docs here are mostly for reading the string.

gilluminate · 2025-03-18T23:32:57Z

clients/fides-js/rollup.config.mjs

@@ -16,7 +16,7 @@ const GZIP_SIZE_ERROR_KB = 45; // fail build if bundle size exceeds this
 const GZIP_SIZE_WARN_KB = 35; // log a warning if bundle size exceeds this

 // TCF
-const GZIP_SIZE_TCF_ERROR_KB = 87;
+const GZIP_SIZE_TCF_ERROR_KB = 90;


we're not at this max size yet, but we're getting close to it. Seemed appropriate to keep this more general rather than bumping it with every edit.

gilluminate · 2025-03-18T23:33:57Z

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

-    [cookie, savedConsent, experience, options, isAutomatedConsent],
-  );
+  const showBanner = useMemo(() => {
+    return shouldResurfaceBanner(experience, cookie, savedConsent, options);


all of the boolean logic was moved in to the method for reuse and stability.

gilluminate · 2025-03-18T23:36:30Z

clients/fides-js/src/components/notices/NoticeOverlay.tsx

  propertyId,
 }) => {
  const { i18n, currentLocale, setCurrentLocale } = useI18n();
+  const parsedCookie: FidesCookie | undefined = getFidesConsentCookie();
+  const savedConsent = window.Fides.saved_consent;


@eastandwestwind I made sure the OT migration tests still pass with this change, but with the passed in savedConsent it was missing any GPC updates that happened between initialization and the overlay updating here. As you may recall, we run the GPC logic asynchronously after initialize() which is where the params on this component get set.

gilluminate · 2025-03-18T23:41:26Z

clients/fides-js/src/fides-headless.ts

-    if (!this.cookie) {
-      throw new Error("Should have a cookie");
-    }
-    return shouldResurfaceConsent(


moved this logic in to the method as well

gilluminate · 2025-03-18T23:41:59Z

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

-export const shouldResurfaceConsent = (
-  experience: PrivacyExperience | PrivacyExperienceMinimal,
-  cookie: FidesCookie,
+export const shouldResurfaceBanner = (


renamed for clarity

gilluminate · 2025-03-18T23:44:40Z

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

-  // TODO (PROD-1792): we should *also* resurface in the special case where the
-  // saved consent is only recorded with a consentMethod of "dismiss"


since I was adding logic for GPC, I knocked this TODO out at the same time :)

gilluminate · 2025-03-18T23:45:23Z

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

  consent: NoticeConsent | undefined,
 ): boolean => {
  if (notice.consent_mechanism === ConsentMechanism.NOTICE_ONLY) {
    return true;
  }
  // Note about GPC - consent has already applied to the cookie at this point, so we can trust preference there
-  // DEFER (PROD-1780): delete context arg for safety


confirmed this was no longer used

gilluminate · 2025-03-18T23:47:03Z

clients/fides-js/src/lib/gpp/string-to-consent.ts

@@ -209,7 +209,8 @@ export const fidesStringToConsent = ({
  fidesString,
  cmpApi,
 }: FidesStringToConsentArgs) => {
-  if (!fidesString || !cmpApi) {
+  const { gpp: gppString }: DecodedFidesString = decodeFidesString(fidesString);
+  if (!fidesString || !gppString || !cmpApi) {


Minor optimization here, no reason to continue decoding the GPP string if one wasn't passed in.

gilluminate · 2025-03-19T16:55:47Z

clients/fides-js/src/components/notices/NoticeOverlay.tsx

@@ -258,8 +258,17 @@ const NoticeOverlay: FunctionComponent<OverlayProps> = ({
  }, [cookie, options.debug]);

  const handleDismiss = useCallback(() => {
-    handleUpdatePreferences(ConsentMethod.DISMISS, initialEnabledNoticeKeys());
-  }, [handleUpdatePreferences, initialEnabledNoticeKeys]);
+    if (!consentCookieObjHasSomeConsentSet(parsedCookie?.consent)) {


This addressed a bug where if someone returns to the page, loads the modal from the link, and then closes the modal, their previous consent method was changed to dismissed even though no changes were made.

gilluminate · 2025-03-19T16:56:29Z

clients/fides-js/src/components/tcf/TcfOverlay.tsx

@@ -460,8 +466,10 @@ export const TcfOverlay = ({
  }, [cookie, options.debug]);

  const handleDismiss = useCallback(() => {
-    handleUpdateAllPreferences(ConsentMethod.DISMISS, draftIds);
-  }, [handleUpdateAllPreferences, draftIds]);
+    if (!consentCookieObjHasSomeConsentSet(parsedCookie?.consent)) {


same bug as above, but on the TCF side

eastandwestwind · 2025-03-20T18:37:42Z

clients/fides-js/docs/interfaces/Fides.md

+#### Example
+
+```ts
+const encoded = Fides.encodeNoticeConsentString({data_sales_and_sharing:0,analytics:1});


ohhh this is so handy, thanks for adding this!

eastandwestwind · 2025-03-20T18:55:50Z

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

+ * @param base64String The base64 encoded Notice Consent string
+ * @returns Decoded consent data object or null if decoding fails
+ */
+export const decodeNoticeConsentString = (


can we also expose this on the Fides obj? I can see it might be a handy util for testing and onboarding customers

eastandwestwind · 2025-03-20T19:09:52Z

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

+  const [tc = "", ac = "", gpp = "", nc = ""] =
+    fidesString.split(FIDES_SEPARATOR);
+  // If there's no TC, remove AC
+  return tc ? { tc, ac, gpp, nc } : { tc: "", ac: "", gpp, nc };


There's the formatFidesStringWithGpp method in this file- I think we still need to support nc within this too

vercel bot deployed to Preview – fides-privacy-center March 15, 2025 00:56 View deployment

gilluminate marked this pull request as draft March 15, 2025 00:57

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from 2eb6843 to e280bcf Compare March 17, 2025 17:45

vercel bot deployed to Preview – fides-privacy-center March 17, 2025 17:45 View deployment

vercel bot deployed to Preview – fides-privacy-center March 17, 2025 17:59 View deployment

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from fefe384 to b714d57 Compare March 17, 2025 18:00

vercel bot deployed to Preview – fides-privacy-center March 17, 2025 18:00 View deployment

vercel bot deployed to Preview – fides-privacy-center March 17, 2025 18:16 View deployment

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from 3cb239f to 69574de Compare March 17, 2025 18:18

vercel bot deployed to Preview – fides-privacy-center March 17, 2025 18:19 View deployment

gilluminate requested review from eastandwestwind and removed request for eastandwestwind March 18, 2025 02:40

vercel bot deployed to Preview – fides-privacy-center March 18, 2025 22:55 View deployment

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from 78268ad to 771e970 Compare March 18, 2025 23:08

vercel bot deployed to Preview – fides-privacy-center March 18, 2025 23:08 View deployment

gilluminate marked this pull request as ready for review March 18, 2025 23:24

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from 771e970 to 53af48c Compare March 18, 2025 23:25

gilluminate requested a review from eastandwestwind March 18, 2025 23:25

vercel bot deployed to Preview – fides-privacy-center March 18, 2025 23:26 View deployment

gilluminate commented Mar 18, 2025

View reviewed changes

vercel bot deployed to Preview – fides-privacy-center March 19, 2025 15:40 View deployment

vercel bot deployed to Preview – fides-privacy-center March 19, 2025 15:48 View deployment

vercel bot deployed to Preview – fides-privacy-center March 19, 2025 16:51 View deployment

vercel bot deployed to Preview – fides-privacy-center March 19, 2025 16:55 View deployment

gilluminate commented Mar 19, 2025

View reviewed changes

vercel bot deployed to Preview – fides-plus-nightly March 20, 2025 15:36 View deployment

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 15:37 View deployment

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 16:20 View deployment

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 16:30 View deployment

gilluminate added 14 commits March 20, 2025 10:57

Notice Consent String encoder/decoder

4f8c54f

update fides-string decoder to support Notice Consent strings

24322c0

fix: don't try to get consent from gppString if it's empty

317b009

add notice consent encoder to window.Fides for convenience

7109551

remove unused context param

bc50a80

convert GPC preferences to include Fides String override

cb65742

update docs

9411c2a

update tests

12275ed

Update consent-banner.cy.ts

518f451

Update CHANGELOG.md

064feb2

fix banner surfacing logic

4a965e6

doc updates

9eef510

fix cookie check + resurface TCF when dismissed

033cc01

add tests for resurfacing based on dismissal

3808c74

gilluminate force-pushed the gill/LJ-305/add-janus-to-fides-string branch from 3800dd2 to 3808c74 Compare March 20, 2025 16:57

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 16:58 View deployment

Merge branch 'main' into gill/LJ-305/add-janus-to-fides-string

2702190

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 17:21 View deployment

eastandwestwind requested changes Mar 20, 2025

View reviewed changes

Merge branch 'main' into gill/LJ-305/add-janus-to-fides-string

07af60b

vercel bot deployed to Preview – fides-privacy-center March 20, 2025 19:37 View deployment

vercel bot deployed to Preview – fides-plus-nightly March 20, 2025 19:41 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add notice consent to Fides string #5895

Add notice consent to Fides string #5895

gilluminate commented Mar 15, 2025 •

edited

Loading

vercel bot commented Mar 15, 2025 •

edited

Loading

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 18, 2025

gilluminate Mar 19, 2025 •

edited

Loading

gilluminate Mar 19, 2025

eastandwestwind Mar 20, 2025

eastandwestwind Mar 20, 2025

eastandwestwind Mar 20, 2025

		// TODO (PROD-1792): we should also resurface in the special case where the
		// saved consent is only recorded with a consentMethod of "dismiss"

Add notice consent to Fides string #5895

Are you sure you want to change the base?

Add notice consent to Fides string #5895

Conversation

gilluminate commented Mar 15, 2025 • edited Loading

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

vercel bot commented Mar 15, 2025 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gilluminate Mar 19, 2025 • edited Loading

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

gilluminate commented Mar 15, 2025 •

edited

Loading

vercel bot commented Mar 15, 2025 •

edited

Loading

gilluminate Mar 19, 2025 •

edited

Loading