@appzung/react-native-code-push 9.0.2 → 10.0.0

package/src/types.ts

@@ -0,0 +1,237 @@
+import type { NativeUpdateNotification } from 'code-push/script/acquisition-sdk';
+import type { DeploymentStatus } from './enums/DeploymentStatus.enum';
+import type { InstallMode } from './enums/InstallMode.enum';
+import type { SyncStatus } from './enums/SyncStatus.enum';
+
+export interface UpdateDialog {
+  /**
+   * Indicates whether you would like to append the description of an available release to the
+   * notification message which is displayed to the end user. Defaults to false.
+   */
+  appendReleaseDescription?: boolean;
+
+  /**
+   * Indicates the string you would like to prefix the release description with, if any, when
+   * displaying the update notification to the end user. Defaults to " Description: "
+   */
+  descriptionPrefix?: string;
+
+  /**
+   * The text to use for the button the end user must press in order to install a mandatory update. Defaults to "Continue".
+   */
+  mandatoryContinueButtonLabel?: string;
+
+  /**
+   * The text used as the body of an update notification, when the update is specified as mandatory.
+   * Defaults to "An update is available that must be installed.".
+   */
+  mandatoryUpdateMessage?: string;
+
+  /**
+   * The text to use for the button the end user can press in order to ignore an optional update that is available. Defaults to "Ignore".
+   */
+  optionalIgnoreButtonLabel?: string;
+
+  /**
+   * The text to use for the button the end user can press in order to install an optional update. Defaults to "Install".
+   */
+  optionalInstallButtonLabel?: string;
+
+  /**
+   * The text used as the body of an update notification, when the update is optional. Defaults to "An update is available. Would you like to install it?".
+   */
+  optionalUpdateMessage?: string;
+
+  /**
+   * The text used as the header of an update notification that is displayed to the end user. Defaults to "Update available".
+   */
+  title?: string;
+}
+
+export type DownloadProgressCallback = (progress: DownloadProgress) => void;
+export type SyncStatusChangedCallback = (status: SyncStatus) => void;
+export type HandleBinaryVersionMismatchCallback = (update: NativeUpdateNotification) => void;
+
+export interface DownloadProgress {
+  /**
+   * The total number of bytes expected to be received for this update.
+   */
+  totalBytes: number;
+
+  /**
+   * The number of bytes downloaded thus far.
+   */
+  receivedBytes: number;
+}
+
+export interface LocalPackage extends Package {
+  /**
+   * Installs the update by saving it to the location on disk where the runtime expects to find the latest version of the app.
+   *
+   * @param installMode Indicates when you would like the update changes to take effect for the end-user.
+   * @param minimumBackgroundDuration For resume-based installs, this specifies the number of seconds the app needs to be in the background before forcing a restart. Defaults to 0 if unspecified.
+   * @param onUpdateInstalled An optional promise called after app installation
+   */
+  install(
+    installMode?: InstallMode,
+    minimumBackgroundDuration?: number,
+    onUpdateInstalled?: () => Promise<void> | void,
+  ): Promise<void>;
+}
+
+export interface Package {
+  /**
+   * The app binary version that this update is dependent on. This is the value that was
+   * specified via the appStoreVersion parameter when calling the CLI's release command.
+   */
+  appVersion: string;
+
+  /**
+   * The release channel public ID that was used to originally download this update.
+   */
+  releaseChannelPublicId: string;
+
+  /**
+   * The description of the update. This is the same value that you specified in the CLI when you released the update.
+   */
+  description: string;
+
+  /**
+   * Indicates whether this update has been previously installed but was rolled back.
+   */
+  failedInstall: boolean;
+
+  /**
+   * Indicates whether this is the first time the update has been run after being installed.
+   */
+  isFirstRun: boolean;
+
+  /**
+   * Indicates whether the update is considered mandatory. This is the value that was specified in the CLI when the update was released.
+   */
+  isMandatory: boolean;
+
+  /**
+   * Indicates whether this update is in a "pending" state. When true, that means the update has been downloaded and installed, but the app restart
+   * needed to apply it hasn't occurred yet, and therefore, its changes aren't currently visible to the end-user.
+   */
+  isPending: boolean;
+
+  /**
+   * The internal label automatically given to the update by the CodePush server. This value uniquely identifies the update within its release channel.
+   */
+  label: string;
+
+  /**
+   * The SHA hash value of the update.
+   */
+  packageHash: string;
+
+  /**
+   * The size of the code contained within the update, in bytes.
+   */
+  packageSize: number;
+}
+
+export interface RemotePackage extends Package {
+  /**
+   * Downloads the available update from the CodePush service.
+   *
+   * @param downloadProgressCallback An optional callback that allows tracking the progress of the update while it is being downloaded.
+   */
+  download(downloadProgressCallback?: DownloadProgressCallback): Promise<LocalPackage>;
+
+  /**
+   * The URL at which the package is available for download.
+   */
+  downloadUrl: string;
+}
+
+export interface SyncOptions {
+  /**
+   * Specifies the release channel you want to query for an update against. By default, this value is derived from the Info.plist
+   * file (iOS) and strings resources (Android), but this option allows you to override it from the script-side if you need to
+   * dynamically use a different release channel for a specific call to sync.
+   */
+  releaseChannelPublicId?: string;
+
+  /**
+   * Specifies when you would like to install optional updates (i.e. those that aren't marked as mandatory).
+   * Defaults to codePush.InstallMode.ON_NEXT_RESTART.
+   */
+  installMode?: InstallMode;
+
+  /**
+   * Specifies when you would like to install updates which are marked as mandatory.
+   * Defaults to codePush.InstallMode.IMMEDIATE.
+   */
+  mandatoryInstallMode?: InstallMode;
+
+  /**
+   * Specifies the minimum number of seconds that the app needs to have been in the background before restarting the app. This property
+   * only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME` or `InstallMode.ON_NEXT_SUSPEND`, and can be useful
+   * for getting your update in front of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying
+   * the update immediately after a resume or unless the app suspension is long enough to not matter, regardless how long it was in the background.
+   */
+  minimumBackgroundDuration?: number;
+
+  /**
+   * An "options" object used to determine whether a confirmation dialog should be displayed to the end user when an update is available,
+   * and if so, what strings to use. Defaults to null, which has the effect of disabling the dialog completely. Setting this to any truthy
+   * value will enable the dialog with the default strings, and passing an object to this parameter allows enabling the dialog as well as
+   * overriding one or more of the default strings.
+   */
+  updateDialog?: UpdateDialog | true;
+
+  /**
+   * The rollback retry mechanism allows the application to attempt to reinstall an update that was previously rolled back (with the restrictions
+   * specified in the options). It is an "options" object used to determine whether a rollback retry should occur, and if so, what settings to use
+   * for the rollback retry. This defaults to null, which has the effect of disabling the retry mechanism. Setting this to true will enable
+   * the retry mechanism with the default settings, and passing an object to this parameter allows enabling the rollback retry as well as overriding
+   * one or more of the default values.
+   */
+  rollbackRetryOptions?: RollbackRetryOptions | true;
+
+  ignoreFailedUpdates?: boolean;
+}
+
+export interface RollbackRetryOptions {
+  /**
+   * Specifies the minimum time in hours that the app will wait after the latest rollback
+   * before attempting to reinstall same rolled-back package. Defaults to `24`.
+   */
+  delayInHours?: number;
+
+  /**
+   * Specifies the maximum number of retry attempts that the app can make before it stops trying.
+   * Cannot be less than `1`. Defaults to `1`.
+   */
+  maxRetryAttempts?: number;
+}
+
+export interface StatusReport {
+  /**
+   * Whether the deployment succeeded or failed.
+   */
+  status: DeploymentStatus;
+
+  /**
+   * The version of the app that was deployed (for a native app upgrade).
+   */
+  appVersion?: string;
+
+  /**
+   * Details of the package that was deployed (or attempted to).
+   */
+  package?: Package;
+
+  /**
+   * Release channel used when deploying the previous package.
+   */
+  previousReleaseChannelPublicId?: string;
+
+  /**
+   * The label (v#) of the package that was upgraded from.
+   */
+  previousLabelOrAppVersion?: string;
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig",
+  "exclude": ["Examples", "lib", "test"]
+}

package/tsconfig.json

@@ -1,14 +1,31 @@
 {
-    "compilerOptions": {
-        "target": "ES5",
-        "module": "commonjs",
-        "lib": ["es6"],
-        "noImplicitAny": true,
-        "noEmitOnError": true,
-        "moduleResolution": "node",
-        "sourceMap": true,
-        "rootDir": "test",
-        "outDir": "bin",
-        "removeComments": true
-    }
+  "exclude": ["test"],
+  "compilerOptions": {
+    "rootDir": ".",
+    "paths": {
+      "@appzung/react-native-code-push": ["./src/index"]
+    },
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react-jsx",
+    "lib": ["ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "noEmit": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitReturns": true,
+    "noImplicitUseStrict": false,
+    "noStrictGenericChecks": false,
+    "noUncheckedIndexedAccess": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "resolvePackageJsonImports": false,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext",
+    "verbatimModuleSyntax": true
+  }
 }

package/windows/CodePush/CodePushConfig.cpp

@@ -36,7 +36,7 @@ namespace winrt::Microsoft::CodePush::ReactNative::implementation
     {
         std::optional<hstring> appVersion;
         std::optional<hstring> buildVersion;
-        std::optional<hstring> deploymentKey;
+        std::optional<hstring> releaseChannelPublicId;
         std::optional<hstring> publicKey;
         std::optional<hstring> serverUrl;
 
@@ -44,7 +44,7 @@ namespace winrt::Microsoft::CodePush::ReactNative::implementation
         {
             appVersion = configMap.TryLookup(AppVersionConfigKey);
             buildVersion = configMap.TryLookup(BuildVersionConfigKey);
-            deploymentKey = configMap.TryLookup(DeploymentKeyConfigKey);
+            releaseChannelPublicId = configMap.TryLookup(ReleaseChannelPublicIdConfigKey);
             publicKey = configMap.TryLookup(PublicKeyKey);
             serverUrl = configMap.TryLookup(ServerURLConfigKey);
         }
@@ -73,7 +73,7 @@ namespace winrt::Microsoft::CodePush::ReactNative::implementation
 
         addToConfiguration(AppVersionConfigKey, appVersion);
         addToConfiguration(BuildVersionConfigKey, buildVersion);
-        addToConfiguration(DeploymentKeyConfigKey, deploymentKey);
+        addToConfiguration(ReleaseChannelPublicIdConfigKey, releaseChannelPublicId);
         addToConfiguration(PublicKeyKey, publicKey);
         addToConfiguration(ServerURLConfigKey, serverUrl);
 

package/windows/CodePush/CodePushConfig.h

@@ -29,8 +29,8 @@ namespace winrt::Microsoft::CodePush::ReactNative::implementation
 
         Windows::Data::Json::JsonObject GetConfiguration();
 
-        hstring GetDeploymentKey() { return QueryConfig(DeploymentKeyConfigKey); }
-        void SetDeploymentKey(std::wstring_view deploymentKey) { m_configuration.Insert(DeploymentKeyConfigKey, deploymentKey); }
+        hstring GetReleaseChannelPublicId() { return QueryConfig(ReleaseChannelPublicIdConfigKey); }
+        void SetReleaseChannelPublicId(std::wstring_view releaseChannelPublicId) { m_configuration.Insert(ReleaseChannelPublicIdConfigKey, releaseChannelPublicId); }
 
         hstring GetServerUrl() { return QueryConfig(ServerURLConfigKey); }
         void SetServerUrl(std::wstring_view serverUrl) { m_configuration.Insert(ServerURLConfigKey, serverUrl); }
@@ -42,7 +42,7 @@ namespace winrt::Microsoft::CodePush::ReactNative::implementation
         static constexpr std::wstring_view AppVersionConfigKey{ L"appVersion" };
         static constexpr std::wstring_view BuildVersionConfigKey{ L"buildVersion" };
         static constexpr std::wstring_view ClientUniqueIDConfigKey{ L"clientUniqueId" };
-        static constexpr std::wstring_view DeploymentKeyConfigKey{ L"deploymentKey" };
+        static constexpr std::wstring_view ReleaseChannelPublicIdConfigKey{ L"releaseChannelPublicId" };
         static constexpr std::wstring_view ServerURLConfigKey{ L"serverUrl" };
         static constexpr std::wstring_view PublicKeyKey{ L"publicKey" };
 

package/windows/CodePush/CodePushNativeModule.cpp

@@ -127,22 +127,22 @@ namespace Microsoft::CodePush::ReactNative
         return ApplicationData::Current().LocalSettings();
     }
 
-    void CodePushNativeModule::OverrideAppVersion(std::wstring_view appVersion) 
+    void CodePushNativeModule::OverrideAppVersion(std::wstring_view appVersion)
     {
         CodePushConfig::Current().SetAppVersion(appVersion);
     }
 
-    void CodePushNativeModule::SetDeploymentKey(std::wstring_view deploymentKey) 
+    void CodePushNativeModule::SetReleaseChannelPublicId(std::wstring_view releaseChannelPublicId)
     {
-        CodePushConfig::Current().SetDeploymentKey(deploymentKey);
+        CodePushConfig::Current().SetReleaseChannelPublicId(releaseChannelPublicId);
     }
 
     /*
      * This method checks to see whether a specific package hash
      * has previously failed installation.
      */
-    bool CodePushNativeModule::IsFailedHash(std::wstring_view packageHash) 
-    { 
+    bool CodePushNativeModule::IsFailedHash(std::wstring_view packageHash)
+    {
         auto localSettings{ GetLocalSettings() };
         auto failedUpdatesData{ localSettings.Values().TryLookup(FailedUpdatesKey) };
         if (failedUpdatesData == nullptr)
@@ -186,7 +186,7 @@ namespace Microsoft::CodePush::ReactNative
      * This method is used to get the count of rollback for the package
      * using the latest rollback information.
      */
-    int CodePushNativeModule::GetRollbackCountForPackage(std::wstring_view packageHash, const JsonObject& latestRollbackInfo) 
+    int CodePushNativeModule::GetRollbackCountForPackage(std::wstring_view packageHash, const JsonObject& latestRollbackInfo)
     {
         auto oldPackageHash{ latestRollbackInfo.GetNamedString(LatestRollbackPackageHashKey, L"null") };
         if (packageHash == oldPackageHash)
@@ -194,7 +194,7 @@ namespace Microsoft::CodePush::ReactNative
             auto oldCount{ latestRollbackInfo.GetNamedNumber(LatestRollbackCountKey, 0) };
             return static_cast<int>(oldCount);
         }
-        return 0; 
+        return 0;
     }
 
     /*
@@ -203,7 +203,7 @@ namespace Microsoft::CodePush::ReactNative
      * been applied yet via an app restart.
      */
     /*static*/ bool CodePushNativeModule::IsPendingUpdate(std::wstring_view packageHash)
-    { 
+    {
         auto localSettings{ GetLocalSettings() };
         auto pendingUpdateData{ localSettings.Values().TryLookup(PendingUpdateKey) };
         if (pendingUpdateData != nullptr)
@@ -211,7 +211,7 @@ namespace Microsoft::CodePush::ReactNative
             auto pendingUpdateString{ unbox_value<hstring>(pendingUpdateData) };
             JsonObject pendingUpdate;
             auto success{ JsonObject::TryParse(pendingUpdateString, pendingUpdate) };
-        
+
             // If there is a pending update whose "state" isn't loading, then we consider it "pending".
             // Additionally, if a specific hash was provided, we ensure it matches that of the pending update.
             auto updateIsPending{ success &&
@@ -478,9 +478,9 @@ namespace Microsoft::CodePush::ReactNative
      * This is the native side of the CodePush.getConfiguration method. It isn't
      * currently exposed via the "react-native-code-push" module, and is used
      * internally only by the CodePush.checkForUpdate method in order to get the
-     * app version, as well as the deployment key that was configured in App.cpp.
+     * app version, as well as the release channel that was configured in App.cpp.
      */
-    fire_and_forget CodePushNativeModule::GetConfiguration(ReactPromise<IJsonValue> promise) noexcept 
+    fire_and_forget CodePushNativeModule::GetConfiguration(ReactPromise<IJsonValue> promise) noexcept
     {
         auto configuration{ CodePushConfig::Current().GetConfiguration() };
         if (isRunningBinaryVersion)
@@ -498,7 +498,7 @@ namespace Microsoft::CodePush::ReactNative
     /*
      * This method is the native side of the CodePush.getUpdateMetadata method.
      */
-    fire_and_forget CodePushNativeModule::GetUpdateMetadataAsync(CodePushUpdateState updateState, ReactPromise<IJsonValue> promise) noexcept 
+    fire_and_forget CodePushNativeModule::GetUpdateMetadataAsync(CodePushUpdateState updateState, ReactPromise<IJsonValue> promise) noexcept
     {
         auto package{ co_await CodePushPackage::GetCurrentPackageAsync() };
         if (package == nullptr)
@@ -539,14 +539,14 @@ namespace Microsoft::CodePush::ReactNative
             package.Insert(PackageIsPendingKey, JsonValue::CreateBooleanValue(currentUpdateIsPending));
             promise.Resolve(package);
         }
-        co_return; 
+        co_return;
     }
 
     /*
      * This method is the native side of the LocalPackage.install method.
      */
-    fire_and_forget CodePushNativeModule::InstallUpdateAsync(JsonObject updatePackage, CodePushInstallMode installMode, int minimumBackgroundDuration, ReactPromise<void> promise) noexcept 
-    { 
+    fire_and_forget CodePushNativeModule::InstallUpdateAsync(JsonObject updatePackage, CodePushInstallMode installMode, int minimumBackgroundDuration, ReactPromise<void> promise) noexcept
+    {
         try
         {
             co_await CodePushPackage::InstallPackageAsync(updatePackage, IsPendingUpdate(L""));
@@ -568,7 +568,7 @@ namespace Microsoft::CodePush::ReactNative
 
         // Signal to JS that the update has been applied.
         promise.Resolve();
-        co_return; 
+        co_return;
     }
 
     /*
@@ -659,7 +659,7 @@ namespace Microsoft::CodePush::ReactNative
      * This information will be used to decide whether the application
      * should ignore the update or not.
      */
-    void CodePushNativeModule::GetLatestRollbackInfo(ReactPromise<IJsonValue> promise) noexcept 
+    void CodePushNativeModule::GetLatestRollbackInfo(ReactPromise<IJsonValue> promise) noexcept
     {
         auto localSettings{ GetLocalSettings() };
         auto res{ localSettings.Values().TryLookup(LatestRollbackInfoKey) };
@@ -698,7 +698,7 @@ namespace Microsoft::CodePush::ReactNative
         promise.Resolve(JsonValue::CreateNullValue());
     }
 
-    void CodePushNativeModule::Allow(ReactPromise<JSValue> promise) noexcept 
+    void CodePushNativeModule::Allow(ReactPromise<JSValue> promise) noexcept
     {
         CodePushUtils::Log(L"Re-allowing restarts.");
         m_allowed = true;
@@ -714,7 +714,7 @@ namespace Microsoft::CodePush::ReactNative
         promise.Resolve(JSValue::Null);
     }
 
-    void CodePushNativeModule::ClearPendingRestart() noexcept 
+    void CodePushNativeModule::ClearPendingRestart() noexcept
     {
         m_restartQueue.clear();
     }
@@ -729,7 +729,7 @@ namespace Microsoft::CodePush::ReactNative
     /*
      * This method is the native side of the CodePush.restartApp() method.
      */
-    fire_and_forget CodePushNativeModule::RestartApp(bool onlyIfUpdateIsPending, ReactPromise<JSValue> promise) noexcept 
+    fire_and_forget CodePushNativeModule::RestartApp(bool onlyIfUpdateIsPending, ReactPromise<JSValue> promise) noexcept
     {
         co_await RestartAppInternal(onlyIfUpdateIsPending);
         promise.Resolve(JSValue::Null);
@@ -737,11 +737,11 @@ namespace Microsoft::CodePush::ReactNative
 
     /*
      * This method clears CodePush's downloaded updates.
-     * It is needed to switch to a different deployment if the current deployment is more recent.
-     * Note: we don�t recommend to use this method in scenarios other than that (CodePush will call this method
+     * It is needed to switch to a different release channel if the current release channel is more recent.
+     * Note: we don�t recommend to use this method in scenarios other than that (CodePush will call this method
      * automatically when needed in other cases) as it could lead to unpredictable behavior.
      */
-    fire_and_forget CodePushNativeModule::ClearUpdates() noexcept 
+    fire_and_forget CodePushNativeModule::ClearUpdates() noexcept
     {
         co_await ClearUpdatesStaticAsync();
     }
@@ -752,7 +752,7 @@ namespace Microsoft::CodePush::ReactNative
      * removeBundleUrl. It is only to be used during tests and no-ops if the test
      * configuration flag is not set.
      */
-    fire_and_forget CodePushNativeModule::DownloadAndReplaceCurrentBundle(std::wstring remoteBundleUrl) noexcept 
+    fire_and_forget CodePushNativeModule::DownloadAndReplaceCurrentBundle(std::wstring remoteBundleUrl) noexcept
     {
         auto errorMessage{ L"Error: DownloadAndReplaceCurrentBundle is not currently implmented" };
         hresult_error error{ E_NOTIMPL, errorMessage };
@@ -764,7 +764,7 @@ namespace Microsoft::CodePush::ReactNative
      * This method is checks if a new status update exists (new version was installed,
      * or an update failed) and return its details (version label, status).
      */
-    fire_and_forget CodePushNativeModule::GetNewStatusReportAsync(ReactPromise<IJsonValue> promise) noexcept 
+    fire_and_forget CodePushNativeModule::GetNewStatusReportAsync(ReactPromise<IJsonValue> promise) noexcept
     {
         if (needToReportRollback)
         {
@@ -816,12 +816,12 @@ namespace Microsoft::CodePush::ReactNative
         co_return;
     }
 
-    void CodePushNativeModule::RecordStatusReported(JsonObject statusReport) noexcept 
+    void CodePushNativeModule::RecordStatusReported(JsonObject statusReport) noexcept
     {
         CodePushTelemetryManager::RecordStatusReported(statusReport);
     }
 
-    void CodePushNativeModule::SaveStatusReportForRetry(JsonObject statusReport) noexcept 
+    void CodePushNativeModule::SaveStatusReportForRetry(JsonObject statusReport) noexcept
     {
         CodePushTelemetryManager::SaveStatusReportForRetry(statusReport);
     }

package/windows/CodePush/CodePushNativeModule.h

@@ -47,7 +47,7 @@ namespace Microsoft::CodePush::ReactNative
 		static winrt::Windows::Storage::ApplicationDataContainer GetLocalSettings();
 
 		void OverrideAppVersion(std::wstring_view appVersion);
-		void SetDeploymentKey(std::wstring_view deploymentKey);
+		void SetReleaseChannelPublicId(std::wstring_view releaseChannelPublicId);
 
 		bool IsFailedHash(std::wstring_view packageHash);
 
@@ -79,7 +79,7 @@ namespace Microsoft::CodePush::ReactNative
 		 * This is the native side of the CodePush.getConfiguration method. It isn't
 		 * currently exposed via the "react-native-code-push" module, and is used
 		 * internally only by the CodePush.checkForUpdate method in order to get the
-		 * app version, as well as the deployment key that was configured in the Info.plist file.
+		 * app version, as well as the release channel that was configured.
 		 */
 		REACT_METHOD(GetConfiguration, L"getConfiguration");
 		winrt::fire_and_forget GetConfiguration(winrt::Microsoft::ReactNative::ReactPromise<winrt::Windows::Data::Json::IJsonValue> promise) noexcept;
@@ -151,8 +151,8 @@ namespace Microsoft::CodePush::ReactNative
 
 		/*
 		 * This method clears CodePush's downloaded updates.
-		 * It is needed to switch to a different deployment if the current deployment is more recent.
-		 * Note: we don�t recommend to use this method in scenarios other than that (CodePush will call this method
+		 * It is needed to switch to a different release channel if the current release channel is more recent.
+		 * Note: we don�t recommend to use this method in scenarios other than that (CodePush will call this method
 		 * automatically when needed in other cases) as it could lead to unpredictable behavior.
 		 */
 		REACT_METHOD(ClearUpdates, L"clearUpdates");

package/windows/CodePush/CodePushTelemetryManager.cpp

@@ -18,12 +18,12 @@ namespace Microsoft::CodePush::ReactNative
 
     static const std::wstring_view AppVersionKey{ L"appVersion" };
     static const std::wstring_view DeploymentFailed{ L"DeploymentFailed" };
-    static const std::wstring_view DeploymentKeyKey{ L"deploymentKey" };
+    static const std::wstring_view ReleaseChannelPublicIdKey{ L"releaseChannelPublicId" };
     static const std::wstring_view DeploymentSucceeded{ L"DeploymentSucceeded" };
     static const std::wstring_view LabelKey{ L"label" };
     static const std::wstring_view LastDeploymentReportKey{ L"CODE_PUSH_LAST_DEPLOYMENT_REPORT" };
     static const std::wstring_view PackageKey{ L"package" };
-    static const std::wstring_view PreviousDeploymentKeyKey{ L"previousDeploymentKey" };
+    static const std::wstring_view PreviousReleaseChannelPublicIdKey{ L"previousReleaseChannelPublicId" };
     static const std::wstring_view PreviousLabelOrAppVersionKey{ L"previousLabelOrAppVersion" };
     static const std::wstring_view RetryDeploymentReportKey{ L"CODE_PUSH_RETRY_DEPLOYMENT_REPORT" };
     static const std::wstring_view StatusKey{ L"status" };
@@ -42,12 +42,12 @@ namespace Microsoft::CodePush::ReactNative
         {
             if (IsStatusReportIdentifierCodePushLabel(previousStatusReportIdentifier))
             {
-                auto previousDeploymentKey{ GetDeploymentKeyFromStatusReportIdentifier(previousStatusReportIdentifier) };
+                auto previousReleaseChannelPublicId{ GetReleaseChannelPublicIdFromStatusReportIdentifier(previousStatusReportIdentifier) };
                 auto previousLabel{ GetVersionLabelFromStatusReportIdentifier(previousStatusReportIdentifier) };
                 ClearRetryStatusReport();
                 JsonObject out;
                 out.Insert(AppVersionKey, JsonValue::CreateStringValue(appVersion));
-                out.Insert(PreviousDeploymentKeyKey, JsonValue::CreateStringValue(previousDeploymentKey));
+                out.Insert(PreviousReleaseChannelPublicIdKey, JsonValue::CreateStringValue(previousReleaseChannelPublicId));
                 out.Insert(PreviousLabelOrAppVersionKey, JsonValue::CreateStringValue(previousLabel));
                 return out;
             }
@@ -109,12 +109,12 @@ namespace Microsoft::CodePush::ReactNative
                 ClearRetryStatusReport();
                 if (IsStatusReportIdentifierCodePushLabel(previousStatusReportIdentifier))
                 {
-                    auto previousDeploymentKey{ GetDeploymentKeyFromStatusReportIdentifier(previousStatusReportIdentifier) };
+                    auto previousReleaseChannelPublicId{ GetReleaseChannelPublicIdFromStatusReportIdentifier(previousStatusReportIdentifier) };
                     auto previousLabel{ GetVersionLabelFromStatusReportIdentifier(previousStatusReportIdentifier) };
                     JsonObject out;
                     out.Insert(PackageKey, currentPackage);
                     out.Insert(StatusKey, JsonValue::CreateStringValue(DeploymentSucceeded));
-                    out.Insert(PreviousDeploymentKeyKey, JsonValue::CreateStringValue(previousDeploymentKey));
+                    out.Insert(PreviousReleaseChannelPublicIdKey, JsonValue::CreateStringValue(previousReleaseChannelPublicId));
                     out.Insert(PreviousLabelOrAppVersionKey, JsonValue::CreateStringValue(previousLabel));
                     return out;
                 }
@@ -165,22 +165,22 @@ namespace Microsoft::CodePush::ReactNative
         localSettings.Values().Remove(RetryDeploymentReportKey);
     }
 
-    /*static*/ std::wstring_view CodePushTelemetryManager::GetDeploymentKeyFromStatusReportIdentifier(std::wstring_view statusReportIdentifier)
+    /*static*/ std::wstring_view CodePushTelemetryManager::GetReleaseChannelPublicIdFromStatusReportIdentifier(std::wstring_view statusReportIdentifier)
     {
         return statusReportIdentifier.substr(0, statusReportIdentifier.find(':'));
     }
 
     /*static*/ hstring CodePushTelemetryManager::GetPackageStatusReportIdentifier(const JsonObject& package)
     {
-        // Because deploymentKeys can be dynamically switched, we use a
-        // combination of the deploymentKey and label as the packageIdentifier.
-        if (package.HasKey(DeploymentKeyKey) && package.HasKey(LabelKey))
+        // Because release channels can be dynamically switched, we use a
+        // combination of the release channel public ID and label as the packageIdentifier.
+        if (package.HasKey(ReleaseChannelPublicIdKey) && package.HasKey(LabelKey))
         {
             return L"";
         }
-        auto deploymentKey{ package.GetNamedString(DeploymentKeyKey) };
+        auto releaseChannelPublicId{ package.GetNamedString(ReleaseChannelPublicIdKey) };
         auto label{ package.GetNamedString(LabelKey) };
-        return deploymentKey + L":" + label;
+        return releaseChannelPublicId + L":" + label;
     }
 
     /*static*/ hstring CodePushTelemetryManager::GetPreviousStatusReportIdentifier()

package/windows/CodePush/CodePushTelemetryManager.h

@@ -19,7 +19,7 @@ namespace Microsoft::CodePush::ReactNative
 
 	private:
 		static void ClearRetryStatusReport();
-		static std::wstring_view GetDeploymentKeyFromStatusReportIdentifier(std::wstring_view statusReportIdentifier);
+		static std::wstring_view GetReleaseChannelPublicIdFromStatusReportIdentifier(std::wstring_view statusReportIdentifier);
 		static winrt::hstring GetPackageStatusReportIdentifier(const winrt::Windows::Data::Json::JsonObject& package);
 		static winrt::hstring GetPreviousStatusReportIdentifier();
 		static std::wstring_view GetVersionLabelFromStatusReportIdentifier(std::wstring_view statusReportIdentifier);