Merge pull request #294 from Microsoft/updateMetadata

codePush.getUpdateMetadata

Author: lostintangent

CodePush.js

@@ -100,12 +100,16 @@ const getConfiguration = (() => {
 })();
 
 async function getCurrentPackage() {
-  const localPackage = await NativeCodePush.getCurrentPackage();
-  if (localPackage) {
-      localPackage.failedInstall = await NativeCodePush.isFailedUpdate(localPackage.packageHash);
-      localPackage.isFirstRun = await NativeCodePush.isFirstRun(localPackage.packageHash);
+  return await getUpdateMetadata(CodePush.UpdateState.LATEST);
+}
+
+async function getUpdateMetadata(updateState) {
+  const updateMetadata = await NativeCodePush.getUpdateMetadata(updateState || CodePush.UpdateState.RUNNING);
+  if (updateMetadata) {
+    updateMetadata.failedInstall = await NativeCodePush.isFailedUpdate(updateMetadata.packageHash);
+    updateMetadata.isFirstRun = await NativeCodePush.isFirstRun(updateMetadata.packageHash);
   }
-  return localPackage;
+  return updateMetadata;
 }
 
 function getPromisifiedSdk(requestFetchAdapter, config) {
@@ -383,45 +387,52 @@ let CodePush;
 // and therefore, it doesn't make sense initializing 
 // the JS interface when it wouldn't work anyways.
 if (NativeCodePush) {
-    CodePush = {
-        AcquisitionSdk: Sdk,
-        checkForUpdate,
-        getConfiguration,
-        getCurrentPackage,
-        log,
-        notifyApplicationReady,
-        restartApp,
-        setUpTestDependencies,
-        sync,
-        InstallMode: {
-            IMMEDIATE: NativeCodePush.codePushInstallModeImmediate, // Restart the app immediately
-            ON_NEXT_RESTART: NativeCodePush.codePushInstallModeOnNextRestart, // Don't artificially restart the app. Allow the update to be "picked up" on the next app restart
-            ON_NEXT_RESUME: NativeCodePush.codePushInstallModeOnNextResume // Restart the app the next time it is resumed from the background
-        },
-        SyncStatus: {
-            CHECKING_FOR_UPDATE: 0,
-            AWAITING_USER_ACTION: 1,
-            DOWNLOADING_PACKAGE: 2,
-            INSTALLING_UPDATE: 3,
-            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: {
-            appendReleaseDescription: false,
-            descriptionPrefix: " Description: ",
-            mandatoryContinueButtonLabel: "Continue",
-            mandatoryUpdateMessage: "An update is available that must be installed.",
-            optionalIgnoreButtonLabel: "Ignore",
-            optionalInstallButtonLabel: "Install",
-            optionalUpdateMessage: "An update is available. Would you like to install it?",
-            title: "Update available"
-        }
+  CodePush = {
+    AcquisitionSdk: Sdk,
+    checkForUpdate,
+    getConfiguration,
+    getCurrentPackage,
+    getUpdateMetadata,
+    log,
+    notifyAppReady: notifyApplicationReady,
+    notifyApplicationReady,
+    restartApp,
+    setUpTestDependencies,
+    sync,
+    InstallMode: {
+      IMMEDIATE: NativeCodePush.codePushInstallModeImmediate, // Restart the app immediately
+      ON_NEXT_RESTART: NativeCodePush.codePushInstallModeOnNextRestart, // Don't artificially restart the app. Allow the update to be "picked up" on the next app restart
+      ON_NEXT_RESUME: NativeCodePush.codePushInstallModeOnNextResume // Restart the app the next time it is resumed from the background
+    },
+    SyncStatus: {
+      CHECKING_FOR_UPDATE: 0,
+      AWAITING_USER_ACTION: 1,
+      DOWNLOADING_PACKAGE: 2,
+      INSTALLING_UPDATE: 3,
+      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
+    },
+    UpdateState: {
+      RUNNING: NativeCodePush.codePushUpdateStateRunning,
+      PENDING: NativeCodePush.codePushUpdateStatePending,
+      LATEST: NativeCodePush.codePushUpdateStateLatest
+    },
+    DEFAULT_UPDATE_DIALOG: {
+      appendReleaseDescription: false,
+      descriptionPrefix: " Description: ",
+      mandatoryContinueButtonLabel: "Continue",
+      mandatoryUpdateMessage: "An update is available that must be installed.",
+      optionalIgnoreButtonLabel: "Ignore",
+      optionalInstallButtonLabel: "Install",
+      optionalUpdateMessage: "An update is available. Would you like to install it?",
+      title: "Update available"
     }
+  };
 } else {
-    log("The CodePush module doesn't appear to be properly installed. Please double-check that everything is setup correctly.");
+  log("The CodePush module doesn't appear to be properly installed. Please double-check that everything is setup correctly.");
 }
 
-module.exports = CodePush;
+module.exports = CodePush;

README.md

@@ -378,7 +378,7 @@ When you require `react-native-code-push`, the module object provides the follow
 
 * [checkForUpdate](#codepushcheckforupdate): Asks the CodePush service whether the configured app deployment has an update available. 
 
-* [getCurrentPackage](#codepushgetcurrentpackage): Retrieves the metadata about the currently installed update (e.g. description, installation time, size).
+* [getUpdateMetadata](#codepushgetupdatemetadata): Retrieves the metadata for an installed update (e.g. description, mandatory).
 
 * [notifyApplicationReady](#codepushnotifyapplicationready): Notifies the CodePush runtime that an installed update is considered successful. If you are manually checking for and installing updates (i.e. not using the [sync](#codepushsync) method to handle it all for you), then this method **MUST** be called; otherwise CodePush will treat the update as failed and rollback to the previous version when the app next restarts.
 
@@ -417,33 +417,41 @@ codePush.checkForUpdate()
 });
 ```
 
-#### codePush.getCurrentPackage
+#### codePush.getUpdateMetadata
 
 ```javascript
-codePush.getCurrentPackage(): Promise<LocalPackage>;
+codePush.getUpdateMetadata(updateState: UpdateState = UpdateState.RUNNING): Promise<LocalPackage>;
 ```
 
-Retrieves the metadata about the currently installed "package" (e.g. description, installation time). This can be useful for scenarios such as displaying a "what's new?" dialog after an update has been applied or checking whether there is a pending update that is waiting to be applied via a resume or restart.
+Retrieves the metadata for an installed update (e.g. description, mandatory) whose state matches the specified `updateState` parameter. This can be useful for scenarios such as displaying a "what's new?" dialog after an update has been applied or checking whether there is a pending update that is waiting to be applied via a resume or restart. For more details about the possible update states, and what they represent, refer to the [UpdateState reference](#updatestate).
 
 This method returns a `Promise` which resolves to one of two possible values:
 
-1. `null` if the app is currently running the JS bundle from the binary and not a CodePush update. This occurs in the following scenarios:
+1. `null` if an update with the specified state doesn't currently exist. This occurs in the following scenarios:
 
-    1. The end-user installed the app binary and has yet to install a CodePush update
+    1. The end-user hasn't installed any CodePush updates yet, and therefore, no metadata is available for any updates, regardless what you specify as the `updateState` parameter.
     1. The end-user installed an update of the binary (e.g. from the store), which cleared away the old CodePush updates, and gave precedence back to the JS binary in the binary.
+    1. The `updateState` parameter is set to `UpdateState.RUNNING`, but the app isn't currently running a CodePush update. There may be a pending update, which requires an app restart to become active.
+    1. The `updateState` parameter is set to `UpdateState.PENDING`, but the app doesn't have any pending updates.
 
-2. A [`LocalPackage`](#localpackage) instance which represents the metadata for the currently running CodePush update.
+2. A [`LocalPackage`](#localpackage) instance which represents the metadata for the currently requested CodePush update (either the running or pending).
 
 Example Usage: 
 
 ```javascript
-codePush.getCurrentPackage()
-.then((update) => {
-    // If the current app "session" represents the first time
-    // this update has run, and it had a description provided
-    // with it upon release, let's show it to the end user
-    if (update.isFirstRun && update.description) {
-        // Display a "what's new?" modal
+// Check if there is currently a CodePush update running, and if
+// so, register it with the HockeyApp SDK (https://github.com/slowpath/react-native-hockeyapp)
+// so that crash reports will correctly display the JS bundle version the user was running.
+codePush.getUpdateMetadata().then((update) => {
+    if (update) {
+        hockeyApp.addMetadata({ CodePushRelease: update.label });
+    }
+});
+
+// Check to see if there is still an update pending.
+codePush.getUpdateMetadata(UpdateState.PENDING).then((update) => {
+    if (update) {
+        // There's a pending update, do we want to force a restart?   
     }
 });
 ```
@@ -486,7 +494,6 @@ This method provides support for two different (but customizable) "modes" to eas
 
 2. **Active mode**, which when an update is available, prompts the end user for permission before downloading it, and then immediately applies the update. If an update was released using the `mandatory` flag, the end user would still be notified about the update, but they wouldn't have the choice to ignore it.
 
-
 Example Usage: 
 
 ```javascript
@@ -650,7 +657,7 @@ The CodePush API includes the following enums which can be used to customize the
 
 ##### InstallMode
 
-This enum specified when you would like an installed update to actually be applied, and can be passed to either the `sync` or `LocalPackage.install` methods. It includes the following values:
+This enum specifies when you would like an installed update to actually be applied, and can be passed to either the `sync` or `LocalPackage.install` methods. It includes the following values:
 
 * __codePush.InstallMode.IMMEDIATE__ *(0)* - Indicates that you want to install the update and restart the app immediately. This value is appropriate for debugging scenarios as well as when displaying an update prompt to the user, since they would expect to see the changes immediately after accepting the installation. Additionally, this mode can be used to enforce mandatory updates, since it removes the potentially undesired latency between the update installation and the next time the end user restarts or resumes the app.
 
@@ -672,6 +679,16 @@ This enum is provided to the `syncStatusChangedCallback` function that can be pa
 * __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. 
 
+##### UpdateState
+
+This enum specifies the state that an update is currently in, and can be specified when calling the `getUpdateMetadata` method. It includes the following values:
+
+* __codePush.UpdateState.RUNNING__ *(0)* - Indicates that an update represents the version of the app that is currently running. This can be useful for identifying attributes about the app, for scenarios such as displaying the release description in a "what's new?" dialog or reporting the latest version to an analytics and/or crash reporting service.
+
+* __codePush.UpdateState.PENDING__ *(1)* - Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it. This can be useful for determining whether there is a pending update, which you may want to force a programmatic restart (via `restartApp`) in order to apply.
+ 
+* __codePush.UpdateState.LATEST__ *(2)* - Indicates than an update represents the latest available release, and can be either currently running or pending.
+
 ### Objective-C API Reference (iOS)
 
 The Objective-C API is made available by importing the `CodePush.h` header into your `AppDelegate.m` file, and consists of a single public class named `CodePush`.

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

@@ -353,9 +353,15 @@ public CodePushNativeModule(ReactApplicationContext reactContext) {
         @Override
         public Map<String, Object> getConstants() {
             final Map<String, Object> constants = new HashMap<>();
+            
             constants.put("codePushInstallModeImmediate", CodePushInstallMode.IMMEDIATE.getValue());
             constants.put("codePushInstallModeOnNextRestart", CodePushInstallMode.ON_NEXT_RESTART.getValue());
             constants.put("codePushInstallModeOnNextResume", CodePushInstallMode.ON_NEXT_RESUME.getValue());
+            
+            constants.put("codePushUpdateStateRunning", CodePushUpdateState.RUNNING.getValue());
+            constants.put("codePushUpdateStatePending", CodePushUpdateState.PENDING.getValue());
+            constants.put("codePushUpdateStateLatest", CodePushUpdateState.LATEST.getValue());
+            
             return constants;
         }
 
@@ -481,31 +487,51 @@ public void getConfiguration(Promise promise) {
 
             promise.resolve(configMap);
         }
-
+        
         @ReactMethod
-        public void getCurrentPackage(final Promise promise) {
+        public void getUpdateMetadata(final int updateState, final Promise promise) {
             AsyncTask<Void, Void, Void> asyncTask = new AsyncTask<Void, Void, Void>() {
                 @Override
                 protected Void doInBackground(Void... params) {
                     WritableMap currentPackage = codePushPackage.getCurrentPackage();
+                    
                     if (currentPackage == null) {
                         promise.resolve("");
                         return null;
                     }
 
-                    if (isRunningBinaryVersion) {
-                        currentPackage.putBoolean("_isDebugOnly", true);
-                    }
-
-                    Boolean isPendingUpdate = false;
+                    Boolean currentUpdateIsPending = false;
 
                     if (currentPackage.hasKey(PACKAGE_HASH_KEY)) {
                         String currentHash = currentPackage.getString(PACKAGE_HASH_KEY);
-                        isPendingUpdate = CodePush.this.isPendingUpdate(currentHash);
+                        currentUpdateIsPending = CodePush.this.isPendingUpdate(currentHash);
                     }
+                    
+                    if (updateState == CodePushUpdateState.PENDING.getValue() && !currentUpdateIsPending) {
+                        // The caller wanted a pending update
+                        // but there isn't currently one.
+                        promise.resolve("");
+                    } else if (updateState == CodePushUpdateState.RUNNING.getValue() && currentUpdateIsPending) {
+                        // The caller wants the running update, but the current
+                        // one is pending, so we need to grab the previous.
+                        promise.resolve(codePushPackage.getPreviousPackage());
+                    } else {
+                        // The current package satisfies the request:
+                        // 1) Caller wanted a pending, and there is a pending update
+                        // 2) Caller wanted the running update, and there isn't a pending
+                        // 3) Caller wants the latest update, regardless if it's pending or not
+                        if (isRunningBinaryVersion) {
+                            // This only matters in Debug builds. Since we do not clear "outdated" updates,
+                            // we need to indicate to the JS side that somehow we have a current update on
+                            // disk that is not actually running.
+                            currentPackage.putBoolean("_isDebugOnly", true);
+                        }
 
-                    currentPackage.putBoolean("isPending", isPendingUpdate);
-                    promise.resolve(currentPackage);
+                        // Enable differentiating pending vs. non-pending updates
+                        currentPackage.putBoolean("isPending", currentUpdateIsPending);
+                        promise.resolve(currentPackage);
+                    }
+                    
                     return null;
                 }
             };

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

@@ -18,7 +18,6 @@
 import java.nio.ByteBuffer;
 
 public class CodePushPackage {
-
     private final String CODE_PUSH_FOLDER_PREFIX = "CodePush";
     private final String CURRENT_PACKAGE_KEY = "currentPackage";
     private final String DIFF_MANIFEST_FILE_NAME = "hotcodepush.json";
@@ -124,18 +123,21 @@ public String getPreviousPackageHash() {
     }
 
     public WritableMap getCurrentPackage() {
-        String folderPath = getCurrentPackageFolderPath();
-        if (folderPath == null) {
+        String packageHash = getCurrentPackageHash();
+        if (packageHash == null) {
             return null;
         }
-
-        String packagePath = CodePushUtils.appendPathComponent(folderPath, PACKAGE_FILE_NAME);
-        try {
-            return CodePushUtils.getWritableMapFromFile(packagePath);
-        } catch (IOException e) {
-            // Should not happen unless the update metadata was somehow deleted.
+        
+        return getPackage(packageHash);
+    }
+    
+    public WritableMap getPreviousPackage() {
+        String packageHash = getPreviousPackageHash();
+        if (packageHash == null) {
             return null;
         }
+        
+        return getPackage(packageHash);
     }
 
     public WritableMap getPackage(String packageHash) {
@@ -340,8 +342,6 @@ public void downloadAndReplaceCurrentBundle(String remoteBundleUrl, String bundl
     }
 
     public void clearUpdates() {
-        File statusFile = new File(getStatusFilePath());
-        statusFile.delete();
         FileUtils.deleteDirectoryAtPath(getCodePushPath());
     }
-}
+}

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

@@ -0,0 +1,15 @@
+package com.microsoft.codepush.react;
+
+public enum CodePushUpdateState {
+    RUNNING(0),
+    PENDING(1),
+    LATEST(2);
+
+    private final int value;
+    CodePushUpdateState(int value) {
+        this.value = value;
+    }
+    public int getValue() {
+        return this.value;
+    }
+}