[LP-10929] Using operation queue to execute writes in bg (#324)

* Using operation queue to execute writes in bg

* Fixing build errors

Removing unused schemes

* Fixing failing tests

* Fixing failing tests

* 2.6.3-beta1 test background

* update version

* Better naming

* Reverting .pbxproj

* Removing semicolons

* Fixing failing tests

Author: milos1290

Example/Leanplum-SDK.xcodeproj/project.pbxproj

@@ -687,7 +687,7 @@
 			files = (
 			);
 			inputPaths = (
-				"${SRCROOT}/Pods/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example-frameworks.sh",
+				"${PODS_ROOT}/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example-frameworks.sh",
 				"${BUILT_PRODUCTS_DIR}/Leanplum-iOS-SDK/Leanplum.framework",
 			);
 			name = "[CP] Embed Pods Frameworks";
@@ -696,7 +696,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example-frameworks.sh\"\n";
+			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example-frameworks.sh\"\n";
 			showEnvVarsInLog = 0;
 		};
 		AA36E9F20FC263CA34118B64 /* [CP] Check Pods Manifest.lock */ = {
@@ -723,7 +723,7 @@
 			files = (
 			);
 			inputPaths = (
-				"${SRCROOT}/Pods/Target Support Files/Pods-Leanplum-SDK_Tests/Pods-Leanplum-SDK_Tests-frameworks.sh",
+				"${PODS_ROOT}/Target Support Files/Pods-Leanplum-SDK_Tests/Pods-Leanplum-SDK_Tests-frameworks.sh",
 				"${BUILT_PRODUCTS_DIR}/Leanplum-iOS-SDK/Leanplum.framework",
 				"${BUILT_PRODUCTS_DIR}/OCMock/OCMock.framework",
 				"${BUILT_PRODUCTS_DIR}/OHHTTPStubs/OHHTTPStubs.framework",
@@ -736,7 +736,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-Leanplum-SDK_Tests/Pods-Leanplum-SDK_Tests-frameworks.sh\"\n";
+			shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Leanplum-SDK_Tests/Pods-Leanplum-SDK_Tests-frameworks.sh\"\n";
 			showEnvVarsInLog = 0;
 		};
 /* End PBXShellScriptBuildPhase section */

Example/Tests/Classes/Extensions/LeanplumRequest+Categories.m

@@ -38,6 +38,10 @@ + (void)swizzle_methods
                                  withMethod:@selector(swizzle_sendNow)
                                       error:&error
                                       class:[LeanplumRequest class]];
+    success &= [LPSwizzle swizzleMethod:@selector(sendEventually:)
+                             withMethod:@selector(swizzle_sendEventually:)
+                                  error:&error
+                                  class:[LeanplumRequest class]];
     success &= [LPSwizzle swizzleClassMethod:@selector(get:params:)
                              withClassMethod:@selector(swizzle_get:params:)
                                        error:&error
@@ -63,6 +67,11 @@ - (void)swizzle_sendNow
     func(self, selector);
 }
 
+- (void)swizzle_sendEventually:(BOOL) sync
+{
+    [self swizzle_sendEventually:YES];
+}
+
 - (void)swizzle_download
 {
 

Example/Tests/Classes/LPActionManagerTest.m

@@ -33,6 +33,7 @@
 #import "LPNetworkEngine+Category.h"
 #import "Leanplum+Extensions.h"
 #import "LPUIAlert.h"
+#import "LPOperationQueue.h"
 
 @interface LPActionManager (Test)
 - (void)requireMessageContent:(NSString *)messageId
@@ -260,7 +261,7 @@ - (void)test_push_token
         return YES;
     }];
     [manager leanplum_application:app didRegisterForRemoteNotificationsWithDeviceToken:token];
-    
+
     // Test push token is sent if the token changes.
     token = [@"sample2" dataUsingEncoding:NSUTF8StringEncoding];
     formattedToken = [token description];
@@ -276,6 +277,7 @@ - (void)test_push_token
         return YES;
     }];
     [manager leanplum_application:app didRegisterForRemoteNotificationsWithDeviceToken:token];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     [self waitForExpectationsWithTimeout:2 handler:nil];
 }
 

Example/Tests/Classes/LPCountAggregatorTest.m

@@ -140,8 +140,8 @@ - (void)test_sendAllCounts {
     OCMStub([leanplumRequestMock post:LP_METHOD_LOG params:[OCMArg any]]).andReturn(leanplumRequestMock);
 
     [countAggregator sendAllCounts];
-    
-    OCMVerify([leanplumRequestMock sendEventually]);
+
+    [[[leanplumRequestMock verify] ignoringNonObjectArgs] sendEventually:[OCMArg any]];
 }
 
 @end

Example/Tests/Classes/LPEventDataManagerTest.m

@@ -34,6 +34,7 @@
 #import "LPNetworkEngine+Category.h"
 #import "LeanplumReachability+Category.h"
 #import "LPJSON.h"
+#import "LPOperationQueue.h"
 
 @interface LPEventDataManager(UnitTest)
 
@@ -44,7 +45,6 @@ + (void)migrateRequests;
 @interface LeanplumRequest(UnitTest)
 
 - (void)sendNow:(BOOL)async;
-+ (NSOperationQueue *)sendNowQueue;
 
 @end
 
@@ -112,10 +112,12 @@ - (void)test_track_save
     [LPEventDataManager deleteEventsWithLimit:10000];
 
     [Leanplum track:@"sample"];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     NSArray *events = [LPEventDataManager eventsWithLimit:10000];
     XCTAssertTrue(events.count == 1);
 
     [Leanplum track:@"sample2"];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     events = [LPEventDataManager eventsWithLimit:10000];
     XCTAssertTrue(events.count == 2);
 
@@ -163,8 +165,8 @@ - (void)test_request_synchronous
     XCTAssertTrue(timedOut == 0);
 
     // Clean up.
-    [[LeanplumRequest sendNowQueue] cancelAllOperations];
-    [[LeanplumRequest sendNowQueue] waitUntilAllOperationsAreFinished];
+    [[LPOperationQueue serialQueue] cancelAllOperations];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     [OHHTTPStubs removeAllStubs];
 }
 
@@ -217,6 +219,9 @@ - (void)test_uuid
     [Leanplum track:@"sample"];
     [Leanplum track:@"sample2"];
     [[LeanplumRequest post:@"sample3" params:nil] sendNow:YES];
+
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
+
     NSArray *events = [LPEventDataManager eventsWithLimit:10000];
     XCTAssertTrue(events.count == 3);
     XCTAssertTrue([events[0][@"uuid"] isEqual:events[1][@"uuid"]]);
@@ -225,6 +230,9 @@ - (void)test_uuid
     // After sending, the last one should have a different uuid.
     [NSThread sleepForTimeInterval:0.4];
     [Leanplum track:@"sample4"];
+
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
+
     events = [LPEventDataManager eventsWithLimit:10000];
     XCTAssertTrue(events.count == 4);
     XCTAssertTrue([events[0][@"uuid"] isEqual:events[1][@"uuid"]]);
@@ -244,13 +252,15 @@ - (void)test_uuid
 
     [[LeanplumRequest post:@"sample4" params:nil] sendNow:NO];
     [NSThread sleepForTimeInterval:0.1];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     events = [LPEventDataManager eventsWithLimit:10000];
     XCTAssertTrue(events.count == 0);
 
     // UUID should be different after the 10k mark.
     for (int i=0; i<MAX_EVENTS_PER_API_CALL+1; i++) {
         [Leanplum track:@"s"];
     }
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     events = [LPEventDataManager eventsWithLimit:900000];
     XCTAssertTrue(events.count == MAX_EVENTS_PER_API_CALL+1);
     XCTAssertFalse([events[0][@"uuid"] isEqual:events[MAX_EVENTS_PER_API_CALL][@"uuid"]]);
@@ -294,14 +304,14 @@ - (void)test_response_index
     [self expectationWithDescription:@"operationExpectation"];
     [LPNetworkEngine validate_operation:^(LPNetworkOperation *operation) {
         NSArray *events = [LPEventDataManager eventsWithLimit:900000];
-        XCTAssertTrue(events.count == 3);
+        XCTAssertTrue(events.count == 1);
         [operationExpectation fulfill];
         return YES;
     }];
 
     // Freeze the operation queue for a bit to let events queue up.
-    NSOperationQueue *sendNowQueue = [LeanplumRequest sendNowQueue];
-    [sendNowQueue addOperationWithBlock:^{
+    NSOperationQueue *serialQueue = [LPOperationQueue serialQueue];
+    [serialQueue addOperationWithBlock:^{
         [NSThread sleepForTimeInterval:0.2];
     }];
 
@@ -315,11 +325,14 @@ - (void)test_response_index
         [responseExpectation fulfill];
     }];
     [request sendNow:YES];
-    
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
+
+
     // Add extra events.
     [Leanplum track:@"s"];
     [Leanplum track:@"s2"];
-    
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
+
     [self waitForExpectationsWithTimeout:2 handler:nil];
 }
 

Example/Tests/Classes/LPRequestSenderTest.m

@@ -15,14 +15,15 @@
 #import <Leanplum/LPRequestFactory.h>
 #import <Leanplum/LPRequest.h>
 #import <Leanplum/LPCountAggregator.h>
+#import "LeanplumHelper.h"
+#import "LPOperationQueue.h"
 
 @interface LPRequestSender(UnitTest)
 
 @property (nonatomic, strong) id<LPNetworkEngineProtocol> engine;
 
 - (void)sendNow:(id<LPRequesting>)request sync:(BOOL)sync;
 - (void)sendRequests:(BOOL)sync;
-- (NSOperationQueue *)sendNowQueue;
 
 @end
 
@@ -32,8 +33,11 @@ @interface LPRequestSenderTest : XCTestCase
 
 @implementation LPRequestSenderTest
 
-- (void)setUp {
-    // Put setup code here. This method is called before the invocation of each test method in the class.
++ (void)setUp
+{
+    [super setUp];
+    // Called only once to setup method swizzling.
+    [LeanplumHelper setup_method_swizzling];
 }
 
 - (void)tearDown {
@@ -73,7 +77,7 @@ - (void)testSend {
     OCMStub([configMock accessKey]).andReturn(@"accessKey");
     [requestSender send:request];
 
-    OCMVerify([requestSenderMock sendEventually:request]);
+    [[[requestSenderMock verify] ignoringNonObjectArgs] sendEventually:request sync:[OCMArg any]];
 
     [requestSenderMock stopMocking];
     [configMock stopMocking];
@@ -89,9 +93,9 @@ - (void)testSendNow {
     OCMStub([configMock accessKey]).andReturn(@"accessKey");
     [requestSender sendNow:request];
 
-    OCMVerify([requestSenderMock sendNow:request sync:false]);
-    OCMVerify([requestSenderMock sendEventually:request]);
-    OCMVerify([requestSenderMock sendRequests:false]);
+    [[[requestSenderMock verify] ignoringNonObjectArgs] sendNow:request sync:[OCMArg any]];
+    [[[requestSenderMock verify] ignoringNonObjectArgs] sendEventually:request sync:[OCMArg any]];
+    [[[requestSenderMock verify] ignoringNonObjectArgs] sendRequests:[OCMArg any]];
 
     [requestSenderMock stopMocking];
     [configMock stopMocking];
@@ -101,7 +105,7 @@ - (void)testSendEventually {
     LPRequest *request = [LPRequest post:@"test" params:@{}];
     LPRequestSender *requestSender = [[LPRequestSender alloc] init];
     id eventDataManagerMock = OCMClassMock([LPEventDataManager class]);
-    [requestSender sendEventually:request];
+    [requestSender sendEventually:request sync:YES];
 
     OCMVerify([eventDataManagerMock addEvent:[OCMArg isNotNil]]);
 
@@ -131,7 +135,7 @@ - (void)testSendIfNotConnected {
     OCMStub([reachabilityMock isReachable]).andReturn(false);
     [requestSender sendIfConnected:request];
 
-    OCMVerify([requestSenderMock sendEventually:request]);
+    [[[requestSenderMock verify] ignoringNonObjectArgs] sendEventually:request sync:[OCMArg any]];
 
     [requestSenderMock stopMocking];
     [reachabilityMock stopMocking];
@@ -199,18 +203,4 @@ - (void) testSendRequestsSync {
     [eventDataManagerMock stopMocking];
 }
 
-- (void) testSendRequestsAsync {
-    LPRequestSender *requestSender = OCMPartialMock([[LPRequestSender alloc] init]);
-    id requestOperationMock = OCMClassMock([NSBlockOperation class]);
-    OCMStub([requestOperationMock new]).andReturn(requestOperationMock);
-    id mockQueue = OCMClassMock([NSOperationQueue class]);
-    OCMStub([requestSender sendNowQueue]).andReturn(mockQueue);
-    [requestSender sendRequests:false];
-
-    OCMVerify([requestOperationMock addExecutionBlock:[OCMArg any]]);
-    OCMVerify([mockQueue addOperation:requestOperationMock]);
-    
-    [requestOperationMock stopMocking];
-    [mockQueue stopMocking];
-}
 @end

Example/Tests/Classes/LeanplumTest.m

@@ -39,6 +39,7 @@
 #import "LPConstants.h"
 #import "LPRegisterDevice.h"
 #import "Leanplum.h"
+#import "LPOperationQueue.h"
 
 /**
  * Tests leanplum public methods, we seed predefined response that comes from backend
@@ -810,9 +811,9 @@ - (void) test_track_events_priority_countDown
         XCTAssertEqual(outputDict[messageIdOne][@"countdown"], outputDict[messageIdOne][@"countdown"], @"Countdown not Equal");
     }];
     [Leanplum track:trackName];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
     [Leanplum forceContentUpdate];
     XCTAssertTrue([Leanplum hasStarted]);
-    
 }
 
 /**

Example/Tests/Classes/Utilities/LeanplumHelper.m

@@ -36,6 +36,7 @@
 #import "LPNetworkEngine+Category.h"
 #import "LPNetworkOperation+Category.h"
 #import "LPAPIConfig.h"
+#import "LPOperationQueue.h"
 
 NSString *APPLICATION_ID = @"app_nLiaLr3lXvCjXhsztS1Gw8j281cPLO6sZetTDxYnaSk";
 NSString *DEVELOPMENT_KEY = @"dev_2bbeWLmVJyNrqI8F21Kn9nqyUPRkVCUoLddBkHEyzmk";
@@ -45,12 +46,6 @@
 
 NSInteger DISPATCH_WAIT_TIME = 4;
 
-@interface LeanplumRequest(LeanplumHelper)
-
-+ (NSOperationQueue *)sendNowQueue;
-
-@end
-
 @implementation LeanplumHelper
 
 static BOOL swizzled = NO;
@@ -129,8 +124,8 @@ + (void)clean_up {
     [[LPAPIConfig sharedConfig] setToken:nil];
     [LeanplumRequest reset];
     [LeanplumHelper reset_user_defaults];
-    [[LeanplumRequest sendNowQueue] cancelAllOperations];
-    [[LeanplumRequest sendNowQueue] waitUntilAllOperationsAreFinished];
+    [[LPOperationQueue serialQueue] cancelAllOperations];
+    [[LPOperationQueue serialQueue] waitUntilAllOperationsAreFinished];
 }
 
 + (dispatch_time_t)default_dispatch_time {