@blotoutio/edgetag-sdk-browser 0.26.1 → 0.26.3

package/index.js

@@ -90,7 +90,18 @@
             return error;
         }
     };
+    const allowLog = () => {
+        try {
+            return localStorage.getItem('edgeTagDebug') === '1';
+        }
+        catch {
+            return false;
+        }
+    };
     const log = (data) => {
+        if (!allowLog()) {
+            return;
+        }
         console.log('[EdgeTag]', getMessage(data));
     };
     const error = (data) => {
@@ -324,7 +335,7 @@
             referrer: getReferrer(),
             search: getSearch(),
             locale: getLocale(),
-            sdkVersion: "0.26.1" ,
+            sdkVersion: "0.26.3" ,
             ...(payload || {}),
         };
         let storage = {};
@@ -432,7 +443,64 @@
         return memoryConsent;
     };
 
-    const allowedProvider = new Set();
+    const isBool = (v) => typeof v == 'boolean';
+    const isRecord = (v) => !!v && typeof v == 'object';
+    /**
+     * This function validates user consent for a given provider and tag name.
+     * It should be used in conjunction with `UserConsent`, not `ProvidersConfig`.
+     */
+    const hasUserConsent = (consent, provider, tagName) => {
+        if (!isRecord(consent)) {
+            return false;
+        }
+        let allowed = isBool(consent.all) ? consent.all : false;
+        if (provider in consent) {
+            const providerSpecific = consent[provider];
+            if (isBool(providerSpecific)) {
+                allowed = providerSpecific;
+            }
+            else if (isRecord(providerSpecific)) {
+                if ('all' in providerSpecific && isBool(providerSpecific.all)) {
+                    allowed = providerSpecific.all;
+                }
+                if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
+                    allowed = providerSpecific[tagName];
+                }
+            }
+        }
+        return allowed;
+    };
+    /**
+     * This function validates provider allowance for a given provider and tag name.
+     * It should not be used to validate `UserConsent`.
+     */
+    const isProviderInstanceAllowed = (providersConfig, provider, tagName) => {
+        if (!isRecord(providersConfig)) {
+            return true;
+        }
+        let allowed = isBool(providersConfig.all) ? providersConfig.all : true;
+        if (provider in providersConfig) {
+            const providerSpecific = providersConfig[provider];
+            if (isBool(providerSpecific)) {
+                allowed = providerSpecific;
+            }
+            else if (isRecord(providerSpecific)) {
+                if ('all' in providerSpecific && isBool(providerSpecific.all)) {
+                    allowed = providerSpecific.all;
+                }
+                if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
+                    allowed = providerSpecific[tagName];
+                }
+            }
+        }
+        return allowed;
+    };
+
+    const upsert = (map, key, update, createDefault) => {
+        const currentValue = map.has(key) ? map.get(key) : createDefault();
+        return map.set(key, update(currentValue));
+    };
+
     let initialized = false;
     const providersPackages = {};
     const setPreferences = (preferences) => {
@@ -472,12 +540,9 @@
     const setInitialized = () => {
         initialized = true;
     };
-    const getAllowedProviders = () => allowedProvider;
-    const setAllowedProviders = (providers) => {
-        for (const provider of providers) {
-            allowedProvider.add(provider);
-        }
-    };
+    const configuredTags = new Map();
+    const addConfiguredTag = (pkg, tagName) => upsert(configuredTags, pkg, (names) => names.add(tagName), () => new Set());
+    const getConfiguredTags = () => configuredTags;
 
     const manifestVariables = {};
     const addProviderVariable = (name, variables, tagName) => {
@@ -512,59 +577,6 @@
         }
     };
 
-    const isBool = (v) => typeof v == 'boolean';
-    const isRecord = (v) => !!v && typeof v == 'object';
-    /**
-     * This function validates user consent for a given provider and tag name.
-     * It should be used in conjunction with `UserConsent`, not `ProvidersConfig`.
-     */
-    const hasUserConsent = (consent, provider, tagName) => {
-        if (!isRecord(consent)) {
-            return false;
-        }
-        let allowed = isBool(consent.all) ? consent.all : false;
-        if (provider in consent) {
-            const providerSpecific = consent[provider];
-            if (isBool(providerSpecific)) {
-                allowed = providerSpecific;
-            }
-            else if (isRecord(providerSpecific)) {
-                if ('all' in providerSpecific && isBool(providerSpecific.all)) {
-                    allowed = providerSpecific.all;
-                }
-                if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
-                    allowed = providerSpecific[tagName];
-                }
-            }
-        }
-        return allowed;
-    };
-    /**
-     * This function validates provider allowance for a given provider and tag name.
-     * It should not be used to validate `UserConsent`.
-     */
-    const isProviderInstanceAllowed = (providersConfig, provider, tagName) => {
-        if (!isRecord(providersConfig)) {
-            return true;
-        }
-        let allowed = isBool(providersConfig.all) ? providersConfig.all : true;
-        if (provider in providersConfig) {
-            const providerSpecific = providersConfig[provider];
-            if (isBool(providerSpecific)) {
-                allowed = providerSpecific;
-            }
-            else if (isRecord(providerSpecific)) {
-                if ('all' in providerSpecific && isBool(providerSpecific.all)) {
-                    allowed = providerSpecific.all;
-                }
-                if (tagName in providerSpecific && isBool(providerSpecific[tagName])) {
-                    allowed = providerSpecific[tagName];
-                }
-            }
-        }
-        return allowed;
-    };
-
     const sendTag = ({ eventName, eventId, data, providerData, providers, options, }) => {
         const payload = {
             eventName,
@@ -591,47 +603,44 @@
             eventId = generateEventId(eventName);
         }
         const providerPackages = getProvidersPackage();
+        const configuredTags = getConfiguredTags();
         const userId = handleGetUserId();
         const providerData = {};
         const consent = getConsent();
-        const allowedProviders = getAllowedProviders();
-        let anyProviderCalled = false;
-        if (providerPackages) {
-            for (const pkg of Object.values(providerPackages)) {
-                if (!pkg || !pkg.name || !pkg.tag) {
+        for (const pkg of Object.values(providerPackages)) {
+            if (!pkg || !pkg.name || !pkg.tag) {
+                continue;
+            }
+            if (!configuredTags.has(pkg.name)) {
+                log(`Provider ${pkg.name} is not in allow list`);
+                continue;
+            }
+            const variables = getProviderVariables(pkg.name);
+            const result = {};
+            const providerVariables = Object.entries(variables);
+            const executionContext = new Map();
+            for (const [tagName, variableSet] of providerVariables) {
+                if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
+                    log(`Provider instance is not allowed (${pkg.name}: ${tagName})`);
                     continue;
                 }
-                if (!allowedProviders.has(pkg.name)) {
+                if (!hasUserConsent(consent, pkg.name, tagName)) {
+                    log(`Consent is missing (${pkg.name}: ${tagName})`);
                     continue;
                 }
-                const variables = getProviderVariables(pkg.name);
-                const result = {};
-                const providerVariables = Object.entries(variables);
-                const executionContext = new Map();
-                for (const [tagName, variableSet] of providerVariables) {
-                    if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
-                        log(`Provider instance is not allowed (${pkg.name}: ${tagName})`);
-                        continue;
-                    }
-                    if (!hasUserConsent(consent, pkg.name, tagName)) {
-                        log(`Consent is missing (${pkg.name}: ${tagName})`);
-                        continue;
-                    }
-                    anyProviderCalled = true;
-                    result[tagName] = pkg.tag({
-                        userId,
-                        eventName,
-                        eventId,
-                        data: JSON.parse(JSON.stringify(data)),
-                        sendTag,
-                        manifestVariables: variableSet,
-                        executionContext,
-                    });
-                }
-                providerData[pkg.name] = result;
+                result[tagName] = pkg.tag({
+                    userId,
+                    eventName,
+                    eventId,
+                    data: JSON.parse(JSON.stringify(data)),
+                    sendTag,
+                    manifestVariables: variableSet,
+                    executionContext,
+                });
             }
+            providerData[pkg.name] = result;
         }
-        if (!anyProviderCalled) {
+        if (!hasAllowedManifestTags(configuredTags, consent, providers)) {
             return;
         }
         sendTag({
@@ -643,6 +652,17 @@
             options,
         });
     };
+    const hasAllowedManifestTags = (tags, consent, providersConfig) => {
+        for (const [pkg, tagNames] of tags) {
+            for (const tagName of tagNames) {
+                if (hasUserConsent(consent, pkg, tagName) &&
+                    isProviderInstanceAllowed(providersConfig, pkg, tagName)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    };
 
     const handleData = (data, providers, options) => {
         if (!data || Object.keys(data).length === 0) {
@@ -651,33 +671,32 @@
         }
         saveKV(data);
         const providerPackages = getProvidersPackage();
+        const configuredTags = getConfiguredTags();
         const userId = handleGetUserId();
         const consent = getConsent();
-        const allowedProviders = getAllowedProviders();
-        if (providerPackages) {
-            for (const pkg of Object.values(providerPackages)) {
-                if (!pkg || !pkg.user || !pkg.name) {
+        for (const pkg of Object.values(providerPackages)) {
+            if (!pkg || !pkg.user || !pkg.name) {
+                continue;
+            }
+            if (!configuredTags.has(pkg.name)) {
+                log(`Provider ${pkg.name} is not in allow list`);
+                continue;
+            }
+            const variables = getProviderVariables(pkg.name);
+            for (const [tagName, variableSet] of Object.entries(variables)) {
+                if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
+                    log(`Data not allowed for ${pkg.name} (${tagName})`);
                     continue;
                 }
-                if (!allowedProviders.has(pkg.name)) {
+                if (!hasUserConsent(consent, pkg.name, tagName)) {
+                    log(`Consent is missing for ${pkg.name} (${tagName})`);
                     continue;
                 }
-                const variables = getProviderVariables(pkg.name);
-                for (const [tagName, variableSet] of Object.entries(variables)) {
-                    if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
-                        log(`Data not allowed for ${pkg.name} (${tagName})`);
-                        continue;
-                    }
-                    if (!hasUserConsent(consent, pkg.name, tagName)) {
-                        log(`Consent is missing for ${pkg.name} (${tagName})`);
-                        continue;
-                    }
-                    pkg.user({
-                        userId,
-                        data,
-                        manifestVariables: variableSet,
-                    });
-                }
+                pkg.user({
+                    userId,
+                    data,
+                    manifestVariables: variableSet,
+                });
             }
         }
         postRequest(getDataURL(), { data, providers }, options).catch(error);
@@ -780,8 +799,8 @@
     const handleManifest = (manifest) => {
         const providerPackages = getProvidersPackage();
         const userId = handleGetUserId();
-        setAllowedProviders(manifest.map((provider) => provider.package));
         manifest.forEach((provider) => {
+            addConfiguredTag(provider.package, provider.tagName);
             addProviderVariable(provider.package, provider.variables, provider.tagName);
             if (provider.rules) {
                 Object.entries(provider.rules).forEach(([name, recipe]) => {
@@ -793,18 +812,16 @@
                     }
                 });
             }
-            if (providerPackages) {
-                const pkg = providerPackages[provider.package];
-                if (pkg && pkg.name && pkg.init) {
-                    pkg.init({
-                        userId,
-                        manifest: provider,
-                        sendTag,
-                        sendEdgeData: handleData,
-                        getEdgeData: handleGetData,
-                        keyName: `${keyPrefix}Store`,
-                    });
-                }
+            const pkg = providerPackages[provider.package];
+            if (pkg && pkg.name && pkg.init) {
+                pkg.init({
+                    userId,
+                    manifest: provider,
+                    sendTag,
+                    sendEdgeData: handleData,
+                    getEdgeData: handleGetData,
+                    keyName: `${keyPrefix}Store`,
+                });
             }
         });
         setInitialized();
@@ -831,7 +848,7 @@
         getRequest(url.href)
             .then((result) => {
             if (!result) {
-                log('Initialization failed');
+                error('Initialization failed');
                 return;
             }
             if (result.userId) {
@@ -854,35 +871,33 @@
         saveKV({
             [key]: value,
         });
-        const consent = getConsent();
-        const allowedProviders = getAllowedProviders();
         const providerPackages = getProvidersPackage();
+        const configuredTags = getConfiguredTags();
+        const consent = getConsent();
         const userId = handleGetUserId();
-        if (providerPackages) {
-            for (const pkg of Object.values(providerPackages)) {
-                if (!pkg || !pkg.name || !pkg.user) {
+        for (const pkg of Object.values(providerPackages)) {
+            if (!pkg || !pkg.name || !pkg.user) {
+                continue;
+            }
+            if (!configuredTags.has(pkg.name)) {
+                log(`Provider ${pkg.name} is not in allow list`);
+                continue;
+            }
+            const variables = getProviderVariables(pkg.name);
+            for (const [tagName, variableSet] of Object.entries(variables)) {
+                if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
+                    log(`User not allowed for ${pkg.name} (${tagName})`);
                     continue;
                 }
-                if (!allowedProviders.has(pkg.name)) {
+                if (!hasUserConsent(consent, pkg.name, tagName)) {
+                    log(`User doesn't have consent for ${pkg.name} (${tagName})`);
                     continue;
                 }
-                const variables = getProviderVariables(pkg.name);
-                for (const [tagName, variableSet] of Object.entries(variables)) {
-                    if (!isProviderInstanceAllowed(providers, pkg.name, tagName)) {
-                        // should we be logging this?
-                        log(`User not allowed for ${pkg.name} (${tagName})`);
-                        continue;
-                    }
-                    if (!hasUserConsent(consent, pkg.name, tagName)) {
-                        log(`User doesn't have consent for ${pkg.name} (${tagName})`);
-                        continue;
-                    }
-                    pkg.user({
-                        userId,
-                        data: { [key]: value },
-                        manifestVariables: variableSet,
-                    });
-                }
+                pkg.user({
+                    userId,
+                    data: { [key]: value },
+                    manifestVariables: variableSet,
+                });
             }
         }
         postRequest(getUserURL(), {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/edgetag-sdk-browser",
-  "version": "0.26.1",
+  "version": "0.26.3",
   "description": "Browser SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",