Improvements to request interceptor and event queue init, remove unused CoreTelephony references (#146)

* make use of non main thread dependend token generation

* Update comments

* remove unecessary parse

* allow nil properties

* properly set self.task

* remove unecessary protocol setting

* remove unused var

* Don't include JSON payload in flush logging.

* Remove comment, change eventQueue property from atomic to nonatomic.

---------

Co-authored-by: Alexander Simson <[email protected]>

Author: gast04

Castle/Internal/CASAPIClient.m

@@ -66,7 +66,6 @@ - (NSURLSessionDataTask *)dataTaskWithPath:(NSString *)path
 
         // Parse response data
         if(data) {
-            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
             NSString *contentType = httpResponse.allHeaderFields[@"Content-Type"];
 
             // Check for application/json content-type and parse response

Castle/Internal/CASCustom.m

@@ -37,11 +37,17 @@ + (nullable instancetype)eventWithName:(nullable NSString *)name properties:(nul
         CASLog(@"Event name can't be nil.");
         return nil;
     }
-    
+
     if([name isEqualToString:@""]) {
         CASLog(@"Event names must be at least one (1) character long.");
         return nil;
     }
+
+    if(!properties) {
+        // prevent dropping from nil properties in event, as it is allowed
+        // per signature
+        properties = @{};
+    }
 
     BOOL valid = [CASEvent propertiesContainValidData:properties];
     if(!valid) {

Castle/Internal/CASEventQueue.m

@@ -41,12 +41,18 @@ - (instancetype)init
 {
     self = [super init];
     if (self) {
-        dispatch_sync(CASEventStorageQueue(), ^{
-            // Read stored queue from disk
-            self.eventQueue = [self storedQueue].mutableCopy;
-            
-            // Initialize API client
-            self.client = [CASAPIClient clientWithConfiguration:[Castle configuration]];
+        // Immediate initialize
+        self.eventQueue = [[NSMutableArray alloc] init];
+        self.client = [CASAPIClient clientWithConfiguration:[Castle configuration]];
+
+        dispatch_async(CASEventStorageQueue(), ^{
+            NSArray *storedEvents = [self storedQueue];
+            if (storedEvents.count > 0) {
+                // Prepend to current queue
+                NSMutableArray *combined = [storedEvents mutableCopy];
+                [combined addObjectsFromArray:self.eventQueue];
+                self.eventQueue = combined;
+            }
         });
     }
     return self;
@@ -233,7 +239,7 @@ - (void)flush
 
                 self.task = nil;
 
-                CASLog(@"Successfully flushed (%ld) events: %@", monitorModel.events.count, [monitorModel JSONPayload]);
+                CASLog(@"Successfully flushed (%ld) events", monitorModel.events.count);
 
                 if ([self eventQueueExceedsFlushLimit] && self.eventQueue.count > 0) {
                     CASLog(@"Current event queue still exceeds flush limit. Flush again");

Castle/Internal/CASRequestInterceptor.m

@@ -43,25 +43,17 @@ + (BOOL)requestIsCacheEquivalent:(NSURLRequest *)a toRequest:(NSURLRequest *)b
 
 - (void)startLoading
 {
-    dispatch_sync(dispatch_get_main_queue(), ^{
-        // Always flush the queue when a request is intercepted
-        [Castle flush];
-    });
-    
     NSMutableURLRequest *newRequest = [self.request mutableCopy];
     [NSURLProtocol setProperty:@YES forKey:CASRecursiveRequestFlagProperty inRequest:newRequest];
 
-    dispatch_sync(dispatch_get_main_queue(), ^{
-        // Set custom header
-        [newRequest setValue:[Castle createRequestToken] forHTTPHeaderField:CastleRequestTokenHeaderName];
-    });
+    // Set custom header
+    [newRequest setValue:[Castle createRequestToken] forHTTPHeaderField:CastleRequestTokenHeaderName];
 
     NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
-    config.protocolClasses = [config.protocolClasses arrayByAddingObject:self.class];
     NSURLSession *session = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil];
 
-    NSURLSessionDataTask *task = [session dataTaskWithRequest:newRequest];
-    [task resume];
+    self.task = [session dataTaskWithRequest:newRequest];
+    [self.task resume];
 }
 
 - (void)stopLoading
@@ -76,10 +68,8 @@ - (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task willPer
     if (response) {
         NSMutableURLRequest *redirectRequest = [newRequest mutableCopy];
 
-        dispatch_sync(dispatch_get_main_queue(), ^{
-            // Set custom header
-            [redirectRequest setValue:[Castle createRequestToken] forHTTPHeaderField:CastleRequestTokenHeaderName];
-        });
+        // Set custom header
+        [redirectRequest setValue:[Castle createRequestToken] forHTTPHeaderField:CastleRequestTokenHeaderName];
 
         [[self client] URLProtocol:self wasRedirectedToRequest:redirectRequest redirectResponse:response];
 

Castle/Public/Castle.m

@@ -9,9 +9,6 @@
 
 #import <UIKit/UIKit.h>
 
-#import <CoreTelephony/CTCarrier.h>
-#import <CoreTelephony/CTTelephonyNetworkInfo.h>
-
 #import "CASAPIClient.h"
 #import "CASUtils.h"
 #import "CASEvent.h"
@@ -81,8 +78,6 @@ - (NSURL *)baseURL
 
 NSString *const CastleRequestTokenHeaderName = @"X-Castle-Request-Token";
 
-static CTTelephonyNetworkInfo *_telephonyNetworkInfo;
-
 @interface Castle ()
 @property (nonatomic, strong, nullable) CastleConfiguration *configuration;
 @property (nonatomic, strong, nullable) CASEventQueue *eventQueue;