Merge pull request #768 from adjust/v542

Version 5.4.2

Author: Aditi3

Adjust.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name                    = "Adjust"
   s.module_name             = "AdjustSdk"
-  s.version                 = "5.4.1"
+  s.version                 = "5.4.2"
   s.summary                 = "This is the iOS SDK of Adjust. You can read more about it at https://adjust.com."
   s.homepage                = "https://github.com/adjust/ios_sdk"
   s.license                 = { :type => 'MIT', :file => 'LICENSE' }

Adjust/Adjust.h

@@ -2,7 +2,7 @@
 //  Adjust.h
 //  Adjust SDK
 //
-//  V5.4.1
+//  V5.4.2
 //  Created by Christian Wellenbrock (@wellle) on 23rd July 2013.
 //  Copyright (c) 2012-Present Adjust GmbH. All rights reserved.
 //

Adjust/Internal/ADJActivityHandler.m

@@ -1599,19 +1599,21 @@ - (void)launchAttributionResponseTasksI:(ADJActivityHandler *)selfI
 }
 
 - (void)launchPurchaseVerificationResponseTasksI:(ADJActivityHandler *)selfI
-                purchaseVerificationResponseData:(ADJPurchaseVerificationResponseData *)purchaseVerificationResponseData {
+                purchaseVerificationResponseData:(ADJPurchaseVerificationResponseData *)responseData {
     [selfI.logger debug:
-        @"Got purchase_verification JSON response with message: %@", purchaseVerificationResponseData.message];
-    ADJPurchaseVerificationResult *verificationResult = [[ADJPurchaseVerificationResult alloc] init];
-    verificationResult.verificationStatus = purchaseVerificationResponseData.jsonResponse[@"verification_status"];
-    verificationResult.code = [(NSNumber *)purchaseVerificationResponseData.jsonResponse[@"code"] intValue];
-    verificationResult.message = purchaseVerificationResponseData.jsonResponse[@"message"];
-    purchaseVerificationResponseData.purchaseVerificationPackage.purchaseVerificationCallback(verificationResult);
-
-    if (purchaseVerificationResponseData.purchaseVerificationPackage &&
-        purchaseVerificationResponseData.purchaseVerificationPackage.event)
-    {
-        [self trackEvent:purchaseVerificationResponseData.purchaseVerificationPackage.event];
+        @"Got purchase_verification JSON response with message: %@", responseData.message];
+    if (responseData.error == nil) {
+        ADJPurchaseVerificationResult *verificationResult = [[ADJPurchaseVerificationResult alloc] init];
+        verificationResult.verificationStatus = responseData.jsonResponse[@"verification_status"];
+        verificationResult.code = [(NSNumber *)responseData.jsonResponse[@"code"] intValue];
+        verificationResult.message = responseData.jsonResponse[@"message"];
+        responseData.purchaseVerificationPackage.purchaseVerificationCallback(verificationResult);
+    } else {
+        responseData.purchaseVerificationPackage.purchaseVerificationCallback(responseData.error);
+    }
+
+    if (responseData.purchaseVerificationPackage && responseData.purchaseVerificationPackage.event) {
+        [self trackEvent:responseData.purchaseVerificationPackage.event];
     }
 }
 

Adjust/Internal/ADJAdjustFactory.h

@@ -18,6 +18,7 @@
 + (double)sessionInterval;
 + (double)subsessionInterval;
 + (double)requestTimeout;
++ (double)verifyRequestTimeout;
 + (NSNumber *)attStatus;
 + (NSString *)idfa;
 + (NSTimeInterval)timerInterval;

Adjust/Internal/ADJAdjustFactory.m

@@ -53,7 +53,14 @@ + (double)subsessionInterval {
 
 + (double)requestTimeout {
     if (internalRequestTimeout == -1) {
-        return 60;                 // 60 second
+        return 60;                 // 60 seconds
+    }
+    return internalRequestTimeout;
+}
+
++ (double)verifyRequestTimeout {
+    if (internalRequestTimeout == -1) {
+        return 30;                 // 30 seconds
     }
     return internalRequestTimeout;
 }

Adjust/Internal/ADJPurchaseVerificationHandler.h

@@ -1,9 +1,9 @@
 //
 //  ADJPurchaseVerificationHandler.h
-//  Adjust
+//  Adjust SDK
 //
 //  Created by Uglješa Erceg (@uerceg) on May 25th 2023.
-//  Copyright © 2023 Adjust. All rights reserved.
+//  Copyright © 2023-Present Adjust. All rights reserved.
 //
 
 #import <Foundation/Foundation.h>

Adjust/Internal/ADJPurchaseVerificationHandler.m

@@ -10,7 +10,6 @@
 #import "ADJUtil.h"
 #import "ADJLogger.h"
 #import "ADJAdjustFactory.h"
-#import "ADJBackoffStrategy.h"
 #import "ADJUserDefaults.h"
 #import "ADJPackageBuilder.h"
 #import "ADJPurchaseVerificationResult.h"
@@ -24,12 +23,11 @@ @interface ADJPurchaseVerificationHandler()
 @property (nonatomic, strong) ADJRequestHandler *requestHandler;
 
 @property (nonatomic, assign) BOOL paused;
-@property (nonatomic, strong) ADJBackoffStrategy *backoffStrategy;
+@property (nonatomic, assign) BOOL isSendingPurchaseVerificationPackage;
 
 @property (nonatomic, weak) id<ADJLogger> logger;
 @property (nonatomic, weak) id<ADJActivityHandler> activityHandler;
 
-@property (nonatomic, assign) NSInteger lastPackageRetriesCount;
 @property (nonatomic, strong) NSNumber *lastPackageRetryInMilli;
 
 @end
@@ -48,12 +46,12 @@ - (id)initWithActivityHandler:(id<ADJActivityHandler>)activityHandler
 
     self.internalQueue = dispatch_queue_create(kInternalQueueName, DISPATCH_QUEUE_SERIAL);
     self.logger = ADJAdjustFactory.logger;
-    self.lastPackageRetriesCount = 0;
 
-    self.requestHandler = [[ADJRequestHandler alloc] initWithResponseCallback:self
-                                                                  urlStrategy:urlStrategy
-                                                               requestTimeout:[ADJAdjustFactory requestTimeout]
-                                                          adjustConfiguration:activityHandler.adjustConfig];
+    self.requestHandler =
+    [[ADJRequestHandler alloc] initWithResponseCallback:self
+                                            urlStrategy:urlStrategy
+                                         requestTimeout:[ADJAdjustFactory verifyRequestTimeout]
+                                    adjustConfiguration:activityHandler.adjustConfig];
 
     [ADJUtil launchInQueue:self.internalQueue
                 selfInject:self
@@ -68,6 +66,8 @@ - (void)pauseSending {
                 selfInject:self
                      block:^(ADJPurchaseVerificationHandler *selfI) {
         selfI.paused = YES;
+        selfI.isSendingPurchaseVerificationPackage = NO;
+        selfI.lastPackageRetryInMilli = nil;
     }];
 }
 
@@ -114,9 +114,10 @@ - (void)teardown {
 
     self.internalQueue = nil;
     self.logger = nil;
-    self.backoffStrategy = nil;
     self.packageQueue = nil;
     self.activityHandler = nil;
+    self.isSendingPurchaseVerificationPackage = NO;
+    self.lastPackageRetryInMilli = nil;
 }
 
 #pragma mark - Private & helper methods
@@ -126,7 +127,8 @@ -   (void)initI:(ADJPurchaseVerificationHandler *)selfI
   startsSending:(BOOL)startsSending {
     selfI.activityHandler = activityHandler;
     selfI.paused = !startsSending;
-    selfI.backoffStrategy = [ADJAdjustFactory sdkClickHandlerBackoffStrategy];
+    selfI.isSendingPurchaseVerificationPackage = NO;
+    selfI.lastPackageRetryInMilli = nil;
     selfI.packageQueue = [NSMutableArray array];
 }
 
@@ -143,63 +145,47 @@ - (void)sendNextPurchaseVerificationPackageI:(ADJPurchaseVerificationHandler *)s
         [selfI.logger debug:@"Purchase verification handler is paused"];
         return;
     }
-    NSUInteger queueSize = selfI.packageQueue.count;
-    if (queueSize == 0) {
+    if (selfI.isSendingPurchaseVerificationPackage) {
+        [selfI.logger debug:@"Purchase verification handler is already sending a package"];
+        return;
+    }
+    if (selfI.packageQueue.count == 0) {
         return;
     }
     if ([selfI.activityHandler isGdprForgotten]) {
-        [selfI.logger debug:@"purchase_verification request won't be fired for forgotten user"];
+        [selfI.logger debug:@"purchase_verification request won't be sent for GDPR forgotten user"];
+        return;
+    }
+
+    // check if we need to wait for backend-requested retry_in delay
+    NSNumber *waitTime = [selfI waitTimeTimeInterval];
+    if (waitTime != nil) {
+        dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)([waitTime doubleValue] * NSEC_PER_SEC)), 
+                       selfI.internalQueue, ^{
+            // clear the retry delay after waiting
+            selfI.lastPackageRetryInMilli = nil;
+            [selfI sendNextPurchaseVerificationPackage];
+        });
         return;
     }
 
+    // get the package but keep it in the queue until processing is complete
     ADJActivityPackage *purchaseVerificationPackage = [self.packageQueue objectAtIndex:0];
-    [self.packageQueue removeObjectAtIndex:0];
 
     if (![purchaseVerificationPackage isKindOfClass:[ADJActivityPackage class]]) {
         [selfI.logger error:@"Failed to read purchase_verification package"];
+        // remove the bad package to prevent infinite loop
+        [selfI.packageQueue removeObjectAtIndex:0];
+        selfI.isSendingPurchaseVerificationPackage = NO;
         [selfI sendNextPurchaseVerificationPackage];
         return;
     }
 
-    dispatch_block_t work = ^{
-        [selfI.requestHandler sendPackageByPOST:purchaseVerificationPackage
-                              sendingParameters:nil];
-        [selfI sendNextPurchaseVerificationPackage];
-    };
-
-    NSNumber *waitTimeSecondsDouble = [selfI waitTimeTimeInterval];
-
-    if (waitTimeSecondsDouble != nil) {
-        dispatch_after(dispatch_time(DISPATCH_TIME_NOW,
-                                     (int64_t)(waitTimeSecondsDouble.doubleValue * NSEC_PER_SEC)),
-                       self.internalQueue, work);
-    } else {
-        work();
-    }
-}
-- (NSNumber *)waitTimeTimeInterval {
-    if (self.lastPackageRetriesCount > 0) {
-        NSTimeInterval waitTime = [ADJUtil waitingTime:self.lastPackageRetriesCount
-                                       backoffStrategy:self.backoffStrategy];
-
-        [self.logger verbose:
-         @"Waiting for %@ seconds before retrying purchase_verification for the %d time",
-         [ADJUtil secondsNumberFormat:waitTime], self.lastPackageRetriesCount];
-
-        return @(waitTime);
-    }
-
-    if (self.lastPackageRetryInMilli != nil) {
-        NSTimeInterval waitTime = [self.lastPackageRetryInMilli intValue] / 1000.0;
-
-        [self.logger verbose:
-         @"Waiting for %@ seconds before retrying purchase_verification with retry_in",
-         [ADJUtil secondsNumberFormat:waitTime]];
-
-        return @(waitTime);
-    }
+    // set flag to indicate we're sending a package
+    selfI.isSendingPurchaseVerificationPackage = YES;
 
-    return nil;
+    [selfI.requestHandler sendPackageByPOST:purchaseVerificationPackage
+                          sendingParameters:nil];
 }
 
 - (void)updatePackagesTrackingI:(ADJPurchaseVerificationHandler *)selfI
@@ -220,50 +206,65 @@ - (void)updatePackagesTrackingI:(ADJPurchaseVerificationHandler *)selfI
 }
 
 - (void)responseCallback:(ADJResponseData *)responseData {
+    // reset flag to indicate we're done processing this package
+    self.isSendingPurchaseVerificationPackage = NO;
+    
     if (!responseData.jsonResponse) {
         [self.logger error:
             @"Could not get purchase_verification JSON response with message: %@", responseData.message];
         ADJPurchaseVerificationResult *verificationResult = [[ADJPurchaseVerificationResult alloc] init];
         verificationResult.verificationStatus = @"not_verified";
         verificationResult.code = 102;
         verificationResult.message = responseData.message;
-        responseData.purchaseVerificationPackage.purchaseVerificationCallback(verificationResult);
-    }
-    // Check if any package response contains information that user has opted out.
-    // If yes, disable SDK and flush any potentially stored packages that happened afterwards.
-    if (responseData.trackingState == ADJTrackingStateOptedOut) {
-        self.lastPackageRetriesCount = 0;
+        ((ADJPurchaseVerificationResponseData *)responseData).error = verificationResult;
+    } else {
+        // check if any package response contains information that user has opted out.
+        // if yes, disable SDK and flush any potentially stored packages that happened afterwards.
+        if (responseData.trackingState == ADJTrackingStateOptedOut) {
+            [self.activityHandler setTrackingStateOptedOut];
+            return;
+        }
+
+        // check if backend requested retry_in delay
+        if (responseData.retryInMilli != nil) {
+            self.lastPackageRetryInMilli = responseData.retryInMilli;
+            [self.logger error:@"Retrying purchase_verification package with retry in %d ms",
+             [responseData.retryInMilli intValue]];
+            
+            // package stays in queue - schedule retry
+            [self sendNextPurchaseVerificationPackage];
+            return;
+        }
+
+        // reset retry counter after successful response
         self.lastPackageRetryInMilli = nil;
-        [self.activityHandler setTrackingStateOptedOut];
-        return;
     }
 
-    if ([self retryPackageWithResponse:responseData]) {
-        [self sendPurchaseVerificationPackage:responseData.purchaseVerificationPackage];
-        return;
+    // processing is complete - remove the package from queue
+    if (self.packageQueue.count > 0) {
+        [self.packageQueue removeObjectAtIndex:0];
     }
 
-    self.lastPackageRetriesCount = 0;
-    self.lastPackageRetryInMilli = nil;
+    // finish package tracking without retrying / backoff
     [self.activityHandler finishedTracking:responseData];
+    
+    // process next package in queue if any
+    [self sendNextPurchaseVerificationPackage];
 }
 
-- (BOOL)retryPackageWithResponse:(ADJResponseData *)responseData {
-    if (responseData.jsonResponse == nil) {
-        self.lastPackageRetriesCount++;
-        [self.logger error:@"Retrying purchase_verification package for the %d time",
-         self.lastPackageRetriesCount];
-        return YES;
-    }
+- (NSNumber *)waitTimeTimeInterval {
+    // handle backend-requested retry_in delay
+    if (self.lastPackageRetryInMilli != nil) {
+        NSTimeInterval waitTime = [self.lastPackageRetryInMilli intValue] / 1000.0;
 
-    if (responseData.retryInMilli != nil) {
-        self.lastPackageRetryInMilli = responseData.retryInMilli;
-        [self.logger error:@"Retrying purchase_verification package with retry in %d ms",
-         [responseData.retryInMilli intValue]];
-        return YES;
+        [self.logger verbose:
+         @"Waiting for %@ seconds before retrying purchase_verification with retry_in",
+         [ADJUtil secondsNumberFormat:waitTime]];
+
+        return @(waitTime);
     }
 
-    return NO;
+    return nil;
 }
 
 @end

Adjust/Internal/ADJResponseData.h

@@ -15,6 +15,8 @@
 #import "ADJSessionFailure.h"
 #import "ADJActivityPackage.h"
 
+@class ADJPurchaseVerificationResult;
+
 typedef NS_ENUM(int, ADJTrackingState) {
     ADJTrackingStateOptedOut = 1
 };
@@ -72,6 +74,9 @@ typedef NS_ENUM(int, ADJTrackingState) {
 @end
 
 @interface ADJPurchaseVerificationResponseData : ADJResponseData
+
+@property (nonatomic, strong) ADJPurchaseVerificationResult *error;
+
 @end
 
 @interface ADJEventResponseData : ADJResponseData

Adjust/Internal/ADJUtil.m

@@ -31,7 +31,7 @@
 static NSRegularExpression *goLinkUniversalLinkRegex = nil;
 static NSRegularExpression *excludedDeeplinkRegex = nil;
 
-static NSString * const kClientSdk                  = @"ios5.4.1";
+static NSString * const kClientSdk                  = @"ios5.4.2";
 static NSString * const kDeeplinkParam              = @"deep_link=";
 static NSString * const kSchemeDelimiter            = @"://";
 static NSString * const kDefaultScheme              = @"AdjustUniversalScheme";

AdjustBridge/AdjustBridgeRegister.m

@@ -176,7 +176,7 @@ function canSend(okCheck, errReason) {
                 if (this.sdkPrefix) {
                     return this.sdkPrefix;
                 } else {
-                    return 'web-bridge5.4.1';
+                    return 'web-bridge5.4.2';
                 }
             },