@bravemobile/react-native-code-push 10.0.0-beta.0 → 10.0.0-beta.2

package/CodePush.js

@@ -253,9 +253,11 @@ async function tryReportStatus(statusReport, retryOnAppResume) {
       const label = statusReport.package.label;
       if (statusReport.status === "DeploymentSucceeded") {
         log(`Reporting CodePush update success (${label})`);
+        sharedCodePushOptions?.onUpdateSuccess(label);
       } else {
         log(`Reporting CodePush update rollback (${label})`);
         await NativeCodePush.setLatestRollbackInfo(statusReport.package.packageHash);
+        sharedCodePushOptions?.onUpdateRollback(label);
       }
     }
 
@@ -464,16 +466,22 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
         }
       };
 
+  let remotePackageLabel;
   try {
     await CodePush.notifyApplicationReady();
 
     syncStatusChangeCallback(CodePush.SyncStatus.CHECKING_FOR_UPDATE);
     const remotePackage = await checkForUpdate(handleBinaryVersionMismatchCallback);
+    remotePackageLabel = remotePackage.label;
 
     const doDownloadAndInstall = async () => {
       syncStatusChangeCallback(CodePush.SyncStatus.DOWNLOADING_PACKAGE);
+      sharedCodePushOptions.onDownloadStart?.(remotePackageLabel);
+
       const localPackage = await remotePackage.download(downloadProgressCallback);
 
+      sharedCodePushOptions.onDownloadSuccess?.(remotePackageLabel);
+
       // Determine the correct install mode based on whether the update is mandatory or not.
       resolvedInstallMode = localPackage.isMandatory ? syncOptions.mandatoryInstallMode : syncOptions.installMode;
 
@@ -556,6 +564,7 @@ async function syncInternal(options = {}, syncStatusChangeCallback, downloadProg
     }
   } catch (error) {
     syncStatusChangeCallback(CodePush.SyncStatus.UNKNOWN_ERROR);
+    sharedCodePushOptions?.onSyncError(remotePackageLabel ?? 'unknown', error);
     log(error.message);
     throw error;
   }
@@ -582,8 +591,24 @@ let CodePush;
  * @type {{
  *   releaseHistoryFetcher: releaseHistoryFetcher | undefined,
  *   setReleaseHistoryFetcher(releaseHistoryFetcherFunction: releaseHistoryFetcher | undefined): void,
+ *
  *   updateChecker: updateChecker | undefined,
  *   setUpdateChecker(updateCheckerFunction: updateChecker | undefined): void,
+ *
+ *   onUpdateSuccess: (label: string) => void | undefined,
+ *   setOnUpdateSuccess(onUpdateSuccessFunction: (label: string) => void | undefined): void,
+ *
+ *   onUpdateRollback: (label: string) => void | undefined,
+ *   setOnUpdateRollback(onUpdateRollbackFunction: (label: string) => void | undefined): void,
+ *
+ *   onDownloadStart: (label: string) => void | undefined,
+ *   setOnDownloadStart(onDownloadStartFunction: (label: string) => void | undefined): void,
+ *
+ *   onDownloadSuccess: (label: string) => void | undefined,
+ *   setOnDownloadSuccess(onDownloadSuccessFunction: (label: string) => void | undefined): void,
+ *
+ *   onSyncError: (label: string, error: Error) => void | undefined,
+ *   setOnSyncError(onSyncErrorFunction: (label: string, error: Error) => void | undefined): void,
  * }}
  */
 const sharedCodePushOptions = {
@@ -598,6 +623,36 @@ const sharedCodePushOptions = {
     if (typeof updateCheckerFunction !== 'function') throw new Error('Please pass a function to updateChecker');
     this.updateChecker = updateCheckerFunction;
   },
+  onUpdateSuccess: undefined,
+  setOnUpdateSuccess(onUpdateSuccessFunction) {
+    if (!onUpdateSuccessFunction) return;
+    if (typeof onUpdateSuccessFunction !== 'function') throw new Error('Please pass a function to onUpdateSuccess');
+    this.onUpdateSuccess = onUpdateSuccessFunction;
+  },
+  onUpdateRollback: undefined,
+  setOnUpdateRollback(onUpdateRollbackFunction) {
+    if (!onUpdateRollbackFunction) return;
+    if (typeof onUpdateRollbackFunction !== 'function') throw new Error('Please pass a function to onUpdateRollback');
+    this.onUpdateRollback = onUpdateRollbackFunction;
+  },
+  onDownloadStart: undefined,
+  setOnDownloadStart(onDownloadStartFunction) {
+    if (!onDownloadStartFunction) return;
+    if (typeof onDownloadStartFunction !== 'function') throw new Error('Please pass a function to onDownloadStart');
+    this.onDownloadStart = onDownloadStartFunction;
+  },
+  onDownloadSuccess: undefined,
+  setOnDownloadSuccess(onDownloadSuccessFunction) {
+    if (!onDownloadSuccessFunction) return;
+    if (typeof onDownloadSuccessFunction !== 'function') throw new Error('Please pass a function to onDownloadSuccess');
+    this.onDownloadSuccess = onDownloadSuccessFunction;
+  },
+  onSyncError: undefined,
+  setOnSyncError(onSyncErrorFunction) {
+    if (!onSyncErrorFunction) return;
+    if (typeof onSyncErrorFunction !== 'function') throw new Error('Please pass a function to onSyncError');
+    this.onSyncError = onSyncErrorFunction;
+  },
 }
 
 function codePushify(options = {}) {
@@ -627,6 +682,13 @@ function codePushify(options = {}) {
   sharedCodePushOptions.setReleaseHistoryFetcher(options.releaseHistoryFetcher);
   sharedCodePushOptions.setUpdateChecker(options.updateChecker);
 
+  // set telemetry callbacks
+  sharedCodePushOptions.setOnUpdateSuccess(options.onUpdateSuccess);
+  sharedCodePushOptions.setOnUpdateRollback(options.onUpdateRollback);
+  sharedCodePushOptions.setOnDownloadStart(options.onDownloadStart);
+  sharedCodePushOptions.setOnDownloadSuccess(options.onDownloadSuccess);
+  sharedCodePushOptions.setOnSyncError(options.onSyncError);
+
   const decorator = (RootComponent) => {
     class CodePushComponent extends React.Component {
       constructor(props) {

package/README.md

@@ -217,6 +217,16 @@ export default CodePush({
 > The URL for fetching the release history should point to the resource location generated by the CLI tool.
 
 
+#### 4-1. Telemetry Callbacks
+
+Please refer to the [CodePushOptions](https://github.com/Soomgo-Mobile/react-native-code-push/blob/f0d26f7614af41c6dd4daecd9f7146e2383b2b0d/typings/react-native-code-push.d.ts#L76-L95) type for more details.
+- **onUpdateSuccess:** Triggered when the update bundle is executed successfully.
+- **onUpdateRollback:** Triggered when there is an issue executing the update bundle, leading to a rollback.
+- **onDownloadStart:** Triggered when the bundle download begins.
+- **onDownloadSuccess:** Triggered when the bundle download completes successfully.
+- **onSyncError:** Triggered when an unknown error occurs during the update process. (`CodePush.SyncStatus.UNKNOWN_ERROR` status)
+
+
 ### 5. Configure the CLI Tool
 
 > [!TIP]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bravemobile/react-native-code-push",
-  "version": "10.0.0-beta.0",
+  "version": "10.0.0-beta.2",
   "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

@@ -73,6 +73,26 @@ export interface CodePushOptions extends SyncOptions {
      * @deprecated It will be removed in the next major version. Please migrate to `releaseHistoryFetcher`.
      */
     updateChecker?: (updateRequest: UpdateCheckRequest) => Promise<{ update_info: UpdateCheckResponse }>;
+    /**
+     * Callback function that is called when the update installation succeeds.
+     */
+    onUpdateSuccess?: (label: string) => void;
+    /**
+     * Callback function that is called when the update rolled back.
+     */
+    onUpdateRollback?: (label: string) => void;
+    /**
+     * Callback function that is called when download starts.
+     */
+    onDownloadStart?: (label: string) => void;
+    /**
+     * Callback function that is called when download finished successfully.
+     */
+    onDownloadSuccess?: (label: string) => void;
+    /**
+     * Callback function that is called when sync process failed.
+     */
+    onSyncError?: (label: string, error: Error) => void;
 }
 
 export interface DownloadProgress {