Merge pull request #257 from Microsoft/simplify-android-setup

Simplify android setup

Author: geof90

Examples/CodePushDemoApp/android/app/src/main/java/com/microsoft/codepushdemoapp/MainActivity.java

@@ -1,7 +1,5 @@
 package com.microsoft.codepushdemoapp;
 
-import android.os.Bundle;
-
 import com.facebook.react.ReactActivity;
 import com.facebook.react.ReactPackage;
 import com.facebook.react.shell.MainReactPackage;
@@ -12,17 +10,9 @@
 
 public class MainActivity extends ReactActivity {
 
-    private CodePush codePush;
-
-    @Override
-    protected void onCreate(Bundle savedInstanceState) {
-        codePush = new CodePush("deployment-key-here", this, BuildConfig.DEBUG);
-        super.onCreate(savedInstanceState);
-    }
-
     @Override
     protected String getJSBundleFile() {
-        return this.codePush.getBundleUrl("index.android.bundle");
+        return CodePush.getBundleUrl("index.android.bundle");
     }
 
     /**
@@ -51,7 +41,7 @@ protected boolean getUseDeveloperSupport() {
     protected List<ReactPackage> getPackages() {
         return Arrays.<ReactPackage>asList(
                 new MainReactPackage(),
-                this.codePush.getReactPackage()
+                new CodePush("deployment-key-here", this, BuildConfig.DEBUG)
         );
     }
 }

README.md

@@ -269,7 +269,7 @@ After installing the plugin and syncing your Android Studio project with Gradle,
     }
     ```
 
-2. Ensure that the `android.defaultConfig.versionName` property in your `android/app/build.gradle` file is set to a semver compliant value. Note that if the value provided is missing a patch version, the CodePush server will assume it is `0`, i.e. `1.0` will be treated as `1.0.0`.
+2. Ensure that the `android.defaultConfig.versionName` property in your `android/app/build.gradle` file is set to a semver-compliant value. Note that if the value provided is missing a patch version, the CodePush server will assume it is `0`, i.e. `1.0` will be treated as `1.0.0`.
 
     ```gradle
     android {
@@ -297,12 +297,7 @@ After installing the plugin and syncing your Android Studio project with Gradle,
     import com.microsoft.codepush.react.CodePush;
 
     public class MainActivity extends ReactActivity {
-        // 2. Define a private field to hold the CodePush runtime instance
-        private CodePush _codePush;
-
-        ...
-
-        // 3. Override the getJSBundleFile method in order to let
+        // 2. Override the getJSBundleFile method in order to let
         // the CodePush runtime determine where to get the JS
         // bundle location from on each app start
         @Override
@@ -312,41 +307,20 @@ After installing the plugin and syncing your Android Studio project with Gradle,
 
         @Override
         protected List<ReactPackage> getPackages() {
-            // 4. Instantiate an instance of the CodePush runtime, using the right deployment key. If you don't
-            // already have it, you can run "code-push deployment ls <appName> -k" to retrieve your key.
-            this._codePush = new CodePush("0dsIDongIcoH0mqAmoR0CYb5FhBZNy1w4Bf-l", this, BuildConfig.DEBUG);
-
-            // 5. Add the CodePush package to the list of existing packages
-            return Arrays.<ReactPackage>asList(
-                new MainReactPackage(), this._codePush.getReactPackage());
-        }
-
-        ...
-    }
-    ```
-    
-2. If you used RNPM to install/link the CodePush plugin, there are two additional changes you'll need to make due to the fact that RNPM makes some assumptions about 3rd party modules that we don't currently support. If you're not using RNPM then simply skip to step #3:
-
-    ```java
-    ...
-    // 1. Remove the following import statement
-    import com.microsoft.codepush.react.CodePushReactPackage;
-    ...
-    public class MainActivity extends ReactActivity {
-        ...
-        @Override
-        protected List<ReactPackage> getPackages() {
+            // 3. Instantiate an instance of the CodePush runtime and add it to the list of
+            // existing packages, specifying the right deployment key. If you don't already 
+            // have it, you can run "code-push deployment ls <appName> -k" to retrieve your key.
             return Arrays.<ReactPackage>asList(
-                ...
-                new CodePushReactPackage() // 2. Remove this line
-                ...
+                new MainReactPackage(), 
+                new CodePush("deployment-key-here", this, BuildConfig.DEBUG)
             );
         }
+
         ...
     }
     ```
 
-3. Ensure that the `android.defaultConfig.versionName` property in your `android/app/build.gradle` file is set to a semver compliant value. Note that if the value provided is missing a patch version, the CodePush server will assume it is `0`, i.e. `1.0` will be treated as `1.0.0`.
+2. Ensure that the `android.defaultConfig.versionName` property in your `android/app/build.gradle` file is set to a semver-compliant value. Note that if the value provided is missing a patch version, the CodePush server will assume it is `0`, i.e. `1.0` will be treated as `1.0.0`.
 
     ```gradle
     android {

android/app/src/main/java/com/microsoft/codepush/react/CodePush.java

@@ -39,7 +39,7 @@
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 
-public class CodePush {
+public class CodePush implements ReactPackage {
     private static boolean needToReportRollback = false;
     private static boolean isRunningBinaryVersion = false;
     private static boolean testConfigurationFlag = false;
@@ -48,8 +48,8 @@ public class CodePush {
 
     private String assetsBundleFileName;
 
-    private final String ASSETS_BUNDLE_PREFIX = "assets://";
-    private final String BINARY_MODIFIED_TIME_KEY = "binaryModifiedTime";
+    private static final String ASSETS_BUNDLE_PREFIX = "assets://";
+    private static final String BINARY_MODIFIED_TIME_KEY = "binaryModifiedTime";
     private final String CODE_PUSH_PREFERENCES = "CodePush";
     private final String DOWNLOAD_PROGRESS_EVENT_NAME = "CodePushDownloadProgress";
     private final String FAILED_UPDATES_KEY = "CODE_PUSH_FAILED_UPDATES";
@@ -65,7 +65,6 @@ public class CodePush {
     // Helper classes.
     private CodePushNativeModule codePushNativeModule;
     private CodePushPackage codePushPackage;
-    private CodePushReactPackage codePushReactPackage;
     private CodePushTelemetryManager codePushTelemetryManager;
 
     // Config properties.
@@ -78,6 +77,8 @@ public class CodePush {
     private Context applicationContext;
     private final boolean isDebugMode;
 
+    private static CodePush currentInstance;
+
     public CodePush(String deploymentKey, Activity mainActivity) {
         this(deploymentKey, mainActivity, false);
     }
@@ -100,6 +101,11 @@ public CodePush(String deploymentKey, Activity mainActivity, boolean isDebugMode
         }
 
         initializeUpdateAfterRestart();
+        if (currentInstance != null) {
+            CodePushUtils.log("More than one CodePush instance has been initialized. Please use the instance method codePush.getBundleUrlInternal() to get the correct bundleURL for a particular instance.");
+        }
+
+        currentInstance = this;
     }
 
     private void clearReactDevBundleCache() {
@@ -129,10 +135,18 @@ private long getBinaryResourcesModifiedTime() {
         }
     }
 
-    public String getBundleUrl(String assetsBundleFileName) {
+    public static String getBundleUrl(String assetsBundleFileName) {
+        if (currentInstance == null) {
+            throw new CodePushNotInitializedException("A CodePush instance has not been created yet. Have you added it to your app's list of ReactPackages?");
+        }
+
+        return currentInstance.getBundleUrlInternal(assetsBundleFileName);
+    }
+
+    public String getBundleUrlInternal(String assetsBundleFileName) {
         this.assetsBundleFileName = assetsBundleFileName;
         String binaryJsBundleUrl = ASSETS_BUNDLE_PREFIX + assetsBundleFileName;
-        long binaryResourcesModifiedTime = getBinaryResourcesModifiedTime();
+        long binaryResourcesModifiedTime = this.getBinaryResourcesModifiedTime();
 
         try {
             String packageFilePath = codePushPackage.getCurrentPackageBundlePath(this.assetsBundleFileName);
@@ -143,7 +157,7 @@ public String getBundleUrl(String assetsBundleFileName) {
                 return binaryJsBundleUrl;
             }
 
-            ReadableMap packageMetadata = codePushPackage.getCurrentPackage();
+            ReadableMap packageMetadata = this.codePushPackage.getCurrentPackage();
             Long binaryModifiedDateDuringPackageInstall = null;
             String binaryModifiedDateDuringPackageInstallString = CodePushUtils.tryGetString(packageMetadata, BINARY_MODIFIED_TIME_KEY);
             if (binaryModifiedDateDuringPackageInstallString != null) {
@@ -159,7 +173,7 @@ public String getBundleUrl(String assetsBundleFileName) {
                 return packageFilePath;
             } else {
                 // The binary version is newer.
-                didUpdate = false;
+                this.didUpdate = false;
                 if (!this.isDebugMode || !this.appVersion.equals(packageAppVersion)) {
                     this.clearUpdates();
                 }
@@ -206,13 +220,6 @@ private JSONObject getPendingUpdate() {
             return null;
         }
     }
-
-    public ReactPackage getReactPackage() {
-        if (codePushReactPackage == null) {
-            codePushReactPackage = new CodePushReactPackage();
-        }
-        return codePushReactPackage;
-    }
 
     private void initializeUpdateAfterRestart() {
         JSONObject pendingUpdate = getPendingUpdate();
@@ -349,6 +356,7 @@ private void loadBundle() {
             Intent intent = mainActivity.getIntent();
             mainActivity.finish();
             mainActivity.startActivity(intent);
+            currentInstance = null;
         }
 
         @ReactMethod
@@ -439,7 +447,6 @@ protected Void doInBackground(Void... params) {
 
         @ReactMethod
         public void getNewStatusReport(final Promise promise) {
-
             AsyncTask<Void, Void, Void> asyncTask = new AsyncTask<Void, Void, Void>() {
                 @Override
                 protected Void doInBackground(Void... params) {
@@ -605,27 +612,25 @@ public String getName() {
         }
     }
 
-    private class CodePushReactPackage implements ReactPackage {
-        @Override
-        public List<NativeModule> createNativeModules(ReactApplicationContext reactApplicationContext) {
-            List<NativeModule> nativeModules = new ArrayList<>();
-            CodePush.this.codePushNativeModule = new CodePushNativeModule(reactApplicationContext);
-            CodePushDialog dialogModule = new CodePushDialog(reactApplicationContext, mainActivity);
+    @Override
+    public List<NativeModule> createNativeModules(ReactApplicationContext reactApplicationContext) {
+        List<NativeModule> nativeModules = new ArrayList<>();
+        this.codePushNativeModule = new CodePushNativeModule(reactApplicationContext);
+        CodePushDialog dialogModule = new CodePushDialog(reactApplicationContext, mainActivity);
 
-            nativeModules.add(CodePush.this.codePushNativeModule);
-            nativeModules.add(dialogModule);
+        nativeModules.add(this.codePushNativeModule);
+        nativeModules.add(dialogModule);
 
-            return nativeModules;
-        }
+        return nativeModules;
+    }
 
-        @Override
-        public List<Class<? extends JavaScriptModule>> createJSModules() {
-            return new ArrayList<>();
-        }
+    @Override
+    public List<Class<? extends JavaScriptModule>> createJSModules() {
+        return new ArrayList<>();
+    }
 
-        @Override
-        public List<ViewManager> createViewManagers(ReactApplicationContext reactApplicationContext) {
-            return new ArrayList<>();
-        }
+    @Override
+    public List<ViewManager> createViewManagers(ReactApplicationContext reactApplicationContext) {
+        return new ArrayList<>();
     }
 }

android/app/src/main/java/com/microsoft/codepush/react/CodePushNotInitializedException.java

@@ -0,0 +1,12 @@
+package com.microsoft.codepush.react;
+
+public final class CodePushNotInitializedException extends RuntimeException {
+
+    public CodePushNotInitializedException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public CodePushNotInitializedException(String message) {
+        super(message);
+    }
+}