Added activity null checks. Reworked attribution for ios. Increased SDK version. Merge pull request #29 from Countly/dev-junaid

Author: ArtursKadikis

CHANGELOG.md

@@ -1,3 +1,5 @@
+## 20.4.8
+* Added "recordAttributionID" call to support changes in iOS 14 related to App Tracking Permission.
 ## 20.4.7
 * Adding call to set consent during init
 

Countly.js

@@ -119,8 +119,8 @@ Countly.recordView = function(recordView, segments){
 
 /**
  * 
- * Set Push notification messaging mode and callbacks for push notifications
- * Should be call after Countly init
+ * Set messaging mode for push notifications
+ * Should be call before Countly init
  */
 Countly.pushTokenType = function(tokenType, channelName, channelDescription){
     var args = [];
@@ -674,10 +674,36 @@ Countly.enableApm = function(){
 /**
  * 
  * Enable campaign attribution reporting to Countly.
+ * For iOS use "recordAttributionID" instead of "enableAttribution"
  * Should be call before Countly init
  */
-Countly.enableAttribution = function() {
-    CountlyReactNative.enableAttribution();
+Countly.enableAttribution = async function(attributionID = "") {
+    if (Platform.OS.match("ios")) {
+        if(attributionID == "") {
+            if(await CountlyReactNative.isLoggingEnabled()) {
+                console.error("[CountlyReactNative] enableAttribution, attribution Id for iOS can't be empty string");
+            }
+            return "attribution Id for iOS can't be empty string";
+        }
+        Countly.recordAttributionID(attributionID);
+    }
+    else {
+        CountlyReactNative.enableAttribution();
+    }
+}
+
+/**
+ * 
+ * set attribution Id for campaign attribution reporting.
+ * Currently implemented for iOS only
+ * For Android just call the enableAttribution to enable campaign attribution.
+ */
+
+Countly.recordAttributionID = function(attributionID){
+    if (!Platform.OS.match("ios")) return "recordAttributionID : To be implemented";
+    var args = [];
+    args.push(attributionID);
+    CountlyReactNative.recordAttributionID(args);
 }
 
 /*

android/src/main/java/ly/count/android/sdk/react/CountlyReactNative.java

@@ -66,7 +66,7 @@ public String toString(){
 
 public class CountlyReactNative extends ReactContextBaseJavaModule {
 
-    public static final String TAG = "CountlyReactNative";
+    public static final String TAG = "CountlyReactNativePlugin";
     private String COUNTLY_RN_SDK_VERSION_STRING = "20.04.7";
     private String COUNTLY_RN_SDK_NAME = "js-rnb-android";
 
@@ -119,8 +119,13 @@ public void init(ReadableArray args, Promise promise){
           Countly.sharedInstance().COUNTLY_SDK_VERSION_STRING = COUNTLY_RN_SDK_VERSION_STRING;
 
         this.config.setContext(_reactContext);
-        Activity activity = getCurrentActivity();
-        this.config.setApplication(activity.getApplication());
+        Activity activity = getActivity();
+        if (activity != null) {
+            this.config.setApplication(activity.getApplication());
+        }
+        else {
+            log("init, Activity is null, some features will not work", LogLevel.WARNING);
+        }
         if(deviceId == null || "".equals(deviceId)){
         }else{
             if(deviceId.equals("TemporaryDeviceID")){
@@ -504,7 +509,11 @@ public void callback(String result) {
 
     @ReactMethod
     public void askForNotificationPermission(ReadableArray args){
-        Activity activity = this._reactContext.getCurrentActivity();
+        Activity activity = this.getActivity();
+        if (activity == null) {
+            log("askForNotificationPermission failed, Activity is null", LogLevel.ERROR);
+            return;
+        }
         Context context = this._reactContext;
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
             NotificationManager notificationManager = (NotificationManager) context.getSystemService(context.NOTIFICATION_SERVICE);
@@ -532,7 +541,12 @@ public void onComplete(Task<InstanceIdResult> task) {
 
     @ReactMethod
     public void start(){
-        Countly.sharedInstance().onStart(getCurrentActivity());
+        Activity activity = this.getActivity();
+        if (activity == null) {
+            log("start failed, Activity is null", LogLevel.ERROR);
+            return;
+        }
+        Countly.sharedInstance().onStart(activity);
     }
 
     @ReactMethod
@@ -778,7 +792,11 @@ public void remoteConfigClearValues(Promise promise){
 
     @ReactMethod
     public void showStarRating(ReadableArray args, final Callback callback){
-        Activity activity = getCurrentActivity();
+        Activity activity = getActivity();
+        if (activity == null) {
+            log("showStarRating failed, Activity is null", LogLevel.ERROR);
+            return;
+        }
         Countly.sharedInstance().ratings().showStarRating(activity, new StarRatingCallback(){
 
             @Override
@@ -796,9 +814,13 @@ public void onDismiss() {
 
     @ReactMethod
     public void showFeedbackPopup(ReadableArray args){
+        Activity activity = getActivity();
+        if (activity == null) {
+            log("showFeedbackPopup failed, Activity is null", LogLevel.ERROR);
+            return;
+        }
         String widgetId = args.getString(0);
         String closeFeedBackButton = args.getString(1);
-        Activity activity = getCurrentActivity();
         Countly.sharedInstance().ratings().showFeedbackPopup( widgetId, closeFeedBackButton, activity, null);
     }
 
@@ -864,6 +886,12 @@ public void enableApm(ReadableArray args){
     public void enableAttribution(){
         this.config.setEnableAttribution(true);
     }
+
+    @ReactMethod
+    public void recordAttributionID(ReadableArray args){
+        String attributionID = args.getString(0);
+        log("recordAttributionID: Not implemented for Android");
+    }
 
     enum LogLevel {INFO, DEBUG, VERBOSE, WARNING, ERROR}
     static void log(String message, LogLevel logLevel)  {
@@ -893,4 +921,13 @@ static void log(String message, Throwable tr, LogLevel logLevel)  {
         }
     }
 
+    Activity getActivity() {
+        Activity activity = getCurrentActivity();
+        if(activity == null && _reactContext != null)
+        {
+            activity = _reactContext.getCurrentActivity();
+        }
+        return activity;
+    }
+
 }

example/Example.js

@@ -1,6 +1,17 @@
 import React, { Component } from 'react';
 import { Text, Button, ScrollView, Image, View, Alert } from 'react-native';
 import Countly from 'countly-sdk-react-native-bridge';
+/*
+First add "react-native-permissions" and "react-native-idfa" plugins to implement the attribution feature for iOS.
+Here is the link of both plugins:
+https://www.npmjs.com/package/react-native-permissions
+https://www.npmjs.com/package/react-native-idfa
+
+Here is the required import from above mentioned plugins
+
+import {request, PERMISSIONS, RESULTS} from 'react-native-permissions';
+import { IDFA } from 'react-native-idfa';
+*/
 
 var successCodes = [100, 101, 200, 201, 202, 205, 300, 301, 303, 305];
 var failureCodes = [400, 402, 405, 408, 500, 501, 502, 505];
@@ -53,15 +64,61 @@ class Example extends Component {
         // Countly.pinnedCertificates("count.ly.cer"); // It will ensure that connection is made with one of the public keys specified
         // Countly.setHttpPostForced(false); // Set to "true" if you want HTTP POST to be used for all requests
         Countly.enableApm(); // Enable APM features, which includes the recording of app start time.
-        Countly.enableAttribution(); // Enable to measure your marketing campaign performance by attributing installs from specific campaigns.
+        Countly.pushTokenType(Countly.messagingMode.DEVELOPMENT, "Channel Name", "Channel Description"); // Set messaging mode for push notifications
+        if (!Platform.OS.match("ios")){
+          Countly.enableAttribution(); // Enable to measure your marketing campaign performance by attributing installs from specific campaigns.
+        }
+        /*
+        For iOS 14+ apple changes regarding app tracking you need to ask the user for permission to track app.
+        For permission you can use this plugin
+        https://www.npmjs.com/package/react-native-permissions
+
+        For IDFA you can use this plugin
+        https://www.npmjs.com/package/react-native-idfa
+        
+        Below is the example app that how you can use both these plugins Countly SDK iOS attibution feature.
+
+        if (Platform.OS.match("ios")) {
+        request(PERMISSIONS.IOS.APP_TRACKING_TRANSPARENCY)
+          .then((result) => {
+            switch (result) {
+              case RESULTS.UNAVAILABLE:
+                console.log(
+                  'This feature is not available (on this device / in this context)',
+                );
+                break;
+              case RESULTS.DENIED:
+                console.log(
+                  'The permission has not been requested / is denied but requestable',
+                );
+                break;
+              case RESULTS.GRANTED:
+                console.log('The permission is granted');
+                IDFA.getIDFA().then((idfa) => {
+                  console.log('idfa : ' + idfa);
+                  Countly.recordAttributionID(idfa);
+                })
+                .catch((e) => {
+                  console.error(e);
+                });
+                break;
+              case RESULTS.BLOCKED:
+                console.log('The permission is denied and not requestable anymore');
+                break;
+            }
+          })
+          .catch((error) => {
+            // …
+          });
+        }
+        */
 
         await Countly.init("https://master.count.ly", "5b77e4c785410351f32d8aa286d2383195d13b93", "123456"); // Initialize the countly SDK.
 
         /** 
          * Push notifications settings 
          * Should be call after init
         */
-        Countly.pushTokenType(Countly.messagingMode.DEVELOPMENT, "Channel Name", "Channel Description"); // Set messaging mode for push notifications
         Countly.registerForNotification(function(theNotification){
           console.log("Just received this notification data: " + JSON.stringify(theNotification));
           alert('theNotification: ' + JSON.stringify(theNotification));

example/install.sh

@@ -11,7 +11,7 @@ rm App.js
 curl https://raw.githubusercontent.com/Countly/countly-sdk-react-native-bridge/master/example/App.js --output App.js
 curl https://raw.githubusercontent.com/Countly/countly-sdk-react-native-bridge/master/example/Example.js --output Example.js
 
-yarn add [email protected].7
+yarn add [email protected].8
 
 cd ./ios
 pod install

ios/src/CountlyReactNative.h

@@ -63,4 +63,5 @@ typedef void (^Result)(id _Nullable result);
 - (void)enableApm:(NSArray*_Nullable)arguments;
 
 - (void)enableAttribution;
+- (void)recordAttributionID:(NSArray*_Nullable)arguments;
 @end

ios/src/CountlyReactNative.m

@@ -941,6 +941,21 @@ + (void) log: (NSString *) theMessage{
   });
 }
 
+RCT_EXPORT_METHOD(recordAttributionID:(NSArray*)arguments) {
+    dispatch_async(dispatch_get_main_queue(), ^ {
+        NSString* attributionID = [arguments objectAtIndex:0];
+        if(CountlyCommon.sharedInstance.hasStarted) {
+          [Countly.sharedInstance recordAttributionID: attributionID];
+        }
+        else {
+          if (config == nil){
+            config = CountlyConfig.new;
+          }
+          config.attributionID = attributionID;
+        }
+    });
+}
+
 - (void)addCountlyFeature:(CLYFeature)feature
 {
     if(countlyFeatures == nil) {
@@ -972,7 +987,7 @@ void CountlyRNInternalLog(NSString *format, ...)
     va_start(args, format);
 
     NSString* logString = [NSString.alloc initWithFormat:format arguments:args];
-    NSLog(@"[CountlyReactNative] %@", logString);
+    NSLog(@"[CountlyReactNativePlugin] %@", logString);
 
     va_end(args);
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "countly-sdk-react-native-bridge",
-  "version": "20.4.7",
+  "version": "20.4.8",
   "author": "Countly <[email protected]> (https://count.ly/)",
   "bugs": {
     "url": "https://github.com/Countly/countly-sdk-react-native-bridge/issues"