Merge pull request #129 from Microsoft/restart_improvement

Adding conditional check to restartApp method

Author: lostintangent

CodePush.js

@@ -109,6 +109,10 @@ function log(message) {
   console.log(`[CodePush] ${message}`)
 }
 
+function restartApp(onlyIfUpdateIsPending = false) {
+  NativeCodePush.restartApp(onlyIfUpdateIsPending);
+}
+
 var testConfig;
 
 // This function is only used for tests. Replaces the default SDK, configuration and native bridge
@@ -265,7 +269,7 @@ const CodePush = {
   getCurrentPackage,
   log,
   notifyApplicationReady: NativeCodePush.notifyApplicationReady,
-  restartApp: NativeCodePush.restartApp,
+  restartApp,
   setUpTestDependencies,
   sync,
   InstallMode: {

CodePush.m

@@ -203,11 +203,11 @@ - (BOOL)isPendingUpdate:(NSString*)packageHash
     NSUserDefaults *preferences = [NSUserDefaults standardUserDefaults];
     NSDictionary *pendingUpdate = [preferences objectForKey:PendingUpdateKey];
 
-    // If there is a pending update, whose hash is equal to the one
-    // specified, and its "state" isn't loading, then we consider it "pending".
+    // If there is a pending update whose "state" isn't loading, then we consider it "pending".
+    // Additionally, if a specific hash was provided, we ensure it matches that of the pending update.
     BOOL updateIsPending = pendingUpdate &&
                            [pendingUpdate[PendingUpdateIsLoadingKey] boolValue] == NO &&
-                           [pendingUpdate[PendingUpdateHashKey] isEqualToString:packageHash];
+                           (!packageHash || [pendingUpdate[PendingUpdateHashKey] isEqualToString:packageHash]);
 
     return updateIsPending;
 }
@@ -467,9 +467,13 @@ - (void)savePendingUpdate:(NSString *)packageHash
 /*
  * This method is the native side of the CodePush.restartApp() method.
  */
-RCT_EXPORT_METHOD(restartApp)
+RCT_EXPORT_METHOD(restartApp:(BOOL)onlyIfUpdateIsPending)
 {
-    [self loadBundle];
+    // If this is an unconditional restart request, or there
+    // is current pending update, then reload the app.
+    if (!onlyIfUpdateIsPending || [self isPendingUpdate:nil]) {
+        [self loadBundle];
+    }
 }
 
 /*

README.md

@@ -336,12 +336,15 @@ If you are using the `sync` function, and doing your update check on app start,
 #### codePush.restartApp		
 		
 ```javascript		
-codePush.restartApp(): void;		
+codePush.restartApp(onlyIfUpdateIsPending: Boolean = false): void;		
 ```		
 		
-Immediately restarts the app. If there is an update pending, it will be presented to the end user and the rollback timer (if specified when installing the update) will begin. Otherwise, calling this method simply has the same behavior as the end user killing and restarting the process. This method is for advanced scenarios, and is primarily useful when the following conditions are true:		
+Immediately restarts the app. If a truthy value is provided to the `onlyIfUpdateIsPending` parameter, then the app will only restart if there is actually a pending update waiting to be applied.
+
+This method is for advanced scenarios, and is primarily useful when the following conditions are true:		
 
-1. Your app is specifying an install mode value of `ON_NEXT_RESTART` or `ON_NEXT_RESUME` when calling the `sync` or `LocalPackage.install` methods. This has the effect of not applying your update until the app has been restarted (by either the end user or OS)	or resumed, and therefore, the update won't be immediately displayed to the end user 	.
+1. Your app is specifying an install mode value of `ON_NEXT_RESTART` or `ON_NEXT_RESUME` when calling the `sync` or `LocalPackage.install` methods. This has the effect of not applying your update until the app has been restarted (by either the end user or OS)	or resumed, and therefore, the update won't be immediately displayed to the end user.
+
 2. You have an app-specific user event (e.g. the end user navigated back to the app's home route) that allows you to apply the update in an unobtrusive way, and potentially gets the update in front of the end user sooner then waiting until the next restart or resume.		
 
 #### codePush.sync

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

@@ -241,7 +241,7 @@ private boolean isPendingUpdate(String packageHash) {
         try {
             boolean updateIsPending = pendingUpdate != null &&
                                       pendingUpdate.getBoolean(PENDING_UPDATE_IS_LOADING_KEY) == false &&
-                                      pendingUpdate.getString(PENDING_UPDATE_HASH_KEY).equals(packageHash);
+                                      (packageHash == null || pendingUpdate.getString(PENDING_UPDATE_HASH_KEY).equals(packageHash));
             return updateIsPending;
         }
         catch (JSONException e) {
@@ -483,8 +483,12 @@ public void notifyApplicationReady(Promise promise) {
         }
 
         @ReactMethod
-        public void restartApp() {
-            loadBundle();
+        public void restartApp(boolean onlyIfUpdateIsPending) {
+            // If this is an unconditional restart request, or there
+            // is current pending update, then reload the app.
+            if (!onlyIfUpdateIsPending || CodePush.this.isPendingUpdate(null)) {
+                loadBundle();
+            }
         }
 
         @ReactMethod