Custom metrics feature added (#58)

* Custom Metric override feature added.

* SDK version updated to 20.11.7

* Index issue fixed

* Removed metrics enum

* Safe checks added

* Example added for custom metrics

* Removed extra data from custom metrics example

* — Added checks in 'setCustomMetrics' function for data validation of metrics passed by user.
— Updated documentation for 'setCustomMetrics' function

* Update setCustomMetrics function to async for await usage

* — Warning text updated
— length check added
— changed if to else if

* Changing metric comment

* Rework of if else statements and added return statements

Co-authored-by: ArtursKadikis <[email protected]>

Author: ijunaid

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 20.11.7
+* Added "setCustomMetrics" method to set the metrics you want to override
+
 ## 20.11.6
 * !! To handle the push notification you need to add the notifcation callback "didReceiveNotificationResponse" in your "AppDelegate.m" file and send the reponse to Countly SDK using this function "onNotificationResponse", for more detials please check the below mentioned link of "Handling push callbacks" section in Countly SDK documentation.
 https://support.count.ly/hc/en-us/articles/360037813231-React-Native-Bridge-#handling-push-callbacks

Countly.js

@@ -844,6 +844,43 @@ Countly.appLoadingFinished = async function(){
     CountlyReactNative.appLoadingFinished()
   }
 
+  /**
+   * Set the metrics you want to override
+   * Should be called before Countly init
+   * @param {Object} customMetric - metric with key/value pair
+   * Supported data type for customMetric values is String
+   */
+  Countly.setCustomMetrics = async function(customMetric){
+    if(!customMetric) {
+        if(await CountlyReactNative.isLoggingEnabled()) {
+            console.error("[CountlyReactNative] setCustomMetrics, customMetric should not be null or undefined");
+        }
+        return "customMetric should not be null or undefined";
+    }
+    if(typeof customMetric !== 'object'){
+        if(await CountlyReactNative.isLoggingEnabled()) {
+            console.warn("[CountlyReactNative] setCustomMetrics, unsupported data type of customMetric '" + (typeof customMetric) + "'");
+        }
+        return "Unsupported data type of customMetric '" + (typeof customMetric) + "'";
+    }
+    var args = [];
+    customMetric = customMetric || {};
+    for(var key in customMetric){
+        if (typeof customMetric[key] == "string") {
+            args.push(key.toString());
+            args.push(customMetric[key].toString());
+        }
+        else {
+            if(await CountlyReactNative.isLoggingEnabled()) {
+                console.warn("[CountlyReactNative] setCustomMetrics, skipping value for key '" + key.toString() + "', due to unsupported data type '" + (typeof customMetric[key]) + "'");
+            }
+        }
+    }
+    if(args.length != 0) {
+        CountlyReactNative.setCustomMetrics(args);
+    }
+}
+
 /*
 Countly.initNative = function(){
     CountlyReactNative.initNative();

CountlyReactNative.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'CountlyReactNative'
-  s.version = '20.11.6'
+  s.version = '20.11.7'
   s.license = {
     :type => 'COMMUNITY',
     :text => <<-LICENSE

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

@@ -74,7 +74,7 @@ public String toString(){
 public class CountlyReactNative extends ReactContextBaseJavaModule implements LifecycleEventListener {
 
     public static final String TAG = "CountlyRNPlugin";
-    private String COUNTLY_RN_SDK_VERSION_STRING = "20.11.6";
+    private String COUNTLY_RN_SDK_VERSION_STRING = "20.11.7";
     private String COUNTLY_RN_SDK_NAME = "js-rnb-android";
 
     private static CountlyConfig config = new CountlyConfig();
@@ -1015,6 +1015,21 @@ public void recordAttributionID(ReadableArray args){
     public void appLoadingFinished(){
         Countly.sharedInstance().apm().setAppIsLoaded();
     }
+
+    @ReactMethod
+    public void setCustomMetrics(ReadableArray args){
+        Map<String, String> customMetric = new HashMap<>();
+        for (int i = 0, il = args.size(); i < il; i += 2) {
+            try{
+                if(i+1 < il) {
+                    customMetric.put(args.getString(i), args.getString(i + 1));
+                }
+            }catch(Exception exception){
+                log("setCustomMetrics, could not parse metrics, skipping it. ", LogLevel.ERROR);
+            }
+        }
+        this.config.setMetricOverride(customMetric);
+    }
 
     enum LogLevel {INFO, DEBUG, VERBOSE, WARNING, ERROR}
     static void log(String message, LogLevel logLevel)  {

example/Example.js

@@ -431,6 +431,13 @@ class Example extends Component {
         Countly.testCrash();
     }
     */
+  setCustomMetrics(){
+    var customMetric = {
+      "_carrier": "Custom Carrier"
+    };
+    Countly.setCustomMetrics(customMetric);
+  }
+  
 
     test(){
       this.onInit();
@@ -534,6 +541,7 @@ class Example extends Component {
             < Button onPress = { this.showNPS } title = "Show NPS" color = "#00b5ad"> </Button>
             < Button onPress = { this.eventSendThreshold } title = "Set Event Threshold" color = "#00b5ad"> </Button>
             < Button onPress = { this.setCustomCrashSegments } title = "Set Custom Crash Segment" color = "#00b5ad"> </Button>
+            < Button onPress = { this.setCustomMetrics } title = "Set Custom Metrics" color = "#00b5ad"> </Button>
             <Text style={[{textAlign: 'center'}]}>Other Methods End</Text>
             <Text style={[{textAlign: 'center'}]}>.</Text>
 

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].6
+yarn add [email protected].7
 
 cd ./ios
 pod install

ios/src/CountlyReactNative.h

@@ -64,6 +64,7 @@ typedef void (^Result)(id _Nullable result);
 - (void)endTrace:(NSArray*_Nullable)arguments;
 - (void)recordNetworkTrace:(NSArray*_Nullable)arguments;
 - (void)enableApm:(NSArray*_Nullable)arguments;
+- (void)setCustomMetrics:(NSArray*_Nullable)arguments;
 
 - (void)enableAttribution;
 - (void)recordAttributionID:(NSArray*_Nullable)arguments;

ios/src/CountlyReactNative.m

@@ -21,7 +21,7 @@ @interface CountlyFeedbackWidget ()
 + (CountlyFeedbackWidget *)createWithDictionary:(NSDictionary *)dictionary;
 @end
 
-NSString* const kCountlyReactNativeSDKVersion = @"20.11.6";
+NSString* const kCountlyReactNativeSDKVersion = @"20.11.7";
 NSString* const kCountlyReactNativeSDKName = @"js-rnb-ios";
 
 CountlyConfig* config = nil;
@@ -1056,6 +1056,18 @@ + (void) log: (NSString *) theMessage{
   });
 }
 
+RCT_EXPORT_METHOD(setCustomMetrics:(NSArray*)arguments) {
+    dispatch_async(dispatch_get_main_queue(), ^ {
+        NSMutableDictionary *metrics = [[NSMutableDictionary alloc] init];
+        for(int i=0,il=(int)arguments.count;i<il;i+=2){
+          if(i+1 < il){
+            metrics[[arguments objectAtIndex:i]] = [arguments objectAtIndex:i+1];
+          }
+        }
+        config.customMetrics = metrics;
+    });
+}
+
 - (void)addCountlyFeature:(CLYFeature)feature
 {
     if(countlyFeatures == nil) {

package.json

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