@appzung/react-native-code-push 11.0.0-rc1 → 11.0.0-rc10

package/src/internals/utils/fetchRetry.ts

@@ -0,0 +1,72 @@
+export async function fetchRetry(url: string, options: FetchRetryOptions = {}, attempt = 0): Promise<Response> {
+  const {
+    maxRetries = 3,
+    initialBackoff = 1000,
+    backoffMultiplier = 2,
+    maxRetryDelay = 30000,
+    ...fetchOptions
+  } = options;
+
+  try {
+    const response = await fetch(url, fetchOptions);
+    if (response.ok || !(response.status === 429 || response.status >= 500)) {
+      return response;
+    }
+
+    if (attempt >= maxRetries) {
+      return response;
+    }
+
+    const retryAfter = parseRetryAfterHeader(response);
+    if (retryAfter && retryAfter > maxRetryDelay) {
+      return response;
+    }
+
+    const delay = retryAfter ?? addJitter(initialBackoff * Math.pow(backoffMultiplier, attempt));
+
+    await new Promise((resolve) => setTimeout(resolve, delay));
+
+    return fetchRetry(url, options, attempt + 1);
+  } catch (error) {
+    if (attempt >= maxRetries) {
+      throw error;
+    }
+
+    const delay = addJitter(initialBackoff * Math.pow(backoffMultiplier, attempt));
+
+    await new Promise((resolve) => setTimeout(resolve, delay));
+
+    return fetchRetry(url, options, attempt + 1);
+  }
+}
+
+interface FetchRetryOptions extends RequestInit {
+  maxRetries?: number;
+  initialBackoff?: number;
+  backoffMultiplier?: number;
+  maxRetryDelay?: number;
+}
+
+function parseRetryAfterHeader(response: Response): number | null {
+  const retryAfter = response.headers.get('Retry-After');
+  if (!retryAfter) {
+    return null;
+  }
+
+  if (!isNaN(Number(retryAfter))) {
+    return parseInt(retryAfter, 10) * 1000;
+  }
+
+  try {
+    const retryDate = new Date(retryAfter).getTime();
+    const now = Date.now();
+    return retryDate > now ? retryDate - now : 0;
+  } catch (e) {
+    return null;
+  }
+}
+
+function addJitter(delay: number): number {
+  const jitterFactor = 0.5 + Math.random() * 0.5;
+  return Math.floor(delay * jitterFactor);
+}

package/src/internals/utils/log.ts

@@ -1,4 +1,14 @@
-/* Logs messages to console with the [CodePush] prefix */
-export function log(message: string): void {
-  console.log(`[CodePush] ${message}`);
+import type { LogLevel } from '../../enums/LogLevel.enum';
+import { getLogLevel } from '../../logLevel';
+import { getLogger } from '../logger';
+
+/* Logs messages using the configured logger */
+export function log(level: LogLevel, message: string): void {
+  const currentLogLevel = getLogLevel();
+  if (level < currentLogLevel) {
+    return;
+  }
+
+  const logger = getLogger();
+  logger(level, message);
 }

package/src/internals/utils/queryStringify.ts

@@ -0,0 +1,22 @@
+export function queryStringify(object: { [key: string]: any }): string {
+  let queryString = '';
+  let isFirst = true;
+
+  for (const property in object) {
+    if (object.hasOwnProperty(property)) {
+      const value = object[property];
+      if (value !== null && typeof value !== 'undefined') {
+        if (!isFirst) {
+          queryString += '&';
+        }
+
+        queryString += encodeURIComponent(property) + '=';
+        queryString += encodeURIComponent(value);
+      }
+
+      isFirst = false;
+    }
+  }
+
+  return queryString;
+}

package/src/internals/utils/requestFetchAdapter.ts

@@ -0,0 +1,36 @@
+import { LogLevel } from '../../enums/LogLevel.enum';
+import type { Http } from '../CodePushApiSdk.types';
+import { version } from '../version';
+import { fetchRetry } from './fetchRetry';
+import { log } from './log';
+
+export const requestFetchAdapter: Http.Requester = {
+  async request(method, url, requestBody) {
+    const headers = {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+      'X-CodePush-Plugin-Name': '@appzung/react-native-code-push',
+      'X-CodePush-Plugin-Version': version,
+    };
+
+    if (requestBody && typeof requestBody === 'object') {
+      requestBody = JSON.stringify(requestBody);
+    }
+
+    const requestId = Math.round(Math.random() * 10000);
+    log(LogLevel.DEBUG, `[${requestId}] Will fetch ${method} ${url}`);
+
+    const response = await fetchRetry(url, {
+      method,
+      headers,
+      body: requestBody,
+    });
+
+    const statusCode = response.status;
+
+    log(LogLevel.DEBUG, `[${requestId}] Done fetching with status code ${statusCode}`);
+
+    const body = await response.text();
+    return { statusCode, body };
+  },
+};

package/src/internals/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '11.0.0-rc1';
+export const version = '11.0.0-rc10';

package/src/logLevel.ts

@@ -0,0 +1,9 @@
+import { LogLevel } from './enums/LogLevel.enum';
+
+let logLevel = LogLevel.INFO;
+
+export const setLogLevel = (level: LogLevel) => {
+  logLevel = level;
+};
+
+export const getLogLevel = () => logLevel;

package/src/logger.ts

@@ -0,0 +1,2 @@
+export { setLogger, resetLogger } from './internals/logger';
+export type { LoggerFunction } from './internals/logger';

package/src/notifyAppReady.ts

@@ -1,13 +1,18 @@
 import { AppState, type NativeEventSubscription } from 'react-native';
+import { LogLevel } from './enums/LogLevel.enum';
+import { CodePushApiSdk } from './internals/CodePushApiSdk';
 import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
 import { getConfiguration } from './internals/getConfiguration';
-import { getPromisifiedSdk } from './internals/getPromisifiedSdk';
 import { log } from './internals/utils/log';
-import { requestFetchAdapter } from './internals/utils/request-fetch-adapter';
+import { requestFetchAdapter } from './internals/utils/requestFetchAdapter';
 import type { StatusReport } from './types';
 
 /**
+ * @function
+ *
  * Notifies the CodePush runtime that an installed update is considered successful.
+ *
+ * If you are manually checking for and installing updates (i.e. not using the `sync` method to handle it all for you), then this method **MUST** be called; otherwise CodePush will treat the update as failed and rollback to the previous version when the app next restarts.
  */
 export const notifyAppReady = (() => {
   // This ensures that notifyApplicationReadyInternal is only called once
@@ -24,32 +29,35 @@ export const notifyAppReady = (() => {
 })();
 
 async function notifyApplicationReadyInternal() {
+  log(LogLevel.DEBUG, 'notifyApplicationReady');
+
   await NativeRNAppZungCodePushModule.notifyApplicationReady();
   const statusReport = await NativeRNAppZungCodePushModule.getNewStatusReport();
-  statusReport && tryReportStatus(statusReport); // Don't wait for this to complete.
+  if (statusReport) {
+    log(LogLevel.DEBUG, `tryReportStatus ${statusReport.status || '(no update)'}`);
+
+    tryReportStatus(statusReport); // Don't wait for this to complete.
+  } else {
+    log(LogLevel.DEBUG, `Nothing to report`);
+  }
 
   return statusReport;
 }
 
 async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: NativeEventSubscription) {
   const config = await getConfiguration();
-  const previousLabelOrAppVersion = statusReport.previousLabelOrAppVersion;
+  const previousLabelOrAppVersion = statusReport.previousLabelOrAppVersion ?? null;
   const previousReleaseChannelPublicId = statusReport.previousReleaseChannelPublicId || config.releaseChannelPublicId;
   try {
     if (statusReport.appVersion) {
-      log(`Reporting binary update (${statusReport.appVersion})`);
+      log(LogLevel.INFO, `Reporting binary update (${statusReport.appVersion})`);
 
       if (!config.releaseChannelPublicId) {
         throw new Error('Release channel is missing');
       }
 
-      const sdk = getPromisifiedSdk(requestFetchAdapter, config);
-      await sdk.reportStatusDeploy(
-        /* deployedPackage */ undefined,
-        /* status */ undefined,
-        previousLabelOrAppVersion,
-        previousReleaseChannelPublicId,
-      );
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
+      await sdk.reportStatusDeploy(null, previousLabelOrAppVersion, previousReleaseChannelPublicId);
     } else {
       if (!statusReport.package) {
         throw new Error('Missing package in status report');
@@ -57,17 +65,19 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
 
       const label = statusReport.package.label;
       if (statusReport.status === 'DeploymentSucceeded') {
-        log(`Reporting CodePush update success (${label})`);
+        log(LogLevel.INFO, `Reporting CodePush update success (${label})`);
       } else {
-        log(`Reporting CodePush update rollback (${label})`);
+        log(LogLevel.INFO, `Reporting CodePush update rollback (${label})`);
         await NativeRNAppZungCodePushModule.setLatestRollbackInfo(statusReport.package.packageHash);
       }
 
       config.releaseChannelPublicId = statusReport.package.releaseChannelPublicId;
-      const sdk = getPromisifiedSdk(requestFetchAdapter, config);
+      const sdk = new CodePushApiSdk(requestFetchAdapter, log, config);
       await sdk.reportStatusDeploy(
-        { ...statusReport.package, deploymentKey: statusReport.package.releaseChannelPublicId },
-        statusReport.status,
+        {
+          package: statusReport.package,
+          status: statusReport.status,
+        },
         previousLabelOrAppVersion,
         previousReleaseChannelPublicId,
       );
@@ -76,7 +86,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
     NativeRNAppZungCodePushModule.recordStatusReported(statusReport);
     retryOnAppResume && retryOnAppResume.remove();
   } catch (e) {
-    log(`Report status failed: ${JSON.stringify(statusReport)}`);
+    log(LogLevel.WARN, `Report status failed: ${JSON.stringify(statusReport)}`);
     NativeRNAppZungCodePushModule.saveStatusReportForRetry(statusReport);
     // Try again when the app resumes
     if (!retryOnAppResume) {
@@ -84,6 +94,7 @@ async function tryReportStatus(statusReport: StatusReport, retryOnAppResume?: Na
         if (newState !== 'active') return;
         const refreshedStatusReport = await NativeRNAppZungCodePushModule.getNewStatusReport();
         if (refreshedStatusReport) {
+          log(LogLevel.DEBUG, `tryReportStatus on active appState ${statusReport.status || '(no update)'}`);
           tryReportStatus(refreshedStatusReport, resumeListener);
         } else {
           resumeListener && resumeListener.remove();

package/src/resetClientUniqueId.ts

@@ -0,0 +1,11 @@
+import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
+import { reloadCachedConfiguration } from './internals/getConfiguration';
+
+/**
+ * Resets the client's unique ID. You may use this in some GDPR compliance scenarios. Note that this will create a new MAU if a new request is sent later.
+ */
+export const resetClientUniqueId = async () => {
+  const newId = await NativeRNAppZungCodePushModule.resetClientUniqueId();
+  await reloadCachedConfiguration();
+  return newId;
+};

package/src/restartApp.ts

@@ -3,8 +3,10 @@ import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePu
 /**
  * Immediately restarts the app.
  *
+ * If there is an update pending, it will be immediately displayed to the end user. Otherwise, calling this method simply has the same behavior as the end user killing and restarting the process.
+ *
  * @param onlyIfUpdateIsPending Indicates whether you want the restart to no-op if there isn't currently a pending update.
  */
-export async function restartApp(onlyIfUpdateIsPending = false) {
-  NativeRNAppZungCodePushModule.restartApp(onlyIfUpdateIsPending);
+export function restartApp(onlyIfUpdateIsPending = false) {
+  return NativeRNAppZungCodePushModule.restartApp(onlyIfUpdateIsPending);
 }

package/src/sync.ts

@@ -1,6 +1,7 @@
 import { Alert, type AlertButton, Platform } from 'react-native';
 import { checkForUpdate } from './checkForUpdates';
 import { InstallMode } from './enums/InstallMode.enum';
+import { LogLevel } from './enums/LogLevel.enum';
 import { SyncStatus } from './enums/SyncStatus.enum';
 import { getCurrentPackage } from './internals/getCurrentPackage';
 import { shouldUpdateBeIgnored } from './internals/shouldUpdateBeIgnored';
@@ -62,38 +63,39 @@ async function syncInternal(
       : (syncStatus: SyncStatus) => {
           switch (syncStatus) {
             case SyncStatus.CHECKING_FOR_UPDATE:
-              log('Checking for update.');
+              log(LogLevel.INFO, 'Checking for update.');
               break;
             case SyncStatus.AWAITING_USER_ACTION:
-              log('Awaiting user action.');
+              log(LogLevel.INFO, 'Awaiting user action.');
               break;
             case SyncStatus.DOWNLOADING_PACKAGE:
-              log('Downloading package.');
+              log(LogLevel.INFO, 'Downloading package.');
               break;
             case SyncStatus.INSTALLING_UPDATE:
-              log('Installing update.');
+              log(LogLevel.INFO, 'Installing update.');
               break;
             case SyncStatus.UP_TO_DATE:
-              log('App is up to date.');
+              log(LogLevel.INFO, 'App is up to date.');
               break;
             case SyncStatus.UPDATE_IGNORED:
-              log('User cancelled the update.');
+              log(LogLevel.INFO, 'User cancelled the update.');
               break;
             case SyncStatus.UPDATE_INSTALLED:
-              if (resolvedInstallMode == InstallMode.ON_NEXT_RESTART) {
-                log('Update is installed and will be run on the next app restart.');
-              } else if (resolvedInstallMode == InstallMode.ON_NEXT_RESUME) {
-                if (!!syncOptions.minimumBackgroundDuration) {
+              if (resolvedInstallMode === InstallMode.ON_NEXT_RESTART) {
+                log(LogLevel.INFO, 'Update is installed and will be run on the next app restart.');
+              } else if (resolvedInstallMode === InstallMode.ON_NEXT_RESUME) {
+                if (syncOptions.minimumBackgroundDuration) {
                   log(
+                    LogLevel.INFO,
                     `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.');
+                  log(LogLevel.INFO, 'Update is installed and will be run when the app next resumes.');
                 }
               }
               break;
             case SyncStatus.UNKNOWN_ERROR:
-              log('An unknown error occurred.');
+              log(LogLevel.ERROR, 'An unknown error occurred.');
               break;
           }
         };
@@ -127,7 +129,10 @@ async function syncInternal(
 
     if (!remotePackage || updateShouldBeIgnored) {
       if (updateShouldBeIgnored) {
-        log('An update is available, but it is being ignored due to having been previously rolled back.');
+        log(
+          LogLevel.INFO,
+          'An update is available, but it is being ignored due to having been previously rolled back.',
+        );
       }
 
       const currentPackage = await getCurrentPackage();
@@ -195,6 +200,7 @@ async function syncInternal(
   } catch (error) {
     syncStatusChangeCallback(SyncStatus.UNKNOWN_ERROR);
     log(
+      LogLevel.ERROR,
       error != null && typeof error === 'object' && 'message' in error && typeof error.message === 'string'
         ? error.message
         : 'Unknown',
@@ -204,8 +210,12 @@ async function syncInternal(
 }
 
 /**
+ * @function
+ *
  * Allows checking for an update, downloading it and installing it, all with a single call.
  *
+ * Unless you need custom UI and/or behavior, we recommend most developers to use this method when integrating CodePush into their apps, if they are not using the `withCodePush` HOC.
+ *
  * @param options Options used to configure the end-user update experience (e.g. show a prompt?, install the update immediately?).
  * @param syncStatusChangedCallback An optional callback that allows tracking the status of the sync operation, as opposed to simply checking the resolved state via the returned Promise.
  * @param downloadProgressCallback An optional callback that allows tracking the progress of an update while it is being downloaded.
@@ -222,29 +232,33 @@ export const sync = (() => {
 
   return (
     options?: SyncOptions,
-    syncStatusChangeCallback?: SyncStatusChangedCallback,
+    syncStatusChangedCallback?: SyncStatusChangedCallback,
     downloadProgressCallback?: DownloadProgressCallback,
     handleBinaryVersionMismatchCallback?: HandleBinaryVersionMismatchCallback,
   ): Promise<SyncStatus> => {
-    let syncStatusCallbackWithTryCatch: SyncStatusChangedCallback | undefined;
-    let downloadProgressCallbackWithTryCatch: DownloadProgressCallback | undefined;
+    log(LogLevel.DEBUG, `sync start`);
 
-    if (typeof syncStatusChangeCallback === 'function') {
-      syncStatusCallbackWithTryCatch = (...args) => {
-        try {
-          syncStatusChangeCallback(...args);
-        } catch (error) {
-          log(`An error has occurred : ${error instanceof Error ? error.stack : 'unknown'}`);
-        }
-      };
-    }
+    let syncStatusCallbackWithTryCatch: SyncStatusChangedCallback = (status) => {
+      log(LogLevel.DEBUG, `sync status ${SyncStatus[status]}`);
+
+      if (typeof syncStatusChangedCallback !== 'function') {
+        return;
+      }
 
+      try {
+        syncStatusChangedCallback(status);
+      } catch (error) {
+        log(LogLevel.ERROR, `An error has occurred : ${error instanceof Error ? error.stack : 'unknown'}`);
+      }
+    };
+
+    let downloadProgressCallbackWithTryCatch: DownloadProgressCallback | undefined;
     if (typeof downloadProgressCallback === 'function') {
       downloadProgressCallbackWithTryCatch = (...args) => {
         try {
           downloadProgressCallback(...args);
         } catch (error) {
-          log(`An error has occurred: ${error instanceof Error ? error.stack : 'unknown'}`);
+          log(LogLevel.ERROR, `An error has occurred: ${error instanceof Error ? error.stack : 'unknown'}`);
         }
       };
     }
@@ -252,7 +266,7 @@ export const sync = (() => {
     if (syncInProgress) {
       typeof syncStatusCallbackWithTryCatch === 'function'
         ? syncStatusCallbackWithTryCatch(SyncStatus.SYNC_IN_PROGRESS)
-        : log('Sync already in progress.');
+        : log(LogLevel.WARN, 'Sync already in progress.');
       return Promise.resolve(SyncStatus.SYNC_IN_PROGRESS);
     }
 

package/src/telemetry.ts

@@ -0,0 +1,21 @@
+import { NativeRNAppZungCodePushModule } from './internals/NativeRNAppZungCodePushModule';
+import { reloadCachedConfiguration } from './internals/getConfiguration';
+
+/**
+ * Controls telemetry reporting.
+ *
+ * @param enabled - When false, updates on this device will stop appearing as failed, pending or succeeded in analytics.
+ */
+export async function setTelemetryEnabled(enabled: boolean): Promise<void> {
+  await NativeRNAppZungCodePushModule.setTelemetryEnabled(enabled);
+  await reloadCachedConfiguration();
+}
+
+/**
+ * Gets the current telemetry enabled status.
+ *
+ * When setTelemetryEnabled has never been enabled, returns the default value set in your configuration.
+ */
+export function getTelemetryEnabled(): Promise<boolean> {
+  return NativeRNAppZungCodePushModule.getTelemetryEnabled();
+}