Replace BranchKey tag with live, test and test mode tags

Author: Adrian Marquez

src/index.js

@@ -31,6 +31,7 @@ const standardEvent = {
 var Branch = function Branch() {
   this.debugMode = false;
   this.trackingDisabled = false;
+  this.sessionInitialized = false;
 };
 
 // JavsSript to SDK wrappers
@@ -85,7 +86,15 @@ Branch.prototype.disableTracking = function disableTracking(isEnabled) {
   return execute("disableTracking", [value]);
 };
 
+Branch.prototype.enableTestMode = function initSession() {
+  if (this.sessionInitialized) {
+    return executeReject("[enableTestMode] should be called before [initSession]");
+  }
+  return execute("enableTestMode");
+};
+
 Branch.prototype.initSession = function initSession() {
+  this.sessionInitialized = true;
   return execute("initSession");
 };
 

src/ios/BranchSDK.h

@@ -26,6 +26,7 @@
 @property (strong, nonatomic) NSMutableArray *branchUniversalObjArray;
 
 // BranchSDK Basic Methods
+- (void)enableTestMode:(CDVInvokedUrlCommand*)command;
 - (void)initSession:(CDVInvokedUrlCommand*)command;
 - (void)disableTracking:(CDVInvokedUrlCommand*)command;
 - (void)setDebug:(CDVInvokedUrlCommand*)command;

src/ios/BranchSDK.m

@@ -86,6 +86,11 @@ - (void)continueUserActivity:(CDVInvokedUrlCommand*)command
 #pragma mark - Public APIs
 #pragma mark - Branch Basic Methods
 
+- (void)enableTestMode:(CDVInvokedUrlCommand*)command
+{
+  [Branch setUseTestBranchKey:TRUE];
+}
+
 - (void)initSession:(CDVInvokedUrlCommand*)command
 {
   [[Branch getInstance] registerPluginName:@"CordovaIonic" version:pluginVersion];

src/scripts/android/updateAndroidManifest.js

@@ -87,9 +87,14 @@
     const keys = ["io.branch.sdk.BranchKey", "io.branch.sdk.TestMode"];
     const vals = [
       preferences.branchKey,
-      preferences.androidTestMode || "false"
+      preferences.branchTestMode || preferences.androidTestMode || "false"
     ];
 
+    if (preferences.branchKeyTest) {
+      keys.push("io.branch.sdk.BranchKey.test");
+      vals.push(preferences.branchKeyTest);
+    }
+
     // remove old
     for (var i = 0; i < keys.length; i++) {
       metadatas = removeBasedOnAndroidName(metadatas, keys[i]);

src/scripts/ios/updatePlist.js

@@ -90,7 +90,15 @@
     }
 
     // override
-    obj.branch_key = preferences.branchKey;
+    if (preferences.branchKeyTest) {
+      obj.branch_key = {
+        live: preferences.branchKey,
+        test: preferences.branchKeyTest
+      };
+    } else {
+      obj.branch_key = preferences.branchKey;
+    }
+    
     obj.branch_app_domain = linkDomains[0];
 
     return obj;

src/scripts/npm/processConfigXml.js

@@ -57,7 +57,9 @@
     return {
       projectRoot: getProjectRoot(context),
       projectName: getProjectName(configXml),
-      branchKey: getBranchValue(branchXml, "branch-key"),
+      branchKey: getBranchKey(branchXml, "branch-key-live"),
+      branchKeyTest: getBranchValue(branchXml, "branch-key-test"),
+      branchTestMode: getBranchValue(branchXml, "branch-test-mode"),
       linkDomain: getBranchLinkDomains(branchXml, "link-domain"),
       androidLinkDomain: getBranchLinkDomains(branchXml, "android-link-domain"),
       iosLinkDomain: getBranchLinkDomains(branchXml, "ios-link-domain"),
@@ -68,7 +70,7 @@
       iosTeamDebug: getBranchValue(branchXml, "ios-team-debug"), // optional
       androidBundleId: getBundleId(configXml, "android"), // optional
       androidPrefix: getBranchValue(branchXml, "android-prefix"), // optional
-      androidTestMode: getBranchValue(branchXml, "android-testmode") // optional
+      androidTestMode: getBranchValue(branchXml, "android-testmode") // DEPRECATED optional
     };
   }
 
@@ -99,6 +101,12 @@
     return branchXml.hasOwnProperty(key) ? branchXml[key][0].$.value : null;
   }
 
+  // read branch value from (<branch-key> DEPRECATED)
+  // or <branch-key-live>
+  function getBranchKey(branchXml) {
+    return getBranchValue(branchXml, "branch-key-live") || getBranchValue(branchXml, "branch-key");
+  }
+
   // read branch value from <branch-config>
   // for multiple <link-domain>, <android-link-domain> or <ios-link-domain>
   function getBranchLinkDomains(branchXml, key) {
@@ -207,9 +215,14 @@
         'BRANCH SDK: Invalid "name" in your config.xml. Docs https://goo.gl/GijGKP'
       );
     }
-    if (preferences.branchKey === null) {
+    if (preferences.branchKey === null && preferences.branchKeyLive === null) {
+      throw new Error(
+        'BRANCH SDK: Invalid "branch-key-live" in <branch-config> in your config.xml. Docs https://goo.gl/GijGKP'
+      );
+    }
+    if (preferences.branchKey === null && preferences.branchKeyTest === null) {
       throw new Error(
-        'BRANCH SDK: Invalid "branch-key" in <branch-config> in your config.xml. Docs https://goo.gl/GijGKP'
+        'BRANCH SDK: Invalid "branch-key-test" in <branch-config> in your config.xml. Docs https://goo.gl/GijGKP'
       );
     }
     if (
@@ -280,5 +293,16 @@
         'BRANCH SDK: Invalid "android-testmode" in <branch-config> in your config.xml. Docs https://goo.gl/GijGKP'
       );
     }
+    if (
+      !(
+        preferences.branchTestMode === "true" ||
+        preferences.branchTestMode === "false" ||
+        preferences.branchTestMode === null
+      )
+    ) {
+      throw new Error(
+        'BRANCH SDK: Invalid "branch-test-mode" in <branch-config> in your config.xml. Docs https://goo.gl/GijGKP'
+      );
+    }
   }
 })();