react-native-update 10.59.2 → 10.61.0

package/src/error.ts

@@ -7,61 +7,44 @@
  * Android/iOS/Harmony modules — and flow through promise rejections onto the
  * `code` property, which toUpdateError() preserves.
  */
-export type UpdateErrorCode =
+const UPDATE_ERROR_CODES = [
   // JS-layer codes
-  | 'MODULE_NOT_LOADED'
-  | 'APPKEY_REQUIRED'
-  | 'NO_ENDPOINTS'
-  | 'HTTP_STATUS'
-  // A 2xx check response that is not a check verdict (schema gate).
-  | 'INVALID_RESPONSE'
-  | 'CHECK_FAILED'
-  | 'DOWNLOAD_FAILED'
-  | 'SWITCH_VERSION_FAILED'
-  | 'MARK_SUCCESS_FAILED'
-  | 'APK_INSTALL_PENDING'
-  | 'APK_DOWNLOAD_FAILED'
-  // A throw from a user-provided hook (e.g. beforeReload) — not an update
-  // pipeline failure, and excluded from server-side patch-health telemetry.
-  | 'USER_HOOK_ERROR'
-  // A second client/provider in the same process — a hard integration error;
-  // the SDK is a process-level singleton.
-  | 'SINGLETON_VIOLATION'
-  // Native codes (see cpp/patch_core/error_codes.h)
-  | 'INVALID_OPTIONS'
-  | 'PATCH_FAILED'
-  | 'FILE_OPERATION_FAILED'
-  | 'RESTART_FAILED'
-  | 'RESET_FAILED'
-  | 'INVALID_HASH_INFO'
-  | 'UNSUPPORTED_PLATFORM'
-  | 'APK_INSTALL_PERMISSION_REQUIRED'
-  | 'APK_INSTALL_FAILED';
-
-const KNOWN_CODES = new Set<string>([
   'MODULE_NOT_LOADED',
   'APPKEY_REQUIRED',
   'NO_ENDPOINTS',
   'HTTP_STATUS',
+  // A 2xx check response that is not a check verdict (schema gate).
   'INVALID_RESPONSE',
   'CHECK_FAILED',
-  'DOWNLOAD_FAILED',
-  'SWITCH_VERSION_FAILED',
-  'MARK_SUCCESS_FAILED',
   'APK_INSTALL_PENDING',
   'APK_DOWNLOAD_FAILED',
+  // A throw from a user-provided hook (e.g. beforeReload) — not an update
+  // pipeline failure, and excluded from server-side patch-health telemetry.
   'USER_HOOK_ERROR',
+  // A second client/provider in the same process — a hard integration error;
+  // the SDK is a process-level singleton.
   'SINGLETON_VIOLATION',
+  // Native codes (cpp/patch_core/error_codes.h)
+  // <generated:native-error-codes> (scripts/contract.ts; bun scripts/generate-contract.ts)
   'INVALID_OPTIONS',
+  'DOWNLOAD_FAILED',
   'PATCH_FAILED',
   'FILE_OPERATION_FAILED',
+  'SWITCH_VERSION_FAILED',
+  'MARK_SUCCESS_FAILED',
   'RESTART_FAILED',
   'RESET_FAILED',
   'INVALID_HASH_INFO',
   'UNSUPPORTED_PLATFORM',
   'APK_INSTALL_PERMISSION_REQUIRED',
   'APK_INSTALL_FAILED',
-]);
+  // </generated:native-error-codes>
+] as const;
+
+/** A stable error code (see UPDATE_ERROR_CODES). */
+export type UpdateErrorCode = (typeof UPDATE_ERROR_CODES)[number];
+
+const KNOWN_CODES = new Set<string>(UPDATE_ERROR_CODES);
 
 /**
  * Narrow an arbitrary `code` property (axios' ERR_NETWORK, Node's

package/src/i18n.ts

@@ -1,108 +1,43 @@
 import enTranslations from './locales/en';
 import zhTranslations from './locales/zh';
 
+type Locale = 'zh' | 'en';
 type TranslationKey = keyof typeof zhTranslations | keyof typeof enTranslations;
 type TranslationValues = Record<string, string | number>;
 
+const translations: Record<Locale, Record<string, string>> = {
+  zh: zhTranslations,
+  en: enTranslations,
+};
+
 class I18n {
-  private currentLocale: 'zh' | 'en' = 'en';
-  private translations = {
-    zh: zhTranslations,
-    en: enTranslations,
-  };
+  private currentLocale: Locale = 'en';
 
-  /**
-   * Set locale directly
-   * @param locale - 'zh' or 'en'
-   */
-  setLocale(locale: 'zh' | 'en') {
+  setLocale(locale: Locale) {
     this.currentLocale = locale;
   }
 
   /**
-   * Get current locale
-   */
-  getLocale(): 'zh' | 'en' {
-    return this.currentLocale;
-  }
-
-  /**
-   * Translate a key with optional interpolation
-   * @param key - Translation key
-   * @param values - Values for interpolation (optional)
-   * @returns Translated string with interpolated values
+   * Translate a key, filling `{{name}}` placeholders from `values` (unknown
+   * placeholders are kept). A key missing from the current locale falls back
+   * to the other one, then to the key itself.
    */
   t(key: TranslationKey, values?: TranslationValues): string {
-    const translation =
-      this.translations[this.currentLocale][
-        key as keyof (typeof this.translations)[typeof this.currentLocale]
-      ];
-
-    if (!translation) {
-      // Fallback to the other locale if key not found
-      const fallbackLocale = this.currentLocale === 'zh' ? 'en' : 'zh';
-      const fallbackTranslation =
-        this.translations[fallbackLocale][
-          key as keyof (typeof this.translations)[typeof fallbackLocale]
-        ];
-
-      if (!fallbackTranslation) {
-        // If still not found, return the key itself
-        return String(key);
-      }
-
-      return this.interpolate(fallbackTranslation, values);
-    }
-
-    return this.interpolate(translation, values);
-  }
-
-  /**
-   * Interpolate values into a string template
-   * Supports {{key}} syntax
-   * @param template - String template with {{key}} placeholders
-   * @param values - Values to interpolate
-   * @returns Interpolated string
-   */
-  private interpolate(template: string, values?: TranslationValues): string {
+    const fallbackLocale = this.currentLocale === 'zh' ? 'en' : 'zh';
+    const template =
+      translations[this.currentLocale][key] ||
+      translations[fallbackLocale][key] ||
+      String(key);
     if (!values) {
       return template;
     }
-
-    return template.replace(/\{\{(\w+)\}\}/g, (match, key) => {
-      const value = values[key];
+    return template.replace(/\{\{(\w+)\}\}/g, (match, name) => {
+      const value = values[name];
       return value !== undefined ? String(value) : match;
     });
   }
-
-  /**
-   * Add or update translations for a specific locale
-   * @param locale - Target locale
-   * @param translations - Translation object to merge
-   */
-  addTranslations(locale: 'zh' | 'en', translations: Record<string, string>) {
-    this.translations[locale] = {
-      ...this.translations[locale],
-      ...translations,
-    };
-  }
 }
 
-// Create singleton instance
 const i18n = new I18n();
 
-// Export both the instance and the class for flexibility
-export { I18n, i18n };
 export default i18n;
-
-/**
- * Usage examples:
- *
- * // Direct locale setting (new preferred method)
- * i18n.setLocale('zh'); // Chinese
- * i18n.setLocale('en'); // English
- *
- * // Get translations
- * i18n.t('checking_update'); // Based on current locale
- * i18n.t('download_progress', { progress: 50 }); // With interpolation
- */

package/src/locales/en.ts

@@ -1,11 +1,7 @@
 export default {
   // Common messages
-  checking_update: 'Checking for updates...',
   update_failed: 'Update failed',
 
-  // Progress messages with interpolation
-  download_progress: 'Download progress: {{progress}}%',
-
   // Alert messages
   alert_title: 'Notice',
   alert_update_ready: 'Download completed. Update now?',
@@ -29,7 +25,7 @@ export default {
     'A second UpdateProvider was mounted: make sure the app renders exactly one UpdateProvider',
   error_parse_version_info: 'Failed to parse currentVersionInfo: {{info}}',
   warn_unknown_bundle:
-    'The bundle embedded in this binary is not registered on the update platform; incremental updates are degraded to full downloads. Upload the package with pushy uploadIpa / uploadApk / uploadApp.',
+    'The bundle embedded in this binary is not registered on the update platform; incremental updates are degraded to full downloads. Upload the package with {{cli}} uploadIpa / uploadApk / uploadApp.',
   error_update_check_failed: 'Update check failed',
   error_cannot_connect_server:
     'Can not connect to update server. Please check your network.',

package/src/locales/zh.ts

@@ -1,11 +1,7 @@
 export default {
   // Common messages
-  checking_update: '正在检查更新...',
   update_failed: '更新失败',
 
-  // Progress messages with interpolation
-  download_progress: '下载进度: {{progress}}%',
-
   // Alert messages
   alert_title: '提示',
   alert_update_ready: '下载完毕，是否立即更新?',
@@ -27,7 +23,7 @@ export default {
     '检测到同时挂载多个 UpdateProvider：请确保应用中只有一个 UpdateProvider',
   error_parse_version_info: '解析 currentVersionInfo 失败: {{info}}',
   warn_unknown_bundle:
-    '当前二进制内嵌 bundle 未在更新平台注册，增量更新已降级为全量。请使用 pushy uploadIpa / uploadApk / uploadApp 上传对应安装包。',
+    '当前二进制内嵌 bundle 未在更新平台注册，增量更新已降级为全量。请使用 {{cli}} uploadIpa / uploadApk / uploadApp 上传对应安装包。',
   error_update_check_failed: '更新检查失败',
   error_cannot_connect_server: '无法连接到更新服务器。请检查网络连接。',
   error_cannot_connect_backup:

package/src/provider.tsx

@@ -11,7 +11,6 @@ import { Alert, AppState, Linking, Platform } from 'react-native';
 import { type Cresc, type Pushy, sharedState } from './client';
 import { ProgressContext, UpdateContext } from './context';
 import {
-  cInfo,
   currentVersion,
   currentVersionInfo,
   getCurrentVersionInfo,
@@ -19,9 +18,29 @@ import {
   rolledBackVersion,
 } from './core';
 import type { CheckResult, ProgressData, UpdateTestPayload } from './type';
-import { decideDownload, resolveCheckResult } from './updateFlowCore';
+import { decideDownload } from './updateFlowCore';
 import { assertWeb, isWeb, log, noop, parseQueryParams } from './utils';
 
+// A switch action applied to the hash of the given update info; a no-op
+// without one. Called without info it targets the downloaded version — the
+// only one client.switchVersion(Later) accepts — and only falls back to the
+// last checked info before anything was downloaded. Defaulting to the last
+// checked info alone made a check that found a newer release after the
+// download (updateInfo moved on) turn "switch now" into a silent no-op.
+const forUpdateHash =
+  <T,>(
+    updateInfoRef: { current?: CheckResult },
+    getDownloadedHash: () => string | undefined,
+    apply: (hash: string) => Promise<T>
+  ) =>
+  async (info?: CheckResult) => {
+    const hash =
+      info !== undefined
+        ? info.hash
+        : getDownloadedHash() || updateInfoRef.current?.hash;
+    return hash ? apply(hash) : undefined;
+  };
+
 export const UpdateProvider = ({
   client,
   children,
@@ -100,22 +119,42 @@ export const UpdateProvider = ({
     [client, alertError]
   );
 
-  const switchVersion = useCallback(
-    async (info: CheckResult | undefined = updateInfoRef.current) => {
-      if (info?.hash) {
-        return client.switchVersion(info.hash);
-      }
-    },
+  const switchVersion = useMemo(
+    () =>
+      forUpdateHash(
+        updateInfoRef,
+        client.getDownloadedHash,
+        client.switchVersion
+      ),
     [client]
   );
 
-  const switchVersionLater = useCallback(
-    async (info: CheckResult | undefined = updateInfoRef.current) => {
-      if (info?.hash) {
-        return client.switchVersionLater(info.hash);
+  const switchVersionLater = useMemo(
+    () =>
+      forUpdateHash(
+        updateInfoRef,
+        client.getDownloadedHash,
+        client.switchVersionLater
+      ),
+    [client]
+  );
+
+  // Client pipeline errors were already surfaced via the onError
+  // subscription; errors thrown by user hooks (beforeCheckUpdate,
+  // afterDownloadUpdate) bypass the pipeline and are surfaced here. Asking
+  // the client instead of checking `e.code` matters: axios/system errors
+  // carry their own code without ever entering the pipeline.
+  const surfaceCaughtError = useCallback(
+    (e: any, title: string) => {
+      if (!client.wasEmitted(e)) {
+        setLastError(e);
+        alertError(title, e.message);
+      }
+      if (options.throwError) {
+        throw e;
       }
     },
-    [client]
+    [client, options, alertError]
   );
 
   const downloadUpdate = useCallback(
@@ -162,27 +201,17 @@ export const UpdateProvider = ({
         ]);
         return true;
       } catch (e: any) {
-        // Client pipeline errors were already surfaced via the onError
-        // subscription; errors thrown by user hooks (afterDownloadUpdate)
-        // bypass the pipeline and are surfaced here. Asking the client
-        // instead of checking `e.code` matters: axios/system errors carry
-        // their own code without ever entering the pipeline.
-        if (!client.wasEmitted(e)) {
-          setLastError(e);
-          alertError(client.t('update_failed'), e.message);
-        }
-        if (options.throwError) {
-          throw e;
-        }
+        surfaceCaughtError(e, client.t('update_failed'));
         return false;
       }
     },
-    [client, options, alertUpdate, alertError]
+    [client, options, alertUpdate, surfaceCaughtError]
   );
 
   const downloadAndInstallApk = useCallback(
     async (downloadUrl: string) => {
-      if (Platform.OS === 'android' && downloadUrl) {
+      // The client itself is a no-op off Android.
+      if (downloadUrl) {
         await client.downloadAndInstallApk(downloadUrl, setProgress);
       }
     },
@@ -215,36 +244,20 @@ export const UpdateProvider = ({
       // No throttle here: the client already dedupes checks via its 5s
       // response cache, and a second throttle layer silently returned
       // undefined, indistinguishable from a failed check.
-      let rootInfo: CheckResult | undefined;
+      // Already resolved for this device (gray rollout, running version) by
+      // the client.
+      let info: CheckResult | undefined;
       try {
-        rootInfo = await client.checkUpdate(extra);
+        info = await client.checkUpdate(extra);
       } catch (e: any) {
-        // Client pipeline errors were already surfaced via the onError
-        // subscription; errors thrown by user hooks (beforeCheckUpdate)
-        // bypass the pipeline and are surfaced here (see wasEmitted).
-        if (!client.wasEmitted(e)) {
-          setLastError(e);
-          alertError(client.t('error_update_check_failed'), e.message);
-        }
-        if (options.throwError) {
-          throw e;
-        }
+        surfaceCaughtError(e, client.t('error_update_check_failed'));
         return;
       }
-      if (!rootInfo) {
+      if (!info) {
         // Check was skipped or failed with no cached result; keep the last
         // known updateInfo instead of overwriting it with an empty object.
         return;
       }
-      let info = resolveCheckResult(
-        rootInfo,
-        {
-          packageVersion: client.getEffectivePackageVersion(),
-          currentVersion,
-          uuid: cInfo.uuid,
-        },
-        log
-      );
       if (
         info.update &&
         (typeof info.hash !== 'string' || info.hash.length === 0)
@@ -354,13 +367,14 @@ export const UpdateProvider = ({
       client,
       options,
       alertUpdate,
-      alertError,
+      surfaceCaughtError,
       openExpiredDownload,
       downloadUpdate,
     ]
   );
 
-  const markSuccess = client.markSuccess;
+  // Stable arrow-function properties of the (pinned) client.
+  const { markSuccess, restartApp, resetToPackagedBundle } = client;
 
   // The lifecycle effects below key on the primitive option values they read
   // (re-read on every render, i.e. after every setOptions), so a setOptions
@@ -528,16 +542,15 @@ export const UpdateProvider = ({
     [parseTestPayload]
   );
 
-  const restartApp = useCallback(async () => {
-    return client.restartApp();
-  }, [client]);
-
-  const resetToPackagedBundle = useCallback(
-    async (resetOptions?: { restart?: boolean }) => {
-      return client.resetToPackagedBundle(resetOptions);
-    },
-    [client]
-  );
+  // parseTestPayload's identity follows checkUpdate (and through it the
+  // update strategy callbacks); the Linking subscription reads it through a
+  // ref so it is set up once instead of re-running — and replaying the
+  // initial URL — on every such change.
+  const latestParseTestPayload = useRef(parseTestPayload);
+  useEffect(() => {
+    latestParseTestPayload.current = parseTestPayload;
+  }, [parseTestPayload]);
+  const initialUrlHandled = useRef(false);
 
   useEffect(() => {
     if (!assertWeb()) {
@@ -552,25 +565,31 @@ export const UpdateProvider = ({
       // malformed deep link must not become an unhandled rejection / a throw
       // inside the 'url' event handler.
       const params = parseQueryParams(url);
-      parseTestPayload({
+      latestParseTestPayload.current({
         type: params.type ?? null,
         data: params.data ?? null,
       });
     };
 
-    Linking.getInitialURL().then(parseLinking).catch(noop);
+    // The launch URL is one event: a remount (StrictMode included) must not
+    // replay it.
+    if (!initialUrlHandled.current) {
+      initialUrlHandled.current = true;
+      Linking.getInitialURL().then(parseLinking).catch(noop);
+    }
     const linkingHandler = ({ url }: { url: string }) => {
       parseLinking(url);
     };
     const linkingListener = Linking.addEventListener('url', linkingHandler);
     return () => {
-      if ('removeEventListener' in Linking) {
-        (Linking as any).removeEventListener('url', linkingHandler);
-      } else {
+      // RN < 0.65 returns no subscription, only removeEventListener.
+      if (typeof linkingListener?.remove === 'function') {
         linkingListener.remove();
+      } else {
+        (Linking as any).removeEventListener('url', linkingHandler);
       }
     };
-  }, [parseTestPayload]);
+  }, []);
 
   // progress lives in its own context (see context.ts), so this value only
   // changes when the update state itself changes, not on every progress tick.

package/src/telemetry.ts

@@ -14,19 +14,6 @@ export type ServerEventType =
 // Failure detail is stored server-side in a VARCHAR(512); stay under it.
 export const MAX_DETAIL_LENGTH = 500;
 
-export interface ServerReportPayload {
-  type: ServerEventType;
-  hash: string;
-  packageVersion?: string;
-  cInfo?: {
-    rnu?: string;
-    rn?: string;
-    os?: string;
-    uuid?: string;
-  };
-  detail?: string;
-}
-
 /**
  * Maps a local report event to the server-side aggregate type, or undefined
  * for events the server does not collect. A DOWNLOAD_FAILED whose underlying

package/src/type.ts

@@ -41,21 +41,6 @@ interface RootResult {
   bundleStatus?: 'matched' | 'rebuiltSameJs' | 'unknownBundle';
 }
 
-export type UpToDateCheckResult = RootResult & {
-  upToDate: true;
-};
-
-export type UpdateAvailableCheckResult = RootResult &
-  Partial<VersionInfo> & {
-    update: true;
-    expVersion?: VersionInfo;
-  };
-
-export type ExpiredCheckResult = RootResult & {
-  expired: true;
-  downloadUrl: string;
-};
-
 export type CheckResult = RootResult &
   Partial<VersionInfo> & {
     expVersion?: VersionInfo;

package/src/updateFlowCore.ts

@@ -118,6 +118,117 @@ export const dedupeEndpoints = (
   return result;
 };
 
+// Values the natives assume for keys a persisted native check config omits.
+const NATIVE_CONFIG_DEFAULTS: Record<string, unknown> = {
+  disabled: false,
+  queryUrls: [],
+  rnu: '',
+  rn: '',
+  afterDownload: 'none',
+};
+
+/**
+ * Deep equality of JSON values, key order ignored. Object members whose value
+ * is undefined count as absent, matching JSON.stringify (they do not exist on
+ * the wire).
+ */
+export const jsonDeepEqual = (a: unknown, b: unknown): boolean => {
+  if (a === b) {
+    return true;
+  }
+  if (Array.isArray(a) || Array.isArray(b)) {
+    return (
+      Array.isArray(a) &&
+      Array.isArray(b) &&
+      a.length === b.length &&
+      a.every((value, index) => jsonDeepEqual(value, b[index]))
+    );
+  }
+  if (!a || !b || typeof a !== 'object' || typeof b !== 'object') {
+    return false;
+  }
+  const left = a as Record<string, unknown>;
+  const right = b as Record<string, unknown>;
+  const definedKeys = (object: Record<string, unknown>) =>
+    Object.keys(object).filter((key) => object[key] !== undefined);
+  const leftKeys = definedKeys(left);
+  return (
+    leftKeys.length === definedKeys(right).length &&
+    leftKeys.every(
+      (key) =>
+        // biome-ignore lint/suspicious/noPrototypeBuiltins: Object.hasOwn is missing from JSC before iOS 15.4
+        Object.prototype.hasOwnProperty.call(right, key) &&
+        jsonDeepEqual(left[key], right[key])
+    )
+  );
+};
+
+// Each string loses every trailing '/', then entries (strings or not) are
+// deduplicated by JSON value, keeping the first occurrence.
+const canonicalUrlList = (value: unknown): unknown => {
+  if (!Array.isArray(value)) {
+    return value;
+  }
+  const result: unknown[] = [];
+  const visited = new Set<string>();
+  for (const item of value) {
+    if (typeof item === 'string') {
+      const url = item.replace(/\/+$/, '');
+      if (!visited.has(url)) {
+        visited.add(url);
+        result.push(url);
+      }
+    } else if (!result.some((existing) => jsonDeepEqual(existing, item))) {
+      result.push(item);
+    }
+  }
+  return result;
+};
+
+/**
+ * Canonical form of a persisted native check config (shared contract C1 with
+ * the Android/iOS/Harmony natives): absent keys take their native defaults,
+ * `endpoints`/`queryUrls` lose trailing '/' and duplicates (first occurrence
+ * kept). Undefined when the JSON is unparseable or not an object.
+ */
+export function canonicalizeNativeConfig(
+  configJson: string
+): Record<string, unknown> | undefined {
+  let parsed: unknown;
+  try {
+    parsed = JSON.parse(configJson);
+  } catch {
+    return undefined;
+  }
+  if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
+    return undefined;
+  }
+  const canonical: Record<string, unknown> = {
+    ...NATIVE_CONFIG_DEFAULTS,
+    ...(parsed as Record<string, unknown>),
+  };
+  for (const key of ['endpoints', 'queryUrls']) {
+    if (key in canonical) {
+      canonical[key] = canonicalUrlList(canonical[key]);
+    }
+  }
+  return canonical;
+}
+
+/**
+ * Whether two native check config JSON strings describe the same config
+ * (contract C1): their canonical forms are deep-equal, key order ignored.
+ * Anything unparseable is never equivalent.
+ */
+export function nativeConfigsEquivalent(
+  leftJson: string,
+  rightJson: string
+): boolean {
+  const left = canonicalizeNativeConfig(leftJson);
+  const right = canonicalizeNativeConfig(rightJson);
+  return !!left && !!right && jsonDeepEqual(left, right);
+}
+
 /**
  * The endpoint plan: dedupe, then move the sampled pick to the front (load
  * spreading), keeping the rest in configured order as the fallback sequence.
@@ -223,8 +334,10 @@ export interface CheckFingerprintInput {
   appKey?: string;
   endpoints?: string[];
   queryUrls?: string[];
-  uuid?: string;
-  /** The exact serialized request body (identity fields + extra). */
+  /**
+   * The exact serialized request body (identity fields + extra; the client
+   * uuid travels inside its cInfo).
+   */
   body: string;
 }
 
@@ -236,16 +349,9 @@ export function buildCheckFingerprint({
   appKey,
   endpoints,
   queryUrls,
-  uuid,
   body,
 }: CheckFingerprintInput): string {
-  return JSON.stringify([
-    appKey ?? '',
-    endpoints ?? [],
-    queryUrls ?? [],
-    uuid ?? '',
-    body,
-  ]);
+  return JSON.stringify([appKey ?? '', endpoints ?? [], queryUrls ?? [], body]);
 }
 
 /**