feat: add support for hasUnmappedDestinations (#905)

Author: zikaari

packages/core/src/__tests__/__helpers__/mockSegmentStore.ts

@@ -12,6 +12,7 @@ import type {
   DestinationFilters,
   IntegrationSettings,
   RoutingRule,
+  SegmentAPIConsentSettings,
   SegmentAPIIntegrations,
   UserInfoState,
 } from '../../types';
@@ -22,6 +23,7 @@ export type StoreData = {
   isReady: boolean;
   context?: DeepPartial<Context>;
   settings: SegmentAPIIntegrations;
+  consentSettings?: SegmentAPIConsentSettings;
   filters: DestinationFilters;
   userInfo: UserInfoState;
   deepLinkData: DeepLinkData;
@@ -33,6 +35,7 @@ const INITIAL_VALUES: StoreData = {
   settings: {
     [SEGMENT_DESTINATION_KEY]: {},
   },
+  consentSettings: undefined,
   filters: {},
   userInfo: {
     anonymousId: 'anonymousId',
@@ -71,6 +74,9 @@ export class MockSegmentStore implements Storage {
   private callbacks = {
     context: createCallbackManager<DeepPartial<Context> | undefined>(),
     settings: createCallbackManager<SegmentAPIIntegrations>(),
+    consentSettings: createCallbackManager<
+      SegmentAPIConsentSettings | undefined
+    >(),
     filters: createCallbackManager<DestinationFilters>(),
     userInfo: createCallbackManager<UserInfoState>(),
     deepLinkData: createCallbackManager<DeepLinkData>(),
@@ -123,6 +129,19 @@ export class MockSegmentStore implements Storage {
     },
   };
 
+  readonly consentSettings: Watchable<SegmentAPIConsentSettings | undefined> &
+    Settable<SegmentAPIConsentSettings | undefined> = {
+    get: createMockStoreGetter(() => this.data.consentSettings),
+    onChange: (callback: (value?: SegmentAPIConsentSettings) => void) =>
+      this.callbacks.consentSettings.register(callback),
+    set: (value) => {
+      this.data.consentSettings =
+        value instanceof Function ? value(this.data.consentSettings) : value;
+      this.callbacks.consentSettings.run(this.data.consentSettings);
+      return this.data.consentSettings;
+    },
+  };
+
   readonly filters: Watchable<DestinationFilters | undefined> &
     Settable<DestinationFilters> &
     Dictionary<string, RoutingRule, DestinationFilters> = {

packages/core/src/analytics.ts

@@ -59,6 +59,7 @@ import {
   SegmentError,
   translateHTTPError,
 } from './errors';
+import type { SegmentAPIConsentSettings } from '.';
 
 type OnPluginAddedCallback = (plugin: Plugin) => void;
 
@@ -116,6 +117,11 @@ export class SegmentClient {
    */
   readonly settings: Watchable<SegmentAPIIntegrations | undefined>;
 
+  /**
+   * Access or subscribe to integration settings
+   */
+  readonly consentSettings: Watchable<SegmentAPIConsentSettings | undefined>;
+
   /**
    * Access or subscribe to destination filter settings
    */
@@ -198,6 +204,11 @@ export class SegmentClient {
       onChange: this.store.settings.onChange,
     };
 
+    this.consentSettings = {
+      get: this.store.consentSettings.get,
+      onChange: this.store.consentSettings.onChange,
+    };
+
     this.filters = {
       get: this.store.filters.get,
       onChange: this.store.filters.onChange,
@@ -305,12 +316,14 @@ export class SegmentClient {
       const resJson: SegmentAPISettings =
         (await res.json()) as SegmentAPISettings;
       const integrations = resJson.integrations;
+      const consentSettings = resJson.consentSettings;
       const filters = this.generateFiltersMap(
         resJson.middlewareSettings?.routingRules ?? []
       );
       this.logger.info(`Received settings from Segment succesfully.`);
       await Promise.all([
         this.store.settings.set(integrations),
+        this.store.consentSettings.set(consentSettings),
         this.store.filters.set(filters),
       ]);
     } catch (e) {

packages/core/src/plugins/ConsentPlugin.ts

@@ -80,18 +80,20 @@ export class ConsentPlugin extends Plugin {
     if (this.isDestinationPlugin(plugin)) {
       plugin.add(
         new ConsentFilterPlugin((event) => {
+          const allCategories =
+            this.analytics?.consentSettings.get()?.allCategories || [];
           const settings = this.analytics?.settings.get() || {};
           const preferences = event.context?.consent?.categoryPreferences || {};
 
           if (plugin.key === SEGMENT_DESTINATION_KEY) {
+            const noneConsented = allCategories.every(
+              (category) => !preferences[category]
+            );
+
             return (
               this.isConsentUpdateEvent(event) ||
-              !(
-                Object.values(preferences).every((consented) => !consented) &&
-                Object.entries(settings)
-                  .filter(([k]) => k !== SEGMENT_DESTINATION_KEY)
-                  .every(([_, v]) => this.containsConsentSettings(v))
-              )
+              !this.isConsentFeatureSetup() ||
+              !(noneConsented && !this.hasUnmappedDestinations())
             );
           }
 
@@ -127,6 +129,16 @@ export class ConsentPlugin extends Plugin {
   private isConsentUpdateEvent(event: SegmentEvent): boolean {
     return (event as TrackEventType).event === CONSENT_PREF_UPDATE_EVENT;
   }
+
+  private hasUnmappedDestinations(): boolean {
+    return (
+      this.analytics?.consentSettings.get()?.hasUnmappedDestinations === true
+    );
+  }
+
+  private isConsentFeatureSetup(): boolean {
+    return typeof this.analytics?.consentSettings.get() === 'object';
+  }
 }
 
 /**

packages/core/src/plugins/__tests__/consent/destinationMultipleCategories.test.ts

@@ -13,6 +13,7 @@ describe('Destinations multiple categories', () => {
     createTestClient(
       {
         settings: destinationsMultipleCategories.integrations,
+        consentSettings: destinationsMultipleCategories.consentSettings,
       },
       { autoAddSegmentDestination: true }
     );

packages/core/src/plugins/__tests__/consent/mockSettings/ConsentNotEnabledAtSegment.json

@@ -68,4 +68,3 @@
   "legacyVideoPluginsEnabled": false,
   "remotePlugins": []
 }
-

packages/core/src/plugins/__tests__/consent/mockSettings/DestinationsMultipleCategories.json

@@ -64,10 +64,10 @@
   "legacyVideoPluginsEnabled": false,
   "remotePlugins": [],
   "consentSettings": {
+    "hasUnmappedDestinations": false,
     "allCategories": [
       "C0001",
       "C0002"
     ]
   }
 }
-

packages/core/src/plugins/__tests__/consent/mockSettings/NoUnmappedDestinations.json

@@ -93,6 +93,7 @@
   "legacyVideoPluginsEnabled": false,
   "remotePlugins": [],
   "consentSettings": {
+    "hasUnmappedDestinations": false,
     "allCategories": [
       "C0001",
       "C0002",
@@ -102,4 +103,3 @@
     ]
   }
 }
-

packages/core/src/plugins/__tests__/consent/mockSettings/UnmappedDestinations.json

@@ -89,6 +89,7 @@
   "legacyVideoPluginsEnabled": false,
   "remotePlugins": [],
   "consentSettings": {
+    "hasUnmappedDestinations": true,
     "allCategories": [
       "C0001",
       "C0002",
@@ -98,4 +99,3 @@
     ]
   }
 }
-

packages/core/src/plugins/__tests__/consent/noUnmapped.test.ts

@@ -8,6 +8,7 @@ describe('No unmapped destinations', () => {
   const createClient = () =>
     createTestClient({
       settings: noUnmappedDestinations.integrations,
+      consentSettings: noUnmappedDestinations.consentSettings,
     });
 
   test('no to all', async () => {

packages/core/src/plugins/__tests__/consent/unmapped.test.ts

@@ -13,6 +13,7 @@ describe('Unmapped destinations', () => {
     createTestClient(
       {
         settings: unmappedDestinations.integrations,
+        consentSettings: unmappedDestinations.consentSettings,
       },
       { autoAddSegmentDestination: true }
     );

packages/core/src/storage/sovranStorage.ts

@@ -14,6 +14,7 @@ import type {
   UserInfoState,
   RoutingRule,
   DestinationFilters,
+  SegmentAPIConsentSettings,
 } from '..';
 import { getUUID } from '../uuid';
 import { createGetter } from './helpers';
@@ -34,6 +35,7 @@ type Data = {
   eventsToRetry: SegmentEvent[];
   context: DeepPartial<Context>;
   settings: SegmentAPIIntegrations;
+  consentSettings: SegmentAPIConsentSettings | undefined;
   userInfo: UserInfoState;
   filters: DestinationFilters;
 };
@@ -43,6 +45,7 @@ const INITIAL_VALUES: Data = {
   eventsToRetry: [],
   context: {},
   settings: {},
+  consentSettings: undefined,
   filters: {},
   userInfo: {
     anonymousId: getUUID(),
@@ -141,6 +144,9 @@ export class SovranStorage implements Storage {
   private storePersistorSaveDelay?: number;
   private readinessStore: Store<ReadinessStore>;
   private contextStore: Store<{ context: DeepPartial<Context> }>;
+  private consentSettingsStore: Store<{
+    consentSettings: SegmentAPIConsentSettings | undefined;
+  }>;
   private settingsStore: Store<{ settings: SegmentAPIIntegrations }>;
   private userInfoStore: Store<{ userInfo: UserInfoState }>;
   private deepLinkStore: Store<DeepLinkData> = deepLinkStore;
@@ -155,6 +161,9 @@ export class SovranStorage implements Storage {
     Settable<SegmentAPIIntegrations> &
     Dictionary<string, IntegrationSettings, SegmentAPIIntegrations>;
 
+  readonly consentSettings: Watchable<SegmentAPIConsentSettings | undefined> &
+    Settable<SegmentAPIConsentSettings | undefined>;
+
   readonly filters: Watchable<DestinationFilters | undefined> &
     Settable<DestinationFilters> &
     Dictionary<string, RoutingRule, DestinationFilters>;
@@ -271,6 +280,44 @@ export class SovranStorage implements Storage {
       },
     };
 
+    // Consent settings
+
+    this.consentSettingsStore = createStore(
+      { consentSettings: INITIAL_VALUES.consentSettings },
+      {
+        persist: {
+          storeId: `${this.storeId}-consentSettings`,
+          persistor: this.storePersistor,
+          saveDelay: this.storePersistorSaveDelay,
+          onInitialized: markAsReadyGenerator('hasRestoredSettings'),
+        },
+      }
+    );
+
+    this.consentSettings = {
+      get: createStoreGetter(this.consentSettingsStore, 'consentSettings'),
+      onChange: (
+        callback: (value?: SegmentAPIConsentSettings | undefined) => void
+      ) =>
+        this.consentSettingsStore.subscribe((store) =>
+          callback(store.consentSettings)
+        ),
+      set: async (value) => {
+        const { consentSettings } = await this.consentSettingsStore.dispatch(
+          (state) => {
+            let newState: typeof state.consentSettings;
+            if (value instanceof Function) {
+              newState = value(state.consentSettings);
+            } else {
+              newState = Object.assign({}, state.consentSettings, value);
+            }
+            return { consentSettings: newState };
+          }
+        );
+        return consentSettings;
+      },
+    };
+
     // Filters
 
     this.filtersStore = createStore(INITIAL_VALUES.filters, {

packages/core/src/storage/types.ts

@@ -1,4 +1,5 @@
 import type { Unsubscribe, Persistor } from '@segment/sovran-react-native';
+import type { SegmentAPIConsentSettings } from '..';
 import type {
   Context,
   DeepPartial,
@@ -71,6 +72,9 @@ export interface Storage {
     Settable<SegmentAPIIntegrations> &
     Dictionary<string, IntegrationSettings, SegmentAPIIntegrations>;
 
+  readonly consentSettings: Watchable<SegmentAPIConsentSettings | undefined> &
+    Settable<SegmentAPIConsentSettings | undefined>;
+
   readonly filters: Watchable<DestinationFilters | undefined> &
     Settable<DestinationFilters> &
     Dictionary<string, RoutingRule, DestinationFilters>;

packages/core/src/types.ts

@@ -290,6 +290,11 @@ export type SegmentAPIIntegrations = {
   [key: string]: IntegrationSettings;
 };
 
+export type SegmentAPIConsentSettings = {
+  allCategories: string[];
+  hasUnmappedDestinations: boolean;
+};
+
 export type RoutingRule = Rule;
 
 export interface MetricsOptions {
@@ -309,6 +314,7 @@ export type SegmentAPISettings = {
     routingRules: RoutingRule[];
   };
   metrics?: MetricsOptions;
+  consentSettings?: SegmentAPIConsentSettings;
 };
 
 export type DestinationMetadata = {