Move PublicKey and ServerUrl properties to string resources (#1740)

alexandergoncharov-zz · web-flow · commit f29c96f29abf · 2019-12-11T16:48:01.000+03:00
diff --git a/Examples/CodePushDemoApp-pre0.49/android/app/src/main/java/com/codepushdemoapp/MainApplication.java b/Examples/CodePushDemoApp-pre0.49/android/app/src/main/java/com/codepushdemoapp/MainApplication.java
@@ -30,7 +30,7 @@ public boolean getUseDeveloperSupport() {
     protected List<ReactPackage> getPackages() {
       return Arrays.<ReactPackage>asList(
           new MainReactPackage(),
-            new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)
+            new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)
       );
     }
   };
diff --git a/Examples/CodePushDemoApp-pre0.49/android/app/src/main/res/values/strings.xml b/Examples/CodePushDemoApp-pre0.49/android/app/src/main/res/values/strings.xml
@@ -1,4 +1,4 @@
 <resources>
-    <string moduleConfig="true" name="reactNativeCodePush_androidDeploymentKey">deployment-key-here</string>
+    <string moduleConfig="true" name="CodePushDeploymentKey">deployment-key-here</string>
     <string name="app_name">CodePushDemoApp</string>
 </resources>
diff --git a/Examples/CodePushDemoApp/android/app/src/main/java/com/codepushdemoapp/MainApplication.java b/Examples/CodePushDemoApp/android/app/src/main/java/com/codepushdemoapp/MainApplication.java
@@ -30,7 +30,7 @@ public boolean getUseDeveloperSupport() {
     protected List<ReactPackage> getPackages() {
       return Arrays.<ReactPackage>asList(
           new MainReactPackage(),
-            new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)
+            new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)
       );
     }
 
diff --git a/Examples/CodePushDemoApp/android/app/src/main/res/values/strings.xml b/Examples/CodePushDemoApp/android/app/src/main/res/values/strings.xml
@@ -1,4 +1,4 @@
 <resources>
-    <string moduleConfig="true" name="reactNativeCodePush_androidDeploymentKey">deployment-key-here</string>
+    <string moduleConfig="true" name="CodePushDeploymentKey">deployment-key-here</string>
     <string name="app_name">CodePushDemoApp</string>
 </resources>
diff --git a/android/app/src/main/java/com/microsoft/codepush/react/CodePush.java b/android/app/src/main/java/com/microsoft/codepush/react/CodePush.java
@@ -77,6 +77,12 @@ public CodePush(String deploymentKey, Context context, boolean isDebugMode) {
 
         mCurrentInstance = this;
 
+        String publicKeyFromStrings = getCustomPropertyFromStringsIfExist("PublicKey");
+        if (publicKeyFromStrings != null) mPublicKey = publicKeyFromStrings;
+
+        String serverUrlFromStrings = getCustomPropertyFromStringsIfExist("ServerUrl");
+        if (serverUrlFromStrings != null) mServerUrl = serverUrlFromStrings;
+
         clearDebugCacheIfNeeded(null);
         initializeUpdateAfterRestart();
     }
@@ -120,10 +126,29 @@ private String getPublicKeyByResourceDescriptor(int publicKeyResourceDescriptor)
         return publicKey;
     }
 
+    private String getCustomPropertyFromStringsIfExist(String propertyName) {
+        String property;
+      
+        String packageName = mContext.getPackageName();
+        int resId = mContext.getResources().getIdentifier("CodePush" + propertyName, "string", packageName);
+        
+        if (resId != 0) {
+            property = mContext.getString(resId);
+
+            if (!property.isEmpty()) {
+                return property;
+            } else {
+                CodePushUtils.log("Specified " + propertyName + " is empty");
+            } 
+        }
+
+        return null;
+    }
+
     public void clearDebugCacheIfNeeded(ReactInstanceManager instanceManager) {
         boolean isLiveReloadEnabled = false;
 
-        // Use instanceManager for checking if we use LiveRelaod mode. In this case we should not remove ReactNativeDevBundle.js file
+        // Use instanceManager for checking if we use LiveReload mode. In this case we should not remove ReactNativeDevBundle.js file
         // because we get error with trying to get this after reloading. Issue: https://github.com/Microsoft/react-native-code-push/issues/1272
         if (instanceManager != null) {
             DevSupportManager devSupportManager = instanceManager.getDevSupportManager();
diff --git a/docs/api-android.md b/docs/api-android.md
@@ -1,5 +1,23 @@
 ### Java API Reference (Android)
 
+### API for React Native 0.60 version and above
+
+Since `autolinking` uses `react-native.config.js` to link plugins, constructors are specified in that file. But you can override custom variables to manage the CodePush plugin by placing these values in string resources.
+
+* __Public Key__ - used for bundle verification in the Code Signing Feature. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
+    To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushPublicKey`. CodePush automatically gets this property and enables the Code Signing feature. For example:
+    ```xml
+    <string moduleConfig="true" name="CodePushPublicKey">your-public-key</string>
+    ```
+
+* __Server Url__ - used for specifying CodePush Server Url.
+    The Default value: "https://codepush.appcenter.ms/" is overridden by adding your path to `strings.xml` with name `CodePushServerUrl`. CodePush automatically gets this property and will use this path to send requests. For example:
+    ```xml
+    <string moduleConfig="true" name="CodePushServerUrl">https://yourcodepush.server.com</string>
+    ```
+
+### API for React Native lower than 0.60
+
 The Java API is made available by importing the `com.microsoft.codepush.react.CodePush` class into your `MainActivity.java` file, and consists of a single public class named `CodePush`.
 
 #### CodePush
@@ -16,9 +34,9 @@ Constructs the CodePush client runtime and represents the `ReactPackage` instanc
 
     2. The local cache that the React Native runtime maintains in debug mode is deleted whenever a CodePush update is installed. This ensures that when the app is restarted after an update is applied, you will see the expected changes. As soon as [this PR](https://github.com/facebook/react-native/pull/4738) is merged, we won't need to do this anymore.
 
-- __CodePush(String deploymentKey, Context context, boolean isDebugMode, Integer publicKeyResourceDescriptor)__ - Equivalent to the previous constructor, but allows you to specify the public key resource descriptor needed to read public key content. Please refer to [Code Signing](setup-android.md#code-signing) section for more details about Code Signing Feature.
+- __CodePush(String deploymentKey, Context context, boolean isDebugMode, Integer publicKeyResourceDescriptor)__ - Equivalent to the previous constructor, but allows you to specify the public key resource descriptor needed to read public key content. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
 
-- __CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl)__ Constructor allows you to specify CodePush Server Url. The Default value: `"https://codepush.appcenter.ms/"` is overridden by value specfied in `serverUrl`. 
+- __CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl)__ Constructor allows you to specify CodePush Server Url. The Default value: `"https://codepush.appcenter.ms/"` is overridden by value specified in `serverUrl`.
 
 ##### Builder
 
@@ -46,7 +64,7 @@ As an alternative to constructors *you can also use `CodePushBuilder`* to setup
 
 * __public CodePushBuilder setServerUrl(String serverUrl)__ - allows you to specify CodePush Server Url. Default value: `"https://codepush.appcenter.ms/"`.
 
-* __public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescriptor)__ - allows you to specify Public Key resource descriptor which will be used for reading Public Key content for `strings.xml` file. Please refer to [Code Signing](#code-signing) section for more detailed information about purpose of this parameter.
+* __public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescriptor)__ - allows you to specify Public Key resource descriptor which will be used for reading Public Key content for `strings.xml` file. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more detailed information about purpose of this parameter.
 
 * __public CodePush build()__ - return configured `CodePush` instance.
 
diff --git a/docs/multi-deployment-testing-android.md b/docs/multi-deployment-testing-android.md
@@ -23,13 +23,13 @@ To set this up, perform the following steps:
             debug {
                 ...
                 // Note: CodePush updates should not be tested in Debug mode as they are overriden by the RN packager. However, because CodePush checks for updates in all modes, we must supply a key.
-                resValue "string", "reactNativeCodePush_androidDeploymentKey", '""'
+                resValue "string", "CodePushDeploymentKey", '""'
                 ...
             }
 
             releaseStaging {
                 ...
-                resValue "string", "reactNativeCodePush_androidDeploymentKey", '"<INSERT_STAGING_KEY>"'
+                resValue "string", "CodePushDeploymentKey", '"<INSERT_STAGING_KEY>"'
 
                 // Note: It is a good idea to provide matchingFallbacks for the new buildType you create to prevent build issues
                 // Add the following line if not already there
@@ -39,7 +39,7 @@ To set this up, perform the following steps:
 
             release {
                 ...
-                resValue "string", "reactNativeCodePush_androidDeploymentKey", '"<INSERT_PRODUCTION_KEY>"'
+                resValue "string", "CodePushDeploymentKey", '"<INSERT_PRODUCTION_KEY>"'
                 ...
             }
         }
diff --git a/docs/setup-android.md b/docs/setup-android.md
@@ -13,7 +13,7 @@
     * [For React Native >= v0.29 (Background React Instances)](#for-react-native--v029-background-react-instances)
     * [For React Native v0.19 - v0.28 (Background React Instances)](#for-react-native-v019---v028-background-react-instances)
   * [WIX React Native Navigation applications (ver 1.x)](#wix-react-native-navigation-applications)
-  * [Code Signing setup](#code-signing-setup)
+* [Code Signing setup](#code-signing-setup)
 
 In order to integrate CodePush into your Android project, please perform the following steps:
 
@@ -52,7 +52,7 @@ In order to integrate CodePush into your Android project, please perform the fol
 
 3. Add the Deployment key to `strings.xml`:
    
-   To let the CodePush runtime know which deployment it should query for updates against, open your app's `strings.xml` file and add a new string named `reactNativeCodePush_androidDeploymentKey`, whose value is the key of the deployment you want to configure this app against (like the key for the `Staging` deployment for the `FooBar` app). You can retrieve this value by running `code-push deployment ls <appName> -k` in the CodePush CLI (the `-k` flag is necessary since keys aren't displayed by default) and copying the value of the `Deployment Key` column which corresponds to the deployment you want to use (see below). Note that using the deployment's name (like Staging) will not work. That "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
+   To let the CodePush runtime know which deployment it should query for updates, open your app's `strings.xml` file and add a new string named `CodePushDeploymentKey`, whose value is the key of the deployment you want to configure this app against (like the key for the `Staging` deployment for the `FooBar` app). You can retrieve this value by running `code-push deployment ls <appName> -k` in the CodePush CLI (the `-k` flag is necessary since keys aren't displayed by default) and copying the value of the `Deployment Key` column which corresponds to the deployment you want to use (see below). Note that using the deployment's name (like Staging) will not work. The "friendly name" is intended only for authenticated management usage from the CLI, and not for public consumption within your app.
 
    ![Deployment list](https://cloud.githubusercontent.com/assets/116461/11601733/13011d5e-9a8a-11e5-9ce2-b100498ffb34.png)
 
@@ -63,11 +63,11 @@ In order to integrate CodePush into your Android project, please perform the fol
    ```xml
     <resources>
         <string name="app_name">AppName</string>
-        <string moduleConfig="true" name="reactNativeCodePush_androidDeploymentKey">DeploymentKey</string>
+        <string moduleConfig="true" name="CodePushDeploymentKey">DeploymentKey</string>
     </resources>
     ```
 
-    *Note: You can also set your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
+    *Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
 
 ### Plugin Installation for React Native lower than 0.60 (Android)
 
@@ -414,11 +414,11 @@ public class MainApplication extends NavigationApplication {
 }
 ```
 
-#### Code Signing setup
+### Code Signing setup
 
 Starting with CLI version **2.1.0** you can self sign bundles during release and verify its signature before installation of update. For more info about Code Signing please refer to [relevant code-push documentation section](https://github.com/Microsoft/code-push/tree/master/cli#code-signing). In order to use Public Key for Code Signing you need to do following steps:
 
- 1. Add `CodePushPublicKey` string item to `/path_to_your_app/android/app/src/main/res/values/strings.xml`. It may looks like this:
+   Add `CodePushPublicKey` string item to `/path_to_your_app/android/app/src/main/res/values/strings.xml`. It may looks like this:
 
  ```xml
  <resources>
@@ -435,9 +435,9 @@ zwIDAQAB
 </resources>
  ```
 
- 2. Configure `CodePush` instance to use this parameter
+#### For React Native <= v0.60 you should configure the `CodePush` instance to use this parameter using one of the following approaches
 
- * using constructor
+##### Using constructor
 
 ```java
 new CodePush(
@@ -447,9 +447,7 @@ new CodePush(
     R.string.CodePushPublicKey)
 ```
 
- or
-
- * using builder
+##### Using builder
 
  ```java
 new CodePushBuilder("deployment-key-here",getApplicationContext())
diff --git a/docs/setup-ios.md b/docs/setup-ios.md
@@ -50,8 +50,8 @@ Once you've acquired the CodePush plugin, you need to integrate it into the Xcod
 
    In order to effectively make use of the `Staging` and `Production` deployments that were created along with your CodePush app, refer to the [multi-deployment testing](../README.md#multi-deployment-testing) docs below before actually moving your app's usage of CodePush into production.
 
-   *Note: You can also set your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
-
+   *Note: If you need to dynamically use a different deployment, you can also override your deployment key in JS code using [Code-Push options](./api-js.md#CodePushOptions)*
+   
 ### Plugin Installation for React Native lower than 0.60 (iOS)
 
 In order to accommodate as many developer preferences as possible, the CodePush plugin supports iOS installation via three mechanisms:
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
   },
   "rnpm": {
     "android": {
-      "packageInstance": "new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"
+      "packageInstance": "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"
     },
     "ios": {
       "sharedLibraries": [
diff --git a/react-native.config.js b/react-native.config.js
@@ -3,7 +3,7 @@ module.exports = {
         platforms: {
             android: {
                 packageInstance:
-                    "new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"
+                    "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"
             }
         }
     }
diff --git a/scripts/postunlink/android/postunlink.js b/scripts/postunlink/android/postunlink.js
@@ -63,7 +63,7 @@ module.exports = () => {
         if (!~stringsResourcesContent.indexOf(deploymentKeyName)) {
             console.log(`${deploymentKeyName} already removed from the strings.xml`);
         } else {
-            var AndroidDeploymentKey = stringsResourcesContent.match(/(<string moduleConfig="true" name="reactNativeCodePush_androidDeploymentKey">.*<\/string>)/);
+            var AndroidDeploymentKey = stringsResourcesContent.match(/(<string moduleConfig="true" name="CodePushDeploymentKey">.*<\/string>)/);
             if (AndroidDeploymentKey) {
                 stringsResourcesContent = stringsResourcesContent.replace(`\n\t${AndroidDeploymentKey[0]}`,"");
                 fs.writeFileSync(stringsResourcesPath, stringsResourcesContent);
diff --git a/scripts/tools/linkToolsAndroid.js b/scripts/tools/linkToolsAndroid.js
@@ -14,7 +14,7 @@ exports.getJSBundleFileOverride = `
 exports.reactNativeHostInstantiation = "new ReactNativeHost(this) {";
 exports.mainActivityClassDeclaration = "public class MainActivity extends ReactActivity {";
 exports.codePushGradleLink = `\napply from: "../../node_modules/react-native-code-push/android/codepush.gradle"`;
-exports.deploymentKeyName = "reactNativeCodePush_androidDeploymentKey";
+exports.deploymentKeyName = "CodePushDeploymentKey";
 
 exports.getMainApplicationLocation = function () {
     return findMainApplication() || glob.sync("**/MainApplication.java", ignoreFolders)[0];

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public boolean getUseDeveloperSupport() {`
`30`	`30`	`protected List<ReactPackage> getPackages() {`
`31`	`31`	`return Arrays.<ReactPackage>asList(`
`32`	`32`	`new MainReactPackage(),`
`33`		`- new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)`
	`33`	`+ new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)`
`34`	`34`	`);`
`35`	`35`	`}`
`36`	`36`	`};`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ module.exports = {`
`3`	`3`	`platforms: {`
`4`	`4`	`android: {`
`5`	`5`	`packageInstance:`
`6`		`- "new CodePush(getResources().getString(R.string.reactNativeCodePush_androidDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"`
	`6`	`+ "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"`
`7`	`7`	`}`
`8`	`8`	`}`
`9`	`9`	`}`