Side load GVL translations to reduce payload size

ethyca · Jul 9, 2024 · f901d27 · f901d27
1 parent 072ac20
commit f901d27
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/clients/fides-js/src/lib/initialize.ts b/clients/fides-js/src/lib/initialize.ts
@@ -20,6 +20,7 @@ import {
   updateCookieFromNoticePreferences,
 } from "./cookie";
 import {
+  ComponentType,
   ConsentMechanism,
   ConsentMethod,
   FidesConfig,
@@ -430,6 +431,26 @@ export const initialize = async ({
       fides.cookie = updatedCookie;
 
       if (shouldInitOverlay) {
+        if (
+          fidesRegionString &&
+          fides.experience.experience_config?.component ===
+            ComponentType.TCF_OVERLAY
+        ) {
+          debugLog(options.debug, "Fetching GVL translations...");
+          const { gvl_translations: gvlt } = await fetchExperience(
+            fidesRegionString,
+            options.fidesApiUrl,
+            options.debug,
+            options.apiOptions,
+            undefined,
+            true
+          );
+
+          // eslint-disable-next-line no-param-reassign
+          fides.experience.gvl_translations = gvlt;
+          debugLog(options.debug, "GVL translations loaded", gvlt);
+        }
+
         // Initialize the i18n singleton before we render the overlay
         const i18n = setupI18n();
         initializeI18n(

diff --git a/clients/fides-js/src/services/api.ts b/clients/fides-js/src/services/api.ts
@@ -27,7 +27,8 @@ export const fetchExperience = async (
   fidesApiUrl: string,
   debug: boolean,
   apiOptions?: FidesApiOptions | null,
-  propertyId?: string | null
+  propertyId?: string | null,
+  includeGvlTranslations?: boolean
 ): Promise<PrivacyExperience | EmptyExperience> => {
   debugLog(debug, `Fetching experience in location: ${userLocationString}`);
   if (apiOptions?.getPrivacyExperienceFn) {
@@ -87,6 +88,13 @@ export const fetchExperience = async (
     // that have no relevant experiences
     const experience = (body.items && body.items[0]) ?? {};
     debugLog(debug, "Recieved experience response from Fides API");
+    if (
+      experience.experience_config?.component === ComponentType.TCF_OVERLAY &&
+      !includeGvlTranslations
+    ) {
+      // Remove GVL translations from experience to reduce payload size
+      experience.gvl_translations = undefined;
+    }
     return experience;
   } catch (e) {
     debugLog(