@bravemobile/react-native-code-push 12.4.1 → 13.1.0-beta.0

package/typings/react-native-code-push.d.ts

@@ -28,6 +28,12 @@ export interface ReleaseInfo {
     enabled: boolean;
     mandatory: boolean;
     downloadUrl: string;
+    /**
+     * The URL of a binary patch archive built against the JS bundle embedded in the app binary.
+     * It is only present when the release was published together with such a patch, and a client
+     * that cannot use it downloads the full update from `downloadUrl` instead.
+     */
+    binaryPatchDownloadUrl?: string;
     packageHash: string;
     rollout?: number;
 }
@@ -35,6 +41,12 @@ export interface ReleaseInfo {
 // from code-push SDK
 export interface UpdateCheckResponse {
     download_url?: string;
+    /**
+     * The URL of a binary patch archive built against the JS bundle embedded in the app binary.
+     * It is only present when the release was published together with such a patch, and a client
+     * that cannot use it downloads the full update from `download_url` instead.
+     */
+    binary_patch_download_url?: string;
     description?: string;
     is_available: boolean;
     is_disabled?: boolean;
@@ -47,6 +59,50 @@ export interface UpdateCheckResponse {
     is_mandatory?: boolean;
 }
 
+/**
+ * Why an update that was published with a binary patch had to be downloaded in full
+ * instead. These are the words every platform's applier reports, so a rollout can be
+ * judged by them whichever platform it is running on.
+ */
+export type BinaryPatchFallbackReason =
+    /** The bundle inside the app binary could not be opened or read. */
+    | "base_bundle_unavailable"
+    /** The bundle inside the app binary is not the one the patch was computed against. */
+    | "base_hash_mismatch"
+    /** The manifest is missing, malformed, points outside the archive, or asks for too much. */
+    | "invalid_manifest"
+    /** The patch was produced by a format or a codec this client cannot apply. */
+    | "unsupported_format"
+    /** The applier refused the patch, or the restored bundle could not be written. */
+    | "patch_apply_failed"
+    /** The restored bundle is not the one the manifest promised. */
+    | "target_verification_failed"
+    /** The update restored from the patch did not pass the checks that follow the restore. */
+    | "package_verification_failed";
+
+/**
+ * How installing an update from its binary patch archive went.
+ */
+export interface BinaryPatchResult {
+    /**
+     * Whether the update was installed from its patch archive, or had to be downloaded in
+     * full instead. A fallback is not an error: the update is installed either way.
+     */
+    status: "applied" | "fallback";
+
+    /**
+     * Why the full archive had to be downloaded. Absent when the patch was applied, and
+     * also when the attempt ended in an error none of the appliers has a word for.
+     */
+    fallbackReason?: BinaryPatchFallbackReason;
+
+    /**
+     * How long the patch work took, in milliseconds: applying the patch when it was
+     * applied, and the whole attempt when it was given up on.
+     */
+    applyDurationMs: number;
+}
+
 export interface CodePushOptions extends SyncOptions {
     /**
      * The `ignoreFailedUpdates` option is only available as an option for `CodePush.sync()`.
@@ -192,6 +248,14 @@ export interface RemotePackage extends Package {
      * The URL at which the package is available for download.
      */
     downloadUrl: string;
+
+    /**
+     * The URL at which a binary patch archive of this package is available for download.
+     * The patch is built against the JS bundle embedded in the app binary, so it is only
+     * present when the release was published together with one. When it is absent, the
+     * package is downloaded in full from `downloadUrl`.
+     */
+    binaryPatchDownloadUrl?: string;
 }
 
 export interface SyncOptions {
@@ -239,6 +303,19 @@ export interface SyncOptions {
      */
     rollbackRetryOptions?: RollbackRetryOptions;
 
+    /**
+     * An optional callback for observing how an update published with a binary patch was
+     * installed: whether it came from the patch archive, why it did not when it did not, and
+     * how long the patch work took. It is called once per download that had a patch to try,
+     * with the label of the release being installed.
+     *
+     * Purely for observation. The library neither stores the result nor sends it anywhere -
+     * an app that wants it in its telemetry sends it itself - and nothing about the update
+     * depends on the callback: registering none changes nothing, and one that throws is
+     * logged and does not fail the install.
+     */
+    onBinaryPatchResult?: (label: string, result: BinaryPatchResult) => void;
+
     /**
      * Specifies whether to ignore the update if the installation fails.
      * If set to false, the update will be retried when the sync method is called, even if the previous installation attempt failed.

package/android/app/src/main/java/com/microsoft/codepush/react/CodePushDialog.java

@@ -1,102 +0,0 @@
-package com.microsoft.codepush.react;
-
-import android.app.Activity;
-import android.app.AlertDialog;
-import android.content.DialogInterface;
-
-import com.facebook.react.bridge.Callback;
-import com.facebook.react.bridge.LifecycleEventListener;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.bridge.ReactContextBaseJavaModule;
-import com.facebook.react.bridge.ReactMethod;
-
-public class CodePushDialog extends ReactContextBaseJavaModule{
-
-    public CodePushDialog(ReactApplicationContext reactContext) {
-        super(reactContext);
-    }
-
-    @ReactMethod
-    public void showDialog(final String title, final String message, final String button1Text,
-                           final String button2Text, final Callback successCallback, Callback errorCallback) {
-        Activity currentActivity = getCurrentActivity();
-        if (currentActivity == null || currentActivity.isFinishing()) {
-            // If getCurrentActivity is null, it could be because the app is backgrounded,
-            // so we show the dialog when the app resumes)
-            getReactApplicationContext().addLifecycleEventListener(new LifecycleEventListener() {
-                @Override
-                public void onHostResume() {
-                    Activity currentActivity = getCurrentActivity();
-                    if (currentActivity != null) {
-                        getReactApplicationContext().removeLifecycleEventListener(this);
-                        showDialogInternal(title, message, button1Text, button2Text, successCallback, currentActivity);
-                    }
-                }
-
-                @Override
-                public void onHostPause() {
-
-                }
-
-                @Override
-                public void onHostDestroy() {
-
-                }
-            });
-        } else {
-            showDialogInternal(title, message, button1Text, button2Text, successCallback, currentActivity);
-        }
-    }
-
-    private void showDialogInternal(String title, String message, String button1Text,
-                                    String button2Text, final Callback successCallback, Activity currentActivity) {
-        AlertDialog.Builder builder = new AlertDialog.Builder(currentActivity);
-
-        builder.setCancelable(false);
-
-        DialogInterface.OnClickListener clickListener = new DialogInterface.OnClickListener() {
-            @Override
-            public void onClick(DialogInterface dialog, int which) {
-                try {
-                    dialog.cancel();
-                    switch (which) {
-                        case DialogInterface.BUTTON_POSITIVE:
-                            successCallback.invoke(0);
-                            break;
-                        case DialogInterface.BUTTON_NEGATIVE:
-                            successCallback.invoke(1);
-                            break;
-                        default:
-                            throw new CodePushUnknownException("Unknown button ID pressed.");
-                    }
-                } catch (Throwable e) {
-                    CodePushUtils.log(e);
-                }
-            }
-        };
-
-        if (title != null) {
-            builder.setTitle(title);
-        }
-
-        if (message != null) {
-            builder.setMessage(message);
-        }
-
-        if (button1Text != null) {
-            builder.setPositiveButton(button1Text, clickListener);
-        }
-
-        if (button2Text != null) {
-            builder.setNegativeButton(button2Text, clickListener);
-        }
-
-        AlertDialog dialog = builder.create();
-        dialog.show();
-    }
-
-    @Override
-    public String getName() {
-        return "CodePushDialog";
-    }
-}

package/src/AlertAdapter.js

@@ -1,24 +0,0 @@
-import React, { Platform } from "react-native";
-let { Alert } = React;
-
-if (Platform.OS === "android") {
-  const { NativeModules: { CodePushDialog } } = React;
-
-  Alert = {
-    alert(title, message, buttons) {
-      if (buttons.length > 2) {
-        throw "Can only show 2 buttons for Android dialog.";
-      }
-
-      const button1Text = buttons[0] ? buttons[0].text : null,
-            button2Text = buttons[1] ? buttons[1].text : null;
-
-      CodePushDialog.showDialog(
-        title, message, button1Text, button2Text,
-        (buttonId) => { buttons[buttonId].onPress && buttons[buttonId].onPress(); },
-        (error) => { throw error; });
-    }
-  };
-}
-
-module.exports = { Alert };