Merge pull request #413 from Countly/reserved_event

feat: added ability to record reserved events

Author: turtledreams

CHANGELOG.md

@@ -1,5 +1,7 @@
 ## XX.XX.XX
-* Mitigated a networking health check recording issue.
+* Added the ability to record reserved events.
+
+* Mitigated a possible Health Check network log recording issue.
 
 ## 25.4.5
 * Added "requestTimeoutDuration" init config parameter to change request timeout duration in seconds.

Countly.h

@@ -843,7 +843,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)halt;
 - (void)halt:(BOOL) clearStorage;
 
-/* Combine all events in event queue into a request and attempt to process stored requests on demand
+/**
+ * Combine all events in event queue into a request and attempt to process stored requests on demand
  */
 - (void)attemptToSendStoredRequests;
 

Countly.m

@@ -864,22 +864,25 @@ - (void)recordEvent:(NSString *)key segmentation:(NSDictionary *)segmentation co
 {
     CLY_LOG_I(@"%s %@ %@ %lu %f %f", __FUNCTION__, key, segmentation, (unsigned long)count, sum, duration);
 
-    if (!CountlyConsentManager.sharedInstance.consentForEvents)
-    {
-        CLY_LOG_W(@"Consent for events not given! Event will not be recorded.");
-        return;
-    }
-    
-    BOOL isReservedEvent = [self isReservedEvent:key];
+    NSNumber* isReservedEvent = [self isReservedEvent:key];
 
     if (isReservedEvent)
     {
-        CLY_LOG_W(@"A reserved event detected for key: '%@', event will not be recorded.", key);
+        CLY_LOG_V(@"%s, A reserved event detected: %@", __FUNCTION__, key);
+        if (!isReservedEvent.boolValue)
+        {
+            CLY_LOG_W(@"%s, No consent given for the reserved event! Event will not be recorded.", __FUNCTION__);
+            return;
+        }
+        CLY_LOG_V(@"%s, Specific consent given for the reserved event! So, it will be recorded.", __FUNCTION__);
+    } else if (!CountlyConsentManager.sharedInstance.consentForEvents) {
+        CLY_LOG_W(@"%s, Consent for events not given! Event will not be recorded.", __FUNCTION__);
         return;
     }
+    
     if (!CountlyServerConfig.sharedInstance.customEventTrackingEnabled)
     {
-        CLY_LOG_D(@"'recordEvent' is aborted: Custom Event Tracking is disabled from server config!");
+        CLY_LOG_D(@"%s, aborted: Custom Event Tracking is disabled from server config!", __FUNCTION__);
         return;
     }
 
@@ -997,20 +1000,21 @@ - (BOOL)isAppInForeground {
 #endif
 }
 
-
-- (BOOL)isReservedEvent:(NSString *)key
+/// This checks that given key requires any extra consent
+- (NSNumber *)isReservedEvent:(NSString *)key
 {
-    NSArray<NSString *>* reservedEvents =
-    @[
-        kCountlyReservedEventOrientation,
-        kCountlyReservedEventStarRating,
-        kCountlyReservedEventSurvey,
-        kCountlyReservedEventNPS,
-        kCountlyReservedEventPushAction,
-        kCountlyReservedEventView,
-    ];
-    
-    return [reservedEvents containsObject:key];
+    NSDictionary <NSString *, NSNumber *>* reservedEvents =
+    @{
+        kCountlyReservedEventOrientation: @(CountlyConsentManager.sharedInstance.consentForUserDetails),
+        kCountlyReservedEventStarRating: @(CountlyConsentManager.sharedInstance.consentForFeedback),
+        kCountlyReservedEventSurvey: @(CountlyConsentManager.sharedInstance.consentForFeedback),
+        kCountlyReservedEventNPS: @(CountlyConsentManager.sharedInstance.consentForFeedback),
+        kCountlyReservedEventPushAction: @(CountlyConsentManager.sharedInstance.consentForPushNotifications),
+        kCountlyReservedEventView: @(CountlyConsentManager.sharedInstance.consentForViewTracking),
+    };
+
+    NSNumber* aReservedEvent = reservedEvents[key];
+    return aReservedEvent;
 }
 
 #pragma mark -