wip

segmentio · Nov 7, 2023 · 5600222 · 5600222
1 parent bc890e6
commit 5600222
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/packages/browser/src/browser/index.ts b/packages/browser/src/browser/index.ts
@@ -96,6 +96,8 @@ export interface LegacySettings {
      */
     allCategories: string[]
   }
+
+  disableAnalytics: boolean
 }
 
 export interface AnalyticsBrowserSettings extends AnalyticsSettings {
@@ -323,6 +325,14 @@ async function loadAnalytics(
     legacySettings = options.updateCDNSettings(legacySettings)
   }
 
+  // if options.disable is a function, we allow user to disable analytics based on CDN Settings
+  if (typeof options.disable === 'function') {
+    const disabled = await options.disable(legacySettings)
+    if (disabled) {
+      return [new NullAnalytics(), Context.system()]
+    }
+  }
+
   const retryQueue: boolean =
     legacySettings.integrations['Segment.io']?.retryQueue ?? true
 

diff --git a/packages/browser/src/core/analytics/analytics.ts b/packages/browser/src/core/analytics/analytics.ts
@@ -133,9 +133,19 @@ export interface InitOptions {
    * Disable sending any data to Segment's servers. All emitted events and API calls (including .ready()), will be no-ops, and no cookies or localstorage will be used.
    *
    * @example
+   * ### Basic (Will not not fetch any CDN settings)
+   * ```ts
    * disable: process.env.NODE_ENV === 'test'
+   * ```
+   *
+   * ### Advanced (Fetches CDN Settings. Do not use this unless you require CDN settings for some reason)
+   * ```ts
+   * disable: (cdnSettings) => cdnSettings.foo === 'bar'
+   * ```
    */
-  disable?: boolean
+  disable?:
+    | boolean
+    | ((LegacySettings: LegacySettings) => boolean | Promise<boolean>)
 }
 
 /* analytics-classic stubs */