Merge pull request #514 from adjust/v4270

uerceg · web-flow · commit 5959e7fb0d68 · 2021-03-18T00:08:26.000+01:00
Version 4.27.0
diff --git a/Adjust.podspec b/Adjust.podspec
@@ -1,11 +1,11 @@
 Pod::Spec.new do |s|
   s.name           = "Adjust"
-  s.version        = "4.26.1"
+  s.version        = "4.27.0"
   s.summary        = "This is the iOS SDK of adjust. You can read more about it at http://adjust.com."
   s.homepage       = "https://github.com/adjust/ios_sdk"
   s.license        = { :type => 'MIT', :file => 'MIT-LICENSE' }
   s.author         = { "Christian Wellenbrock" => "welle@adjust.com" }
-  s.source         = { :git => "https://github.com/adjust/ios_sdk.git", :tag => "v4.26.1" }
+  s.source         = { :git => "https://github.com/adjust/ios_sdk.git", :tag => "v4.27.0" }
   s.ios.deployment_target = '6.0'
   s.tvos.deployment_target = '9.0'
   s.framework      = 'SystemConfiguration'
diff --git a/Adjust/ADJActivityHandler.m b/Adjust/ADJActivityHandler.m
@@ -1725,9 +1725,11 @@ - (BOOL)shouldFetchAdServicesI:(ADJActivityHandler *)selfI {
 - (void)checkForAdServicesAttributionI:(ADJActivityHandler *)selfI {
     if (@available(iOS 14.3, tvOS 14.3, *)) {
         if ([selfI shouldFetchAdServicesI:selfI]) {
-            NSError *error = nil;
-            NSString *token = [[UIDevice currentDevice] adjFetchAdServicesAttribution:&error];
-            [selfI setAdServicesAttributionToken:token error:error];
+            dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+                NSError *error = nil;
+                NSString *token = [[UIDevice currentDevice] adjFetchAdServicesAttribution:&error];
+                [selfI setAdServicesAttributionToken:token error:error];
+            });
         }
     }
 }
diff --git a/Adjust/ADJPackageBuilder.m b/Adjust/ADJPackageBuilder.m
@@ -1088,7 +1088,7 @@ - (NSMutableDictionary *)getMeasurementConsentParameters:(BOOL)enabled {
     NSString *enableValue = enabled ? @"enable" : @"disable";
     [ADJPackageBuilder parameters:parameters
                         setString:enableValue
-                           forKey:@"sharing"];
+                           forKey:@"measurement"];
 
     if ([self.trackingStatusManager canGetAttStatus]) {
         [ADJPackageBuilder parameters:parameters setInt:self.trackingStatusManager.attStatus
diff --git a/Adjust/ADJRequestHandler.m b/Adjust/ADJRequestHandler.m
@@ -183,7 +183,7 @@ - (void)sendNSURLSessionRequest:(NSMutableURLRequest *)request
                 [self.logger debug:@"Request succeeded with current URL strategy"];
                 [self.urlStrategy resetAfterSuccess];
                 [self.responseCallback responseCallback:responseData];
-            } else if ([self.urlStrategy shouldRetryAfterFailure]) {
+            } else if ([self.urlStrategy shouldRetryAfterFailure:responseData.activityKind]) {
                 [self.logger debug:@"Request failed with current URL strategy, but it will be retried with new one"];
                 [self retryWithResponseData:responseData
                              methodTypeInfo:methodTypeInfo];
@@ -260,7 +260,7 @@ - (void)sendNSURLConnectionRequest:(NSMutableURLRequest *)request
                 [self.logger debug:@"succeeded with current url strategy"];
                 [self.urlStrategy resetAfterSuccess];
                 [self.responseCallback responseCallback:responseData];
-            } else if ([self.urlStrategy shouldRetryAfterFailure]) {
+            } else if ([self.urlStrategy shouldRetryAfterFailure:responseData.activityKind]) {
                 [self.logger debug:@"failed with current url strategy, but it will retry with new"];
                 [self retryWithResponseData:responseData
                              methodTypeInfo:methodTypeInfo];
@@ -393,6 +393,9 @@ - (void)handleResponseWithData:(NSData *)data
     NSString *urlString =
         [NSString stringWithFormat:@"%@%@%@?%@",
          urlHostString, self.urlStrategy.extraPath, path, queryStringParameters];
+    
+    [self.logger verbose:@"Sending request to endpoint: %@",
+     [NSString stringWithFormat:@"%@%@%@", urlHostString, self.urlStrategy.extraPath, path]];
 
     // [self.logger verbose:@"requestForGetPackage with urlString: %@", urlString];
 
diff --git a/Adjust/ADJUrlStrategy.h b/Adjust/ADJUrlStrategy.h
@@ -19,6 +19,6 @@
 - (NSString *)getUrlHostStringByPackageKind:(ADJActivityKind)activityKind;
 
 - (void)resetAfterSuccess;
-- (BOOL)shouldRetryAfterFailure;
+- (BOOL)shouldRetryAfterFailure:(ADJActivityKind)activityKind;
 
 @end
diff --git a/Adjust/ADJUrlStrategy.m b/Adjust/ADJUrlStrategy.m
@@ -22,6 +22,18 @@
 static NSString * const gdprUrlChina = @"https://gdpr.adjust.world";
 static NSString * const subscritionUrlChina = @"https://subscription.adjust.world";
 
+static NSString * const baseUrlEU = @"https://app.eu.adjust.com";
+static NSString * const gdprUrlEU = @"https://gdpr.eu.adjust.com";
+static NSString * const subscriptionUrlEU = @"https://subscription.eu.adjust.com";
+
+static NSString * const baseUrlTR = @"https://app.tr.adjust.com";
+static NSString * const gdprUrlTR = @"https://gdpr.tr.adjust.com";
+static NSString * const subscriptionUrlTR = @"https://subscription.tr.adjust.com";
+
+static NSString * const baseUrlUS = @"https://app.us.adjust.com";
+static NSString * const gdprUrlUS = @"https://gdpr.us.adjust.com";
+static NSString * const subscriptionUrlUS = @"https://subscription.us.adjust.com";
+
 @interface ADJUrlStrategy ()
 
 @property (nonatomic, copy) NSArray<NSString *> *baseUrlChoicesArray;
@@ -71,6 +83,8 @@ - (instancetype)initWithUrlStrategyInfo:(NSString *)urlStrategyInfo
         return @[baseUrlIndia, baseUrl];
     } else if ([urlStrategyInfo isEqualToString:ADJUrlStrategyChina]) {
         return @[baseUrlChina, baseUrl];
+    } else if ([urlStrategyInfo isEqualToString:ADJDataResidencyEU]) {
+        return @[baseUrlEU];
     } else {
         return @[baseUrl, baseUrlIndia, baseUrlChina];
     }
@@ -82,6 +96,8 @@ - (instancetype)initWithUrlStrategyInfo:(NSString *)urlStrategyInfo
         return @[gdprUrlIndia, gdprUrl];
     } else if ([urlStrategyInfo isEqualToString:ADJUrlStrategyChina]) {
         return @[gdprUrlChina, gdprUrl];
+    } else if ([urlStrategyInfo isEqualToString:ADJDataResidencyEU]) {
+        return @[gdprUrlEU];
     } else {
         return @[gdprUrl, gdprUrlIndia, gdprUrlChina];
     }
@@ -93,6 +109,8 @@ - (instancetype)initWithUrlStrategyInfo:(NSString *)urlStrategyInfo
         return @[subscritionUrlIndia, subscriptionUrl];
     } else if ([urlStrategyInfo isEqualToString:ADJUrlStrategyChina]) {
         return @[subscritionUrlChina, subscriptionUrl];
+    } else if ([urlStrategyInfo isEqualToString:ADJDataResidencyEU]) {
+        return @[subscriptionUrlEU];
     } else {
         return @[subscriptionUrl, subscritionUrlIndia, subscritionUrlChina];
     }
@@ -125,12 +143,21 @@ - (void)resetAfterSuccess {
     self.wasLastAttemptSuccess = YES;
 }
 
-- (BOOL)shouldRetryAfterFailure {
-    NSUInteger nextChoiceIndex = (self.choiceIndex + 1) % self.baseUrlChoicesArray.count;
-    self.choiceIndex = nextChoiceIndex;
-
+- (BOOL)shouldRetryAfterFailure:(ADJActivityKind)activityKind {
     self.wasLastAttemptSuccess = NO;
 
+    NSUInteger choiceListSize;
+    if (activityKind == ADJActivityKindGdpr) {
+        choiceListSize = [_gdprUrlChoicesArray count];
+    } else if (activityKind == ADJActivityKindSubscription) {
+        choiceListSize = [_subscriptionUrlChoicesArray count];
+    } else {
+        choiceListSize = [_baseUrlChoicesArray count];
+    }
+
+    NSUInteger nextChoiceIndex = (self.choiceIndex + 1) % choiceListSize;
+    self.choiceIndex = nextChoiceIndex;
+
     BOOL nextChoiceHasNotReturnedToStartingChoice = self.choiceIndex != self.startingChoiceIndex;
     return nextChoiceHasNotReturnedToStartingChoice;
 }
diff --git a/Adjust/ADJUtil.m b/Adjust/ADJUtil.m
@@ -37,7 +37,7 @@
 static CTTelephonyNetworkInfo *networkInfo = nil;
 #endif
 
-static NSString * const kClientSdk                  = @"ios4.26.1";
+static NSString * const kClientSdk                  = @"ios4.27.0";
 static NSString * const kDeeplinkParam              = @"deep_link=";
 static NSString * const kSchemeDelimiter            = @"://";
 static NSString * const kDefaultScheme              = @"AdjustUniversalScheme";
diff --git a/Adjust/Adjust.h b/Adjust/Adjust.h
@@ -2,7 +2,7 @@
 //  Adjust.h
 //  Adjust
 //
-//  V4.26.1
+//  V4.27.0
 //  Created by Christian Wellenbrock (wellle) on 23rd July 2013.
 //  Copyright © 2012-2017 Adjust GmbH. All rights reserved.
 //
@@ -67,6 +67,7 @@ extern NSString * __nonnull const ADJAdRevenueSourceTapdaq;
  */
 extern NSString * __nonnull const ADJUrlStrategyIndia;
 extern NSString * __nonnull const ADJUrlStrategyChina;
+extern NSString * __nonnull const ADJDataResidencyEU;
 
 /**
  * @brief The main interface to Adjust.
diff --git a/Adjust/Adjust.m b/Adjust/Adjust.m
@@ -44,6 +44,7 @@
 
 NSString * const ADJUrlStrategyIndia = @"UrlStrategyIndia";
 NSString * const ADJUrlStrategyChina = @"UrlStrategyChina";
+NSString * const ADJDataResidencyEU = @"DataResidencyEU";
 
 @implementation AdjustTestOptions
 @end
diff --git a/AdjustBridge/AdjustBridgeRegister.m b/AdjustBridge/AdjustBridgeRegister.m
@@ -246,7 +246,7 @@ + (NSString *)adjust_js {
                 if (this.sdkPrefix) {
                     return this.sdkPrefix;
                 } else {
-                    return 'web-bridge4.26.1';
+                    return 'web-bridge4.27.0';
                 }
             },
             setTestOptions: function(testOptions) {
@@ -361,6 +361,7 @@ + (NSString *)adjust_js {
 
         AdjustConfig.UrlStrategyIndia = 'UrlStrategyIndia';
         AdjustConfig.UrlStrategyChina = 'UrlStrategyChina';
+        AdjustConfig.DataResidencyEU = 'DataResidencyEU';
 
         AdjustConfig.prototype.registerCallbackHandlers = function() {
             var registerCallbackHandler = function(callbackName) {
diff --git a/AdjustTests/AdjustUnitTests/ADJPackageFields.m b/AdjustTests/AdjustUnitTests/ADJPackageFields.m
@@ -16,7 +16,7 @@ - (id) init {
 
     // default values
     self.appToken = @"qwerty123456";
-    self.clientSdk = @"ios4.26.1";
+    self.clientSdk = @"ios4.27.0";
     self.suffix = @"";
     self.environment = @"sandbox";
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+### Version 4.27.0 (17th March 2021)
+
+#### Added
+- Added data residency feature. Support for EU data residency region is added. You can choose this setting by calling `setUrlStrategy:` method of `ADJConfig` instance with `ADJDataResidencyEU` parameter.
+
+#### Changed
+- Changed the measurement consent parameter name from `sharing` to `measurement`.
+
+---
+
 ### Version 4.26.1 (5th February 2021)
 
 #### Fixed
diff --git a/README.md b/README.md
@@ -60,6 +60,7 @@ Read this in other languages: [English][en-readme], [中文][zh-readme], [日本
       * [Deep linking on iOS 9 and later](#deeplinking-setup-new)
       * [Deferred deep linking scenario](#deeplinking-deferred)
       * [Reattribution via deep links](#deeplinking-reattribution)
+   * [Data residency](#data-residency)
 * [Troubleshooting](#troubleshooting)
    * [Issues with delayed SDK initialisation](#ts-delayed-init)
    * [I'm seeing "Adjust requires ARC" error](#ts-arc)
@@ -83,13 +84,13 @@ We will describe the steps to integrate the Adjust SDK into your iOS project. We
 If you're using [CocoaPods][cocoapods], you can add the following line to your `Podfile` and continue from [this step](#sdk-integrate):
 
 ```ruby
-pod 'Adjust', '~> 4.26.1'
+pod 'Adjust', '~> 4.27.0'
 ```
 
 or:
 
 ```ruby
-pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.26.1'
+pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.27.0'
 ```
 
 ---
@@ -128,8 +129,8 @@ If you are having `iMessage` app, you can use the Adjust SDK with it as well wit
 Adjust SDK is able to get additional information in case you link additional iOS frameworks to your app. Please, add following frameworks in case you want to enable Adjust SDK features based on their presence in your app and mark them as optional:
 
 - `AdSupport.framework` - This framework is needed so that SDK can access to IDFA value and (prior to iOS 14) LAT information.
-- `iAd.framework` - This framework is needed so that SDK can automatically handle attribution for ASA campaings you might be running (to be deprecated in the future in favour of `AdServices.framework`).
-- `AdServices.framework` - This framework is needed so that SDK can automatically handle attribution for ASA campaings you might be running.
+- `iAd.framework` - This framework is needed so that SDK can automatically handle attribution for ASA campaigns you might be running (to be deprecated in the future in favour of `AdServices.framework`).
+- `AdServices.framework` - This framework is needed so that SDK can automatically handle attribution for ASA campaigns you might be running.
 - `CoreTelephony.framework` - This framework is needed so that SDK can determine current radio access technology.
 - `StoreKit.framework` - This framework is needed for access to `SKAdNetwork` framework and for Adjust SDK to handle communication with it automatically in iOS 14 or later.
 - `AppTrackingTransparency.framework` - This framework is needed in iOS 14 and later for SDK to be able to wrap user's tracking consent dialog and access to value of the user's consent to be tracked or not.
@@ -1038,6 +1039,12 @@ The call to `appWillOpenUrl` should be done like this to support deep linking re
 }
 ```
 
+### <a id="data-residency"></a>Data residency
+
+In order to enable data residency feature, make sure to make a call to `setUrlStrategy:` method of the `ADJConfig` instance with one of the following constants:
+
+- `ADJDataResidencyEU` for EU data residency region.
+
 ## <a id="troubleshooting"></a>Troubleshooting
 
 ### <a id="ts-delayed-init"></a>Issues with delayed SDK initialisation
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-4.26.1
+4.27.0
diff --git a/doc/chinese/README.md b/doc/chinese/README.md
@@ -76,13 +76,13 @@ Read this in other languages: [English][en-readme], [中文][zh-readme], [日本
 如果您正在使用[CocoaPods][cocoapods],您可以将以下代码行添加至 `Podfile`，然后继续进行[此步骤](#sdk-integrate):
 
 ```ruby
-pod 'Adjust', '~> 4.26.1'
+pod 'Adjust', '~> 4.27.0'
 ```
 
 或:
 
 ```ruby
-pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.26.1'
+pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.27.0'
 ```
 
 ---
@@ -111,12 +111,13 @@ github "adjust/ios_sdk"
 
 ### <a id="sdk-frameworks"></a>添加 iOS 框架
 
-如果您关联额外的 iOS 框架到应用中，Adjust SDK 将能获取更多的信息。请根据应用启用 Adjust SDK 功能的情况，添加下列框架：
+如果您关联额外的 iOS 框架到应用中，Adjust SDK 将能获取更多的信息。请根据应用启用 Adjust SDK 功能的情况，添加下列框架，并将其标记为 "可选" (optional)：
 
-- `AdSupport.framework` - 如果您希望 SDK 能访问 IDFA 值和 (iOS 14 以前) LAT 信息，请添加该框架。
-- `iAd.framework` - 如果您希望 SDK 自动处理您的 ASA 推广活动归因数据，请添加该框架。
-- `CoreTelephony.framework`- 如果您希望 SDK 能辨识当前的无线接入技术，请添加该框架。
-- `StoreKit.framework`- 如果您希望访问 `SKAdNetwork` 框架，同时让 Adjust SDK 在 iOS 14 或未来版本的 iOS 中自动处理与该框架的通讯，请添加该框架。
+- `AdSupport.framework` - 请务必添加该框架，让SDK 能访问 IDFA 值和 (iOS 14 以前的) LAT 信息。
+- `iAd.framework` - 如果您希望 SDK 自动处理您的 ASA 推广活动归因数据，请添加该框架 (未来将替换为 `AdServices.framework`)。
+- `AdServices.framework`- 如果您希望 SDK 自动处理您的 ASA 推广活动归因数据，请添加该框架。
+- `CoreTelephony.framework`- 如果您希望 SDK 能辨识当前的无线接入技术 (radio access)，请添加该框架。
+- `StoreKit.framework`- 如果您希望访问 `SKAdNetwork` 框架，同时让 Adjust SDK 在 iOS 14 或未来版本的 iOS 中自动处理与`SKAdNetwork` 的通讯，请添加该框架。
 - `AppTrackingTransparency.framework` - 如果您希望 SDK 能在 iOS 14 或未来版本的 iOS 中包装用户的跟踪许可对话框，并访问用户跟踪许可的值，请添加该框架。
 
 ### <a id="sdk-integrate"></a>集成SDK至您的应用
diff --git a/doc/english/migrate.md b/doc/english/migrate.md
@@ -1,4 +1,4 @@
-## Migrate your Adjust SDK for iOS to v4.26.1 from v3.4.0
+## Migrate your Adjust SDK for iOS to v4.27.0 from v3.4.0
 
 ### Initial setup
 
diff --git a/doc/english/web_views.md b/doc/english/web_views.md
@@ -64,7 +64,7 @@ We will describe the steps to integrate the Adjust SDK into your iOS project. We
 If you're using [CocoaPods][cocoapods], you can add the following line to your `Podfile` and continue from [this step](#sdk-integrate):
 
 ```ruby
-pod 'Adjust/WebBridge', '~> 4.26.1'
+pod 'Adjust/WebBridge', '~> 4.27.0'
 ```
 
 ---
diff --git a/doc/japanese/README.md b/doc/japanese/README.md
@@ -25,13 +25,13 @@ adjust SDKをiOSプロジェクトに連携する手順を説明します。
 [こちらの手順](#sdk-integrate)に進んでください。
 
 ```ruby
-pod 'Adjust', '~> 4.26.1'
+pod 'Adjust', '~> 4.27.0'
 ```
 
 または
 
 ```ruby
-pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.26.1'
+pod 'Adjust', :git => 'https://github.com/adjust/ios_sdk.git', :tag => 'v4.27.0'
 ```
 
 ---
@@ -68,6 +68,7 @@ StaticかDynamicフレームワークを選択し、プロジェクトに追加
 
 - `AdSupport.framework` - SDKがIDFA値および（iOS 14より前の）LAT情報を呼び出せるようにします。
 - `iAd.framework` - SDKが実行中のASAキャンペーンのアトリビューションを自動的に処理できるようにします。
+- `AdServices.framework`- SDKが実行中のASAキャンペーンのアトリビューションを自動的に処理できるようにします。
 - `CoreTelephony.framework`- SDKが現在のRadio Access Technology（無線アクセス技術）を判別できるようにします。
 - `StoreKit.framework`- iOS 14またはそれ以降において、このフレームワークは「SKAdNetwork」のフレームワークにアクセスし、「SKAdNetwork」との通信をAdjust SDKで自動的に処理できるようにします。
 - `AppTrackingTransparency.framework` -iOS 14またはそれ以降において、このフレームワークはSDKがトラッキングに対するユーザー同意を確認するダイアログをラップし、ユーザーの許諾状況を示す値にアクセスできるようにします。
diff --git a/doc/japanese/web_views.md b/doc/japanese/web_views.md
diff --git a/doc/korean/README.md b/doc/korean/README.md
diff --git a/doc/korean/web_views.md b/doc/korean/web_views.md
diff --git a/doc/migrate.md b/doc/migrate.md

Original file line number	Diff line number	Diff line change
`@@ -1725,9 +1725,11 @@ - (BOOL)shouldFetchAdServicesI:(ADJActivityHandler *)selfI {`
`1725`	`1725`	`- (void)checkForAdServicesAttributionI:(ADJActivityHandler *)selfI {`
`1726`	`1726`	`if (@available(iOS 14.3, tvOS 14.3, *)) {`
`1727`	`1727`	`if ([selfI shouldFetchAdServicesI:selfI]) {`
`1728`		`- NSError *error = nil;`
`1729`		`- NSString *token = [[UIDevice currentDevice] adjFetchAdServicesAttribution:&error];`
`1730`		`- [selfI setAdServicesAttributionToken:token error:error];`
	`1728`	`+ dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{`
	`1729`	`+ NSError *error = nil;`
	`1730`	`+ NSString *token = [[UIDevice currentDevice] adjFetchAdServicesAttribution:&error];`
	`1731`	`+ [selfI setAdServicesAttributionToken:token error:error];`
	`1732`	`+ });`
`1731`	`1733`	`}`
`1732`	`1734`	`}`
`1733`	`1735`	`}`