Merge pull request #450 from Countly/staging

Version 26.1.1

Author: turtledreams

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 26.1.1
+* Added POST method support for contents. 
+* Added robust resource loading checks before displaying content
+* Added Content feature method `previewContent:(NSString *)contentId` (Experimental!).
+* Improved refreshing contents.
+
 ## 26.1.0
 * Added server-side listing filters support for controlling what data gets recorded:
   * Event filters (blacklist/whitelist) to control which events are recorded

Countly-PL.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly-PL'
-  s.version = '26.1.0'
+  s.version = '26.1.1'
   s.license = { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'

Countly.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'Countly'
-  s.version = '26.1.0'
+  s.version = '26.1.1'
   s.license = { :type => 'MIT', :file => 'LICENSE' }
   s.summary  = 'Countly is an innovative, real-time, open source mobile analytics platform.'
   s.homepage = 'https://github.com/Countly/countly-sdk-ios'

Countly.xcodeproj/project.pbxproj

@@ -92,6 +92,7 @@
 		965A2E9D2DDDCDAC00F28F6A /* CountlyHealthTracker.h in Headers */ = {isa = PBXBuildFile; fileRef = 965A2E9A2DDDCDAC00F28F6A /* CountlyHealthTracker.h */; };
 		9673567F2EC60CD400C742D8 /* TestURLProtocol.swift in Sources */ = {isa = PBXBuildFile; fileRef = 9673567E2EC60CD400C742D8 /* TestURLProtocol.swift */; };
 		968426812BF2302C007B303E /* CountlyConnectionManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 968426802BF2302C007B303E /* CountlyConnectionManagerTests.swift */; };
+		96CB10A12F04B3A100D1E2F0 /* CountlyContentBuilderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 96CB10A02F04B3A100D1E2F0 /* CountlyContentBuilderTests.swift */; };
 		9691B7652F1FA35500A6ADCB /* CountlyOverlayWindow.h in Headers */ = {isa = PBXBuildFile; fileRef = 9691B7642F1FA35500A6ADCB /* CountlyOverlayWindow.h */; };
 		9691B7672F1FA35C00A6ADCB /* CountlyOverlayWindow.m in Sources */ = {isa = PBXBuildFile; fileRef = 9691B7662F1FA35C00A6ADCB /* CountlyOverlayWindow.m */; };
 		969E5BCE2ECC4D3200AB406A /* CountlyConsentManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 969E5BCD2ECC4D2C00AB406A /* CountlyConsentManagerTests.swift */; };
@@ -110,6 +111,7 @@
 		D2CFEF972545FBE80026B044 /* CountlyFeedbacksInternal.h in Headers */ = {isa = PBXBuildFile; fileRef = D2CFEF952545FBE80026B044 /* CountlyFeedbacksInternal.h */; };
 		D2CFEF982545FBE80026B044 /* CountlyFeedbacksInternal.m in Sources */ = {isa = PBXBuildFile; fileRef = D2CFEF962545FBE80026B044 /* CountlyFeedbacksInternal.m */; };
 		F041D46C963F3EA85882CB0D /* CountlyRequestCallbackTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7C1C3803ECB0A386136072D6 /* CountlyRequestCallbackTests.swift */; };
+		69F2F899F8C641418B746050 /* CountlyWebViewManagerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EBD1642D826B471A80175BE3 /* CountlyWebViewManagerTests.swift */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -215,6 +217,7 @@
 		96681A9B2D97D9B300A4845A /* CountlyTests.xctestplan */ = {isa = PBXFileReference; lastKnownFileType = text; path = CountlyTests.xctestplan; sourceTree = "<group>"; };
 		9673567E2EC60CD400C742D8 /* TestURLProtocol.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestURLProtocol.swift; sourceTree = "<group>"; };
 		968426802BF2302C007B303E /* CountlyConnectionManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountlyConnectionManagerTests.swift; sourceTree = "<group>"; };
+		96CB10A02F04B3A100D1E2F0 /* CountlyContentBuilderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountlyContentBuilderTests.swift; sourceTree = "<group>"; };
 		9691B7642F1FA35500A6ADCB /* CountlyOverlayWindow.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = CountlyOverlayWindow.h; sourceTree = "<group>"; };
 		9691B7662F1FA35C00A6ADCB /* CountlyOverlayWindow.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = CountlyOverlayWindow.m; sourceTree = "<group>"; };
 		969E5BCD2ECC4D2C00AB406A /* CountlyConsentManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountlyConsentManagerTests.swift; sourceTree = "<group>"; };
@@ -230,6 +233,8 @@
 		D249BF5D254D3D180058A6C2 /* CountlyFeedbackWidget.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CountlyFeedbackWidget.m; sourceTree = "<group>"; };
 		D2CFEF952545FBE80026B044 /* CountlyFeedbacksInternal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CountlyFeedbacksInternal.h; sourceTree = "<group>"; };
 		D2CFEF962545FBE80026B044 /* CountlyFeedbacksInternal.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = CountlyFeedbacksInternal.m; sourceTree = "<group>"; };
+		EBD1642D826B471A80175BE3 /* CountlyWebViewManagerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountlyWebViewManagerTests.swift; sourceTree = "<group>"; };
+		265156CB5F59417EA14BAC2F /* CountlyWebViewManager+Tests.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "CountlyWebViewManager+Tests.h"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -267,7 +272,10 @@
 				1A50D7042B3C5AA3009C6938 /* CountlyBaseTestCase.swift */,
 				1AFD79012B3EF82C00772FBD /* CountlyTests-Bridging-Header.h */,
 				968426802BF2302C007B303E /* CountlyConnectionManagerTests.swift */,
+				96CB10A02F04B3A100D1E2F0 /* CountlyContentBuilderTests.swift */,
 				96E680412BFF89AC0091E105 /* CountlyCrashReporterTests.swift */,
+				EBD1642D826B471A80175BE3 /* CountlyWebViewManagerTests.swift */,
+				265156CB5F59417EA14BAC2F /* CountlyWebViewManager+Tests.h */,
 				3979E47C2C0760E900FA1CA4 /* CountlyUserProfileTests.swift */,
 				3972EDDA2C08A38D00EB9D3E /* CountlyEventStruct.swift */,
 				3966DBCE2C11EE270002ED97 /* CountlyDeviceIDTests.swift */,
@@ -546,6 +554,7 @@
 				1A50D7052B3C5AA3009C6938 /* CountlyBaseTestCase.swift in Sources */,
 				3979E47D2C0760E900FA1CA4 /* CountlyUserProfileTests.swift in Sources */,
 				968426812BF2302C007B303E /* CountlyConnectionManagerTests.swift in Sources */,
+				96CB10A12F04B3A100D1E2F0 /* CountlyContentBuilderTests.swift in Sources */,
 				96329DE42D952F1500BFD641 /* MockURLProtocol.swift in Sources */,
 				96329DE02D9426F300BFD641 /* CountlyServerConfigTests.swift in Sources */,
 				3966DBCF2C11EE270002ED97 /* CountlyDeviceIDTests.swift in Sources */,
@@ -557,6 +566,7 @@
 				3972EDDB2C08A38D00EB9D3E /* CountlyEventStruct.swift in Sources */,
 				9673567F2EC60CD400C742D8 /* TestURLProtocol.swift in Sources */,
 				96E680422BFF89AC0091E105 /* CountlyCrashReporterTests.swift in Sources */,
+				69F2F899F8C641418B746050 /* CountlyWebViewManagerTests.swift in Sources */,
 				A431BFDB50E23B1C056F93A1 /* CountlyQueueFlushRunnablesTests.swift in Sources */,
 				F041D46C963F3EA85882CB0D /* CountlyRequestCallbackTests.swift in Sources */,
 				CD99EB53BFF33C2DA9C50715 /* CountlyCallbackBaseTestCase.swift in Sources */,
@@ -820,7 +830,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.14;
-				MARKETING_VERSION = 26.1.0;
+				MARKETING_VERSION = 26.1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";
@@ -852,7 +862,7 @@
 					"@loader_path/Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 10.14;
-				MARKETING_VERSION = 26.1.0;
+				MARKETING_VERSION = 26.1.1;
 				PRODUCT_BUNDLE_IDENTIFIER = ly.count.CountlyiOSSDK;
 				PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
 				PROVISIONING_PROFILE_SPECIFIER = "";

CountlyCommon.m

@@ -29,7 +29,7 @@ @interface CountlyCommon ()
 #endif
 @end
 
-NSString* const kCountlySDKVersion = @"26.1.0";
+NSString* const kCountlySDKVersion = @"26.1.1";
 NSString* const kCountlySDKName = @"objc-native-ios";
 
 NSString* const kCountlyErrorDomain = @"ly.count.ErrorDomain";

CountlyContentBuilder.h

@@ -35,6 +35,16 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)refreshContentZone;
 
+/**
+ * This is an experimental feature and it can have breaking changes
+ * Previews a specific content by its ID.
+ * This performs a one-time fetch for the given content
+ * without starting periodic content updates.
+ *
+ * @param contentId the ID of the content to preview
+ */
+- (void)previewContent:(NSString *)contentId;
+
 #endif
 NS_ASSUME_NONNULL_END
 @end

CountlyContentBuilder.m

@@ -51,5 +51,16 @@ - (void)changeContent:(NSArray<NSString *> *)tags
     [CountlyContentBuilder.sharedInstance changeContent:tags];
 }
 
+- (void)previewContent:(NSString *)contentId
+{
+    if (!contentId || contentId.length == 0)
+    {
+        CLY_LOG_W(@"%s contentId is null or empty, skipping", __FUNCTION__);
+        return;
+    }
+
+    [CountlyContentBuilderInternal.sharedInstance previewContent:contentId];
+}
+
 #endif
 @end

CountlyContentBuilderInternal.h

@@ -17,7 +17,6 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic) ContentCallback contentCallback;
 @property (nonatomic, assign) WebViewDisplayOption webViewDisplayOption;
 @property (nonatomic, assign) int contentInitialDelay;
-@property (nonatomic, assign) NSUInteger refreshContentZoneDelay;
 
 + (instancetype)sharedInstance;
 
@@ -26,6 +25,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)changeContent:(NSArray<NSString *> *)tags;
 - (void)refreshContentZone;
 - (void)refreshContentZoneJTE;
+- (void)previewContent:(NSString *)contentId;
 
 #endif
 NS_ASSUME_NONNULL_END

CountlyContentBuilderInternal.m

@@ -37,7 +37,6 @@ - (instancetype)init
         _isCurrentlyContentShown = NO;
         _contentQueue = dispatch_queue_create("ly.countly.content.queue", DISPATCH_QUEUE_SERIAL);
         _contentInitialDelay = 4;
-        _refreshContentZoneDelay = 2.5;
     }
 
     return self;
@@ -120,6 +119,10 @@ - (void)changeContent:(NSArray<NSString *> *)tags {
     }
 }
 
+- (void)previewContent:(NSString *)contentId {
+    [self fetchContents:nil contentId:contentId];
+}
+
 - (void)refreshContentZone {
     if (![CountlyServerConfig.sharedInstance refreshContentZoneEnabled])
     {
@@ -130,13 +133,12 @@ - (void)refreshContentZone {
         return;
     }
 
-    [self exitContentZone];
-    [CountlyConnectionManager.sharedInstance attemptToSendStoredRequests];
-    
-    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(_refreshContentZoneDelay * NSEC_PER_SEC)), dispatch_get_main_queue(), ^
-    {
+    [CountlyConnectionManager.sharedInstance addQueueFlushRunnable:^{
+        CLY_LOG_I(@"%s queue flueshed, will re-fetch contents" ,__FUNCTION__);
+        [self exitContentZone];
         [self enterContentZone];
-    });
+    }];
+    [CountlyConnectionManager.sharedInstance attemptToSendStoredRequests];
 }
 
 - (void)refreshContentZoneJTE {
@@ -170,7 +172,7 @@ - (void)fetchContentsForJourneyWithMaxAttempts:(NSInteger)maxAttempts currentAtt
                 [self enterContentZone];
             });
         }
-    }];
+    } contentId:nil];
 }
 
 #pragma mark - Private Methods
@@ -186,10 +188,10 @@ - (void)clearContentState {
 }
 
 - (void)fetchContents {
-    [self fetchContents:nil];
+    [self fetchContents:nil contentId:nil];
 }
 
-- (void)fetchContents:(void (^)(void))failureCallback {
+- (void)fetchContents:(void (^)(void))failureCallback contentId:(NSString *)contentId {
     if (!CountlyConsentManager.sharedInstance.consentForContent)
         return;
 
@@ -207,7 +209,7 @@ - (void)fetchContents:(void (^)(void))failureCallback {
 
     [self setRequestQueueLockedThreadSafe:YES];
 
-    NSURLSessionTask *dataTask = [CountlyCommon.sharedInstance.URLSession dataTaskWithRequest:[self fetchContentsRequest] completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
+    NSURLSessionTask *dataTask = [CountlyCommon.sharedInstance.URLSession dataTaskWithRequest:[self fetchContentsRequest: contentId] completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
         if (error) {
             CLY_LOG_I(@"%s fetch content details failed: [%@]", __FUNCTION__, error);
             [self setRequestQueueLockedThreadSafe:NO];
@@ -242,7 +244,7 @@ - (void)fetchContents:(void (^)(void))failureCallback {
     [dataTask resume];
 }
 
-- (NSURLRequest *)fetchContentsRequest
+- (NSURLRequest *)fetchContentsRequest:(NSString *)contentId
 {
     NSString *queryString = [CountlyConnectionManager.sharedInstance queryEssentials];
     NSString *resolutionJson = [self resolutionJson];
@@ -258,12 +260,28 @@ - (NSURLRequest *)fetchContentsRequest
         queryString = [queryString stringByAppendingFormat:@"&%@=%@", @"dt", deviceType];
     }
 
+    if (contentId) {
+        queryString = [queryString stringByAppendingFormat:@"&%@=%@", @"content_id", contentId.cly_URLEscaped];
+        queryString = [queryString stringByAppendingFormat:@"&%@=%@", @"preview", @"true"];
+    }
+    
     queryString = [CountlyConnectionManager.sharedInstance appendChecksum:queryString];
 
-    NSString *URLString = [NSString stringWithFormat:@"%@%@?%@", CountlyConnectionManager.sharedInstance.host, kCountlyEndpointContent, queryString];
+    NSString *contentEndpoint = [NSString stringWithFormat:@"%@%@", CountlyConnectionManager.sharedInstance.host, kCountlyEndpointContent];
 
-    NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:URLString]];
-    return request;
+    if (queryString.length > kCountlyGETRequestMaxLength || CountlyConnectionManager.sharedInstance.alwaysUsePOST)
+    {
+        NSMutableURLRequest* request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:contentEndpoint]];
+        request.HTTPMethod = @"POST";
+        request.HTTPBody = [queryString cly_dataUTF8];
+        return request.copy;
+    }
+    else
+    {
+        NSString* withQueryString = [contentEndpoint stringByAppendingFormat:@"?%@", queryString];
+        NSURLRequest* request = [NSURLRequest requestWithURL:[NSURL URLWithString:withQueryString]];
+        return request;
+    }
 }
 
 - (NSString *)resolutionJson {