@bravemobile/react-native-code-push 10.0.0 → 11.1.0

package/CodePush.js

@@ -9,6 +9,54 @@ const PackageMixins = require("./package-mixins")(NativeCodePush);
 
 const DEPLOYMENT_KEY = 'deprecated_deployment_key';
 
+/**
+ * @param deviceId {string}
+ * @returns {number}
+ */
+function hashDeviceId(deviceId) {
+  let hash = 0;
+  for (let i = 0; i < deviceId.length; i++) {
+    hash = ((hash << 5) - hash) + deviceId.charCodeAt(i);
+    hash |= 0; // Convert to 32bit int
+  }
+  return Math.abs(hash);
+}
+
+/**
+ * @param clientId {string}
+ * @param packageHash {string}
+ * @returns {number}
+ */
+function getBucket(clientId, packageHash) {
+  const hash = hashDeviceId(`${clientId ?? ''}_${packageHash ?? ''}`);
+  return (Math.abs(hash) % 100);
+}
+
+/**
+ * Note that the `clientUniqueId` value may not guarantee the same value if the app is deleted and re-installed.
+ * In other words, if a user re-installs the app, the result of this function may change.
+ * @returns {Promise<boolean>}
+ */
+async function decideLatestReleaseIsInRollout(versioning, clientId, onRolloutSkipped) {
+  const [latestVersion, latestReleaseInfo] = versioning.findLatestRelease();
+
+  if (latestReleaseInfo.rollout === undefined || latestReleaseInfo.rollout >= 100) {
+    return true;
+  }
+
+  const bucket = getBucket(clientId, latestReleaseInfo.packageHash);
+  const inRollout = bucket < latestReleaseInfo.rollout;
+
+  log(`Bucket: ${bucket}, rollout: ${latestReleaseInfo.rollout} → ${inRollout ? 'IN' : 'OUT'}`);
+
+  if (!inRollout) {
+    log(`Skipping update due to rollout. Bucket ${bucket} is not smaller than rollout range ${latestReleaseInfo.rollout}.`);
+    onRolloutSkipped?.(latestVersion);
+  }
+
+  return inRollout;
+}
+
 async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
   /*
    * Before we ask the server if an update exists, we
@@ -42,6 +90,9 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
     }
   }
 
+  /**
+   * @type {RemotePackage|null|undefined}
+   */
   const update = await (async () => {
     try {
       const updateRequest = {
@@ -58,8 +109,8 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
        */
       const updateChecker = sharedCodePushOptions.updateChecker;
       if (updateChecker) {
+        // We do not provide rollout functionality. This could be implemented in the `updateChecker`.
         const { update_info } = await updateChecker(updateRequest);
-
         return mapToRemotePackageMetadata(update_info);
       } else {
         /**
@@ -77,6 +128,9 @@ async function checkForUpdate(handleBinaryVersionMismatchCallback = null) {
 
         const versioning = new SemverVersioning(releaseHistory);
 
+        const isInRollout = await decideLatestReleaseIsInRollout(versioning, nativeConfig.clientUniqueId, sharedCodePushOptions?.onRolloutSkipped);
+        versioning.setIsLatestReleaseInRollout(isInRollout);
+
         const shouldRollbackToBinary = versioning.shouldRollbackToBinary(runtimeVersion)
         if (shouldRollbackToBinary) {
           // Reset to latest major version and restart
@@ -217,7 +271,7 @@ async function getCurrentPackage() {
 async function getUpdateMetadata(updateState) {
   let updateMetadata = await NativeCodePush.getUpdateMetadata(updateState || CodePush.UpdateState.RUNNING);
   if (updateMetadata) {
-    updateMetadata = {...PackageMixins.local, ...updateMetadata};
+    updateMetadata = { ...PackageMixins.local, ...updateMetadata };
     updateMetadata.failedInstall = await NativeCodePush.isFailedUpdate(updateMetadata.packageHash);
     updateMetadata.isFirstRun = await NativeCodePush.isFirstRun(updateMetadata.packageHash);
   }
@@ -424,47 +478,47 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
     mandatoryInstallMode: CodePush.InstallMode.IMMEDIATE,
     minimumBackgroundDuration: 0,
     updateDialog: null,
-    ...options
+    ...options,
   };
 
   syncStatusChangeCallback = typeof syncStatusChangeCallback === "function"
     ? syncStatusChangeCallback
     : (syncStatus) => {
-        switch(syncStatus) {
-          case CodePush.SyncStatus.CHECKING_FOR_UPDATE:
-            log("Checking for update.");
-            break;
-          case CodePush.SyncStatus.AWAITING_USER_ACTION:
-            log("Awaiting user action.");
-            break;
-          case CodePush.SyncStatus.DOWNLOADING_PACKAGE:
-            log("Downloading package.");
-            break;
-          case CodePush.SyncStatus.INSTALLING_UPDATE:
-            log("Installing update.");
-            break;
-          case CodePush.SyncStatus.UP_TO_DATE:
-            log("App is up to date.");
-            break;
-          case CodePush.SyncStatus.UPDATE_IGNORED:
-            log("User cancelled the update.");
-            break;
-          case CodePush.SyncStatus.UPDATE_INSTALLED:
-            if (resolvedInstallMode == CodePush.InstallMode.ON_NEXT_RESTART) {
-              log("Update is installed and will be run on the next app restart.");
-            } else if (resolvedInstallMode == CodePush.InstallMode.ON_NEXT_RESUME) {
-              if (syncOptions.minimumBackgroundDuration > 0) {
-                log(`Update is installed and will be run after the app has been in the background for at least ${syncOptions.minimumBackgroundDuration} seconds.`);
-              } else {
-                log("Update is installed and will be run when the app next resumes.");
-              }
+      switch (syncStatus) {
+        case CodePush.SyncStatus.CHECKING_FOR_UPDATE:
+          log("Checking for update.");
+          break;
+        case CodePush.SyncStatus.AWAITING_USER_ACTION:
+          log("Awaiting user action.");
+          break;
+        case CodePush.SyncStatus.DOWNLOADING_PACKAGE:
+          log("Downloading package.");
+          break;
+        case CodePush.SyncStatus.INSTALLING_UPDATE:
+          log("Installing update.");
+          break;
+        case CodePush.SyncStatus.UP_TO_DATE:
+          log("App is up to date.");
+          break;
+        case CodePush.SyncStatus.UPDATE_IGNORED:
+          log("User cancelled the update.");
+          break;
+        case CodePush.SyncStatus.UPDATE_INSTALLED:
+          if (resolvedInstallMode == CodePush.InstallMode.ON_NEXT_RESTART) {
+            log("Update is installed and will be run on the next app restart.");
+          } else if (resolvedInstallMode == CodePush.InstallMode.ON_NEXT_RESUME) {
+            if (syncOptions.minimumBackgroundDuration > 0) {
+              log(`Update is installed and will be run after the app has been in the background for at least ${syncOptions.minimumBackgroundDuration} seconds.`);
+            } else {
+              log("Update is installed and will be run when the app next resumes.");
             }
-            break;
-          case CodePush.SyncStatus.UNKNOWN_ERROR:
-            log("An unknown error occurred.");
-            break;
-        }
-      };
+          }
+          break;
+        case CodePush.SyncStatus.UNKNOWN_ERROR:
+          log("An unknown error occurred.");
+          break;
+      }
+    };
 
   let remotePackageLabel;
   try {
@@ -497,7 +551,7 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
 
     if (!remotePackage || updateShouldBeIgnored) {
       if (updateShouldBeIgnored) {
-          log("An update is available, but it is being ignored due to having been previously rolled back.");
+        log("An update is available, but it is being ignored due to having been previously rolled back.");
       }
 
       const currentPackage = await CodePush.getCurrentPackage();
@@ -536,7 +590,7 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
             onPress: () => {
               syncStatusChangeCallback(CodePush.SyncStatus.UPDATE_IGNORED);
               resolve(CodePush.SyncStatus.UPDATE_IGNORED);
-            }
+            },
           });
         }
 
@@ -544,10 +598,10 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
         // right of any other button, add it last
         dialogButtons.push({
           text: installButtonText,
-          onPress:() => {
+          onPress: () => {
             doDownloadAndInstall()
               .then(resolve, reject);
-          }
+          },
         })
 
         // If the update has a description, and the developer
@@ -609,6 +663,9 @@ let CodePush;
  *
  *   onSyncError: (label: string, error: Error) => void | undefined,
  *   setOnSyncError(onSyncErrorFunction: (label: string, error: Error) => void | undefined): void,
+ *
+ *   onRolloutSkipped: (label: string, error: Error) => void | undefined,
+ *   setOnRolloutSkipped(onRolloutSkippedFunction: (label: string, error: Error) => void | undefined): void,
  * }}
  */
 const sharedCodePushOptions = {
@@ -653,6 +710,12 @@ const sharedCodePushOptions = {
     if (typeof onSyncErrorFunction !== 'function') throw new Error('Please pass a function to onSyncError');
     this.onSyncError = onSyncErrorFunction;
   },
+  onRolloutSkipped: undefined,
+  setOnRolloutSkipped(onRolloutSkippedFunction) {
+    if (!onRolloutSkippedFunction) return;
+    if (typeof onRolloutSkippedFunction !== 'function') throw new Error('Please pass a function to onRolloutSkipped');
+    this.onRolloutSkipped = onRolloutSkippedFunction;
+  },
 }
 
 function codePushify(options = {}) {
@@ -671,7 +734,7 @@ function codePushify(options = {}) {
     throw new Error(
 `Unable to find the "Component" class, please either:
 1. Upgrade to a newer version of React Native that supports it, or
-2. Call the codePush.sync API in your component instead of using the @codePush decorator`
+2. Call the codePush.sync API in your component instead of using the @codePush decorator`,
     );
   }
 
@@ -688,6 +751,7 @@ function codePushify(options = {}) {
   sharedCodePushOptions.setOnDownloadStart(options.onDownloadStart);
   sharedCodePushOptions.setOnDownloadSuccess(options.onDownloadSuccess);
   sharedCodePushOptions.setOnSyncError(options.onSyncError);
+  sharedCodePushOptions.setOnRolloutSkipped(options.onRolloutSkipped);
 
   const decorator = (RootComponent) => {
     class CodePushComponent extends React.Component {
@@ -730,7 +794,7 @@ function codePushify(options = {}) {
       }
 
       render() {
-        const props = {...this.props};
+        const props = { ...this.props };
 
         // We can set ref property on class components only (not stateless)
         // Check it by render method
@@ -777,7 +841,7 @@ if (NativeCodePush) {
       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,
+      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
     },
@@ -790,17 +854,17 @@ if (NativeCodePush) {
       CHECKING_FOR_UPDATE: 5,
       AWAITING_USER_ACTION: 6,
       DOWNLOADING_PACKAGE: 7,
-      INSTALLING_UPDATE: 8
+      INSTALLING_UPDATE: 8,
     },
     CheckFrequency: {
       ON_APP_START: 0,
       ON_APP_RESUME: 1,
-      MANUAL: 2
+      MANUAL: 2,
     },
     UpdateState: {
       RUNNING: NativeCodePush.codePushUpdateStateRunning,
       PENDING: NativeCodePush.codePushUpdateStatePending,
-      LATEST: NativeCodePush.codePushUpdateStateLatest
+      LATEST: NativeCodePush.codePushUpdateStateLatest,
     },
     DeploymentStatus: {
       FAILED: "DeploymentFailed",
@@ -814,11 +878,11 @@ if (NativeCodePush) {
       optionalIgnoreButtonLabel: "Ignore",
       optionalInstallButtonLabel: "Install",
       optionalUpdateMessage: "An update is available. Would you like to install it?",
-      title: "Update available"
+      title: "Update available",
     },
     DEFAULT_ROLLBACK_RETRY_OPTIONS: {
       delayInHours: 24,
-      maxRetryAttempts: 1
+      maxRetryAttempts: 1,
     },
   });
 } else {

package/README.md

@@ -8,17 +8,9 @@
 
 ### 🚀 New Architecture support
 
-Tested on the React Native template apps
-
-| RN Version | Old Architecture | New Architecture | New Architecture Bridgeless |
-|--------|--------|--------|--------|
-| 0.73.11 | ✅ | ✅ | Unsupported |
-| 0.74.7 | ✅ | ✅ | ✅ |
-| 0.75.5 | ✅ | ✅ | ✅ |
-| 0.76.7 | ✅ | ✅ | ✅ |
-| 0.77.1 | ✅ | ✅ | ✅ | 
-| 0.78.0 | ✅ | ✅ | ✅ | 
+Supports React Native 0.74 ~ 0.80.
 
+(Tested on the React Native CLI template apps)
 
 ## 🚗 Migration Guide
 

package/android/app/proguard-rules.pro

@@ -24,10 +24,6 @@
     private ** mReactHost; # bridgeless
     public void reload(...); # RN 0.74 and above
 }
-# RN 0.74 and above
--keepclassmembers class com.facebook.react.ReactActivity {
-    public ** getReactDelegate(...);
-}
 # bridgeless
 -keepclassmembers class com.facebook.react.defaults.DefaultReactHostDelegate {
     private ** jsBundleLoader;

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

@@ -6,6 +6,7 @@ import android.os.AsyncTask;
 import android.os.Handler;
 import android.os.Looper;
 import android.view.View;
+import android.view.Choreographer;
 
 import androidx.annotation.OptIn;
 
@@ -25,7 +26,6 @@ import com.facebook.react.bridge.ReactMethod;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.common.annotations.UnstableReactNativeAPI;
-import com.facebook.react.modules.core.ChoreographerCompat;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 import com.facebook.react.modules.core.ReactChoreographer;
 import com.facebook.react.runtime.ReactHostDelegate;
@@ -99,7 +99,7 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
     }
 
     private void loadBundleLegacy() {
-        final Activity currentActivity = getCurrentActivity();
+        final Activity currentActivity = getReactApplicationContext().getCurrentActivity();
         if (currentActivity == null) {
             // The currentActivity can be null if it is backgrounded / destroyed, so we simply
             // no-op to prevent any null pointer exceptions.
@@ -128,7 +128,7 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
 
             ReactHost reactHost = resolveReactHost();
             if (reactHost == null) {
-                // Bridge, Old Architecture and RN < 0.74 (we support Bridgeless >= 0.74)
+                // Bridge, Old Architecture
                 setJSBundleLoaderBridge(instanceManager, latestJSBundleLoader);
                 return;
             }
@@ -184,29 +184,14 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
             new Handler(Looper.getMainLooper()).post(new Runnable() {
                 @Override
                 public void run() {
-                    try {
-                        // reload method introduced in RN 0.74 (https://github.com/reactwg/react-native-new-architecture/discussions/174)
-                        // so, we need to check if reload method exists and call it
-                        try {
-                            ReactDelegate reactDelegate = resolveReactDelegate();
-                            if (reactDelegate == null) {
-                                throw new NoSuchMethodException("ReactDelegate doesn't have reload method in RN < 0.74");
-                            }
+                    ReactDelegate reactDelegate = resolveReactDelegate();
+                    assert reactDelegate != null;
 
-                            resetReactRootViews(reactDelegate);
+                    resetReactRootViews(reactDelegate);
 
-                            Method reloadMethod = reactDelegate.getClass().getMethod("reload");
-                            reloadMethod.invoke(reactDelegate);
-                        } catch (NoSuchMethodException e) {
-                            // RN < 0.74 calls ReactInstanceManager.recreateReactContextInBackground() directly
-                            instanceManager.recreateReactContextInBackground();
-                        }
-                        mCodePush.initializeUpdateAfterRestart();
-                    } catch (Exception e) {
-                        // The recreation method threw an unknown exception
-                        // so just simply fallback to restarting the Activity (if it exists)
-                        loadBundleLegacy();
-                    }
+                    reactDelegate.reload();
+
+                    mCodePush.initializeUpdateAfterRestart();
                 }
             });
 
@@ -223,7 +208,7 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
     //     React Native uses the id field to track react tags and will overwrite this field.
     //     If that is fine, explicitly overwrite the id field to View.NO_ID before calling addRootView."
     private void resetReactRootViews(ReactDelegate reactDelegate) {
-        ReactActivity currentActivity = (ReactActivity) getCurrentActivity();
+        ReactActivity currentActivity = (ReactActivity) getReactApplicationContext().getCurrentActivity();
         if (currentActivity != null) {
             ReactRootView reactRootView = reactDelegate.getReactRootView();
             if (reactRootView != null) {
@@ -242,18 +227,12 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
     }
 
     private ReactDelegate resolveReactDelegate() {
-        ReactActivity currentActivity = (ReactActivity) getCurrentActivity();
+        ReactActivity currentActivity = (ReactActivity) getReactApplicationContext().getCurrentActivity();
         if (currentActivity == null) {
             return null;
         }
 
-        try {
-            Method getReactDelegateMethod = currentActivity.getClass().getMethod("getReactDelegate");
-            return (ReactDelegate) getReactDelegateMethod.invoke(currentActivity);
-        } catch (Exception e) {
-            // RN < 0.74 doesn't have getReactDelegate method
-            return null;
-        }
+        return currentActivity.getReactDelegate();
     }
 
     private ReactHost resolveReactHost() {
@@ -278,7 +257,7 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
             return instanceManager;
         }
 
-        final Activity currentActivity = getCurrentActivity();
+        final Activity currentActivity = getReactApplicationContext().getCurrentActivity();
         if (currentActivity == null) {
             return null;
         }
@@ -390,7 +369,7 @@ public class CodePushNativeModule extends ReactContextBaseJavaModule {
                             getReactApplicationContext().runOnUiQueueThread(new Runnable() {
                                 @Override
                                 public void run() {
-                                    ReactChoreographer.getInstance().postFrameCallback(ReactChoreographer.CallbackType.TIMERS_EVENTS, new ChoreographerCompat.FrameCallback() {
+                                    ReactChoreographer.getInstance().postFrameCallback(ReactChoreographer.CallbackType.TIMERS_EVENTS, new Choreographer.FrameCallback() {
                                         @Override
                                         public void doFrame(long frameTimeNanos) {
                                             if (!latestDownloadProgress.isCompleted()) {

package/cli/commands/releaseCommand/addToReleaseHistory.js

@@ -25,6 +25,7 @@ const fs = require("fs");
  * @param identifier {string?}
  * @param mandatory {boolean?}
  * @param enable {boolean?}
+ * @param rollout {number?}
  * @returns {Promise<void>}
  */
 async function addToReleaseHistory(
@@ -38,6 +39,7 @@ async function addToReleaseHistory(
     identifier,
     mandatory,
     enable,
+    rollout
 ) {
     const releaseHistory = await getReleaseHistory(binaryVersion, platform, identifier);
 
@@ -54,6 +56,10 @@ async function addToReleaseHistory(
         mandatory: mandatory,
         downloadUrl: bundleDownloadUrl,
         packageHash: packageHash,
+    };
+
+    if (typeof rollout === 'number') {
+        newReleaseHistory[appVersion].rollout = rollout;
     }
 
     try {

package/cli/commands/releaseCommand/index.js

@@ -16,6 +16,7 @@ program.command('release')
     .option('-j, --js-bundle-name <string>', 'JS bundle file name (default-ios: "main.jsbundle" / default-android: "index.android.bundle")')
     .option('-m, --mandatory <bool>', 'make the release to be mandatory', parseBoolean, false)
     .option('--enable <bool>', 'make the release to be enabled', parseBoolean, true)
+    .option('--rollout <number>', 'rollout percentage (0-100)', parseFloat)
     .option('--skip-bundle <bool>', 'skip bundle process', parseBoolean, false)
     .option('--skip-cleanup <bool>', 'skip cleanup process', parseBoolean, false)
     .option('--output-bundle-dir <string>', 'name of directory containing the bundle file created by the "bundle" command', OUTPUT_BUNDLE_DIR)
@@ -32,6 +33,7 @@ program.command('release')
      * @param {string} options.bundleName
      * @param {string} options.mandatory
      * @param {string} options.enable
+     * @param {number} options.rollout
      * @param {string} options.skipBundle
      * @param {string} options.skipCleanup
      * @param {string} options.outputBundleDir
@@ -40,6 +42,11 @@ program.command('release')
     .action(async (options) => {
         const config = findAndReadConfigFile(process.cwd(), options.config);
 
+        if (typeof options.rollout === 'number' && (options.rollout < 0 || options.rollout > 100)) {
+            console.error('Rollout percentage number must be between 0 and 100 (inclusive).');
+            process.exit(1);
+        }
+
         await release(
             config.bundleUploader,
             config.getReleaseHistory,
@@ -54,6 +61,7 @@ program.command('release')
             options.bundleName,
             options.mandatory,
             options.enable,
+            options.rollout,
             options.skipBundle,
             options.skipCleanup,
             `${options.outputPath}/${options.outputBundleDir}`,

package/cli/commands/releaseCommand/release.js

@@ -33,6 +33,7 @@ const { addToReleaseHistory } = require("./addToReleaseHistory");
  * @param jsBundleName {string}
  * @param mandatory {boolean}
  * @param enable {boolean}
+ * @param rollout {number}
  * @param skipBundle {boolean}
  * @param skipCleanup {boolean}
  * @param bundleDirectory {string}
@@ -52,6 +53,7 @@ async function release(
     jsBundleName,
     mandatory,
     enable,
+    rollout,
     skipBundle,
     skipCleanup,
     bundleDirectory,
@@ -82,6 +84,7 @@ async function release(
         identifier,
         mandatory,
         enable,
+        rollout,
     )
 
     if (!skipCleanup) {

package/cli/commands/updateHistoryCommand/index.js

@@ -12,6 +12,7 @@ program.command('update-history')
     .option('-c, --config <path>', 'set config file name (JS/TS)', CONFIG_FILE_NAME)
     .option('-m, --mandatory <bool>', 'make the release to be mandatory', parseBoolean, undefined)
     .option('-e, --enable <bool>', 'make the release to be enabled', parseBoolean, undefined)
+    .option('--rollout <number>', 'rollout percentage (0-100)', parseFloat, undefined)
     /**
      * @param {Object} options
      * @param {string} options.appVersion
@@ -21,6 +22,7 @@ program.command('update-history')
      * @param {string} options.config
      * @param {string} options.mandatory
      * @param {string} options.enable
+     * @param {number} options.rollout
      * @return {void}
      */
     .action(async (options) => {
@@ -40,6 +42,7 @@ program.command('update-history')
             options.identifier,
             options.mandatory,
             options.enable,
+            options.rollout
         )
     });
 

package/cli/commands/updateHistoryCommand/updateReleaseHistory.js

@@ -23,6 +23,7 @@ const path = require('path');
  * @param identifier {string?}
  * @param mandatory {boolean?}
  * @param enable {boolean?}
+ * @param rollout {number?}
  * @returns {Promise<void>}
  */
 async function updateReleaseHistory(
@@ -34,6 +35,7 @@ async function updateReleaseHistory(
     identifier,
     mandatory,
     enable,
+    rollout
 ) {
     const releaseHistory = await getReleaseHistory(binaryVersion, platform, identifier);
 
@@ -42,6 +44,7 @@ async function updateReleaseHistory(
 
     if (typeof mandatory === "boolean") updateInfo.mandatory = mandatory;
     if (typeof enable === "boolean") updateInfo.enabled = enable;
+    if (typeof rollout === "number") updateInfo.rollout = rollout;
 
     try {
         const JSON_FILE_NAME = `${binaryVersion}.json`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bravemobile/react-native-code-push",
-  "version": "10.0.0",
+  "version": "11.1.0",
   "description": "React Native plugin for the CodePush service",
   "main": "CodePush.js",
   "typings": "typings/react-native-code-push.d.ts",

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

@@ -29,6 +29,7 @@ export interface ReleaseInfo {
     mandatory: boolean;
     downloadUrl: string;
     packageHash: string;
+    rollout?: number;
 }
 
 // from code-push SDK
@@ -93,6 +94,10 @@ export interface CodePushOptions extends SyncOptions {
      * Callback function that is called when sync process failed.
      */
     onSyncError?: (label: string, error: Error) => void;
+    /**
+     * Callback function that is called when rollout is skipped.
+     */
+    onRolloutSkipped?: (label: string, error: Error) => void;
 }
 
 export interface DownloadProgress {

package/versioning/BaseVersioning.js

@@ -24,13 +24,19 @@ class BaseVersioning {
     this.sortedReleaseHistory = Object.entries(releaseHistory).sort(
       ([a], [b]) => this.sortingMethod(a, b)
     );
+
+    /** @type {boolean} */
+    this.isLatestReleaseInRollout = true;
   }
 
   /**
    * @return {[ReleaseVersion, ReleaseInfo][]}
    */
   get sortedEnabledReleaseHistory() {
-    return this.sortedReleaseHistory.filter(([_, bundle]) => bundle.enabled);
+    const list = this.sortedReleaseHistory.filter(([_, bundle]) => bundle.enabled)
+    // If the latest release is not a rollout target, exclude it from the list.
+    // - This also means that rollout deployment can only be applied to the latest release.
+    return this.isLatestReleaseInRollout ? list : list.slice(1);
   }
 
   /**
@@ -42,6 +48,11 @@ class BaseVersioning {
     );
   }
 
+  /** @param isLatestReleaseInRollout {boolean} */
+  setIsLatestReleaseInRollout(isLatestReleaseInRollout) {
+    this.isLatestReleaseInRollout = isLatestReleaseInRollout;
+  }
+
   /**
    * find latest release in releaseHistory
    * @return {[ReleaseVersion, ReleaseInfo]}

package/versioning/SemverVersioning.test.js

@@ -48,6 +48,36 @@ describe('Semver Versioning Test', () => {
                 { enabled: true, mandatory: true, downloadUrl: 'R3', packageHash: 'P3' }
             ])
         })
+
+        it('should return the previous enabled release if the latest release is not a rollout target', () => {
+            const RELEASED_BUNDLES = {
+                '1.0.0': { enabled: true, mandatory: false, ...MOCK_INFOS },
+                '1.1.0': { enabled: false, mandatory: false, ...MOCK_INFOS }, // not enabled
+                '1.2.0': { enabled: true, mandatory: false, ...MOCK_INFOS, rollout: 30 },
+            };
+            const LATEST_IS_ROLLOUT_TARGET = false;
+
+            const versioning = new SemverVersioning(RELEASED_BUNDLES);
+            versioning.setIsLatestReleaseInRollout(LATEST_IS_ROLLOUT_TARGET);
+
+            const [latestVersion] = versioning.findLatestRelease();
+            expect(latestVersion).toEqual('1.0.0');
+        })
+
+        it('should return the latest release if the latest release is a rollout target', () => {
+            const RELEASED_BUNDLES = {
+                '1.0.0': { enabled: true, mandatory: false, ...MOCK_INFOS },
+                '1.1.0': { enabled: true, mandatory: false, ...MOCK_INFOS },
+                '1.2.0': { enabled: true, mandatory: false, ...MOCK_INFOS, rollout: 30 },
+            };
+            const LATEST_IS_ROLLOUT_TARGET = true;
+
+            const versioning = new SemverVersioning(RELEASED_BUNDLES);
+            versioning.setIsLatestReleaseInRollout(LATEST_IS_ROLLOUT_TARGET);
+
+            const [latestVersion] = versioning.findLatestRelease();
+            expect(latestVersion).toEqual('1.2.0');
+        })
     })
 
     describe('checkIsMandatory', () => {
@@ -159,6 +189,26 @@ describe('Semver Versioning Test', () => {
                 expect(new SemverVersioning(RELEASED_BUNDLES).checkIsMandatory('1.1.1')).toBe(false);
                 expect(new SemverVersioning(RELEASED_BUNDLES).checkIsMandatory('1.2.0')).toBe(true);
             });
+
+            it('When having not-enabled releases and latest mandatory version is not a rollout target', () => {
+                const RELEASED_BUNDLES = {
+                    '1.0.0': FIRST_RELEASE_INFO,
+                    '1.0.1': { enabled: true, mandatory: true, ...MOCK_INFOS },
+                    '1.1.0': { enabled: false, mandatory: false, ...MOCK_INFOS },
+                    '1.1.1': { enabled: true, mandatory: true, ...MOCK_INFOS },
+                    '1.2.0': { enabled: true, mandatory: true, ...MOCK_INFOS, rollout: 30 },
+                };
+                const LATEST_IS_ROLLOUT_TARGET = false;
+
+                const versioning = new SemverVersioning(RELEASED_BUNDLES);
+                versioning.setIsLatestReleaseInRollout(LATEST_IS_ROLLOUT_TARGET);
+
+                expect(versioning.checkIsMandatory('1.0.0')).toBe(true); // update to 1.1.1
+                expect(versioning.checkIsMandatory('1.0.1')).toBe(true); // update to 1.1.1
+                expect(versioning.checkIsMandatory('1.1.0')).toBe(true); // update to 1.1.1
+                expect(versioning.checkIsMandatory('1.1.1')).toBe(false); // up to date
+                expect(versioning.checkIsMandatory('1.2.0')).toBe(true); // rollback target is treated as mandatory
+            })
         })
     })
 
@@ -201,5 +251,33 @@ describe('Semver Versioning Test', () => {
             expect(new SemverVersioning(RELEASED_BUNDLES_1).shouldRollbackToBinary('1.2.0')).toBe(false)
             expect(new SemverVersioning(RELEASED_BUNDLES_2).shouldRollbackToBinary('1.2.0-rc.2')).toBe(false)
         })
+
+        it ('should return true if the latest release is not a rollout target', () => {
+            const RELEASED_BUNDLES = {
+                '1.0.0': { enabled: true, mandatory: false, ...MOCK_INFOS },
+                '1.1.0': { enabled: true, mandatory: false, ...MOCK_INFOS, rollout: 30 },
+            };
+            const LATEST_IS_ROLLOUT_TARGET = false;
+
+            const versioning = new SemverVersioning(RELEASED_BUNDLES);
+            versioning.setIsLatestReleaseInRollout(LATEST_IS_ROLLOUT_TARGET);
+
+            // If the latest release was a rollout target and the rollout value is later reduced, the app might run on version 1.1.0.
+            expect(versioning.shouldRollbackToBinary('1.1.0')).toBe(true);
+        })
+
+        it ('should return false if the latest release and the previous release are both rollout targets', () => {
+            const RELEASED_BUNDLES = {
+                '1.0.0': { enabled: true, mandatory: false, ...MOCK_INFOS },
+                '1.1.0': { enabled: true, mandatory: false, ...MOCK_INFOS, rollout: 30 },
+                '1.2.0': { enabled: true, mandatory: false, ...MOCK_INFOS, rollout: 30 },
+            };
+            const LATEST_IS_ROLLOUT_TARGET = true;
+
+            const versioning = new SemverVersioning(RELEASED_BUNDLES);
+            versioning.setIsLatestReleaseInRollout(LATEST_IS_ROLLOUT_TARGET);
+
+            expect(versioning.shouldRollbackToBinary('1.0.0')).toBe(false); // update to 1.1.0
+        })
     })
 })