Adds and supports new experience config to delete cookie based on host domain (#6706)

eastandwestwind · eastandwestwind · commit 4f2b9d033557 · 2025-10-16T12:29:09.000+02:00
diff --git a/.fides/db_dataset.yml b/.fides/db_dataset.yml
@@ -1475,6 +1475,8 @@ dataset:
       data_categories: [ system.operations ]
     - name: auto_subdomain_cookie_deletion
       data_categories: [ system.operations ]
+    - name: cookie_deletion_based_on_host_domain
+      data_categories: [ system.operations ]
     - name: id
       data_categories: [system.operations]
     - name: name
@@ -1526,6 +1528,8 @@ dataset:
       data_categories: [ system.operations ]
     - name: auto_subdomain_cookie_deletion
       data_categories: [ system.operations ]
+    - name: cookie_deletion_based_on_host_domain
+      data_categories: [ system.operations ]
     - name: id
       data_categories: [system.operations]
     - name: is_default
@@ -2438,6 +2442,8 @@ dataset:
       data_categories: [ system.operations ]
     - name: auto_subdomain_cookie_deletion
       data_categories: [ system.operations ]
+    - name: cookie_deletion_based_on_host_domain
+      data_categories: [ system.operations ]
     - name: id
       data_categories: [system.operations]
     - name: name
diff --git a/clients/admin-ui/cypress/e2e/privacy-experience/experience-editor.cy.ts b/clients/admin-ui/cypress/e2e/privacy-experience/experience-editor.cy.ts
@@ -47,6 +47,7 @@ describe("Experience editor", () => {
           allow_language_selection: false,
           auto_detect_language: true,
           auto_subdomain_cookie_deletion: true,
+          cookie_deletion_based_on_host_domain: true,
           allow_vendor_asset_disclosure: false,
           component: "banner_and_modal",
           disabled: true,
diff --git a/clients/admin-ui/cypress/e2e/privacy-experiences.cy.ts b/clients/admin-ui/cypress/e2e/privacy-experiences.cy.ts
diff --git a/clients/admin-ui/cypress/fixtures/privacy-experiences/experienceConfig.json b/clients/admin-ui/cypress/fixtures/privacy-experiences/experienceConfig.json
@@ -7,6 +7,7 @@
   "allow_language_selection": false,
   "auto_detect_language": true,
   "auto_subdomain_cookie_deletion": true,
+  "cookie_deletion_based_on_host_domain": true,
   "regions": ["us_ca", "us_co", "us_ct", "us_ut", "us_va"],
   "id": "pri_001",
   "created_at": "2024-03-22T20:06:27.119285+00:00",
diff --git a/clients/admin-ui/cypress/fixtures/privacy-experiences/tcf-experience.json b/clients/admin-ui/cypress/fixtures/privacy-experiences/tcf-experience.json
@@ -7,6 +7,7 @@
   "allow_language_selection": true,
   "auto_detect_language": true,
   "auto_subdomain_cookie_deletion": true,
+  "cookie_deletion_based_on_host_domain": true,
   "regions": [
     "be",
     "bg",
diff --git a/clients/admin-ui/src/features/common/form/inputs.tsx b/clients/admin-ui/src/features/common/form/inputs.tsx
@@ -375,6 +375,11 @@ interface CustomSwitchProps {
   isDisabled?: boolean;
   onChange?: (checked: boolean) => void;
   className?: string;
+  /**
+   * When provided, the switch will render with this checked state instead of the Formik-managed value.
+   * Useful for read-only or UI-only switches that shouldn't be toggleable.
+   */
+  checkedOverride?: boolean;
 }
 export const CustomSwitch = ({
   label,
@@ -383,6 +388,7 @@ export const CustomSwitch = ({
   size = "small",
   onChange,
   isDisabled,
+  checkedOverride,
   ...props
 }: CustomSwitchProps & Omit<FieldHookConfig<boolean>, "onChange">) => {
   const [field, meta] = useField({
@@ -395,7 +401,7 @@ export const CustomSwitch = ({
     <Field name={field.name}>
       {({ form: { setFieldValue } }: FieldProps) => (
         <Switch
-          checked={field.checked}
+          checked={checkedOverride ?? field.checked}
           onChange={(v) => {
             setFieldValue(field.name, v);
             onChange?.(v);
@@ -443,7 +449,7 @@ export const CustomSwitch = ({
     return (
       <FormControl isInvalid={isInvalid} width="full">
         <Box display="flex" alignItems="center" justifyContent="space-between">
-          <HStack spacing={1}>
+          <HStack spacing={1} mr={1}>
             <Label htmlFor={props.id || props.name} fontSize="xs" my={0} mr={0}>
               {label}
             </Label>
diff --git a/clients/admin-ui/src/features/privacy-experience/PrivacyExperienceForm.tsx b/clients/admin-ui/src/features/privacy-experience/PrivacyExperienceForm.tsx
@@ -7,6 +7,7 @@ import {
   Divider,
   Flex,
   formatIsoLocation,
+  FormLabel,
   Heading,
   isoStringToEntry,
   Text,
@@ -635,12 +636,35 @@ export const PrivacyExperienceForm = ({
           ]}
         />
       </Collapse>
+      <Divider />
+      <Heading fontSize="md" fontWeight="semibold">
+        Cookie Deletion
+      </Heading>
+      <FormLabel htmlFor="regions" fontSize="xs" my={0} mr={1}>
+        Delete rejected cookies on:
+      </FormLabel>
+      <CustomSwitch
+        name="cookie_deletion_based_on_host_domain"
+        id="cookie_deletion_based_on_host_domain"
+        label="Host's domain"
+        variant="stacked"
+        tooltip="If enabled, deletes user-rejected cookies on the current host domain regardless of the cookie's configured domain. Recommended to enable for ease of consent compliance."
+      />
       <CustomSwitch
         name="auto_subdomain_cookie_deletion"
         id="auto_subdomain_cookie_deletion"
-        label="Automatically delete subdomain cookies"
+        label="Host's subdomain"
+        variant="stacked"
+        tooltip="If enabled, deletes user-rejected cookies on subdomains in addition to main domain. Recommended to enable for full consent compliance."
+      />
+      <CustomSwitch
+        name="configured_domain_cookie_deletion"
+        id="configured_domain_cookie_deletion"
+        label="Configured domain"
         variant="stacked"
-        tooltip="If enabled, automatically deletes cookies set on subdomains in addition to main domain where appropriate. Recommended to enable for full consent compliance."
+        tooltip="Deletes cookies using the cookie's configured domain. This is enabled by default and not configurable in the admin UI."
+        isDisabled
+        checkedOverride
       />
     </PrivacyExperienceConfigColumnLayout>
   );
diff --git a/clients/admin-ui/src/features/privacy-experience/form/helpers.tsx b/clients/admin-ui/src/features/privacy-experience/form/helpers.tsx
@@ -52,6 +52,7 @@ export const defaultInitialValues: Omit<ExperienceConfigCreate, "component"> = {
   translations: defaultTranslations,
   auto_detect_language: true,
   auto_subdomain_cookie_deletion: true,
+  cookie_deletion_based_on_host_domain: true,
   allow_vendor_asset_disclosure: false,
   asset_disclosure_include_types: [],
 };
diff --git a/clients/admin-ui/src/features/privacy-experience/preview/helpers.ts b/clients/admin-ui/src/features/privacy-experience/preview/helpers.ts
@@ -69,6 +69,7 @@ export const buildBaseConfig = (
         allow_language_selection: true,
         auto_detect_language: true,
         auto_subdomain_cookie_deletion: true,
+        cookie_deletion_based_on_host_domain: true,
         component: experienceConfig.component,
         disabled: false,
         dismissable: experienceConfig.dismissable,
diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigCreate.ts
@@ -23,6 +23,7 @@ export type ExperienceConfigCreate = {
   allow_language_selection?: boolean | null;
   auto_detect_language?: boolean | null;
   auto_subdomain_cookie_deletion?: boolean | null;
+  cookie_deletion_based_on_host_domain?: boolean | null;
   /** Enable Vendor / Asset Disclosure */
   allow_vendor_asset_disclosure?: boolean | null;
   /** Asset types to disclose */
diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigResponse.ts
@@ -22,6 +22,7 @@ export type ExperienceConfigResponse = {
   allow_language_selection?: boolean | null;
   auto_detect_language?: boolean | null;
   auto_subdomain_cookie_deletion?: boolean | null;
+  cookie_deletion_based_on_host_domain?: boolean | null;
   /** Enable Vendor / Asset Disclosure */
   allow_vendor_asset_disclosure?: boolean | null;
   /** Asset types to disclose */
diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigResponseNoNotices.ts
@@ -23,6 +23,7 @@ export type ExperienceConfigResponseNoNotices = {
   allow_language_selection?: boolean | null;
   auto_detect_language?: boolean | null;
   auto_subdomain_cookie_deletion?: boolean | null;
+  cookie_deletion_based_on_host_domain?: boolean | null;
   regions: Array<PrivacyNoticeRegion>;
   tcf_configuration_id?: string | null;
   id: string;
diff --git a/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts b/clients/admin-ui/src/types/api/models/ExperienceConfigUpdate.ts
@@ -27,6 +27,7 @@ export type ExperienceConfigUpdate = {
   allow_language_selection?: boolean | null;
   auto_detect_language?: boolean | null;
   auto_subdomain_cookie_deletion?: boolean | null;
+  cookie_deletion_based_on_host_domain?: boolean | null;
   /** Enable Vendor / Asset Disclosure */
   allow_vendor_asset_disclosure?: boolean | null;
   /** Asset types to disclose */
diff --git a/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts b/clients/admin-ui/src/types/api/models/MinimalTCFExperienceConfig.ts
@@ -15,6 +15,7 @@ export type MinimalTCFExperienceConfig = {
   id: string;
   auto_detect_language?: boolean | null;
   auto_subdomain_cookie_deletion?: boolean | null;
+  cookie_deletion_based_on_host_domain?: boolean | null;
   component: ComponentType;
   dismissable?: boolean | null;
   translations?: Array<MinimalTCFBannerTranslation>;
diff --git a/clients/fides-js/__tests__/__fixtures__/mock_experience.json b/clients/fides-js/__tests__/__fixtures__/mock_experience.json
@@ -20,6 +20,7 @@
     "allow_language_selection": true,
     "auto_detect_language": true,
     "auto_subdomain_cookie_deletion": true,
+    "cookie_deletion_based_on_host_domain": true,
     "language": "en",
     "accept_button_label": "Accept Test",
     "acknowledge_button_label": "Acknowledge Test",
diff --git a/clients/fides-js/__tests__/lib/cookie.test.ts b/clients/fides-js/__tests__/lib/cookie.test.ts
@@ -433,6 +433,22 @@ describe("cookies", () => {
           { domain: ".example.co.jp" },
         ],
       },
+      // Host-domain deletion behavior
+      {
+        cookies: [{ name: "host-cookie", domain: "foo.bar.com", path: "/" }],
+        removeSubdomainCookies: false,
+        cookieDeletionBasedOnHostDomain: true,
+        expectedAttributes: [{ domain: "example.co.jp", path: "/" }],
+      },
+      {
+        cookies: [{ name: "host-cookie", domain: "foo.bar.com", path: "/" }],
+        removeSubdomainCookies: true,
+        cookieDeletionBasedOnHostDomain: true,
+        expectedAttributes: [
+          { domain: "example.co.jp", path: "/" },
+          { domain: ".example.co.jp" },
+        ],
+      },
       // these cookies won't actually end up being deleted in the browser
       // https://ethyca.atlassian.net/browse/PROD-2830
       {
@@ -453,13 +469,19 @@ describe("cookies", () => {
       ({
         cookies,
         removeSubdomainCookies,
+        cookieDeletionBasedOnHostDomain,
         expectedAttributes,
       }: {
         cookies: CookiesType[];
         removeSubdomainCookies?: boolean;
+        cookieDeletionBasedOnHostDomain?: boolean;
         expectedAttributes: Array<CookieAttributes | undefined>;
       }) => {
-        removeCookiesFromBrowser(cookies, removeSubdomainCookies);
+        removeCookiesFromBrowser(
+          cookies,
+          cookieDeletionBasedOnHostDomain ?? false,
+          removeSubdomainCookies,
+        );
         const expectedLength = removeSubdomainCookies
           ? cookies.length * 2
           : cookies.length;
diff --git a/clients/fides-js/docs/interfaces/FidesExperienceConfig.md b/clients/fides-js/docs/interfaces/FidesExperienceConfig.md
@@ -29,7 +29,15 @@ This property corresponds with the "Auto detect language" configuration toggle i
 
 > `optional` **auto\_subdomain\_cookie\_deletion**: `boolean`
 
-This property corresponds with the "Automatically delete subdomain cookies" option.
+This property corresponds with the "Delete from host’s subdomain" Cookie Deletion option.
+
+***
+
+### cookie\_deletion\_based\_on\_host\_domain?
+
+> `optional` **cookie\_deletion\_based\_on\_host\_domain**: `boolean`
+
+This property corresponds with the "Delete from host’s domain" Cookie Deletion option.
 
 ***
 
diff --git a/clients/fides-js/src/docs/fides-experience-config.ts b/clients/fides-js/src/docs/fides-experience-config.ts
@@ -22,10 +22,15 @@ export interface FidesExperienceConfig {
   auto_detect_language?: boolean;
 
   /**
-   * This property corresponds with the "Automatically delete subdomain cookies" option.
+   * This property corresponds with the "Delete from host’s subdomain" Cookie Deletion option.
    */
   auto_subdomain_cookie_deletion?: boolean;
 
+  /**
+   * This property corresponds with the "Delete from host’s domain" Cookie Deletion option.
+   */
+  cookie_deletion_based_on_host_domain?: boolean;
+
   /**
    * Each configured experience is presented to the user as one of 4 types of components: `"banner_and_modal"`, `"modal"`, `"privacy_center"`, or `"tcf_overlay"`. This property corresponds with the current user's Experience type.
    */
diff --git a/clients/fides-js/src/lib/consent-types.ts b/clients/fides-js/src/lib/consent-types.ts
@@ -567,6 +567,7 @@ export interface ExperienceConfigMinimal
     | "auto_detect_language"
     | "dismissable"
     | "auto_subdomain_cookie_deletion"
+    | "cookie_deletion_based_on_host_domain"
     | "layer1_button_options"
     | "reject_all_mechanism"
   > {
diff --git a/clients/fides-js/src/lib/cookie.ts b/clients/fides-js/src/lib/cookie.ts
@@ -363,15 +363,19 @@ export const makeConsentDefaultsLegacy = (
  */
 export const removeCookiesFromBrowser = (
   cookiesToRemove: CookiesType[],
+  cookieDeletionBasedOnHostDomain: boolean = true,
   removeSubdomainCookies: boolean = true,
 ) => {
+  const { hostname } = window.location;
   cookiesToRemove.forEach((cookie) => {
+    const domainToUse = cookieDeletionBasedOnHostDomain
+      ? hostname
+      : cookie.domain;
     cookies.remove(cookie.name, {
       path: cookie.path ?? "/",
-      domain: cookie.domain,
+      domain: domainToUse,
     });
     if (removeSubdomainCookies) {
-      const { hostname } = window.location;
       cookies.remove(cookie.name, { domain: `.${hostname}` });
     }
   });
diff --git a/clients/fides-js/src/lib/preferences.ts b/clients/fides-js/src/lib/preferences.ts
@@ -221,6 +221,7 @@ export const updateConsentPreferences = async ({
         if (preference.notice?.cookies) {
           removeCookiesFromBrowser(
             preference.notice.cookies,
+            experience.experience_config?.cookie_deletion_based_on_host_domain,
             experience.experience_config?.auto_subdomain_cookie_deletion,
           );
         }
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_banner_modal.json b/clients/privacy-center/cypress/fixtures/consent/experience_banner_modal.json
@@ -63,6 +63,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-banner-modal-000",
         "component": "banner_and_modal",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_banner_modal_notice_only.json b/clients/privacy-center/cypress/fixtures/consent/experience_banner_modal_notice_only.json
@@ -62,6 +62,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-banner-modal-000",
         "component": "banner_and_modal",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_gpp.json b/clients/privacy-center/cypress/fixtures/consent/experience_gpp.json
@@ -55,6 +55,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-gpp-banner-modal-000",
         "component": "banner_and_modal",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_modal.json b/clients/privacy-center/cypress/fixtures/consent/experience_modal.json
@@ -63,6 +63,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-modal-000",
         "component": "modal",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_privacy_center.json b/clients/privacy-center/cypress/fixtures/consent/experience_privacy_center.json
@@ -63,6 +63,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-privacy-center-000",
         "component": "privacy_center",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_privacy_center_hierarchical.json b/clients/privacy-center/cypress/fixtures/consent/experience_privacy_center_hierarchical.json
@@ -63,6 +63,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-privacy-center-000",
         "component": "privacy_center",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_tcf.json b/clients/privacy-center/cypress/fixtures/consent/experience_tcf.json
@@ -74,6 +74,7 @@
         "allow_language_selection": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "disabled": false,
         "id": "pri_exp-tcf-overlay-000",
         "component": "tcf_overlay",
diff --git a/clients/privacy-center/cypress/fixtures/consent/experience_tcf_minimal.json b/clients/privacy-center/cypress/fixtures/consent/experience_tcf_minimal.json
@@ -13,6 +13,7 @@
         "dismissable": true,
         "auto_detect_language": true,
         "auto_subdomain_cookie_deletion": true,
+        "cookie_deletion_based_on_host_domain": true,
         "component": "tcf_overlay",
         "translations": [
           {
diff --git a/clients/privacy-center/cypress/fixtures/consent/fidesjs_options_banner_modal.json b/clients/privacy-center/cypress/fixtures/consent/fidesjs_options_banner_modal.json
@@ -75,6 +75,7 @@
       "allow_language_selection": true,
       "auto_detect_language": true,
       "auto_subdomain_cookie_deletion": true,
+      "cookie_deletion_based_on_host_domain": true,
       "disabled": false,
       "id": "pri_exp-banner-modal-000",
       "component": "banner_and_modal",
diff --git a/clients/privacy-center/public/fides-js-components-demo.html b/clients/privacy-center/public/fides-js-components-demo.html
@@ -76,6 +76,7 @@
             allow_language_selection: true,
             auto_detect_language: true,
             auto_subdomain_cookie_deletion: true,
+            cookie_deletion_based_on_host_domain: true,
             language: "en",
             accept_button_label: "Accept Test",
             acknowledge_button_label: "Acknowledge Test",
diff --git a/clients/privacy-center/types/api/models/ExperienceConfigCreate.ts b/clients/privacy-center/types/api/models/ExperienceConfigCreate.ts
diff --git a/clients/privacy-center/types/api/models/ExperienceConfigResponse.ts b/clients/privacy-center/types/api/models/ExperienceConfigResponse.ts
diff --git a/clients/privacy-center/types/api/models/ExperienceConfigResponseNoNotices.ts b/clients/privacy-center/types/api/models/ExperienceConfigResponseNoNotices.ts
diff --git a/clients/privacy-center/types/api/models/ExperienceConfigUpdate.ts b/clients/privacy-center/types/api/models/ExperienceConfigUpdate.ts
diff --git a/src/fides/api/alembic/migrations/versions/65a1bc82ae09_adds_experience_config_for_delete_.py b/src/fides/api/alembic/migrations/versions/65a1bc82ae09_adds_experience_config_for_delete_.py
diff --git a/src/fides/api/models/privacy_experience.py b/src/fides/api/models/privacy_experience.py
