Consent - Do not load segment/send events unneccessarily (#1001)

segmentio · Nov 18, 2023 · 57be1ac · 57be1ac
1 parent a72f473
commit 57be1ac
Show file tree

Hide file tree

Showing 11 changed files with 286 additions and 65 deletions.
diff --git a/.changeset/calm-dancers-happen.md b/.changeset/calm-dancers-happen.md
@@ -0,0 +1,9 @@
+---
+'@segment/analytics-consent-tools': minor
+---
+Segment will not load, or, if already loaded, will not send events to segment, if all of the following conditions are met:
+1. No destinations without a consent mapping (consentSettings.hasUnmappedDestinations == false)
+
+    AND
+
+2. User has not consented to any category present in the consentSettings.allCategories array.
diff --git a/.changeset/tame-cooks-invite.md b/.changeset/tame-cooks-invite.md
@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': patch
+---
+
+add hasUnmappedDestinations property to types
diff --git a/examples/standalone-playground/pages/index-consent-no-banner.html b/examples/standalone-playground/pages/index-consent-no-banner.html
@@ -106,10 +106,7 @@
               var t = document.createElement('script')
               t.type = 'text/javascript'
               t.async = !0
-              t.src =
-                'https://cdn.segment.com/analytics.js/v1/' +
-                writeKey +
-                '/analytics.min.js'
+              t.src = '/node_modules/@segment/analytics-next/dist/umd/standalone.js'
               var n = document.getElementsByTagName('script')[0]
               n.parentNode.insertBefore(t, n)
               analytics._loadOptions = e

diff --git a/examples/standalone-playground/pages/index-consent.html b/examples/standalone-playground/pages/index-consent.html
@@ -94,10 +94,7 @@
               var t = document.createElement('script')
               t.type = 'text/javascript'
               t.async = !0
-              t.src =
-                'https://cdn.segment.com/analytics.js/v1/' +
-                writeKey +
-                '/analytics.min.js'
+              t.src = '/node_modules/@segment/analytics-next/dist/umd/standalone.js'
               var n = document.getElementsByTagName('script')[0]
               n.parentNode.insertBefore(t, n)
               analytics._loadOptions = e

diff --git a/packages/browser/src/browser/index.ts b/packages/browser/src/browser/index.ts
@@ -90,11 +90,16 @@ export interface LegacySettings {
    */
   consentSettings?: {
     /**
-     * All unique consent categories.
+     * All unique consent categories for enabled destinations.
      * There can be categories in this array that are important for consent that are not included in any integration  (e.g. 2 cloud mode categories).
      * @example ["Analytics", "Advertising", "CAT001"]
      */
     allCategories: string[]
+
+    /**
+     * Whether or not there are any unmapped destinations for enabled destinations.
+     */
+    hasUnmappedDestinations: boolean
   }
 }
 

diff --git a/packages/consent/consent-tools/package.json b/packages/consent/consent-tools/package.json
@@ -13,7 +13,7 @@
     "!**/test-helpers/**"
   ],
   "scripts": {
-    ".": "yarn run -T turbo run --filter=@segment/analytics-consent-tools",
+    ".": "yarn run -T turbo run --filter=@segment/analytics-consent-tools...",
     "test": "yarn jest",
     "lint": "yarn concurrently 'yarn:eslint .' 'yarn:tsc --noEmit'",
     "build": "rm -rf dist && yarn concurrently 'yarn:build:*'",