Make sure the Segment Consent Preference is always sent. (#22)

Author: didiergarcia

lib/src/main/java/com/segment/analytics/kotlin/consent/ConsentBlocker.kt

@@ -94,8 +94,8 @@ class SegmentConsentBlocker(store: SynchronousStore): ConsentBlocker(SEGMENT_IO_
         val hasUnmappedDestinations = currentState?.hasUnmappedDestinations
 
         // IF we have no unmapped destinations and we have not consented to any categories block (drop)
-        // the event.
-        if (hasUnmappedDestinations == false) {
+        // the event unless it is the Segment Consent Preference Event
+        if (hasUnmappedDestinations == false && (event as? TrackEvent)?.event != EVENT_SEGMENT_CONSENT_PREFERENCE ) {
             val consentedCategoriesSet = getConsentedCategoriesFromEvent(event)
             if (consentedCategoriesSet.isEmpty()) {
                 // Drop the event

lib/src/test/kotlin/com/segment/analytics/kotlin/consent/ConsentBlockerTests.kt

@@ -91,6 +91,54 @@ class ConsentBlockerTests {
         assertNull(processedEvent)
     }
 
+    @Test
+    fun `blocks when no consent and no unmapped destinations`() {
+        val store = SynchronousStore()
+        store.provide(ConsentState.defaultState)
+        var mappings: MutableMap<String, Array<String>> = HashMap()
+        mappings["foo"] = arrayOf("cat1", "cat2")
+        val state = ConsentState(mappings, false, mutableListOf<String>(),true)
+        store.dispatch(UpdateConsentStateActionFull(state), ConsentState::class)
+        val blockingPlugin = ConsentBlocker("foo", store)
+
+        // Stamped Event with all categories false
+        var stamppedEvent = TrackEvent(properties = emptyJsonObject, event = "MyEvent")
+        stamppedEvent.context = buildJsonObject {
+            put(Constants.CONSENT_KEY, buildJsonObject {
+                put(Constants.CATEGORY_PREFERENCE_KEY, buildJsonObject {
+                    put("cat1", JsonPrimitive(false))
+                    put("cat2", JsonPrimitive(false))
+                })
+            })
+        }
+        val processedEvent = blockingPlugin.execute(stamppedEvent)
+        assertNull(processedEvent)
+    }
+
+    @Test
+    fun `does not block the Segment Consent Preference event`() {
+        val store = SynchronousStore()
+        store.provide(ConsentState.defaultState)
+        var mappings: MutableMap<String, Array<String>> = HashMap()
+        mappings["foo"] = arrayOf("cat1", "cat2")
+        val state = ConsentState(mappings, false, mutableListOf<String>(),true)
+        store.dispatch(UpdateConsentStateActionFull(state), ConsentState::class)
+        val blockingPlugin = ConsentBlocker("foo", store)
+
+        // Stamped Event with all categories false
+        var stamppedEvent = TrackEvent(properties = emptyJsonObject, event = Constants.EVENT_SEGMENT_CONSENT_PREFERENCE)
+        stamppedEvent.context = buildJsonObject {
+            put(Constants.CONSENT_KEY, buildJsonObject {
+                put(Constants.CATEGORY_PREFERENCE_KEY, buildJsonObject {
+                    put("cat1", JsonPrimitive(false))
+                    put("cat2", JsonPrimitive(false))
+                })
+            })
+        }
+        val processedEvent = blockingPlugin.execute(stamppedEvent)
+        assertNotNull(processedEvent)
+    }
+
     @Test
     fun `block when nothing in store`() {
         val store = SynchronousStore()