Fix removeGlobalContexts not removing expected context (close snowplow#1006)

Author: Paul Boocock

common/changes/@snowplow/browser-tracker-core/release-3.1.5_2021-09-30-20-35.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix removeGlobalContexts not removing expected context (#1006)",
+      "type": "none",
+      "packageName": "@snowplow/browser-tracker-core"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker-core",
+  "email": "paul@snowplowanalytics.com"
+}

common/changes/@snowplow/tracker-core/release-3.1.5_2021-09-30-20-35.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "comment": "Fix removeGlobalContexts not removing expected context (#1006)",
+      "type": "none",
+      "packageName": "@snowplow/tracker-core"
+    }
+  ],
+  "packageName": "@snowplow/tracker-core",
+  "email": "paul@snowplowanalytics.com"
+}

libraries/browser-tracker-core/CHANGELOG.json

@@ -8,7 +8,7 @@
       "comments": {
         "none": [
           {
-            "comment": "Fix linkDecorationHandler targeting (closes #1002)"
+            "comment": "Fix linkDecorationHandler targeting (#1002)"
           }
         ]
       }

libraries/browser-tracker-core/CHANGELOG.md

@@ -7,7 +7,7 @@ Tue, 21 Sep 2021 14:59:36 GMT
 
 ### Updates
 
-- Fix linkDecorationHandler targeting (closes #1002)
+- Fix linkDecorationHandler targeting (#1002)
 
 ## 3.1.3
 Mon, 23 Aug 2021 10:13:18 GMT

libraries/tracker-core/src/contexts.ts

@@ -193,10 +193,10 @@ export function globalContexts(): GlobalContexts {
       for (const context of contexts) {
         if (isConditionalContextProvider(context)) {
           conditionalProviders = conditionalProviders.filter(
-            (item) => JSON.stringify(item) === JSON.stringify(context)
+            (item) => JSON.stringify(item) !== JSON.stringify(context)
           );
         } else if (isContextPrimitive(context)) {
-          globalPrimitives = globalPrimitives.filter((item) => JSON.stringify(item) === JSON.stringify(context));
+          globalPrimitives = globalPrimitives.filter((item) => JSON.stringify(item) !== JSON.stringify(context));
         }
       }
     },

libraries/tracker-core/test/contexts.ts

@@ -215,6 +215,68 @@ test('Add global contexts', (t) => {
   t.is(globalContexts.getConditionalProviders().length, 2, 'Correct number of conditional providers added');
 });
 
+test('Remove one of two global context primitives', (t) => {
+  const geolocationContext = {
+    schema: 'iglu:com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0',
+    data: {
+      latitude: 40.0,
+      longitude: 55.1,
+    },
+  };
+
+  const webPageContext = {
+    schema: 'iglu:org.schema/WebPage/jsonschema/1-0-0',
+    data: {
+      genre: 'test',
+    },
+  };
+
+  const globalContexts = contexts.globalContexts();
+  globalContexts.addGlobalContexts([geolocationContext, webPageContext]);
+  globalContexts.removeGlobalContexts([geolocationContext]);
+  t.deepEqual(globalContexts.getGlobalPrimitives(), [webPageContext]);
+});
+
+test('Remove one of two global context conditional providers', (t) => {
+  const geolocationContext = {
+    schema: 'iglu:com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0',
+    data: {
+      latitude: 40.0,
+      longitude: 55.1,
+    },
+  };
+
+  function eventTypeContextGenerator(args?: contexts.ContextEvent) {
+    const context: SelfDescribingJson = {
+      schema: 'iglu:com.snowplowanalytics.snowplow/mobile_context/jsonschema/1-0-1',
+      data: {
+        osType: 'ubuntu',
+        osVersion: '2018.04',
+        deviceManufacturer: 'ASUS',
+        deviceModel: args ? String(args['eventType']) : '',
+      },
+    };
+    return context;
+  }
+
+  const bothRuleSet = {
+    accept: ['iglu:com.snowplowanalytics.snowplow/*/jsonschema/*-*-*'],
+    reject: ['iglu:com.snowplowanalytics.snowplow/*/jsonschema/*-*-*'],
+  };
+
+  const filterFunction = function (args?: contexts.ContextEvent) {
+    return args?.eventType === 'ue';
+  };
+
+  const filterProvider: contexts.FilterProvider = [filterFunction, [geolocationContext, eventTypeContextGenerator]];
+  const ruleSetProvider: contexts.RuleSetProvider = [bothRuleSet, [geolocationContext, eventTypeContextGenerator]];
+  const globalContexts = contexts.globalContexts();
+
+  globalContexts.addGlobalContexts([filterProvider, ruleSetProvider]);
+  globalContexts.removeGlobalContexts([filterProvider]);
+  t.deepEqual(globalContexts.getConditionalProviders(), [ruleSetProvider]);
+});
+
 test('Remove global contexts', (t) => {
   const geolocationContext = {
     schema: 'iglu:com.snowplowanalytics.snowplow/geolocation_context/jsonschema/1-1-0',