Merge pull request #46 from AppsFlyerSDK/releases/6.x.x/6.0.x/6.0.7

6.0.7

Author: wesfieldj

Assets/AppsFlyer/AppsFlyer.cs

@@ -6,7 +6,7 @@ namespace AppsFlyerSDK
     public class AppsFlyer : MonoBehaviour
     {
 
-        public static readonly string kAppsFlyerPluginVersion = "6.0.6";
+        public static readonly string kAppsFlyerPluginVersion = "6.0.7";
 
 
         /// <summary>

Assets/AppsFlyer/Editor/AppsFlyerDependencies.xml

@@ -11,7 +11,7 @@
   </androidPackages>
 
   <iosPods>
-    <iosPod name="AppsFlyerFramework" version="6.0.5" minTargetSdk="8.0">
+    <iosPod name="AppsFlyerFramework" version="6.0.7" minTargetSdk="8.0">
     </iosPod>
   </iosPods>
 

Assets/AppsFlyer/Plugins/iOS/AppsFlyer+AppController.m

@@ -27,35 +27,33 @@ @implementation UnityAppController (AppsFlyerSwizzledAppController)
 + (void)load {
     static dispatch_once_t onceToken;
     dispatch_once(&onceToken, ^{
+
+        id swizzleFlag = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"AppsFlyerShouldSwizzle"];
+        BOOL shouldSwizzle = swizzleFlag ? [swizzleFlag boolValue] : NO;
 
-        /** <remove comment if you are swizzling applicationDidBecomeActive>
-         Method method1 = class_getInstanceMethod([self class], @selector(applicationDidBecomeActive:));
-         __original_applicationDidBecomeActive_Imp = method_setImplementation(method1, (IMP)__swizzled_applicationDidBecomeActive);
-         */
-        
-        /** <remove comment if you are swizzling applicationDidEnterBackground>
-         Method method2 = class_getInstanceMethod([self class], @selector(applicationDidEnterBackground:));
-         __original_applicationDidEnterBackground_Imp = method_setImplementation(method2, (IMP)__swizzled_applicationDidEnterBackground);
-         */
-        
-        /** <remove comment if you are swizzling didReceiveRemoteNotification>
-         Method method3 = class_getInstanceMethod([self class], @selector(didReceiveRemoteNotification:));
-         __original_didReceiveRemoteNotification_Imp = method_setImplementation(method3, (IMP)__swizzled_didReceiveRemoteNotification);
-         */
-
-        /** <remove comment if you are swizzling openURL>
-         Method method4 = class_getInstanceMethod([self class], @selector(application:openURL:options:));
-         __original_openUrl_Imp = method_setImplementation(method4, (IMP)__swizzled_openURL);
-         */
-
-        /** <remove comment if you are swizzling continueUserActivity>
-        [self swizzleContinueUserActivity:[self class]];
-        */
-        
+        if(shouldSwizzle){
+            
+            Method method1 = class_getInstanceMethod([self class], @selector(applicationDidBecomeActive:));
+            __original_applicationDidBecomeActive_Imp = method_setImplementation(method1, (IMP)__swizzled_applicationDidBecomeActive);
+                    
+            Method method2 = class_getInstanceMethod([self class], @selector(applicationDidEnterBackground:));
+            __original_applicationDidEnterBackground_Imp = method_setImplementation(method2, (IMP)__swizzled_applicationDidEnterBackground);
+            
+           
+            Method method3 = class_getInstanceMethod([self class], @selector(didReceiveRemoteNotification:));
+            __original_didReceiveRemoteNotification_Imp = method_setImplementation(method3, (IMP)__swizzled_didReceiveRemoteNotification);
+            
+           
+            Method method4 = class_getInstanceMethod([self class], @selector(application:openURL:options:));
+            __original_openUrl_Imp = method_setImplementation(method4, (IMP)__swizzled_openURL);
+            
+           
+            [self swizzleContinueUserActivity:[self class]];
+        }
+
     });
 }
 
-/** <remove comment if you are swizzling continueUserActivity>
 +(void)swizzleContinueUserActivity:(Class)class {
 
     SEL originalSelector = @selector(application:continueUserActivity:restorationHandler:);
@@ -71,70 +69,66 @@ +(void)swizzleContinueUserActivity:(Class)class {
         class_replaceMethod(class, originalSelector, (IMP)__swizzled_continueUserActivity, method_getTypeEncoding(swizzledMethod));
     }
 }
- 
- BOOL __swizzled_continueUserActivity(id self, SEL _cmd, UIApplication* application, NSUserActivity* userActivity, void (^restorationHandler)(NSArray*)) {
- NSLog(@"swizzled continueUserActivity");
-      [[AppsFlyerLib shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
- 
- if(__original_continueUserActivity_Imp){
- return ((BOOL(*)(id, SEL, UIApplication*, NSUserActivity*))__original_continueUserActivity_Imp)(self, _cmd, application, userActivity);
- }
- 
- return YES;
- }
- 
-*/
-
-/** <remove comment if you are swizzling applicationDidBecomeActive>
+
+BOOL __swizzled_continueUserActivity(id self, SEL _cmd, UIApplication* application, NSUserActivity* userActivity, void (^restorationHandler)(NSArray*)) {
+    NSLog(@"swizzled continueUserActivity");
+    [[AppsFlyerLib shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
+    
+    if(__original_continueUserActivity_Imp){
+        return ((BOOL(*)(id, SEL, UIApplication*, NSUserActivity*))__original_continueUserActivity_Imp)(self, _cmd, application, userActivity);
+    }
+    
+    return YES;
+}
+
+
+
 void __swizzled_applicationDidBecomeActive(id self, SEL _cmd, UIApplication* launchOptions) {
     NSLog(@"swizzled applicationDidBecomeActive");
 
     if(didEnteredBackGround){
-        [[[AppsFlyerLib shared] start];
+        [[AppsFlyerLib shared] start];
     }
 
     if(__original_applicationDidBecomeActive_Imp){
         ((void(*)(id,SEL, UIApplication*))__original_applicationDidBecomeActive_Imp)(self, _cmd, launchOptions);
     }
 }
- */
 
-/** <remove comment if you are swizzling applicationDidEnterBackground>
+
 void __swizzled_applicationDidEnterBackground(id self, SEL _cmd, UIApplication* application) {
     NSLog(@"swizzled applicationDidEnterBackground");
     didEnteredBackGround = YES;
     if(__original_applicationDidEnterBackground_Imp){
         ((void(*)(id,SEL, UIApplication*))__original_applicationDidEnterBackground_Imp)(self, _cmd, application);
     }
 }
- */
 
-/** <remove comment if you are swizzling didReceiveRemoteNotification>
+
 BOOL __swizzled_didReceiveRemoteNotification(id self, SEL _cmd, UIApplication* application, NSDictionary* userInfo,void (^UIBackgroundFetchResult)(void) ) {
     NSLog(@"swizzled didReceiveRemoteNotification");
-
-   [[AppsFlyerLib shared] handlePushNotification:userInfo];
-
+    
+    [[AppsFlyerLib shared] handlePushNotification:userInfo];
+    
     if(__original_didReceiveRemoteNotification_Imp){
         return ((BOOL(*)(id, SEL, UIApplication*, NSDictionary*, (UIBackgroundFetchResult)))__original_didReceiveRemoteNotification_Imp)(self, _cmd, application, userInfo, nil);
     }
     return YES;
 }
- */
 
-/** <remove comment if you are swizzling openURL>
+
+
 BOOL __swizzled_openURL(id self, SEL _cmd, UIApplication* application, NSURL* url, NSDictionary * options) {
     NSLog(@"swizzled openURL");
-     [[AppsFlyerLib shared] handleOpenUrl:url options:options];
+    [[AppsFlyerLib shared] handleOpenUrl:url options:options];
     if(__original_openUrl_Imp){
         return ((BOOL(*)(id, SEL, UIApplication*, NSURL*, NSDictionary*))__original_openUrl_Imp)(self, _cmd, application, url, options);
     }
     return YES;
 }
-*/
 
-@end
 
+@end
 
 
 

Assets/AppsFlyer/Plugins/iOS/AppsFlyerAppController.mm

@@ -32,7 +32,13 @@ - (instancetype)init
 {
     self = [super init];
     if (self) {
-        UnityRegisterAppDelegateListener(self);
+        
+        id swizzleFlag = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"AppsFlyerShouldSwizzle"];
+        BOOL shouldSwizzle = swizzleFlag ? [swizzleFlag boolValue] : NO;
+        
+        if(!shouldSwizzle){
+            UnityRegisterAppDelegateListener(self);
+        }
     }
     return self;
 }

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Versions
 
+
+## v6.0.7
+
+* RD-49435 - ios swizzle options fix
+* iOS SDK Version - 6.0.7
+
+
 ## v6.0.6
 
 * RD-48888 - continueUserActivity remove super call

README.md

@@ -21,7 +21,7 @@
 ### <a id="plugin-build-for"> This plugin is built for
 
 - Android AppsFlyer SDK **v5.4.3** 
-- iOS AppsFlyer SDK **v6.0.5**
+- iOS AppsFlyer SDK **v6.0.7**
 
 
 

appsflyer-unity-plugin-6.0.6.unitypackage

@@ -4,7 +4,7 @@ echo "Start Build for appsflyer-unity-plugin.unitypackage"
 
 DEPLOY_PATH=outputs
 UNITY_PATH="/Applications/Unity/Unity.app/Contents/MacOS/Unity"
-PACKAGE_NAME="appsflyer-unity-plugin-6.0.6.unitypackage"
+PACKAGE_NAME="appsflyer-unity-plugin-6.0.7.unitypackage"
 mkdir -p $DEPLOY_PATH
 
 
@@ -20,7 +20,7 @@ mkdir -p $DEPLOY_PATH
 Assets \
 $PWD/$DEPLOY_PATH/$PACKAGE_NAME \
 -quit \
-&& echo "package exported successfully to outputs/appsflyer-unity-plugin-6.0.6.unitypackage" \
+&& echo "package exported successfully to outputs/appsflyer-unity-plugin-6.0.7.unitypackage" \
 || echo "Failed to export package. See create_unity_core.log for more info."
 
 

appsflyer-unity-plugin-6.0.7.unitypackage

@@ -0,0 +1,49 @@
+# iOS Swizzling Guide 
+
+* AppsFlyer Unity Plugin uses the [iOS life cycle](https://developer.apple.com/documentation/uikit/app_and_environment/managing_your_app_s_life_cycle) events for the SDK to work. 
+* The plugins uses [UnityAppController](https://docs.unity3d.com/Manual/UnityasaLibrary-iOS.html) for the lifecycle events to be invoked.
+* Sometimes other plugins (Firebase, Facebook, ect) use the same UnityAppController, which creates conflicts in the lifecycle events.
+* These events include didBecomeActive, didEnterBackground, didReceiveRemoteNotification, continueUserActivity and openURL.
+* When a conflict occurs these methods may not be invoked. 
+* The solution provided by the AppsFlyer Unity Plugin is [Swizzling](https://medium.com/rocknnull/ios-to-swizzle-or-not-to-swizzle-f8b0ed4a1ce6).
+* Starting from `v6.0.7` there is an option to enable swizzling automatically. 
+* To enable swizzling, in the info.plist file, a boolean K/V called `AppsFlyerShouldSwizzle` should be set to 1 (true).
+* This will automatically enable swizzling and solve conflicts with other plugins.
+* This can also be accomplished on the c# side by following these steps:
+
+1. Create a new c# script. (we called ours AFUpdatePlist.cs)
+2. Place the script in a editor folder (Assets > Editor > AFUpdatePlist.cs)
+3. The code in the script should look like this:
+
+```c#
+using System.IO;
+using UnityEngine;
+using UnityEditor;
+using UnityEditor.Callbacks;
+using UnityEditor.iOS.Xcode;
+
+public class MyBuildPostprocessor {
+    
+    [PostProcessBuildAttribute]
+    public static void OnPostprocessBuild(BuildTarget target, string pathToBuiltProject) {
+        
+        if (target == BuildTarget.iOS)
+        {
+            string plistPath = pathToBuiltProject + "/Info.plist";
+            PlistDocument plist = new PlistDocument();
+            plist.ReadFromString(File.ReadAllText(plistPath));
+            
+            PlistElementDict rootDict = plist.root;
+            rootDict.SetBoolean("AppsFlyerShouldSwizzle", true);
+            
+            File.WriteAllText(plistPath, plist.WriteToString());
+            
+            Debug.Log("Info.plist updated with AppsFlyerShouldSwizzle");
+        }
+        
+    }
+}
+```
+
+4. Validate that the code in the [AppsFlyer+AppController](https://github.com/AppsFlyerSDK/appsflyer-unity-plugin/blob/master/Assets/AppsFlyer/Plugins/iOS/AppsFlyer%2BAppController.m) is called on the native side.
+