jonathan feedback

Author: geof90

CodePush.ios.js

@@ -126,7 +126,7 @@ function checkForUpdate() {
  * releases, and displaying a standard confirmation UI to the end-user
  * when an update is available.
  */
-function sync(options = {}, onSyncStatusChange, onDownloadProgress) {  
+function sync(options = {}, syncStatusChangeCallback, downloadProgressCallback) {  
   var syncOptions = {
 
     ignoreFailedUpdates: true,
@@ -137,55 +137,55 @@ function sync(options = {}, onSyncStatusChange, onDownloadProgress) {
     ...options 
   };
 
-  onSyncStatusChange = typeof onSyncStatusChange == "function"
-    ? onSyncStatusChange
+  syncStatusChangeCallback = typeof syncStatusChangeCallback == "function"
+    ? syncStatusChangeCallback
     : function(syncStatus) {
         switch(syncStatus) {
           case CodePush.SyncStatus.CHECKING_FOR_UPDATE:
-            console.log("Checking for update.");
+            console.log("[CodePush] Checking for update.");
             break;
           case CodePush.SyncStatus.DOWNLOADING_PACKAGE:
-            console.log("Downloading package.");
+            console.log("[CodePush] Downloading package.");
             break;
           case CodePush.SyncStatus.AWAITING_USER_ACTION:
-            console.log("Awaiting user action.");
+            console.log("[CodePush] Awaiting user action.");
             break;
           case CodePush.SyncStatus.INSTALLING_UPDATE:
-            console.log("Installing update.");
+            console.log("[CodePush] Installing update.");
             break;
           case CodePush.SyncStatus.IDLE:
-            console.log("Sync is idle.");
+            console.log("[CodePush] Sync is idle.");
             break;
         }
       };
 
-  onDownloadProgress = typeof onDownloadProgress == "function" 
-    ? onDownloadProgress 
+  downloadProgressCallback = typeof downloadProgressCallback == "function" 
+    ? downloadProgressCallback 
     : function(downloadProgress) {
-        console.log(`Expecting ${downloadProgress.totalBytes} bytes, received ${downloadProgress.receivedBytes} bytes.`);
+        console.log(`[CodePush] Expecting ${downloadProgress.totalBytes} bytes, received ${downloadProgress.receivedBytes} bytes.`);
       };
 
   return new Promise((resolve, reject) => {
-    onSyncStatusChange(CodePush.SyncStatus.CHECKING_FOR_UPDATE);
+    syncStatusChangeCallback(CodePush.SyncStatus.CHECKING_FOR_UPDATE);
     checkForUpdate()
       .then((remotePackage) => {
         var doDownloadAndInstall = () => {
-          onSyncStatusChange(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
-          remotePackage.download(onDownloadProgress)
+          syncStatusChangeCallback(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
+          remotePackage.download(downloadProgressCallback)
             .then((localPackage) => {
-              onSyncStatusChange(CodePush.SyncStatus.INSTALLING_UPDATE);
+              syncStatusChangeCallback(CodePush.SyncStatus.INSTALLING_UPDATE);
               return localPackage.install(syncOptions.rollbackTimeout, syncOptions.installMode)
             })
             .then(() => {
-              onSyncStatusChange(CodePush.SyncStatus.IDLE);
+              syncStatusChangeCallback(CodePush.SyncStatus.IDLE);
               resolve(CodePush.SyncResult.UPDATE_INSTALLED)
             })
             .catch(reject)
             .done();
         }
 
         if (!remotePackage || (remotePackage.failedInstall && syncOptions.ignoreFailedUpdates)) {
-          onSyncStatusChange(CodePush.SyncStatus.IDLE);
+          syncStatusChangeCallback(CodePush.SyncStatus.IDLE);
           resolve(CodePush.SyncResult.UP_TO_DATE);
         }
         else if (syncOptions.updateDialog) {
@@ -222,7 +222,7 @@ function sync(options = {}, onSyncStatusChange, onDownloadProgress) {
             message += `${syncOptions.updateDialog.descriptionPrefix} ${remotePackage.description}`;  
           }
 
-          onSyncStatusChange(CodePush.SyncStatus.AWAITING_USER_ACTION);
+          syncStatusChangeCallback(CodePush.SyncStatus.AWAITING_USER_ACTION);
           AlertIOS.alert(syncOptions.updateTitle, message, dialogButtons);
         } else {
           doDownloadAndInstall();

Examples/CodePushDemoApp/CodePushDemoAppTests/InstallUpdateTests/DownloadAndInstallUpdateTest.js

@@ -39,7 +39,7 @@ var DownloadAndInstallUpdateTest = React.createClass({
   runTest() {
     var update = require("./TestPackage");
     NativeBridge.downloadUpdate(update).done((downloadedPackage) => {
-      NativeBridge.installUpdate(downloadedPackage, /*rollbackTimeout*/ 1000, /*restartImmediately*/ true);
+      NativeBridge.installUpdate(downloadedPackage, /*rollbackTimeout*/ 1000, CodePushSdk.InstallMode.IMMEDIATE);
     });
   },
 

README.md

@@ -263,11 +263,11 @@ Contains details about an update package that has been downloaded locally or alr
 - __isFirstRun__: Flag indicating whether this is the first time the package has been run after being installed. (Boolean) This is useful for determining whether you would like to show a "What's New?" UI to the end-user after installing an update.
 
 ##### Methods
-- __install(rollbackTimeout: Number = 0, installMode: CodePush.InstallMode = CodePush.InstallMode.UPDATE_ON_RESTART): Promise<void>__: Installs this package to the application by unzipping its contents (e.g. the JS bundle) and saving it to the location on disk where the runtime expects to find the latest version of the app. If the `restartImmediately` parameter is set to `false`, the install will complete, but it won't take effect until the next time that the app is restarted. Otherwise, the app will be immediately restarted after performing the install, so that the end-user sees the changes.
+- __install(rollbackTimeout: Number = 0, installMode: CodePush.InstallMode = CodePush.InstallMode.UPDATE_ON_RESTART): Promise<void>__: Installs this package to the application by unzipping its contents (e.g. the JS bundle) and saving it to the location on disk where the runtime expects to find the latest version of the app. If the `InstallMode` parameter is set to `UPDATE_ON_RESTART`, the install will complete, but it won't take effect until the next time that the app is restarted. If it is `UPDATE_ON_RESUME`, it will take effect when the app is next resumed after going into the background. If the parameter is set to `IMMEDIATE`, it will immediately restart after performing the install, so that the end-user sees the changes.
 <br /><br />
 If a value greater than zero is provided to the `rollbackTimeout` parameter, the application will wait for the `notifyApplicationReady` method to be called for the given number of milliseconds.
 <br /><br />
-Note: The "rollback timer" doesn't start until the update has actually become active. If you pass a truthy value to the `restartImmediately` parameter, then the rollback timer will also start immediately. However, if you pass a falsey value, then the rollback timer will start the next time the app starts, not at the point that you called `install`.
+Note: The "rollback timer" doesn't start until the update has actually become active. If the `installMode` is `IMMEDIATE`, then the rollback timer will also start immediately. However, if the `installMode` is `UPDATE_ON_RESTART` or `UPDATE_ON_RESUME`, then the rollback timer will start the next time the app starts or resumes, not at the point that you called `install`.
 
 #### RemotePackage
 
@@ -280,7 +280,7 @@ The `RemotePackage` inherits all of the same properties as the `LocalPackage`, b
 - __downloadUrl__: The URL at which the package is available for download. (String). This property is only needed for advanced usage, since the `download` method will automatically handle the acquisition of updates for you.
 
 ##### Methods
-- __download(progressHandler?: Function): Promise<LocalPackage>__: Downloads the package update from the CodePush service. If a `progressHandler` is specified, it will be called periodically with a `DownloadProgress` object (`{ totalBytes: Number, receivedBytes: Number }`) that reports the progress of the download until the download completes. Returns a Promise that resolves with the `LocalPackage`.
+- __download(downloadProgressCallback?: Function): Promise<LocalPackage>__: Downloads the package update from the CodePush service. If a `downloadProgressCallback` is specified, it will be called periodically with a `DownloadProgress` object (`{ totalBytes: Number, receivedBytes: Number }`) that reports the progress of the download until the download completes. Returns a Promise that resolves with the `LocalPackage`.
 
 ---
 

jsconfig.json

@@ -6,17 +6,17 @@ module.exports = (NativeCodePush) => {
     abortDownload: function abortDownload() {
       return NativeCodePush.abortDownload(this);
     },
-    download: function download(progressHandler) {
+    download: function download(downloadProgressCallback) {
       if (!this.downloadUrl) {
         return Promise.reject(new Error("Cannot download an update without a download url"));
       }
 
       var downloadProgressSubscription;
-      if (progressHandler) {
+      if (downloadProgressCallback) {
         // Use event subscription to obtain download progress.   
         downloadProgressSubscription = NativeAppEventEmitter.addListener(
           "CodePushDownloadProgress",
-          progressHandler
+          downloadProgressCallback
         );
       }
 
@@ -36,7 +36,7 @@ module.exports = (NativeCodePush) => {
   };
 
   var local = {
-    install: function install(rollbackTimeout = 0, installMode = NativeCodePush.codePushInstallModeImmediate) {
+    install: function install(rollbackTimeout = 0, installMode = NativeCodePush.codePushInstallModeOnNextRestart) {
       return NativeCodePush.installUpdate(this, rollbackTimeout, installMode);
     }
   };