Merge pull request #410 from Countly/deviceId-interface

Device Id Interface Added

Author: turtledreams

CHANGELOG.md

@@ -4,10 +4,14 @@
   * During an internal timer tick
   * Upon flushing the event queue
 * Added Content feature methods:
-  * enterContentZone, to start Content checks (Experimental!)
-  * exitContentZone, to stop Content checks (Experimental!)
+  * `enterContentZone`, to start Content checks (Experimental!)
+  * `exitContentZone`, to stop Content checks (Experimental!)
+* Added `Countly.deviceId.setID` method for changing device ID based on the device ID type
 * Mitigated an issue where a session could have started while the app was in the background when the device ID was changed (non-merge).
-
+* Deprecated following SDK calls:
+  * `Countly.getCurrentDeviceId` (replaced with: `Countly.deviceId.getID`)
+  * `Countly.getDeviceIDType` (replaced with: `Countly.deviceId.getType`)
+  * `Countly.changeDeviceId` (replaced with: `Countly.deviceId.setID`)
 * Android Specific Changes:
   * ! Minor breaking change ! Unsupported types for user properties will now be omitted, they won't be converted to strings.
   * Disabled caching for webviews.

Countly.d.ts

@@ -402,7 +402,8 @@ declare module "countly-sdk-react-native-bridge" {
     export function disableLocation(): string | void;
 
     /**
-     *
+     * @deprecated use 'Countly.deviceId.getID' instead of 'Countly.getCurrentDeviceId'
+     * 
      * Get currently used device Id.
      * Should be called after Countly init
      *
@@ -411,6 +412,8 @@ declare module "countly-sdk-react-native-bridge" {
     export function getCurrentDeviceId(): Promise<string> | string;
 
     /**
+     * @deprecated use 'Countly.deviceId.getType' instead of 'Countly.getDeviceIDType'
+     * 
      * Get currently used device Id type.
      * Should be called after Countly init
      *
@@ -419,6 +422,8 @@ declare module "countly-sdk-react-native-bridge" {
     export function getDeviceIDType(): Promise<DeviceIdType> | null;
 
     /**
+     * @deprecated use 'Countly.deviceId.setID' instead of 'Countly.changeDeviceId'
+     * 
      * Change the current device id
      *
      * @param {string} newDeviceID id new device id
@@ -427,6 +432,34 @@ declare module "countly-sdk-react-native-bridge" {
      */
     export function changeDeviceId(newDeviceID: string, onServer: boolean): string | void;
 
+    namespace deviceId {
+      /**
+       * 
+       * Get currently used device ID.
+       * Should be called after Countly init
+       *
+       * @returns {string | null} device ID or null
+       */
+      export function getID(): Promise<string> | string;
+
+      /**
+       * 
+       * Get currently used device ID type.
+       * Should be called after Countly init
+       *
+       * @return {DeviceIdType | null} deviceIdType or null
+       */
+      export function getType(): Promise<DeviceIdType> | null;
+
+      /**
+       * Sets device ID according to the device ID Type.
+       * If previous ID was Developer Supplied sets it without merge, otherwise with merge.
+       *
+       * @param {string} newDeviceID device ID to set
+       */
+      export function setID(newDeviceID: string): void;
+    }
+
     /**
      *
      * Set to "true" if you want HTTP POST to be used for all requests

Countly.js

@@ -10,6 +10,7 @@ import CountlyConfig from "./CountlyConfig.js";
 import CountlyState from "./CountlyState.js";
 import Feedback from "./Feedback.js";
 import Event from "./Event.js";
+import DeviceId from "./DeviceId.js";
 import * as L from "./Logger.js";
 import * as Utils from "./Utils.js";
 import * as Validate from "./Validators.js";
@@ -26,6 +27,7 @@ CountlyState.eventEmitter = eventEmitter;
 
 Countly.feedback = new Feedback(CountlyState);
 Countly.events = new Event(CountlyState);
+Countly.deviceId = new DeviceId(CountlyState);
 
 let _isCrashReportingEnabled = false;
 
@@ -458,7 +460,8 @@ Countly.disableLocation = function () {
 };
 
 /**
- *
+ * @deprecated use 'Countly.deviceId.getID' instead of 'Countly.getCurrentDeviceId'
+ * 
  * Get currently used device Id.
  * Should be called after Countly init
  *
@@ -476,6 +479,8 @@ Countly.getCurrentDeviceId = async function () {
 };
 
 /**
+ * @deprecated use 'Countly.deviceId.getType' instead of 'Countly.getDeviceIDType'
+ * 
  * Get currently used device Id type.
  * Should be called after Countly init
  *
@@ -492,7 +497,9 @@ Countly.getDeviceIDType = async function () {
 };
 
 /**
- * Change the current device id
+ * @deprecated use 'Countly.deviceId.setID' instead of 'Countly.changeDeviceId' for setting device ID.
+ * 
+ * Change the current device ID
  *
  * @param {string} newDeviceID id new device id
  * @param {boolean} onServer merge device id

DeviceId.js

@@ -0,0 +1,65 @@
+import * as L from "./Logger.js";
+import * as Utils from "./Utils.js";
+
+class DeviceId {
+    #state;
+
+    constructor(state) {
+        this.#state = state;
+    }
+
+    /**
+     *
+     * Get currently used device ID.
+     * Should be called after Countly init
+     *
+     * @returns {string | null} device ID or null
+     */
+    getID = async function () {
+        if (!this.#state.isInitialized) {
+            L.w("getID, 'init' must be called before 'getID'");
+            return null;
+        }
+        L.d("getID, Getting current device ID");
+        const result = await this.#state.CountlyReactNative.getCurrentDeviceId();
+        return result;
+    };
+
+    /**
+     * Get currently used device ID type.
+     * Should be called after Countly init
+     *
+     * @return {DeviceIdType | null} deviceIdType or null
+     */
+    getType = async function () {
+        if (!this.#state.isInitialized) {
+            L.w("getType, 'init' must be called before 'getType'");
+            return null;
+        }
+        L.d("getType, Getting device ID type");
+        const result = await this.#state.CountlyReactNative.getDeviceIDType();
+        return Utils.intToDeviceIDType(result);
+    };
+
+    /**
+     * Sets device ID according to the device ID Type.
+     * If previous ID was Developer Supplied sets it without merge, otherwise with merge.
+     *
+     * @param {string} newDeviceID - device ID to set
+     */
+    setID = function (newDeviceID) {
+        if (!this.#state.isInitialized) {
+            L.w("setID, 'init' must be called before 'setID'");
+            return;
+        }
+        // Check if newDeviceID is not a string
+        if (!newDeviceID || typeof newDeviceID !== "string" || newDeviceID.length === 0) {
+            L.w("setID, provided device ID is not a valid string:[" + newDeviceID + "]");
+            return;
+        }
+        L.d(`setID, Setting device id as: [${newDeviceID}]`);
+        this.#state.CountlyReactNative.setID(newDeviceID);
+    };
+}
+
+export default DeviceId;

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

@@ -1610,6 +1610,11 @@ public void exitContentZone() {
         Countly.sharedInstance().contents().exitContentZone();
     }
 
+    @ReactMethod
+    public void setID(String newDeviceID) {
+        Countly.sharedInstance().deviceId().setID(newDeviceID);
+    }
+
     @ReactMethod
     public void setCustomMetrics(ReadableArray args) {
         Map<String, String> customMetric = new HashMap<>();

example/CountlyRNExample/DeviceID.tsx

@@ -13,12 +13,17 @@ const changeDeviceId = () => {
     Countly.changeDeviceId("02d56d66-6a39-482d-aff0-d14e4d5e5fda", true);
 };
 
+const setDeviceId = () => {
+    Countly.deviceId.setID("TestingDeviceIDValue");
+};
+
 function DeviceIDScreen({ navigation }) {
     return (
         <SafeAreaView>
             <ScrollView>
                 <CountlyButton title="Temporary Device ID Mode" onPress={temporaryDeviceIdMode} color={lightOrange} />
                 <CountlyButton title="Change Device ID" onPress={changeDeviceId} color={lightOrange} />
+                <CountlyButton title="Set Device ID" onPress={setDeviceId} color={lightOrange} />
             </ScrollView>
         </SafeAreaView>
     );

ios/src/CountlyReactNative.h

@@ -56,6 +56,8 @@ typedef void (^Result)(id _Nullable result);
 - (void)enterContentZone;
 - (void)exitContentZone;
 
+- (void)setID;
+
 #ifndef COUNTLY_EXCLUDE_PUSHNOTIFICATIONS
 - (void)notificationCallback:(NSString *_Nullable)notificationJson;
 + (void)startObservingNotifications;

ios/src/CountlyReactNative.m

@@ -257,6 +257,12 @@ - (void) populateConfig:(id) json {
     }
 }
 
+RCT_EXPORT_METHOD(setID : (NSString *)newDeviceID) { 
+    dispatch_async(dispatch_get_main_queue(), ^{ 
+        [Countly.sharedInstance setID:newDeviceID];
+    });
+}
+
 RCT_EXPORT_METHOD(recordEvent : (NSDictionary *)arguments) {
     dispatch_async(dispatch_get_main_queue(), ^{
         NSString *eventName = [arguments objectForKey:@"n"];