fix to send new events to new endpoint and any old events that might … (#249)

* fix to send new events to new endpoint and any old events that might be around to the old events endpoints

* use clientEngine instead of client_engine

* add a couple of tests for sending to new and old endpoints

Author: thomaszurkan-optimizely

OptimizelySDKEventDispatcher/OptimizelySDKEventDispatcher/OPTLYEventDispatcher.m

@@ -23,8 +23,10 @@
 // TODO - Flush events when network connection has become available.
 
 // --- Event URLs ----
-NSString * const OPTLYEventDispatcherImpressionEventURL   = @"https://logx.optimizely.com/log/decision";
-NSString * const OPTLYEventDispatcherConversionEventURL   = @"https://logx.optimizely.com/log/event";
+NSString * const OPTLYEventDispatcherEventsURL   = @"https://logx.optimizely.com/v1/events";
+
+NSString * const oldOPTLYEventDispatcherImpressionEventURL   = @"https://logx.optimizely.com/log/decision";
+NSString * const oldOPTLYEventDispatcherConversionEventURL   = @"https://logx.optimizely.com/log/event";
 
 // Default interval and timeout values (in s) if not set by users
 const NSInteger OPTLYEventDispatcherDefaultDispatchIntervalTime_s = 0;
@@ -207,6 +209,16 @@ - (void)dispatchNewEvent:(nonnull NSDictionary *)params
     }];
 }
 
+// A saved event has entityId and json in its dictionary so that it can be deleted by entityId
+- (bool)isSavedEvent:(nonnull NSDictionary *)event {
+    return event[@"json"] != nil;
+}
+// It is an old single point event if it contains clientEngine. So, send it to the appropriate endpoint.
+// This may not be necessary but just in case there are some old events in the queue.
+- (bool)isOldEvent:(nonnull NSDictionary *)event {
+    return [self isSavedEvent:event] && event[@"json"][@"clientEngine"] != nil;
+}
+
 - (void)dispatchEvent:(nonnull NSDictionary *)event
          backoffRetry:(BOOL)backoffRetry
             eventType:(OPTLYDataStoreEventType)eventType
@@ -228,9 +240,10 @@ - (void)dispatchEvent:(nonnull NSDictionary *)event
             [self.pendingDispatchEvents addObject:event];
         }
 
-        NSURL *url = [self URLForEvent:eventType];
+        NSURL *url = [self isOldEvent:event] ? [self oldURLForEvent:eventType] : [self URLForEvent:eventType];
 
-        NSDictionary *eventToSend = event[@"json"] == nil ? event : event[@"json"];
+        NSDictionary *eventToSend = [self isSavedEvent:event] ? event[@"json"] : event;
+        
         __weak typeof(self) weakSelf = self;
         [self.networkService dispatchEvent:eventToSend
                               backoffRetry:backoffRetry
@@ -465,14 +478,29 @@ - (NSInteger)numberOfEvents
     return numberOfImpressionEventsSaved + numberOfConversionEventsSaved;
 }
 
+- (NSURL *)oldURLForEvent:(OPTLYDataStoreEventType)eventType {
+    NSURL *url = nil;
+    switch(eventType) {
+        case OPTLYDataStoreEventTypeImpression:
+            url = [NSURL URLWithString:oldOPTLYEventDispatcherImpressionEventURL];
+            break;
+        case OPTLYDataStoreEventTypeConversion:
+            url = [NSURL URLWithString:oldOPTLYEventDispatcherConversionEventURL];
+            break;
+        default:
+            break;
+    }
+    return url;
+}
+
 - (NSURL *)URLForEvent:(OPTLYDataStoreEventType)eventType {
     NSURL *url = nil;
     switch(eventType) {
         case OPTLYDataStoreEventTypeImpression:
-            url = [NSURL URLWithString:OPTLYEventDispatcherImpressionEventURL];
+            url = [NSURL URLWithString:OPTLYEventDispatcherEventsURL];
             break;
         case OPTLYDataStoreEventTypeConversion:
-            url = [NSURL URLWithString:OPTLYEventDispatcherConversionEventURL];
+            url = [NSURL URLWithString:OPTLYEventDispatcherEventsURL];
             break;
         default:
             break;

OptimizelySDKEventDispatcher/OptimizelySDKEventDispatcherTests/OPTLYEventDispatcherTest.m

@@ -119,6 +119,62 @@ - (void)testDispatchImpressionEventSuccess {
     }];
 }
 
+// Test that a successful dispatch:
+//  - no events are persisted
+//  - flushEvents is called
+- (void)testDispatchImpressionOldEventSuccess {
+    [self stubSuccessResponse];
+    
+    OPTLYEventDispatcherDefault *eventDispatcher = [OPTLYEventDispatcherDefault new];
+    id eventDispatcherMock = [OCMockObject partialMockForObject:eventDispatcher];
+    [[eventDispatcherMock expect] flushEvents];
+    
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for dispatchImpressionEvent success."];
+    __weak typeof(self) weakSelf = self;
+    NSMutableDictionary *params = [[NSMutableDictionary alloc] initWithDictionary:self.parameters];
+    params[@"clientEngine"] = @"iOS";
+    [eventDispatcherMock dispatchImpressionEvent:params callback:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
+        NSInteger numberOfSavedEvents = [weakSelf.eventDispatcher numberOfEvents:OPTLYDataStoreEventTypeImpression];
+        XCTAssert(numberOfSavedEvents == 0, @"Impression events should not have been saved.");
+        XCTAssert([response.URL.absoluteString isEqualToString: @"https://logx.optimizely.com/log/decision"]);
+        [eventDispatcherMock verify];
+        [expectation fulfill];
+    }];
+    
+    [self waitForExpectationsWithTimeout:3.0 handler:^(NSError *error) {
+        if (error) {
+            NSLog(@"Timeout error for dispatchImpressionEvent: %@", error);
+        }
+    }];
+}
+
+// Test that a successful dispatch:
+//  - no events are persisted
+//  - flushEvents is called
+- (void)testDispatchImpressionNewEventSuccess {
+    [self stubSuccessResponse];
+    
+    OPTLYEventDispatcherDefault *eventDispatcher = [OPTLYEventDispatcherDefault new];
+    id eventDispatcherMock = [OCMockObject partialMockForObject:eventDispatcher];
+    [[eventDispatcherMock expect] flushEvents];
+    
+    XCTestExpectation *expectation = [self expectationWithDescription:@"Wait for dispatchImpressionEvent success."];
+    __weak typeof(self) weakSelf = self;
+    [eventDispatcherMock dispatchImpressionEvent:self.parameters callback:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
+        NSInteger numberOfSavedEvents = [weakSelf.eventDispatcher numberOfEvents:OPTLYDataStoreEventTypeImpression];
+        XCTAssert(numberOfSavedEvents == 0, @"Impression events should not have been saved.");
+        XCTAssert([response.URL.absoluteString isEqualToString: @"https://logx.optimizely.com/v1/events"]);
+        [eventDispatcherMock verify];
+        [expectation fulfill];
+    }];
+    
+    [self waitForExpectationsWithTimeout:3.0 handler:^(NSError *error) {
+        if (error) {
+            NSLog(@"Timeout error for dispatchImpressionEvent: %@", error);
+        }
+    }];
+}
+
 - (void)testDispatchConversionEventSuccess {
     [self stubSuccessResponse];