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

package/src/CodePush.js

@@ -1,14 +1,46 @@
-import { Alert } from "./AlertAdapter";
-import { AppState, Platform } from "react-native";
+import { Alert, AppState, Platform } from "react-native";
 import log from "./logging";
 import hoistStatics from 'hoist-non-react-statics';
 import { SemverVersioning } from './versioning/SemverVersioning'
 
-let NativeCodePush = require("react-native").NativeModules.CodePush;
-const PackageMixins = require("./package-mixins")(NativeCodePush);
+const NativeCodePushModule = require("./native/NativeCodePush");
+let NativeCodePush = NativeCodePushModule.getNativeCodePush?.() ?? NativeCodePushModule.default;
+const { InstallMode, UpdateState } = NativeCodePushModule;
+let PackageMixins = NativeCodePush ? require("./package-mixins")(NativeCodePush) : null;
 
 const DEPLOYMENT_KEY = 'deprecated_deployment_key';
 
+function getNativeCodePush() {
+  if (!NativeCodePush) {
+    const NativeCodePushModule = require("./native/NativeCodePush");
+    NativeCodePush = NativeCodePushModule.getNativeCodePush?.() ?? NativeCodePushModule.default;
+  }
+
+  if (NativeCodePush && !PackageMixins) {
+    PackageMixins = require("./package-mixins")(NativeCodePush);
+  }
+
+  return NativeCodePush;
+}
+
+function requireNativeCodePush(callerName) {
+  const nativeCodePush = getNativeCodePush();
+  if (!nativeCodePush) {
+    throw new Error(`The CodePush native module isn't available during ${callerName}.`);
+  }
+
+  return nativeCodePush;
+}
+
+function requirePackageMixins(callerName) {
+  const nativeCodePush = requireNativeCodePush(callerName);
+  if (!PackageMixins) {
+    PackageMixins = require("./package-mixins")(nativeCodePush);
+  }
+
+  return PackageMixins;
+}
+
 /**
  * @param deviceId {string}
  * @returns {number}
@@ -67,7 +99,7 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
    * for their specific deployment and version and which are actually
    * different from the CodePush update they have already installed.
    */
-  const nativeConfig = await getConfiguration();
+  const nativeConfig = await getConfiguration("checkForUpdate");
 
   // Use dynamically overridden getCurrentPackage() during tests.
   const localPackage = await module.exports.getCurrentPackage();
@@ -149,6 +181,11 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
          */
         const updateInfo = {
           download_url: latestReleaseInfo.downloadUrl,
+          /**
+           * Only released updates that were published with a binary patch carry this.
+           * When it is missing, the update is downloaded in full from `download_url`.
+           */
+          binary_patch_download_url: latestReleaseInfo.binaryPatchDownloadUrl,
           // (`enabled` will always be true in the release information obtained from the previous process.)
           is_available: latestReleaseInfo.enabled,
           package_hash: latestReleaseInfo.packageHash,
@@ -202,8 +239,9 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
    * 4) The server said there is an update, but the update's hash is the same as that
    *    of the binary's currently running version. This should only happen in Android -
    *    unlike iOS, we don't attach the binary's hash to the updateCheck request
-   *    because we want to avoid having to install diff updates against the binary's
-   *    version, which we can't do yet on Android.
+   *    because an update built against the binary's version does not need one: a
+   *    release published with a binary patch carries the patch archive next to the
+   *    full one, and the client decides for itself which of the two to install.
    */
   if (!update || update.updateAppVersion ||
       localPackage && (update.packageHash === localPackage.packageHash) ||
@@ -217,8 +255,10 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
 
     return null;
   } else {
-    const remotePackage = { ...update, ...PackageMixins.remote() };
-    remotePackage.failedInstall = await NativeCodePush.isFailedUpdate(remotePackage.packageHash);
+    const nativeCodePush = requireNativeCodePush("checkForUpdate");
+    const packageMixins = requirePackageMixins("checkForUpdate");
+    const remotePackage = { ...update, ...packageMixins.remote() };
+    remotePackage.failedInstall = await nativeCodePush.isFailedUpdate(remotePackage.packageHash);
     return remotePackage;
   }
 }
@@ -247,18 +287,24 @@ function mapToRemotePackageMetadata(updateInfo) {
     packageHash: updateInfo.package_hash ?? '',
     packageSize: updateInfo.package_size ?? 0,
     downloadUrl: updateInfo.download_url ?? '',
+    // The field stays out of the package unless the update really has a binary patch,
+    // so that the native side sees exactly what it saw before patches existed.
+    ...(updateInfo.binary_patch_download_url
+      ? { binaryPatchDownloadUrl: updateInfo.binary_patch_download_url }
+      : {}),
   };
 }
 
 const getConfiguration = (() => {
   let config;
-  return async function getConfiguration() {
+  return async function getConfiguration(callerName = "getConfiguration") {
     if (config) {
       return config;
     } else if (testConfig) {
       return testConfig;
     } else {
-      config = await NativeCodePush.getConfiguration();
+      const nativeCodePush = requireNativeCodePush(callerName);
+      config = await nativeCodePush.getConfiguration();
       return config;
     }
   }
@@ -269,11 +315,13 @@ async function getCurrentPackage() {
 }
 
 async function getUpdateMetadata(updateState) {
-  let updateMetadata = await NativeCodePush.getUpdateMetadata(updateState || CodePush.UpdateState.RUNNING);
+  const nativeCodePush = requireNativeCodePush("getUpdateMetadata");
+  const packageMixins = requirePackageMixins("getUpdateMetadata");
+  let updateMetadata = await nativeCodePush.getUpdateMetadata(updateState || CodePush.UpdateState.RUNNING);
   if (updateMetadata) {
-    updateMetadata = { ...PackageMixins.local, ...updateMetadata };
-    updateMetadata.failedInstall = await NativeCodePush.isFailedUpdate(updateMetadata.packageHash);
-    updateMetadata.isFirstRun = await NativeCodePush.isFirstRun(updateMetadata.packageHash);
+    updateMetadata = { ...packageMixins.local, ...updateMetadata };
+    updateMetadata.failedInstall = await nativeCodePush.isFailedUpdate(updateMetadata.packageHash);
+    updateMetadata.isFirstRun = await nativeCodePush.isFirstRun(updateMetadata.packageHash);
   }
   return updateMetadata;
 }
@@ -292,14 +340,21 @@ const notifyApplicationReady = (() => {
 })();
 
 async function notifyApplicationReadyInternal() {
-  await NativeCodePush.notifyApplicationReady();
-  const statusReport = await NativeCodePush.getNewStatusReport();
+  const nativeCodePush = requireNativeCodePush("notifyApplicationReady");
+  await nativeCodePush.notifyApplicationReady();
+  const statusReport = await nativeCodePush.getNewStatusReport();
   statusReport && tryReportStatus(statusReport); // Don't wait for this to complete.
 
   return statusReport;
 }
 
 async function tryReportStatus(statusReport, retryOnAppResume) {
+  const nativeCodePush = getNativeCodePush();
+  if (!nativeCodePush) {
+    retryOnAppResume && retryOnAppResume.remove();
+    return;
+  }
+
   try {
     if (statusReport.appVersion) {
       log(`Reporting binary update (${statusReport.appVersion})`);
@@ -310,22 +365,27 @@ async function tryReportStatus(statusReport, retryOnAppResume) {
         sharedCodePushOptions?.onUpdateSuccess?.(label);
       } else {
         log(`Reporting CodePush update rollback (${label})`);
-        await NativeCodePush.setLatestRollbackInfo(statusReport.package.packageHash);
+        await nativeCodePush.setLatestRollbackInfo(statusReport.package.packageHash);
         sharedCodePushOptions?.onUpdateRollback?.(label);
       }
     }
 
-    NativeCodePush.recordStatusReported(statusReport);
+    nativeCodePush.recordStatusReported(statusReport);
     retryOnAppResume && retryOnAppResume.remove();
   } catch (e) {
     log(`${e}`)
     log(`Report status failed: ${JSON.stringify(statusReport)}`);
-    NativeCodePush.saveStatusReportForRetry(statusReport);
+    nativeCodePush.saveStatusReportForRetry(statusReport);
     // Try again when the app resumes
     if (!retryOnAppResume) {
       const resumeListener = AppState.addEventListener("change", async (newState) => {
         if (newState !== "active") return;
-        const refreshedStatusReport = await NativeCodePush.getNewStatusReport();
+        const refreshedNativeCodePush = getNativeCodePush();
+        if (!refreshedNativeCodePush) {
+          return;
+        }
+
+        const refreshedStatusReport = await refreshedNativeCodePush.getNewStatusReport();
         if (refreshedStatusReport) {
           tryReportStatus(refreshedStatusReport, resumeListener);
         } else {
@@ -358,7 +418,8 @@ async function shouldUpdateBeIgnored(remotePackage, syncOptions) {
     return true;
   }
 
-  const latestRollbackInfo = await NativeCodePush.getLatestRollbackInfo();
+  const nativeCodePush = requireNativeCodePush("shouldUpdateBeIgnored");
+  const latestRollbackInfo = await nativeCodePush.getLatestRollbackInfo();
   if (!validateLatestRollbackInfo(latestRollbackInfo, remotePackage.packageHash)) {
     log("The latest rollback info is not valid.");
     return true;
@@ -407,11 +468,15 @@ let testConfig;
 function setUpTestDependencies(testSdk, providedTestConfig, testNativeBridge) {
   if (testSdk) module.exports.AcquisitionSdk = testSdk;
   if (providedTestConfig) testConfig = providedTestConfig;
-  if (testNativeBridge) NativeCodePush = testNativeBridge;
+  if (testNativeBridge) {
+    NativeCodePush = testNativeBridge;
+    PackageMixins = require("./package-mixins")(NativeCodePush);
+  }
 }
 
 async function restartApp(onlyIfUpdateIsPending = false) {
-  NativeCodePush.restartApp(onlyIfUpdateIsPending);
+  const nativeCodePush = requireNativeCodePush("restartApp");
+  nativeCodePush.restartApp(onlyIfUpdateIsPending);
 }
 
 // This function allows only one syncInternal operation to proceed at any given time.
@@ -478,9 +543,28 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
     mandatoryInstallMode: CodePush.InstallMode.IMMEDIATE,
     minimumBackgroundDuration: 0,
     updateDialog: null,
+    // The callback registered on the decorator is the default for every sync, including a
+    // manual one; a callback passed to this call overrides it for this call.
+    onBinaryPatchResult: sharedCodePushOptions.onBinaryPatchResult ?? null,
     ...options,
   };
 
+  /*
+   * A callback an app registered to observe how a binary patch went must not be able to
+   * cost it an update, so it is isolated the way the other sync callbacks are: whatever it
+   * throws is logged and the install carries on. An app that registered none leaves the
+   * download exactly as it was before this option existed.
+   */
+  const onBinaryPatchResult = typeof syncOptions.onBinaryPatchResult === "function"
+    ? (label, result) => {
+      try {
+        syncOptions.onBinaryPatchResult(label, result);
+      } catch (error) {
+        log(`An error has occurred : ${error.stack}`);
+      }
+    }
+    : null;
+
   syncStatusChangeCallback = typeof syncStatusChangeCallback === "function"
     ? syncStatusChangeCallback
     : (syncStatus) => {
@@ -532,7 +616,10 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
       syncStatusChangeCallback(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
       sharedCodePushOptions.onDownloadStart?.(remotePackageLabel);
 
-      const localPackage = await remotePackage.download(downloadProgressCallback);
+      const localPackage = await remotePackage.download(
+        downloadProgressCallback,
+        onBinaryPatchResult && ((result) => onBinaryPatchResult(remotePackageLabel, result)),
+      );
 
       sharedCodePushOptions.onDownloadSuccess?.(remotePackageLabel);
 
@@ -666,6 +753,9 @@ let CodePush;
  *
  *   onRolloutSkipped: (label: string, error: Error) => void | undefined,
  *   setOnRolloutSkipped(onRolloutSkippedFunction: (label: string, error: Error) => void | undefined): void,
+ *
+ *   onBinaryPatchResult: (label: string, result: object) => void | undefined,
+ *   setOnBinaryPatchResult(onBinaryPatchResultFunction: (label: string, result: object) => void | undefined): void,
  * }}
  */
 const sharedCodePushOptions = {
@@ -716,6 +806,12 @@ const sharedCodePushOptions = {
     if (typeof onRolloutSkippedFunction !== 'function') throw new Error('Please pass a function to onRolloutSkipped');
     this.onRolloutSkipped = onRolloutSkippedFunction;
   },
+  onBinaryPatchResult: undefined,
+  setOnBinaryPatchResult(onBinaryPatchResultFunction) {
+    if (!onBinaryPatchResultFunction) return;
+    if (typeof onBinaryPatchResultFunction !== 'function') throw new Error('Please pass a function to onBinaryPatchResult');
+    this.onBinaryPatchResult = onBinaryPatchResultFunction;
+  },
 }
 
 function codePushify(options = {}) {
@@ -752,6 +848,7 @@ function codePushify(options = {}) {
   sharedCodePushOptions.setOnDownloadSuccess(options.onDownloadSuccess);
   sharedCodePushOptions.setOnSyncError(options.onSyncError);
   sharedCodePushOptions.setOnRolloutSkipped(options.onRolloutSkipped);
+  sharedCodePushOptions.setOnBinaryPatchResult(options.onBinaryPatchResult);
 
   const decorator = (RootComponent) => {
     class CodePushComponent extends React.Component {
@@ -817,76 +914,73 @@ function codePushify(options = {}) {
   }
 }
 
-// If the "NativeCodePush" variable isn't defined, then
-// the app didn't properly install the native module,
-// and therefore, it doesn't make sense initializing
-// the JS interface when it wouldn't work anyways.
-if (NativeCodePush) {
-  CodePush = codePushify;
-  Object.assign(CodePush, {
-    checkForUpdate,
-    getConfiguration,
-    getCurrentPackage,
-    getUpdateMetadata,
-    log,
-    notifyAppReady: notifyApplicationReady,
-    notifyApplicationReady,
-    restartApp,
-    setUpTestDependencies,
-    sync,
-    disallowRestart: NativeCodePush.disallow,
-    allowRestart: NativeCodePush.allow,
-    clearUpdates: NativeCodePush.clearUpdates,
-    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
-      ON_NEXT_SUSPEND: NativeCodePush.codePushInstallModeOnNextSuspend, // Restart the app _while_ it is in the background,
-      // but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
-      // so that user context isn't lost unless the app suspension is long enough to not matter
-    },
-    SyncStatus: {
-      UP_TO_DATE: 0, // The running app is up-to-date
-      UPDATE_INSTALLED: 1, // The app had an optional/mandatory update that was successfully downloaded and is about to be installed.
-      UPDATE_IGNORED: 2, // The app had an optional update and the end-user chose to ignore it
-      UNKNOWN_ERROR: 3,
-      SYNC_IN_PROGRESS: 4, // There is an ongoing "sync" operation in progress.
-      CHECKING_FOR_UPDATE: 5,
-      AWAITING_USER_ACTION: 6,
-      DOWNLOADING_PACKAGE: 7,
-      INSTALLING_UPDATE: 8,
-    },
-    CheckFrequency: {
-      ON_APP_START: 0,
-      ON_APP_RESUME: 1,
-      MANUAL: 2,
-    },
-    UpdateState: {
-      RUNNING: NativeCodePush.codePushUpdateStateRunning,
-      PENDING: NativeCodePush.codePushUpdateStatePending,
-      LATEST: NativeCodePush.codePushUpdateStateLatest,
-    },
-    DeploymentStatus: {
-      FAILED: "DeploymentFailed",
-      SUCCEEDED: "DeploymentSucceeded",
-    },
-    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",
-    },
-    DEFAULT_ROLLBACK_RETRY_OPTIONS: {
-      delayInHours: 24,
-      maxRetryAttempts: 1,
-    },
-  });
-} else {
-  log("The CodePush module doesn't appear to be properly installed. Please double-check that everything is setup correctly.");
-}
+CodePush = codePushify;
+Object.assign(CodePush, {
+  checkForUpdate,
+  getConfiguration,
+  getCurrentPackage,
+  getUpdateMetadata,
+  log,
+  notifyAppReady: notifyApplicationReady,
+  notifyApplicationReady,
+  restartApp,
+  setUpTestDependencies,
+  sync,
+  disallowRestart: () => {
+    const nativeCodePush = requireNativeCodePush("disallowRestart");
+    return nativeCodePush.disallow();
+  },
+  allowRestart: () => {
+    const nativeCodePush = requireNativeCodePush("allowRestart");
+    return nativeCodePush.allow();
+  },
+  clearUpdates: () => {
+    const nativeCodePush = requireNativeCodePush("clearUpdates");
+    return nativeCodePush.clearUpdates();
+  },
+  InstallMode: {
+    IMMEDIATE: InstallMode.IMMEDIATE, // Restart the app immediately
+    ON_NEXT_RESTART: InstallMode.ON_NEXT_RESTART, // Don't artificially restart the app. Allow the update to be "picked up" on the next app restart
+    ON_NEXT_RESUME: InstallMode.ON_NEXT_RESUME, // Restart the app the next time it is resumed from the background
+    ON_NEXT_SUSPEND: InstallMode.ON_NEXT_SUSPEND, // Restart the app _while_ it is in the background,
+    // but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),
+    // so that user context isn't lost unless the app suspension is long enough to not matter
+  },
+  SyncStatus: {
+    UP_TO_DATE: 0, // The running app is up-to-date
+    UPDATE_INSTALLED: 1, // The app had an optional/mandatory update that was successfully downloaded and is about to be installed.
+    UPDATE_IGNORED: 2, // The app had an optional update and the end-user chose to ignore it
+    UNKNOWN_ERROR: 3,
+    SYNC_IN_PROGRESS: 4, // There is an ongoing "sync" operation in progress.
+    CHECKING_FOR_UPDATE: 5,
+    AWAITING_USER_ACTION: 6,
+    DOWNLOADING_PACKAGE: 7,
+    INSTALLING_UPDATE: 8,
+  },
+  CheckFrequency: {
+    ON_APP_START: 0,
+    ON_APP_RESUME: 1,
+    MANUAL: 2,
+  },
+  UpdateState,
+  DeploymentStatus: {
+    FAILED: "DeploymentFailed",
+    SUCCEEDED: "DeploymentSucceeded",
+  },
+  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",
+  },
+  DEFAULT_ROLLBACK_RETRY_OPTIONS: {
+    delayInHours: 24,
+    maxRetryAttempts: 1,
+  },
+});
 
 module.exports = CodePush;