Merge pull request #187 from Microsoft/sync-twice-issue

Sync Twice issue

Author: geof90

CodePush.h

@@ -69,6 +69,7 @@ failCallback:(void (^)(NSError *err))failCallback;
 @interface CodePushPackage : NSObject
 
 + (void)installPackage:(NSDictionary *)updatePackage
+   removePendingUpdate:(BOOL)removePendingUpdate
                  error:(NSError **)error;
 
 + (NSDictionary *)getCurrentPackage:(NSError **)error;

CodePush.js

@@ -139,7 +139,20 @@ function log(message) {
   console.log(`[CodePush] ${message}`)
 }
 
-async function notifyApplicationReady() {
+// This ensures that notifyApplicationReadyInternal is only called once 
+// in the lifetime of this module instance.
+const notifyApplicationReady = (() => {
+  let notifyApplicationReadyPromise;
+  return () => {
+    if (!notifyApplicationReadyPromise) {
+      notifyApplicationReadyPromise = notifyApplicationReadyInternal();
+    }
+    
+    return notifyApplicationReadyPromise;
+  };
+})();
+
+async function notifyApplicationReadyInternal() {
   await NativeCodePush.notifyApplicationReady();  
   const statusReport = await NativeCodePush.getNewStatusReport();
   if (statusReport) {
@@ -170,16 +183,41 @@ function setUpTestDependencies(testSdk, providedTestConfig, testNativeBridge) {
   if (testNativeBridge) NativeCodePush = testNativeBridge;
 }
 
+// This function allows only one syncInternal operation to proceed at any given time.
+// Parallel calls to sync() while one is ongoing yields CodePush.SyncStatus.SYNC_IN_PROGRESS.
+const sync = (() => {
+  let syncInProgress = false;
+  const setSyncCompleted = () => { syncInProgress = false; };
+  
+  return (options = {}, syncStatusChangeCallback, downloadProgressCallback) => {
+    if (syncInProgress) {
+      typeof syncStatusChangeCallback === "function"
+        ? syncStatusChangeCallback(CodePush.SyncStatus.SYNC_IN_PROGRESS)
+        : log("Sync already in progress.");
+      return Promise.resolve(CodePush.SyncStatus.SYNC_IN_PROGRESS);
+    } 
+    
+    syncInProgress = true;
+    const syncPromise = syncInternal(options, syncStatusChangeCallback, downloadProgressCallback);
+    syncPromise
+      .then(setSyncCompleted)
+      .catch(setSyncCompleted)
+      .done();
+
+    return syncPromise;
+  };
+})();
+
 /*
- * The sync method provides a simple, one-line experience for
+ * The syncInternal method provides a simple, one-line experience for
  * incorporating the check, download and application of an update.
  * 
  * It simply composes the existing API methods together and adds additional
  * support for respecting mandatory updates, ignoring previously failed
  * releases, and displaying a standard confirmation UI to the end-user
  * when an update is available.
  */
-async function sync(options = {}, syncStatusChangeCallback, downloadProgressCallback) {  
+async function syncInternal(options = {}, syncStatusChangeCallback, downloadProgressCallback) {  
   const syncOptions = {
 
     deploymentKey: null,
@@ -190,7 +228,7 @@ async function sync(options = {}, syncStatusChangeCallback, downloadProgressCall
     ...options 
   };
 
-  syncStatusChangeCallback = typeof syncStatusChangeCallback == "function"
+  syncStatusChangeCallback = typeof syncStatusChangeCallback === "function"
     ? syncStatusChangeCallback
     : (syncStatus) => {
         switch(syncStatus) {
@@ -229,7 +267,7 @@ async function sync(options = {}, syncStatusChangeCallback, downloadProgressCall
         }
       };
 
-  downloadProgressCallback = typeof downloadProgressCallback == "function" 
+  downloadProgressCallback = typeof downloadProgressCallback === "function" 
     ? downloadProgressCallback 
     : (downloadProgress) => {
         log(`Expecting ${downloadProgress.totalBytes} bytes, received ${downloadProgress.receivedBytes} bytes.`);
@@ -338,6 +376,7 @@ const CodePush = {
     UP_TO_DATE: 4, // The running app is up-to-date
     UPDATE_IGNORED: 5, // The app had an optional update and the end-user chose to ignore it
     UPDATE_INSTALLED: 6, // The app had an optional/mandatory update that was successfully downloaded and is about to be installed.
+    SYNC_IN_PROGRESS: 7, // There is an ongoing "sync" operation in progress.
     UNKNOWN_ERROR: -1
   },
   DEFAULT_UPDATE_DIALOG: {

CodePush.m

@@ -480,6 +480,7 @@ - (void)savePendingUpdate:(NSString *)packageHash
     dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
         NSError *error;
         [CodePushPackage installPackage:updatePackage
+                    removePendingUpdate:[self isPendingUpdate:nil]
                                   error:&error];
 
         if (error) {

CodePushPackage.m

@@ -464,7 +464,8 @@ + (void)copyEntriesInFolder:(NSString *)sourceFolder
 }
 
 + (void)installPackage:(NSDictionary *)updatePackage
-               error:(NSError **)error
+   removePendingUpdate:(BOOL)removePendingUpdate
+                 error:(NSError **)error
 {
     NSString *packageHash = updatePackage[@"packageHash"];
     NSMutableDictionary *info = [self getCurrentPackageInfo:error];
@@ -473,19 +474,32 @@ + (void)installPackage:(NSDictionary *)updatePackage
         return;
     }
 
-    NSString *previousPackageHash = [self getPreviousPackageHash:error];
-    if (!*error && previousPackageHash && ![previousPackageHash isEqualToString:packageHash]) {
-        NSString *previousPackageFolderPath = [self getPackageFolderPath:previousPackageHash];
-        // Error in deleting old package will not cause the entire operation to fail.
-        NSError *deleteError;
-        [[NSFileManager defaultManager] removeItemAtPath:previousPackageFolderPath
-                                                   error:&deleteError];
-        if (deleteError) {
-            NSLog(@"Error deleting old package: %@", deleteError);
+    if (removePendingUpdate) {
+        NSString *currentPackageFolderPath = [self getCurrentPackageFolderPath:error];
+        if (!*error && currentPackageFolderPath) {
+            // Error in deleting pending package will not cause the entire operation to fail.
+            NSError *deleteError;
+            [[NSFileManager defaultManager] removeItemAtPath:currentPackageFolderPath
+                                                       error:&deleteError];
+            if (deleteError) {
+                NSLog(@"Error deleting pending package: %@", deleteError);
+            }
+        }
+    } else {
+        NSString *previousPackageHash = [self getPreviousPackageHash:error];
+        if (!*error && previousPackageHash && ![previousPackageHash isEqualToString:packageHash]) {
+            NSString *previousPackageFolderPath = [self getPackageFolderPath:previousPackageHash];
+            // Error in deleting old package will not cause the entire operation to fail.
+            NSError *deleteError;
+            [[NSFileManager defaultManager] removeItemAtPath:previousPackageFolderPath
+                                                       error:&deleteError];
+            if (deleteError) {
+                NSLog(@"Error deleting old package: %@", deleteError);
+            }
         }
+        [info setValue:info[@"currentPackage"] forKey:@"previousPackage"];
     }
 
-    [info setValue:info[@"currentPackage"] forKey:@"previousPackage"];
     [info setValue:packageHash forKey:@"currentPackage"];
 
     [self updateCurrentPackageInfo:info

README.md

@@ -554,7 +554,7 @@ This method returns a `Promise` which is resolved to a `SyncStatus` code that in
 
 * __codePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - The update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
 
-If the update check and/or the subsequent download fails for any reason, the `Promise` object returned by `sync` will be rejected with the reason.
+* __codePush.SyncStatus.SYNC_IN_PROGRESS__ *(7)* - There is an ongoing `sync` operation running which prevents the current call from being executed.
 
 The `sync` method can be called anywhere you'd like to check for an update. That could be in the `componentWillMount` lifecycle event of your root component, the onPress handler of a `<TouchableHighlight>` component, in the callback of a periodic timer, or whatever else makes sense for your needs. Just like the `checkForUpdate` method, it will perform the network request to check for an update in the background, so it won't impact your UI thread and/or JavaScript thread's responsiveness.
 
@@ -622,6 +622,7 @@ This enum is provided to the `syncStatusChangedCallback` function that can be pa
 * __codePush.SyncStatus.UP_TO_DATE__ *(4)* - The app is fully up-to-date with the configured deployment.
 * __codePush.SyncStatus.UPDATE_IGNORED__ *(5)* - The app has an optional update, which the end user chose to ignore. (This is only applicable when the `updateDialog` is used)
 * __codePush.SyncStatus.UPDATE_INSTALLED__ *(6)* - An available update has been installed and will be run either immediately after the `syncStatusChangedCallback` function returns or the next time the app resumes/restarts, depending on the `InstallMode` specified in `SyncOptions`.
+* __codePush.SyncStatus.SYNC_IN_PROGRESS__ *(7)* - There is an ongoing `sync` operation running which prevents the current call from being executed.
 * __codePush.SyncStatus.UNKNOWN_ERROR__ *(-1)* - The sync operation encountered an unknown error. 
 
 ### Objective-C API Reference (iOS)

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

@@ -481,7 +481,7 @@ public void installUpdate(final ReadableMap updatePackage, final int installMode
                 @Override
                 protected Void doInBackground(Object... params) {
                     try {
-                        codePushPackage.installPackage(updatePackage);
+                        codePushPackage.installPackage(updatePackage, isPendingUpdate(null));
 
                         String pendingHash = CodePushUtils.tryGetString(updatePackage, codePushPackage.PACKAGE_HASH_KEY);
                         if (pendingHash == null) {

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

@@ -259,15 +259,23 @@ public void downloadPackage(Context applicationContext, ReadableMap updatePackag
         CodePushUtils.writeReadableMapToFile(updatePackage, bundlePath);
     }
 
-    public void installPackage(ReadableMap updatePackage) throws IOException {
+    public void installPackage(ReadableMap updatePackage, boolean removePendingUpdate) throws IOException {
         String packageHash = CodePushUtils.tryGetString(updatePackage, PACKAGE_HASH_KEY);
         WritableMap info = getCurrentPackageInfo();
-        String previousPackageHash = getPreviousPackageHash();
-        if (previousPackageHash != null && !previousPackageHash.equals(packageHash)) {
-            FileUtils.deleteDirectoryAtPath(getPackageFolderPath(previousPackageHash));
+        if (removePendingUpdate) {
+            String currentPackageFolderPath = getCurrentPackageFolderPath();
+            if (currentPackageFolderPath != null) {
+                FileUtils.deleteDirectoryAtPath(currentPackageFolderPath);
+            }
+        } else {
+            String previousPackageHash = getPreviousPackageHash();
+            if (previousPackageHash != null && !previousPackageHash.equals(packageHash)) {
+                FileUtils.deleteDirectoryAtPath(getPackageFolderPath(previousPackageHash));
+            }
+
+            info.putString(PREVIOUS_PACKAGE_KEY, CodePushUtils.tryGetString(info, CURRENT_PACKAGE_KEY));
         }
 
-        info.putString(PREVIOUS_PACKAGE_KEY, CodePushUtils.tryGetString(info, CURRENT_PACKAGE_KEY));
         info.putString(CURRENT_PACKAGE_KEY, packageHash);
         updateCurrentPackageInfo(info);
     }