Merge branch 'master' into v12

# Conflicts:
#	package-lock.json
#	package.json

Author: floydkim

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,18 +590,18 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
             onPress: () => {
               syncStatusChangeCallback(CodePush.SyncStatus.UPDATE_IGNORED);
               resolve(CodePush.SyncStatus.UPDATE_IGNORED);
-            }
+            },
           });
         }
 
         // Since the install button should be placed to the
         // 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 {

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 {

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}`,

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) {