feat(inbox): Callback for when Inbox was synced via forceContentUpdate LP-6294 (#89)

alexisoyama · web-flow · commit 816968f91b1c · 2017-10-24T10:37:51.000-07:00
diff --git a/Example/Leanplum-SDK.xcodeproj/project.pbxproj b/Example/Leanplum-SDK.xcodeproj/project.pbxproj
@@ -91,7 +91,8 @@
 		9CB691DE1F15FFF5002D83D8 /* batch_response.json in Resources */ = {isa = PBXBuildFile; fileRef = 9CB691DD1F15FFF5002D83D8 /* batch_response.json */; };
 		9CB691DF1F15FFFF002D83D8 /* batch_response.json in Resources */ = {isa = PBXBuildFile; fileRef = 9CB691DD1F15FFF5002D83D8 /* batch_response.json */; };
 		9CB691E11F1601BA002D83D8 /* EventCallbackManagerTest.m in Sources */ = {isa = PBXBuildFile; fileRef = 9CB691E01F1601BA002D83D8 /* EventCallbackManagerTest.m */; };
-		B08587C9AF0FCE5835E853EA /* Pods_Leanplum_SDK_Tests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 7849230A3D5C6DE5929ED1C8 /* Pods_Leanplum_SDK_Tests.framework */; };
+		9CD04D941F8EE7E30033AB4A /* variables_with_newsfeed_response.json in Resources */ = {isa = PBXBuildFile; fileRef = 9CD04D931F8EB6190033AB4A /* variables_with_newsfeed_response.json */; };
+		9CD04D951F8EE7E30033AB4A /* variables_with_newsfeed_response.json in Resources */ = {isa = PBXBuildFile; fileRef = 9CD04D931F8EB6190033AB4A /* variables_with_newsfeed_response.json */; };
 		B5CCCA2D1D74B64D005ADEE1 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = B5CCCA2C1D74B64D005ADEE1 /* main.m */; };
 		B5CCCA301D74B64D005ADEE1 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = B5CCCA2F1D74B64D005ADEE1 /* AppDelegate.m */; };
 		B5CCCA331D74B64D005ADEE1 /* ViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = B5CCCA321D74B64D005ADEE1 /* ViewController.m */; };
@@ -192,7 +193,7 @@
 		873B8AEA1B1F5CCA007FD442 /* Main.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = Main.storyboard; sourceTree = "<group>"; };
 		9CB691DD1F15FFF5002D83D8 /* batch_response.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = batch_response.json; sourceTree = "<group>"; };
 		9CB691E01F1601BA002D83D8 /* EventCallbackManagerTest.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = EventCallbackManagerTest.m; sourceTree = "<group>"; };
-		9EE2D840C30124E373ADF721 /* Pods_Leanplum_tvOS_SDK_Example.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Leanplum_tvOS_SDK_Example.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		9CD04D931F8EB6190033AB4A /* variables_with_newsfeed_response.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = variables_with_newsfeed_response.json; sourceTree = "<group>"; };
 		A54ACCFCB36AE8C874708A7F /* libPods-Leanplum-SDK_Example-Leanplum-SDK_Tests.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-Leanplum-SDK_Example-Leanplum-SDK_Tests.a"; sourceTree = BUILT_PRODUCTS_DIR; };
 		B5CCCA291D74B64D005ADEE1 /* Leanplum-tvOS-SDK_Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "Leanplum-tvOS-SDK_Example.app"; sourceTree = BUILT_PRODUCTS_DIR; };
 		B5CCCA2C1D74B64D005ADEE1 /* main.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = "<group>"; };
@@ -325,6 +326,7 @@
 				07E5C89C1F052B7800A4B092 /* state_response.json */,
 				07E5C89E1F052B7800A4B092 /* track_event_response.json */,
 				07E5C89F1F052B7800A4B092 /* variables_response.json */,
+				9CD04D931F8EB6190033AB4A /* variables_with_newsfeed_response.json */,
 			);
 			path = Responses;
 			sourceTree = "<group>";
@@ -605,6 +607,7 @@
 				07E5C8DE1F052DC400A4B092 /* newsfeed_response.json in Resources */,
 				07E5C8F61F052DD000A4B092 /* TiedPriorities2.json in Resources */,
 				07E5C8DF1F052DC400A4B092 /* registration_response.json in Resources */,
+				9CD04D951F8EE7E30033AB4A /* variables_with_newsfeed_response.json in Resources */,
 				9CB691DF1F15FFFF002D83D8 /* batch_response.json in Resources */,
 				07E5C8EA1F052DCC00A4B092 /* MainAppIcon.png in Resources */,
 				07E5C8E21F052DC400A4B092 /* start_variables_response.json in Resources */,
@@ -649,6 +652,7 @@
 				07E5C8D61F052B7800A4B092 /* regionData.json in Resources */,
 				07E5C8D81F052B7800A4B092 /* SingleMessage.json in Resources */,
 				07E5C8CB1F052B7800A4B092 /* simple_start_response.json in Resources */,
+				9CD04D941F8EE7E30033AB4A /* variables_with_newsfeed_response.json in Resources */,
 				07E5C8C01F052B7800A4B092 /* MainAppIcon.png in Resources */,
 				07E5C8C11F052B7800A4B092 /* test.file in Resources */,
 				07E5C8CF1F052B7800A4B092 /* track_event_response.json in Resources */,
diff --git a/Example/Tests/Classes/MessagesTest.m b/Example/Tests/Classes/MessagesTest.m
@@ -134,8 +134,6 @@ - (void)runInAppMessagePrioritizationTest:(NSDictionary *)messageConfigs
                        withFilter:self.mockFilter
                     fromMessageId:self.mockFromMessageId
              withContextualValues:self.mockContextualValues];
-    
-    NSLog(@"IDS: %@", calledMessageIds);
 
     XCTAssertTrue([calledMessageIds isEqualToSet:expectedMessageIds]);
 }
diff --git a/Example/Tests/Classes/NewsfeedTest.m b/Example/Tests/Classes/NewsfeedTest.m
@@ -374,4 +374,73 @@ - (void)test_disableFetching
     XCTAssertTrue(timedOut == 0);
 }
 
+- (void)test_onForceContentUpdate {
+    XCTAssertTrue([LeanplumHelper start_development_test]);
+    
+    // FCU without sync
+    id<OHHTTPStubsDescriptor> stub = [OHHTTPStubs stubRequestsPassingTest:
+                                           ^BOOL(NSURLRequest * _Nonnull request) {
+        return [request.URL.host isEqualToString:API_HOST];
+    } withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest *request) {
+        NSString *response_file = OHPathForFile(@"variables_response.json",
+                                               self.class);
+        return [OHHTTPStubsResponse responseWithFileAtPath:response_file
+                                               statusCode:200
+                                                  headers:@{@"Content-Type":@"application/json"}];
+    }];
+    
+    XCTestExpectation *responseExpectation1 = [self expectationWithDescription:@"response1"];
+    [[Leanplum inbox] onForceContentUpdate:^void(BOOL success){
+        XCTAssertTrue(success);
+        [responseExpectation1 fulfill];
+    }];
+    
+    [Leanplum forceContentUpdate:nil];
+    [self waitForExpectationsWithTimeout:2 handler:nil];
+    [OHHTTPStubs removeStub:stub];
+    [[Leanplum inbox] reset];
+    
+    // FCU with sync
+    stub = [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest * _Nonnull request) {
+                return [request.URL.host isEqualToString:API_HOST];
+    } withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest *request) {
+        NSString *response_file = OHPathForFile(@"variables_with_newsfeed_response.json",
+                                                self.class);
+        return [OHHTTPStubsResponse responseWithFileAtPath:response_file
+                                                statusCode:200
+                                                   headers:@{@"Content-Type":@"application/json"}];
+    }];
+    
+    XCTestExpectation *responseExpectation2 = [self expectationWithDescription:@"response2"];
+    [[Leanplum inbox] onForceContentUpdate:^void(BOOL success){
+        XCTAssertTrue(success);
+        [responseExpectation2 fulfill];
+    }];
+    
+    [Leanplum forceContentUpdate:nil];
+    [self waitForExpectationsWithTimeout:2 handler:nil];
+    [OHHTTPStubs removeStub:stub];
+    [[Leanplum inbox] reset];
+    
+    // FCU without internet connection
+    stub = [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
+        return [request.URL.host isEqualToString:API_HOST];;
+    } withStubResponse:^OHHTTPStubsResponse * _Nonnull(NSURLRequest * _Nonnull request) {
+        NSError *error = [NSError errorWithDomain:NSURLErrorDomain
+                                             code:NSURLErrorBadServerResponse userInfo:nil];
+        return [OHHTTPStubsResponse responseWithError:error];
+    }];
+    
+    XCTestExpectation *responseExpectation3 = [self expectationWithDescription:@"response3"];
+    [[Leanplum inbox] onForceContentUpdate:^void(BOOL success){
+        XCTAssertFalse(success);
+        [responseExpectation3 fulfill];
+    }];
+    
+    [Leanplum forceContentUpdate:nil];
+    [self waitForExpectationsWithTimeout:2 handler:nil];
+    [OHHTTPStubs removeStub:stub];
+    [[Leanplum inbox] reset];
+}
+
 @end
diff --git a/Example/Tests/Resources/Responses/variables_with_newsfeed_response.json b/Example/Tests/Resources/Responses/variables_with_newsfeed_response.json
@@ -0,0 +1,28 @@
+{
+    "response": [{
+        "success": true
+    }, {
+        "success": true
+    }, {
+        "vars": {
+
+        },
+        "interfaceRules": [
+
+        ],
+        "variants": [
+
+        ],
+        "regions": {
+
+        },
+        "syncNewsfeed": true,
+        "success": true,
+        "messages": {
+
+        },
+        "interfaceEvents": [
+
+        ]
+    }]
+}
diff --git a/Leanplum-SDK/Classes/LPInbox.h b/Leanplum-SDK/Classes/LPInbox.h
@@ -96,6 +96,7 @@
  * This block is used when you define a callback.
  */
 typedef void (^LeanplumInboxChangedBlock)(void);
+typedef void (^LeanplumInboxSyncedBlock)(BOOL success);
 
 @interface LPInbox : NSObject
 
@@ -150,6 +151,13 @@ typedef void (^LeanplumInboxChangedBlock)(void);
  */
 - (void)onChanged:(LeanplumInboxChangedBlock)block;
 
+/**
+ * Block to call when forceContentUpdate was called.
+ * Returns true if syncing was successful.
+ * Note: use onChanged: for UI.
+ */
+- (void)onForceContentUpdate:(LeanplumInboxSyncedBlock)block;
+
 /**
  @{
  * Adds a responder to be executed when an event happens.
diff --git a/Leanplum-SDK/Classes/LPInbox.m b/Leanplum-SDK/Classes/LPInbox.m
@@ -386,6 +386,7 @@ - (void)reset
     _didLoad = NO;
     _inboxChangedBlocks = nil;
     _inboxChangedResponders = nil;
+    _inboxSyncedBlocks = nil;
     updatingLock = [[NSObject alloc] init];
     _downloadedImageUrls = [NSMutableSet new];
 }
@@ -403,6 +404,15 @@ - (void)triggerInboxChanged
     LP_END_USER_CODE
 }
 
+- (void)triggerInboxSyncedWithStatus:(BOOL)success
+{
+    LP_BEGIN_USER_CODE
+    for (LeanplumInboxSyncedBlock block in _inboxSyncedBlocks.copy) {
+        block(success);
+    }
+    LP_END_USER_CODE
+}
+
 #pragma mark - LPInbox methods
 
 - (void)downloadMessages
@@ -450,13 +460,18 @@ - (void)downloadMessages
             [Leanplum onceVariablesChangedAndNoDownloadsPending:^{
                 LP_END_USER_CODE
                 [self updateMessages:messages unreadCount:unreadCount];
+                [self triggerInboxSyncedWithStatus:YES];
                 LP_BEGIN_USER_CODE
             }];
         } else {
             [self updateMessages:messages unreadCount:unreadCount];
+            [self triggerInboxSyncedWithStatus:YES];
         }
         LP_END_TRY
     }];
+    [req onError:^(NSError *error) {
+        [self triggerInboxSyncedWithStatus:NO];
+    }];
     [req sendIfConnected];
     LP_END_TRY
 }
@@ -521,6 +536,10 @@ - (LPInboxMessage *)messageForId:(NSString *)messageId
 
 - (void)onChanged:(LeanplumInboxChangedBlock)block
 {
+    if (!block) {
+        return;
+    }
+    
     LP_TRY
     if (!_inboxChangedBlocks) {
         _inboxChangedBlocks = [NSMutableArray array];
@@ -532,6 +551,20 @@ - (void)onChanged:(LeanplumInboxChangedBlock)block
     }
 }
 
+- (void)onForceContentUpdate:(LeanplumInboxSyncedBlock)block
+{
+    if (!block) {
+        return;
+    }
+    
+    LP_TRY
+    if (!_inboxSyncedBlocks) {
+        _inboxSyncedBlocks = [NSMutableArray array];
+    }
+    [_inboxSyncedBlocks addObject:[block copy]];
+    LP_END_TRY
+}
+
 - (void)addInboxChangedResponder:(id)responder withSelector:(SEL)selector
 {
     if (!_inboxChangedResponders) {
diff --git a/Leanplum-SDK/Classes/Leanplum.m b/Leanplum-SDK/Classes/Leanplum.m
@@ -2259,6 +2259,8 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block
         }
         if ([response[LP_KEY_SYNC_INBOX] boolValue]) {
             [[self inbox] downloadMessages];
+        } else {
+            [[self inbox] triggerInboxSyncedWithStatus:YES];
         }
         LP_END_TRY
         if (block) {
@@ -2269,6 +2271,7 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block
         if (block) {
             block();
         }
+        [[self inbox] triggerInboxSyncedWithStatus:NO];
     }];
     [req sendIfConnected];
     LP_END_TRY
diff --git a/Leanplum-SDK/Classes/LeanplumInternal.h b/Leanplum-SDK/Classes/LeanplumInternal.h
@@ -164,6 +164,7 @@ typedef void (^LeanplumInboxCacheUpdateBlock)(void);
 @property(strong, nonatomic) NSMutableDictionary *messages;
 @property(strong, nonatomic) NSMutableArray *inboxChangedBlocks;
 @property(strong, nonatomic) NSMutableSet *inboxChangedResponders;
+@property(strong, nonatomic) NSMutableArray *inboxSyncedBlocks;
 @property(strong, nonatomic) NSMutableSet *downloadedImageUrls;
 
 #pragma mark - LPInbox method declaration
@@ -178,6 +179,7 @@ typedef void (^LeanplumInboxCacheUpdateBlock)(void);
 - (void)removeMessageForId:(NSString *)messageId;
 - (void)reset;
 - (void)triggerInboxChanged;
+- (void)triggerInboxSyncedWithStatus:(BOOL)success;
 
 @end
 

Original file line number	Diff line number	Diff line change
`@@ -134,8 +134,6 @@ - (void)runInAppMessagePrioritizationTest:(NSDictionary *)messageConfigs`
`134`	`134`	`withFilter:self.mockFilter`
`135`	`135`	`fromMessageId:self.mockFromMessageId`
`136`	`136`	`withContextualValues:self.mockContextualValues];`
`137`		`-`
`138`		`- NSLog(@"IDS: %@", calledMessageIds);`
`139`	`137`
`140`	`138`	`XCTAssertTrue([calledMessageIds isEqualToSet:expectedMessageIds]);`
`141`	`139`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2259,6 +2259,8 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block`
`2259`	`2259`	`}`
`2260`	`2260`	`if ([response[LP_KEY_SYNC_INBOX] boolValue]) {`
`2261`	`2261`	`[[self inbox] downloadMessages];`
	`2262`	`+ } else {`
	`2263`	`+ [[self inbox] triggerInboxSyncedWithStatus:YES];`
`2262`	`2264`	`}`
`2263`	`2265`	`LP_END_TRY`
`2264`	`2266`	`if (block) {`
`@@ -2269,6 +2271,7 @@ + (void)forceContentUpdate:(LeanplumVariablesChangedBlock)block`
`2269`	`2271`	`if (block) {`
`2270`	`2272`	`block();`
`2271`	`2273`	`}`
	`2274`	`+ [[self inbox] triggerInboxSyncedWithStatus:NO];`
`2272`	`2275`	`}];`
`2273`	`2276`	`[req sendIfConnected];`
`2274`	`2277`	`LP_END_TRY`