@jmartins-tillster/analytics-react-native 2.21.3

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

@@ -0,0 +1,101 @@
+{
+  "integrations": {
+    "DummyDest1": {
+      "versionSettings": {
+        "componentTypes": []
+      },
+      "consentSettings": {
+        "categories": [
+          "C0001",
+          "C0002"
+        ]
+      }
+    },
+    "DummyDest2": {
+      "versionSettings": {
+        "componentTypes": []
+      },
+      "consentSettings": {
+        "categories": [
+          "C0003"
+        ]
+      }
+    },
+    "DummyDest3": {
+      "versionSettings": {
+        "componentTypes": []
+      },
+      "consentSettings": {
+        "categories": [
+          "C0004"
+        ]
+      }
+    },
+    "DummyDest4": {
+      "versionSettings": {
+        "componentTypes": []
+      },
+      "consentSettings": {
+        "categories": [
+          "C0005"
+        ]
+      }
+    },
+    "DummyDest5": {
+      "versionSettings": {
+        "componentTypes": []
+      }
+    },
+    "Segment.io": {
+      "apiKey": "test",
+      "unbundledIntegrations": [],
+      "addBundledMetadata": true,
+      "maybeBundledConfigIds": {},
+      "versionSettings": {
+        "version": "4.4.7",
+        "componentTypes": [
+          "browser"
+        ]
+      },
+      "apiHost": "api.segment.io/v1"
+    }
+  },
+  "plan": {
+    "track": {
+      "__default": {
+        "enabled": true,
+        "integrations": {}
+      }
+    },
+    "identify": {
+      "__default": {
+        "enabled": true
+      }
+    },
+    "group": {
+      "__default": {
+        "enabled": true
+      }
+    }
+  },
+  "edgeFunction": {},
+  "analyticsNextEnabled": true,
+  "middlewareSettings": {},
+  "enabledMiddleware": {},
+  "metrics": {
+    "sampleRate": 0.1,
+    "host": "api.segment.io/v1"
+  },
+  "legacyVideoPluginsEnabled": false,
+  "remotePlugins": [],
+  "consentSettings": {
+    "hasUnmappedDestinations": true,
+    "allCategories": [
+      "C0001",
+      "C0002",
+      "C0003",
+      "C0004",
+      "C0005"
+    ]
+  }
+}

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

@@ -0,0 +1,234 @@
+import { createTestClient } from '../../../test-helpers';
+import { ConsentPlugin } from '../../ConsentPlugin';
+import noUnmappedDestinations from './mockSettings/NoUnmappedDestinations.json';
+import { createConsentProvider, setupTestDestinations } from './utils';
+
+describe('No unmapped destinations', () => {
+  const createClient = () =>
+    createTestClient({
+      settings: noUnmappedDestinations.integrations,
+      consentSettings: noUnmappedDestinations.consentSettings,
+    });
+
+  test('no to all', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    await client.init();
+
+    consentPlugin.start();
+
+    await client.track('test');
+
+    Object.values(testDestinations).forEach((testDestination) => {
+      expect(testDestination.track).not.toHaveBeenCalled();
+    });
+  });
+
+  test('yes to 1', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: false,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).not.toHaveBeenCalled();
+  });
+
+  test('yes to 2', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: true,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).not.toHaveBeenCalled();
+  });
+
+  test('yes to 3', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: true,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).not.toHaveBeenCalled();
+  });
+
+  test('yes to 4', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: false,
+      C0004: true,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).toHaveBeenCalled();
+    expect(testDestinations.dest5.track).not.toHaveBeenCalled();
+  });
+
+  test('yes to 1 and 3', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: false,
+      C0003: true,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).not.toHaveBeenCalled();
+  });
+
+  test('yes to all', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: true,
+      C0003: true,
+      C0004: true,
+      C0005: true,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    await client.track('test');
+
+    expect(testDestinations.dest1.track).toHaveBeenCalled();
+    expect(testDestinations.dest2.track).toHaveBeenCalled();
+    expect(testDestinations.dest3.track).toHaveBeenCalled();
+    expect(testDestinations.dest4.track).toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+});

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

@@ -0,0 +1,265 @@
+import { createTestClient } from '../../../test-helpers';
+import { ConsentPlugin } from '../../ConsentPlugin';
+import unmappedDestinations from './mockSettings/UnmappedDestinations.json';
+import {
+  createConsentProvider,
+  createSegmentWatcher,
+  setupTestDestinations,
+} from './utils';
+
+describe('Unmapped destinations', () => {
+  const createClient = () =>
+    createTestClient(
+      {
+        settings: unmappedDestinations.integrations,
+        consentSettings: unmappedDestinations.consentSettings,
+      },
+      { autoAddSegmentDestination: true }
+    );
+
+  test('no to all', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    await client.init();
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to 1', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: false,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to 2', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: true,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to 3', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: true,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to 4', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: false,
+      C0002: false,
+      C0003: false,
+      C0004: true,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to 1 and 2', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: true,
+      C0003: false,
+      C0004: false,
+      C0005: false,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).toHaveBeenCalled();
+    expect(testDestinations.dest2.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest3.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest4.track).not.toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+
+  test('yes to all', async () => {
+    const { client } = createClient();
+    const testDestinations = setupTestDestinations(client);
+    const mockConsentStatuses = {
+      C0001: true,
+      C0002: true,
+      C0003: true,
+      C0004: true,
+      C0005: true,
+    };
+
+    const consentPlugin = new ConsentPlugin(
+      createConsentProvider(mockConsentStatuses)
+    );
+
+    client.add({
+      plugin: consentPlugin,
+    });
+
+    consentPlugin.start();
+
+    await client.init();
+
+    const segmentDestination = createSegmentWatcher(client);
+
+    await client.track('test');
+
+    expect(segmentDestination).toHaveBeenCalled();
+    expect(testDestinations.dest1.track).toHaveBeenCalled();
+    expect(testDestinations.dest2.track).toHaveBeenCalled();
+    expect(testDestinations.dest3.track).toHaveBeenCalled();
+    expect(testDestinations.dest4.track).toHaveBeenCalled();
+    expect(testDestinations.dest5.track).toHaveBeenCalled();
+  });
+});

package/packages/core/src/plugins/__tests__/consent/utils.ts

@@ -0,0 +1,75 @@
+import { SegmentClient } from '../../..';
+import { UtilityPlugin, DestinationPlugin } from '../../../plugin';
+import { PluginType } from '../../../types';
+import { CategoryConsentStatusProvider } from '../../ConsentPlugin';
+import { SegmentDestination } from '../../SegmentDestination';
+
+beforeEach(() => {
+  jest.spyOn(SegmentDestination.prototype, 'execute');
+});
+
+class SegmentWatcherPlugin extends UtilityPlugin {
+  type = PluginType.after;
+  execute = jest.fn();
+}
+
+class MockDestination extends DestinationPlugin {
+  track = jest.fn();
+
+  constructor(public readonly key: string) {
+    super();
+  }
+}
+
+export const setupTestDestinations = (client: SegmentClient) => {
+  const dest1 = new MockDestination('DummyDest1');
+  const dest2 = new MockDestination('DummyDest2');
+  const dest3 = new MockDestination('DummyDest3');
+  const dest4 = new MockDestination('DummyDest4');
+  const dest5 = new MockDestination('DummyDest5');
+
+  client.add({ plugin: dest1 });
+  client.add({ plugin: dest2 });
+  client.add({ plugin: dest3 });
+  client.add({ plugin: dest4 });
+  client.add({ plugin: dest5 });
+
+  return {
+    dest1,
+    dest2,
+    dest3,
+    dest4,
+    dest5,
+  };
+};
+
+export const createSegmentWatcher = (client: SegmentClient) => {
+  const segmentDestination = client
+    .getPlugins()
+    .find(
+      (p) => (p as DestinationPlugin).key === 'Segment.io'
+    ) as SegmentDestination;
+
+  const segmentWatcher = new SegmentWatcherPlugin();
+  segmentDestination.add(segmentWatcher);
+
+  return segmentWatcher.execute;
+};
+
+export const createConsentProvider = (
+  statuses: Record<string, boolean>
+): CategoryConsentStatusProvider => ({
+  getConsentStatus: () => Promise.resolve(statuses),
+  setApplicableCategories: () => {
+    /** no op */
+  },
+  onConsentChange: () => {
+    /** no op */
+  },
+});
+
+describe('Consent test utils', () => {
+  it('works', () => {
+    // this is just to suppress jest error - "must have at least one test"
+  });
+});