@hot-updater/react-native 1.0.0-rc.1 → 1.0.0-rc.15

package/src/specs/NativeHotUpdater.ts

@@ -2,48 +2,21 @@ import type { TurboModule } from "react-native";
 import { TurboModuleRegistry } from "react-native";
 import type { UnsafeObject } from "react-native/Libraries/Types/CodegenTypes";
 
-export interface ChangedAsset {
-  file?: {
-    compression?: "br" | null;
-    url: string;
-  } | null;
-  fileHash: string;
-  patch?: {
-    algorithm: "bsdiff";
-    baseBundleId: string;
-    baseFileHash: string;
-    patchFileHash: string;
-    patchUrl: string;
-  } | null;
-}
-
 export interface UpdateBundleParams {
   bundleId: string;
   channel?: string;
-  fileUrl: string | null;
-  /**
-   * File hash for integrity/signature verification.
-   *
-   * Format depends on signing configuration:
-   * - Signed: `sig:<base64_signature>` - Native will verify signature (and implicitly hash)
-   * - Unsigned: `<hex_hash>` - Native will verify SHA256 hash only
-   *
-   * Native determines verification mode by checking for "sig:" prefix.
-   */
-  fileHash: string | null;
   /**
-   * Optional signed manifest URL for manifest-driven installation.
+   * Signed manifest URL for installation.
    */
-  manifestUrl?: string | null;
+  manifestUrl: string;
   /**
    * File hash/signature for the manifest file itself.
    */
-  manifestFileHash?: string | null;
-  /**
-   * Per-file URLs for assets that must be downloaded instead of reused from
-   * the currently active bundle.
-   */
-  changedAssets?: UnsafeObject | null;
+  manifestFileHash: string;
+  /** Optional tar.br URL; integrity and sizes come from the verified manifest. */
+  archiveUrl?: string | null;
+  /** Full protocol v1 target file descriptor map. */
+  assets: UnsafeObject;
   /** Full Release Catalog selection receipt committed with the staged Bundle. */
   selection?: UnsafeObject | null;
 }
@@ -66,13 +39,12 @@ export interface Spec extends TurboModule {
    *
    *   Parameter validation:
    *   - MISSING_BUNDLE_ID: Missing or empty bundleId
-   *   - INVALID_FILE_URL: Invalid fileUrl provided
+   *   - INVALID_FILE_URL: Invalid manifest or asset URL provided
    *
    *   Bundle storage:
    *   - DIRECTORY_CREATION_FAILED: Failed to create bundle directory
    *   - DOWNLOAD_FAILED: Failed to download bundle
    *   - INCOMPLETE_DOWNLOAD: Download incomplete (size mismatch)
-   *   - EXTRACTION_FORMAT_ERROR: Invalid or corrupted archive format
    *   - INVALID_BUNDLE: Bundle missing required platform files
    *   - INSUFFICIENT_DISK_SPACE: Insufficient disk space
    *   - MOVE_OPERATION_FAILED: Failed to move bundle files

package/src/store.notification.spec.ts

@@ -61,10 +61,20 @@ describe("hotUpdaterStore notification scheduling", () => {
 
         const nextProgress = Math.min(1, progress + 0.01);
         emitProgress?.({
-          artifactType: "archive",
-          downloadedBytes: nextProgress * 1_000_000,
+          artifactType: "diff",
+          details: {
+            completedFilesCount: nextProgress === 1 ? 1 : 0,
+            files: [
+              {
+                order: 0,
+                path: "index.ios.bundle",
+                progress: nextProgress,
+                status: nextProgress === 1 ? "downloaded" : "downloading",
+              },
+            ],
+            totalFilesCount: 1,
+          },
           progress: nextProgress,
-          totalBytes: 1_000_000,
         });
       }, [progress]);
 

package/src/store.spec.ts

@@ -41,75 +41,6 @@ describe("hotUpdaterStore", () => {
     unsubscribe();
   });
 
-  it("notifies subscribers only when progress events change the snapshot", async () => {
-    const store = await importStore();
-    const listener = vi.fn();
-    const emitProgress = listeners.get("onProgress");
-
-    expect(emitProgress).toBeTypeOf("function");
-
-    const unsubscribe = store.subscribe(listener);
-
-    emitProgress?.({
-      artifactType: "archive",
-      progress: 0.5,
-    });
-    emitProgress?.({
-      artifactType: "archive",
-      progress: 0.5,
-    });
-    emitProgress?.({
-      artifactType: "archive",
-      progress: 1,
-    });
-    store.setState({ isUpdateDownloaded: true });
-
-    expect(listener).toHaveBeenCalledTimes(2);
-    expect(store.getSnapshot()).toEqual({
-      artifactType: "archive",
-      details: null,
-      downloadedBytes: undefined,
-      isUpdateDownloaded: true,
-      progress: 1,
-      totalBytes: undefined,
-    });
-
-    unsubscribe();
-  });
-
-  it("stores archive byte metadata and notifies when only bytes change", async () => {
-    const store = await importStore();
-    const listener = vi.fn();
-    const emitProgress = listeners.get("onProgress");
-
-    const unsubscribe = store.subscribe(listener);
-
-    emitProgress?.({
-      artifactType: "archive",
-      downloadedBytes: 100.4,
-      progress: 0.5,
-      totalBytes: 1_000,
-    });
-    emitProgress?.({
-      artifactType: "archive",
-      downloadedBytes: 250,
-      progress: 0.5,
-      totalBytes: 1_000,
-    });
-
-    expect(listener).toHaveBeenCalledTimes(2);
-    expect(store.getSnapshot()).toEqual({
-      artifactType: "archive",
-      details: null,
-      downloadedBytes: 250,
-      isUpdateDownloaded: false,
-      progress: 0.5,
-      totalBytes: 1_000,
-    });
-
-    unsubscribe();
-  });
-
   it("stores manifest progress metadata while keeping overall progress", async () => {
     const store = await importStore();
     const emitProgress = listeners.get("onProgress");
@@ -163,10 +94,8 @@ describe("hotUpdaterStore", () => {
         ],
         totalFilesCount: 2,
       },
-      downloadedBytes: undefined,
       isUpdateDownloaded: false,
       progress: 0.42,
-      totalBytes: undefined,
     });
   });
 
@@ -279,94 +208,8 @@ describe("hotUpdaterStore", () => {
         ],
         totalFilesCount: 2,
       },
-      downloadedBytes: undefined,
       isUpdateDownloaded: false,
       progress: 0.6,
-      totalBytes: undefined,
-    });
-  });
-
-  it("clears manifest metadata when archive progress events arrive", async () => {
-    const store = await importStore();
-    const emitProgress = listeners.get("onProgress");
-
-    emitProgress?.({
-      artifactType: "diff",
-      details: {
-        completedFilesCount: 2,
-        files: [
-          {
-            order: 0,
-            path: "index.ios.bundle",
-            progress: 1,
-            status: "downloaded",
-          },
-          {
-            order: 1,
-            path: "assets/logo.png",
-            progress: 1,
-            status: "downloaded",
-          },
-          {
-            order: 2,
-            path: "assets/bg.png",
-            progress: 0,
-            status: "pending",
-          },
-        ],
-        totalFilesCount: 3,
-      },
-      progress: 0.9,
-    });
-
-    emitProgress?.({
-      artifactType: "archive",
-      progress: 0.25,
-    });
-
-    expect(store.getSnapshot()).toEqual({
-      artifactType: "archive",
-      details: null,
-      downloadedBytes: undefined,
-      isUpdateDownloaded: false,
-      progress: 0.25,
-      totalBytes: undefined,
-    });
-  });
-
-  it("clears stale manifest metadata even when archive events omit optional fields", async () => {
-    const store = await importStore();
-    const emitProgress = listeners.get("onProgress");
-
-    emitProgress?.({
-      artifactType: "diff",
-      details: {
-        completedFilesCount: 0,
-        files: [
-          {
-            order: 0,
-            path: "manifest.asset.png",
-            progress: 0,
-            status: "failed",
-          },
-        ],
-        totalFilesCount: 1,
-      },
-      progress: 0.2,
-    });
-
-    emitProgress?.({
-      artifactType: "archive",
-      progress: 0.4,
-    });
-
-    expect(store.getSnapshot()).toEqual({
-      artifactType: "archive",
-      details: null,
-      downloadedBytes: undefined,
-      isUpdateDownloaded: false,
-      progress: 0.4,
-      totalBytes: undefined,
     });
   });
 });

package/src/store.ts

@@ -9,10 +9,8 @@ import { addListener } from "./native";
 
 export type HotUpdaterState = {
   progress: number;
-  downloadedBytes: number | undefined;
-  totalBytes: number | undefined;
   isUpdateDownloaded: boolean;
-  artifactType: "archive" | "diff" | null;
+  artifactType: "diff" | null;
   details: HotUpdaterDiffProgressDetails | null;
 };
 
@@ -56,8 +54,6 @@ const areDiffDetailsEqual = (
 const areStatesEqual = (left: HotUpdaterState, right: HotUpdaterState) => {
   return (
     left.progress === right.progress &&
-    left.downloadedBytes === right.downloadedBytes &&
-    left.totalBytes === right.totalBytes &&
     left.isUpdateDownloaded === right.isUpdateDownloaded &&
     left.artifactType === right.artifactType &&
     areDiffDetailsEqual(left.details, right.details)
@@ -78,8 +74,6 @@ const normalizeDownloadPath = (value: string | undefined) => {
 const createHotUpdaterStore = () => {
   let state: HotUpdaterState = {
     progress: 0,
-    downloadedBytes: undefined,
-    totalBytes: undefined,
     isUpdateDownloaded: false,
     artifactType: null,
     details: null,
@@ -165,10 +159,6 @@ const createHotUpdaterStore = () => {
       nextState.details = state.details;
     }
 
-    if (nextState.artifactType !== "diff") {
-      nextState.details = null;
-    }
-
     if (areStatesEqual(state, nextState)) {
       return;
     }
@@ -180,19 +170,8 @@ const createHotUpdaterStore = () => {
   const applyProgressEvent = (event: HotUpdaterProgressEvent) => {
     setState({
       artifactType: event.artifactType,
-      details:
-        event.artifactType === "diff"
-          ? normalizeDiffDetails(event.details)
-          : null,
-      downloadedBytes:
-        event.artifactType === "archive"
-          ? normalizeByteCount(event.downloadedBytes)
-          : undefined,
+      details: normalizeDiffDetails(event.details),
       progress: event.progress,
-      totalBytes:
-        event.artifactType === "archive"
-          ? normalizeByteCount(event.totalBytes)
-          : undefined,
     });
   };
 

package/src/wrap.spec.ts

@@ -1,8 +1,12 @@
-import type React from "react";
-import { beforeEach, describe, expect, it, vi } from "vitest";
+// @vitest-environment jsdom
+
+import { cleanup, render, waitFor } from "@testing-library/react";
+import { createElement, type ComponentType } from "react";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 
 import type {
-  NotifyAppReadyAnalyticsEvent,
+  ActiveUpdateState,
+  NotifyAppReadyInsightsEvent,
   NotifyAppReadyResult,
 } from "./native";
 import type { HotUpdaterOptions } from "./wrap";
@@ -15,14 +19,14 @@ vi.mock("react-native", () => ({
 
 const createNotifyReadResult = (
   result: NotifyAppReadyResult = { status: "UNCHANGED" },
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null = null,
+  insightsEvent: NotifyAppReadyInsightsEvent | null = null,
   pending = false,
 ): {
-  analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+  insightsEvent: NotifyAppReadyInsightsEvent | null;
   pending: boolean;
   result: NotifyAppReadyResult;
 } => ({
-  analyticsEvent,
+  insightsEvent,
   pending,
   result,
 });
@@ -32,14 +36,16 @@ const mocks = vi.hoisted(() => ({
   checkForUpdate: vi.fn(),
   getAppVersion: vi.fn(() => "1.0.0"),
   getBundleId: vi.fn(() => "bundle-id"),
+  getUpdateId: vi.fn(() => "release-id"),
   getChannel: vi.fn(() => "production"),
+  getActiveUpdateState: vi.fn<() => ActiveUpdateState>(),
   getCohort: vi.fn(() => "123"),
   getFingerprintHash: vi.fn(() => "fingerprint-hash"),
   getInstallId: vi.fn(() => "install-id"),
   getPersistedUserIdentity: vi.fn(() => ({})),
   readNotifyAppReady: vi.fn<
     () => {
-      analyticsEvent: NotifyAppReadyAnalyticsEvent | null;
+      insightsEvent: NotifyAppReadyInsightsEvent | null;
       pending: boolean;
       result: NotifyAppReadyResult;
     }
@@ -55,7 +61,9 @@ vi.mock("./native", () => ({
   addListener: mocks.addListener,
   getAppVersion: mocks.getAppVersion,
   getBundleId: mocks.getBundleId,
+  getUpdateId: mocks.getUpdateId,
   getChannel: mocks.getChannel,
+  getActiveUpdateState: mocks.getActiveUpdateState,
   getCohort: mocks.getCohort,
   getFingerprintHash: mocks.getFingerprintHash,
   getInstallId: mocks.getInstallId,
@@ -65,16 +73,16 @@ vi.mock("./native", () => ({
 }));
 
 const createClient = (
-  sendAnalyticsEvent = vi.fn().mockResolvedValue(undefined),
+  sendInsightsEvent = vi.fn().mockResolvedValue(undefined),
 ) => ({
   client: {
     createSession: vi.fn(async () => ({
       fetchReleaseCatalog: vi.fn(),
       resolveArtifact: vi.fn(),
-      sendAnalyticsEvent,
+      sendInsightsEvent,
     })),
   },
-  sendAnalyticsEvent,
+  sendInsightsEvent,
 });
 
 describe("HotUpdater wrap initialization", () => {
@@ -92,13 +100,83 @@ describe("HotUpdater wrap initialization", () => {
     mocks.getAppVersion.mockReturnValue("1.0.0");
     mocks.getPersistedUserIdentity.mockReturnValue({});
     mocks.getBundleId.mockReturnValue("bundle-id");
+    mocks.getUpdateId.mockReturnValue("release-id");
     mocks.getChannel.mockReturnValue("production");
+    mocks.getActiveUpdateState.mockReturnValue({
+      activeSelection: null,
+      stableSelection: null,
+      verificationPending: false,
+    });
     mocks.getCohort.mockReturnValue("123");
     mocks.getFingerprintHash.mockReturnValue("fingerprint-hash");
     mocks.getInstallId.mockReturnValue("install-id");
     mocks.readNotifyAppReady.mockReturnValue(createNotifyReadResult());
   });
 
+  afterEach(cleanup);
+
+  it("does not report No change while an optional download is in progress", async () => {
+    const { client, sendInsightsEvent } = createClient();
+    let complete!: (success: boolean) => void;
+    const download = vi.fn(
+      () =>
+        new Promise<boolean>((resolve) => {
+          complete = resolve;
+        }),
+    );
+    mocks.checkForUpdate.mockResolvedValue({
+      id: "next",
+      status: "UPDATE",
+      shouldForceUpdate: false,
+      message: null,
+      updateBundle: download,
+    });
+    const { wrap } = await import("./wrap");
+    const onUpdateProcessCompleted = vi.fn();
+    const Wrapped = wrap({
+      client,
+      insights: true,
+      updateStrategy: "appVersion",
+      onUpdateProcessCompleted,
+    })(() => null);
+    render(createElement(Wrapped));
+    await waitFor(() => expect(download).toHaveBeenCalledOnce());
+    expect(onUpdateProcessCompleted).toHaveBeenCalledOnce();
+    expect(sendInsightsEvent).not.toHaveBeenCalled();
+    complete(true);
+  });
+
+  it("reports the console ID when up to date while retaining file IDs in insights", async () => {
+    const onUpdateProcessCompleted = vi.fn();
+    const { client, sendInsightsEvent } = createClient();
+    const { wrap } = await import("./wrap");
+    const WrappedComponent = wrap({
+      insights: true,
+      client,
+      onUpdateProcessCompleted,
+      updateStrategy: "appVersion",
+    })(() => null);
+
+    render(createElement(WrappedComponent));
+
+    await waitFor(() =>
+      expect(onUpdateProcessCompleted).toHaveBeenCalledWith({
+        id: "release-id",
+        message: null,
+        shouldForceUpdate: false,
+        status: "UP_TO_DATE",
+      }),
+    );
+    await waitFor(() =>
+      expect(sendInsightsEvent).toHaveBeenCalledWith(
+        expect.objectContaining({
+          toBundleId: "bundle-id",
+          type: "UNCHANGED",
+        }),
+      ),
+    );
+  });
+
   it("returns void from init and defers notifyAppReady to the next frame", async () => {
     vi.useFakeTimers();
 
@@ -110,7 +188,7 @@ describe("HotUpdater wrap initialization", () => {
     );
     vi.stubGlobal("requestAnimationFrame", requestAnimationFrame);
 
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const { init } = await import("./wrap");
 
     const result = init({
@@ -123,17 +201,17 @@ describe("HotUpdater wrap initialization", () => {
 
     expect(result).toBeUndefined();
     expect(mocks.readNotifyAppReady).not.toHaveBeenCalled();
-    expect(sendAnalyticsEvent).not.toHaveBeenCalled();
+    expect(sendInsightsEvent).not.toHaveBeenCalled();
 
     expect(requestAnimationFrame).toHaveBeenCalled();
 
     await vi.runOnlyPendingTimersAsync();
 
     expect(mocks.readNotifyAppReady).toHaveBeenCalledWith();
-    expect(sendAnalyticsEvent).not.toHaveBeenCalled();
+    expect(sendInsightsEvent).not.toHaveBeenCalled();
   });
 
-  it("waits for native launch verification before sending analytics", async () => {
+  it("waits for native launch verification before sending insights", async () => {
     vi.useFakeTimers();
 
     vi.stubGlobal(
@@ -162,18 +240,18 @@ describe("HotUpdater wrap initialization", () => {
         ),
       );
 
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const { init } = await import("./wrap");
 
-    init({ analytics: true, client });
+    init({ insights: true, client });
 
     await vi.runAllTimersAsync();
 
     expect(mocks.readNotifyAppReady).toHaveBeenCalledTimes(2);
-    expect(sendAnalyticsEvent).toHaveBeenCalledTimes(1);
+    expect(sendInsightsEvent).toHaveBeenCalledTimes(1);
   });
 
-  it("sends automatic analytics only from init when enabled", async () => {
+  it("sends automatic insights only from init when enabled", async () => {
     vi.useFakeTimers();
 
     vi.stubGlobal(
@@ -205,11 +283,11 @@ describe("HotUpdater wrap initialization", () => {
       username: "alice",
     });
 
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const { init } = await import("./wrap");
 
     init({
-      analytics: true,
+      insights: true,
       requestHeaders: {
         Authorization: "Bearer token",
       },
@@ -219,7 +297,7 @@ describe("HotUpdater wrap initialization", () => {
 
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).toHaveBeenCalledWith({
+    expect(sendInsightsEvent).toHaveBeenCalledWith({
       appVersion: "1.0.0",
       channel: "production",
       cohort: "123",
@@ -241,7 +319,7 @@ describe("HotUpdater wrap initialization", () => {
     });
   });
 
-  it("guards automatic analytics to a single delivery attempt per runtime", async () => {
+  it("guards automatic insights to a single delivery attempt per runtime", async () => {
     vi.useFakeTimers();
 
     vi.stubGlobal(
@@ -268,18 +346,18 @@ describe("HotUpdater wrap initialization", () => {
       ),
     );
 
-    const { client, sendAnalyticsEvent } = createClient();
+    const { client, sendInsightsEvent } = createClient();
     const { init } = await import("./wrap");
 
-    init({ analytics: true, client });
-    init({ analytics: true, client });
+    init({ insights: true, client });
+    init({ insights: true, client });
 
     await vi.runOnlyPendingTimersAsync();
 
-    expect(sendAnalyticsEvent).toHaveBeenCalledTimes(1);
+    expect(sendInsightsEvent).toHaveBeenCalledTimes(1);
   });
 
-  it("warns without interrupting app readiness when analytics transport fails", async () => {
+  it("warns without interrupting app readiness when insights transport fails", async () => {
     vi.useFakeTimers();
 
     const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
@@ -312,7 +390,7 @@ describe("HotUpdater wrap initialization", () => {
     const { init } = await import("./wrap");
 
     init({
-      analytics: true,
+      insights: true,
       onError,
       onNotifyAppReady,
       client,
@@ -322,7 +400,7 @@ describe("HotUpdater wrap initialization", () => {
 
     expect(onError).not.toHaveBeenCalled();
     expect(warn).toHaveBeenCalledWith(
-      "[HotUpdater] Automatic notifyAppReady analytics failed:",
+      "[HotUpdater] Automatic notifyAppReady insights failed:",
       error,
     );
     expect(onNotifyAppReady).toHaveBeenCalledWith({
@@ -344,14 +422,14 @@ describe("HotUpdater wrap initialization", () => {
 
   it("preserves wrapped component prop inference", async () => {
     const { wrap } = await import("./wrap");
-    const Component: React.ComponentType<{ title: string }> = () => null;
+    const Component: ComponentType<{ title: string }> = () => null;
 
     const WrappedComponent = wrap({
       client: createClient().client,
       updateStrategy: "appVersion",
     })(Component);
 
-    const acceptsTitleProps: React.ComponentType<{ title: string }> =
+    const acceptsTitleProps: ComponentType<{ title: string }> =
       WrappedComponent;
     expect(acceptsTitleProps).toBe(WrappedComponent);
   });