@hot-updater/react-native 1.0.0-rc.17 → 1.0.0-rc.21

package/src/plugins/insights/insights.spec.ts

@@ -1,732 +0,0 @@
-import { isUUIDv7 } from "@hot-updater/core";
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-
-import type {
-  AppReadyResult,
-  BundleDownloadedInfo,
-  HotUpdaterClientHooks,
-  UpdateCheckResult,
-  UpdateError,
-} from "../../clientPlugin";
-import type { InsightsOptions, InsightsUser } from "./index";
-import type { InsightsEventBody } from "./sender";
-
-vi.mock("react-native", () => ({
-  Platform: { OS: "ios" },
-}));
-
-const native = vi.hoisted(() => {
-  Reflect.set(globalThis, "HotUpdater", { SDK_VERSION: "test-sdk-version" });
-  const storage = new Map<string, string>();
-  return {
-    storage,
-    getAppVersion: vi.fn<() => string | null>(() => "1.0.0"),
-    getBundleId: vi.fn(() => "bundle-a"),
-    getChannel: vi.fn(() => "production"),
-    getCohort: vi.fn(() => "123"),
-    getFingerprintHash: vi.fn<() => string | null>(() => "fingerprint-hash"),
-    getInstallId: vi.fn(() => "install-id"),
-    getStorageItem: vi.fn((key: string) => storage.get(key) ?? null),
-    setStorageItem: vi.fn((key: string, value: string | null) => {
-      if (value === null) storage.delete(key);
-      else storage.set(key, value);
-    }),
-  };
-});
-
-vi.mock("../../native", () => native);
-
-const DAY_MS = 86_400_000;
-const MORNING = Date.UTC(2026, 8, 30, 9);
-
-let responses: (number | (() => Response))[] = [];
-const fetchMock = vi.fn(async (_url: string, _init?: RequestInit) => {
-  const next = responses.shift() ?? 204;
-  return typeof next === "number"
-    ? new Response(null, { status: next })
-    : next();
-});
-const sentEvents = () =>
-  fetchMock.mock.calls.map(
-    ([, init]) => JSON.parse(String(init?.body)) as InsightsEventBody,
-  );
-const sentTypes = () => sentEvents().map(({ type }) => type);
-
-/** A server without Insights mounts no `/events`. */
-const disabledResponse = () => new Response(null, { status: 404 });
-
-/** Starts a JavaScript runtime with the plugin; native storage persists across launches. */
-const launch = async (
-  options: InsightsOptions = {},
-  beforeInit?: (
-    plugin: ReturnType<(typeof import("./index"))["insights"]>,
-  ) => void,
-) => {
-  vi.resetModules();
-  const [{ configurePlugins, emitPluginHook }, { insights }] =
-    await Promise.all([import("../../pluginHost"), import("./index")]);
-  const plugin = insights(options);
-  beforeInit?.(plugin);
-  configurePlugins([plugin], {
-    baseURL: "https://updates.example.com/hot-updater",
-    requestHeaders: { "x-api-key": "client-key" },
-  });
-  const emit = <K extends keyof HotUpdaterClientHooks>(
-    name: K,
-    payload: Parameters<NonNullable<HotUpdaterClientHooks[K]>>[0],
-  ) => {
-    emitPluginHook(name, () => payload);
-  };
-  return {
-    plugin,
-    appReady: (result: AppReadyResult) => emit("onAppReady", result),
-    updateCheck: (result: UpdateCheckResult) => emit("onUpdateCheck", result),
-    downloaded: (info: BundleDownloadedInfo) =>
-      emit("onBundleDownloaded", info),
-    updateError: (error: UpdateError) => emit("onUpdateError", error),
-  };
-};
-
-type UnchangedLaunch = Extract<AppReadyResult, { status: "UNCHANGED" }>;
-type TransitionLaunch = Exclude<AppReadyResult, UnchangedLaunch>;
-
-const unchangedLaunch = (
-  overrides: Partial<UnchangedLaunch> = {},
-): UnchangedLaunch => ({
-  status: "UNCHANGED",
-  channel: "production",
-  bundleId: "bundle-a",
-  releaseId: "release-a",
-  previousProcessExit: null,
-  ...overrides,
-});
-
-const appliedLaunch: TransitionLaunch = {
-  status: "UPDATE_APPLIED",
-  channel: "production",
-  fromBundleId: "bundle-a",
-  fromReleaseId: "release-a",
-  toBundleId: "bundle-b",
-  toReleaseId: "release-b",
-  updateStrategy: "appVersion",
-  previousProcessExit: null,
-};
-
-const download: BundleDownloadedInfo = {
-  channel: "production",
-  fromBundleId: "bundle-a",
-  fromReleaseId: "release-a",
-  toBundleId: "bundle-b",
-  toReleaseId: "release-b",
-  updateStrategy: "appVersion",
-  delivery: "manifest",
-  patchFallback: false,
-};
-
-const downloadFailure = (
-  overrides: Partial<UpdateError> = {},
-): UpdateError => ({
-  stage: "download",
-  reason: "hash_mismatch",
-  targetBundleId: "bundle-b",
-  targetReleaseId: "release-b",
-  channel: "production",
-  bundleId: "bundle-a",
-  releaseId: "release-a",
-  updateStrategy: "fingerprint",
-  cause: new Error("hash mismatch"),
-  ...overrides,
-});
-
-const flush = () => vi.runAllTimersAsync();
-
-describe("insights() client plugin", () => {
-  beforeEach(() => {
-    vi.useFakeTimers({ now: MORNING });
-    vi.spyOn(Math, "random").mockReturnValue(0.5);
-    vi.stubGlobal("fetch", fetchMock);
-    vi.stubGlobal("__DEV__", false);
-    fetchMock.mockClear();
-    responses = [];
-    native.storage.clear();
-    native.getAppVersion.mockReturnValue("1.0.0");
-  });
-
-  afterEach(() => {
-    vi.useRealTimers();
-    vi.unstubAllGlobals();
-    vi.restoreAllMocks();
-  });
-
-  it("posts a launch as UNCHANGED with the app's identity", async () => {
-    const app = await launch();
-
-    app.appReady(unchangedLaunch());
-    await flush();
-
-    expect(fetchMock).toHaveBeenCalledOnce();
-    const [url, init] = fetchMock.mock.calls[0]!;
-    expect(url).toBe("https://updates.example.com/hot-updater/events");
-    expect(new Headers(init?.headers).get("x-api-key")).toBe("client-key");
-    const [event] = sentEvents();
-    expect(isUUIDv7(event?.eventId)).toBe(true);
-    expect(event).toEqual({
-      appVersion: "1.0.0",
-      channel: "production",
-      cohort: "123",
-      eventId: event?.eventId,
-      fingerprintHash: "fingerprint-hash",
-      fromBundleId: null,
-      fromReleaseId: null,
-      installId: "install-id",
-      platform: "ios",
-      sdkVersion: "test-sdk-version",
-      toBundleId: "bundle-a",
-      toReleaseId: "release-a",
-      type: "UNCHANGED",
-      updateStrategy: null,
-    });
-  });
-
-  describe("daily launch reports", () => {
-    it("sends UNCHANGED at most once per UTC day across launches", async () => {
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      vi.setSystemTime(Date.UTC(2026, 8, 30, 23, 59));
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-      expect(fetchMock).toHaveBeenCalledOnce();
-
-      vi.setSystemTime(Date.UTC(2026, 9, 1, 0, 1));
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-      expect(sentTypes()).toEqual(["UNCHANGED", "UNCHANGED"]);
-    });
-
-    it.each([
-      { label: "channel", change: { channel: "beta" } },
-      { label: "bundle", change: { bundleId: "bundle-c" } },
-      { label: "Release", change: { releaseId: "release-c" } },
-    ])(
-      "reports a launch again the same day when its $label changes",
-      async ({ change }) => {
-        (await launch()).appReady(unchangedLaunch());
-        await flush();
-
-        (await launch()).appReady(unchangedLaunch(change));
-        await flush();
-
-        expect(sentTypes()).toEqual(["UNCHANGED", "UNCHANGED"]);
-      },
-    );
-
-    it("reports a launch again the same day when the app version or user changes", async () => {
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      native.getAppVersion.mockReturnValue("1.0.1");
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      const app = await launch();
-      app.plugin.setUser({ userId: "user-1" });
-      app.appReady(unchangedLaunch());
-      await flush();
-
-      expect(
-        sentEvents().map(({ appVersion, userId }) => [appVersion, userId]),
-      ).toEqual([
-        ["1.0.0", undefined],
-        ["1.0.1", undefined],
-        ["1.0.1", "user-1"],
-      ]);
-    });
-
-    it("counts a delivered apply as the day's report of its bundle", async () => {
-      (await launch()).appReady(appliedLaunch);
-      await flush();
-
-      (await launch()).appReady(
-        unchangedLaunch({ bundleId: "bundle-b", releaseId: "release-b" }),
-      );
-      await flush();
-
-      expect(sentTypes()).toEqual(["UPDATE_APPLIED"]);
-    });
-
-    it("reports the next launch after a delivered download or failure", async () => {
-      const first = await launch();
-      first.appReady(unchangedLaunch());
-      await flush();
-      first.downloaded(download);
-      await flush();
-
-      const second = await launch();
-      second.appReady(unchangedLaunch());
-      await flush();
-      second.updateError(downloadFailure());
-      await flush();
-
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      expect(sentTypes()).toEqual([
-        "UNCHANGED",
-        "UPDATE_DOWNLOADED",
-        "UNCHANGED",
-        "UPDATE_FAILED",
-        "UNCHANGED",
-      ]);
-    });
-
-    it("reports the launch again when the server did not store it", async () => {
-      responses = [400];
-      vi.spyOn(console, "warn").mockImplementation(() => {});
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      expect(sentTypes()).toEqual(["UNCHANGED", "UNCHANGED"]);
-    });
-
-    it("always sends downloads, applies, and recoveries", async () => {
-      const first = await launch();
-      first.appReady(unchangedLaunch());
-      first.downloaded(download);
-      await flush();
-
-      (await launch()).appReady(appliedLaunch);
-      (await launch()).appReady({
-        ...appliedLaunch,
-        status: "RECOVERED",
-        fromBundleId: "bundle-b",
-        toBundleId: "bundle-a",
-      });
-      await flush();
-
-      expect(sentTypes()).toEqual([
-        "UNCHANGED",
-        "UPDATE_DOWNLOADED",
-        "UPDATE_APPLIED",
-        "RECOVERED",
-      ]);
-    });
-
-    it("sends one report when the launch and a no-update check both report", async () => {
-      const app = await launch();
-
-      app.appReady(unchangedLaunch());
-      app.updateCheck({
-        status: "UNCHANGED",
-        channel: "production",
-        bundleId: "bundle-a",
-        releaseId: "release-a",
-        previousReleaseId: "release-a",
-      });
-      await flush();
-
-      expect(sentTypes()).toEqual(["UNCHANGED"]);
-    });
-
-    it("reports a same-bundle Release adoption with the Release it replaced", async () => {
-      const app = await launch();
-      app.appReady(unchangedLaunch());
-      await flush();
-
-      app.updateCheck({
-        status: "UNCHANGED",
-        channel: "production",
-        bundleId: "bundle-a",
-        releaseId: "release-a2",
-        previousReleaseId: "release-a",
-      });
-      await flush();
-
-      expect(sentEvents()[1]).toMatchObject({
-        fromReleaseId: "release-a",
-        toBundleId: "bundle-a",
-        toReleaseId: "release-a2",
-        type: "UNCHANGED",
-      });
-    });
-
-    it("sends no launch report after a download in the same runtime", async () => {
-      const app = await launch();
-
-      app.downloaded(download);
-      app.downloaded(download);
-      app.updateCheck({
-        status: "UNCHANGED",
-        channel: "production",
-        bundleId: "bundle-b",
-        releaseId: "release-b",
-        previousReleaseId: "release-b",
-      });
-      await flush();
-
-      expect(sentTypes()).toEqual(["UPDATE_DOWNLOADED"]);
-    });
-  });
-
-  describe("when the server runs without Insights", () => {
-    it("sends nothing more in this runtime after a 404", async () => {
-      responses = [disabledResponse];
-      const app = await launch();
-
-      app.appReady(unchangedLaunch());
-      await flush();
-      app.downloaded(download);
-      await flush();
-      vi.setSystemTime(MORNING + 2 * DAY_MS);
-      app.updateError(downloadFailure());
-      await flush();
-
-      expect(sentTypes()).toEqual(["UNCHANGED"]);
-    });
-
-    it("pauses later launches for 24 hours, then probes again", async () => {
-      responses = [disabledResponse];
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      vi.setSystemTime(MORNING + DAY_MS - 1);
-      (await launch()).appReady(appliedLaunch);
-      await flush();
-      expect(fetchMock).toHaveBeenCalledOnce();
-
-      vi.setSystemTime(MORNING + DAY_MS);
-      (await launch()).appReady(appliedLaunch);
-      await flush();
-      expect(sentTypes()).toEqual(["UNCHANGED", "UPDATE_APPLIED"]);
-
-      // The probe was stored, so Insights is on again.
-      (await launch()).appReady({ ...appliedLaunch, toBundleId: "bundle-c" });
-      await flush();
-      expect(sentTypes()).toEqual([
-        "UNCHANGED",
-        "UPDATE_APPLIED",
-        "UPDATE_APPLIED",
-      ]);
-    });
-
-    it("ends a pause that starts after now, from a clock that went back", async () => {
-      native.storage.set(
-        "plugins/insights/pausedAt",
-        String(MORNING + 60 * 60 * 1000),
-      );
-
-      (await launch()).appReady(unchangedLaunch());
-      await flush();
-
-      expect(sentTypes()).toEqual(["UNCHANGED"]);
-    });
-  });
-
-  describe("update failures", () => {
-    it("reports a failure once per UTC day per stage, reason, and target", async () => {
-      const app = await launch();
-
-      app.updateError(downloadFailure({ httpStatus: undefined }));
-      app.updateError(downloadFailure());
-      await flush();
-      (await launch()).updateError(downloadFailure());
-      await flush();
-
-      expect(fetchMock).toHaveBeenCalledOnce();
-      const [event] = sentEvents();
-      expect(event).toMatchObject({
-        fromBundleId: "bundle-a",
-        fromReleaseId: "release-a",
-        metadata: { failure: { reason: "hash_mismatch", stage: "download" } },
-        toBundleId: "bundle-b",
-        toReleaseId: "release-b",
-        type: "UPDATE_FAILED",
-        updateStrategy: "fingerprint",
-      });
-      expect(Object.keys(event?.metadata?.failure ?? {}).sort()).toEqual([
-        "reason",
-        "stage",
-      ]);
-      // A UUIDv7 led by the UTC day, the same on every device for one failure.
-      expect(isUUIDv7(event?.eventId)).toBe(true);
-      expect(parseInt(event!.eventId.replace(/-/g, "").slice(0, 12), 16)).toBe(
-        Date.UTC(2026, 8, 30),
-      );
-
-      (await launch()).updateError(downloadFailure({ reason: "signature" }));
-      vi.setSystemTime(MORNING + DAY_MS);
-      (await launch()).updateError(downloadFailure());
-      await flush();
-
-      const ids = sentEvents().map(({ eventId }) => eventId);
-      expect(
-        sentEvents().map(({ metadata }) => metadata?.failure?.reason),
-      ).toEqual(["hash_mismatch", "signature", "hash_mismatch"]);
-      expect(new Set(ids).size).toBe(3);
-    });
-
-    it("gives a failure that was not delivered the same id when it happens again", async () => {
-      responses = [500, 500, 500];
-      vi.spyOn(console, "warn").mockImplementation(() => {});
-      (await launch()).updateError(downloadFailure());
-      await flush();
-
-      (await launch()).updateError(downloadFailure());
-      await flush();
-
-      const ids = sentEvents().map(({ eventId }) => eventId);
-      expect(ids).toHaveLength(4);
-      expect(new Set(ids).size).toBe(1);
-    });
-
-    it("skips check failures while offline and reports the others against the running bundle", async () => {
-      const app = await launch();
-      const checkFailure = {
-        stage: "check",
-        channel: "production",
-        bundleId: "bundle-a",
-        releaseId: "release-a",
-        updateStrategy: "appVersion",
-        cause: new Error("check failed"),
-      } as const;
-
-      app.updateError({ ...checkFailure, reason: "network" });
-      app.updateError({ ...checkFailure, reason: "http", httpStatus: 503 });
-      await flush();
-
-      expect(sentEvents()).toEqual([
-        expect.objectContaining({
-          fromBundleId: "bundle-a",
-          metadata: {
-            failure: { httpStatus: 503, reason: "http", stage: "check" },
-          },
-          toBundleId: "bundle-a",
-          toReleaseId: null,
-          type: "UPDATE_FAILED",
-        }),
-      ]);
-    });
-
-    it("drops a failure an older server refuses, without retrying, warning, or pausing", async () => {
-      responses = [400];
-      const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
-      const app = await launch();
-
-      app.updateError(downloadFailure());
-      await flush();
-      app.updateError(downloadFailure());
-      app.appReady(unchangedLaunch());
-      await flush();
-
-      expect(sentTypes()).toEqual(["UPDATE_FAILED", "UNCHANGED"]);
-      expect(warn).not.toHaveBeenCalled();
-    });
-  });
-
-  describe("event details", () => {
-    it("says how a download arrived, and when a patch fell back", async () => {
-      const app = await launch();
-
-      app.downloaded({ ...download, delivery: "patch", patchFallback: false });
-      app.downloaded({
-        ...download,
-        toBundleId: "bundle-c",
-        delivery: "archive",
-        patchFallback: true,
-      });
-      await flush();
-
-      expect(sentEvents().map(({ metadata }) => metadata)).toEqual([
-        { delivery: "patch" },
-        { delivery: "archive", patchFallback: true },
-      ]);
-    });
-
-    it("says why the previous process exited on a recovery only", async () => {
-      const app = await launch();
-
-      app.appReady({
-        ...appliedLaunch,
-        status: "RECOVERED",
-        fromBundleId: "bundle-b",
-        toBundleId: "bundle-a",
-        previousProcessExit: "CRASH",
-      });
-      await flush();
-      (await launch()).appReady({
-        ...appliedLaunch,
-        toBundleId: "bundle-c",
-        previousProcessExit: "USER_REQUESTED",
-      });
-      await flush();
-
-      expect(
-        sentEvents().map(({ type, metadata }) => [type, metadata]),
-      ).toEqual([
-        ["RECOVERED", { previousProcessExit: "CRASH" }],
-        ["UPDATE_APPLIED", undefined],
-      ]);
-    });
-
-    it("sends every failure detail it has", async () => {
-      const app = await launch();
-
-      app.updateError(
-        downloadFailure({
-          reason: "http",
-          resource: "archive",
-          httpStatus: 403,
-          originCode: "ExpiredToken",
-          previousProcessExit: "ANR",
-        }),
-      );
-      app.updateError(
-        downloadFailure({
-          reason: "network",
-          resource: "file",
-          transport: "tls",
-        }),
-      );
-      await flush();
-
-      expect(sentEvents().map(({ metadata }) => metadata?.failure)).toEqual([
-        {
-          stage: "download",
-          reason: "http",
-          resource: "archive",
-          httpStatus: 403,
-          originCode: "ExpiredToken",
-          previousProcessExit: "ANR",
-        },
-        {
-          stage: "download",
-          reason: "network",
-          resource: "file",
-          transport: "tls",
-        },
-      ]);
-    });
-  });
-
-  describe("a success for a failed target", () => {
-    it("drops a queued failure for the target a download then staged", async () => {
-      responses = [503];
-      const app = await launch();
-
-      app.appReady(unchangedLaunch());
-      app.updateError(downloadFailure());
-      app.downloaded(download);
-      await flush();
-
-      expect(sentTypes()).toEqual([
-        "UNCHANGED",
-        "UNCHANGED",
-        "UPDATE_DOWNLOADED",
-      ]);
-    });
-
-    it("drops a failure waiting out a backoff once its target applies", async () => {
-      responses = [503];
-      const app = await launch();
-
-      app.updateError(downloadFailure());
-      await Promise.resolve();
-      await vi.advanceTimersByTimeAsync(0);
-      app.appReady(appliedLaunch);
-      await flush();
-
-      expect(sentTypes()).toEqual(["UPDATE_FAILED", "UPDATE_APPLIED"]);
-    });
-
-    it("keeps a failure for another target", async () => {
-      const app = await launch();
-
-      app.updateError(downloadFailure({ targetBundleId: "bundle-c" }));
-      app.downloaded(download);
-      await flush();
-
-      expect(sentTypes()).toEqual(["UPDATE_FAILED", "UPDATE_DOWNLOADED"]);
-    });
-  });
-
-  describe("user", () => {
-    it("attaches a user set before init and keeps it across launches", async () => {
-      (await launch({}, (plugin) => plugin.setUser({ userId: 42 }))).appReady(
-        unchangedLaunch(),
-      );
-      await flush();
-
-      (await launch()).appReady(appliedLaunch);
-      await flush();
-
-      const app = await launch();
-      app.plugin.setUser(null);
-      app.appReady(unchangedLaunch({ bundleId: "bundle-c" }));
-      await flush();
-
-      expect(sentEvents().map(({ userId }) => userId)).toEqual([
-        "42",
-        "42",
-        undefined,
-      ]);
-      expect(sentEvents().every((event) => !("username" in event))).toBe(true);
-    });
-
-    it("takes only a user id", () => {
-      const user: InsightsUser = { userId: "user-1" };
-      // @ts-expect-error Insights keeps no username.
-      const withName: InsightsUser = { userId: "user-1", username: "Alex" };
-      expect([user, withName]).toHaveLength(2);
-    });
-  });
-
-  it.each([
-    { debug: undefined, sends: false },
-    { debug: true, sends: true },
-  ])(
-    "sends from a debug build only with debug: true ($debug)",
-    async ({ debug, sends }) => {
-      vi.stubGlobal("__DEV__", true);
-      const app = await launch(debug === undefined ? {} : { debug });
-
-      app.appReady(unchangedLaunch());
-      await flush();
-
-      expect(fetchMock).toHaveBeenCalledTimes(sends ? 1 : 0);
-    },
-  );
-
-  it("reports a failed install id read as a plugin error, not an update failure", async () => {
-    native.getInstallId.mockImplementationOnce(() => {
-      throw new Error("native install id unavailable");
-    });
-    const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
-    const app = await launch();
-
-    app.appReady(unchangedLaunch());
-    await flush();
-
-    expect(fetchMock).not.toHaveBeenCalled();
-    expect(warn).toHaveBeenCalledWith(
-      '[HotUpdater] Plugin "insights" failed in onAppReady',
-      expect.objectContaining({ message: "native install id unavailable" }),
-    );
-  });
-
-  it("skips a report without a native app version", async () => {
-    native.getAppVersion.mockReturnValue(null);
-    const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
-    const app = await launch();
-
-    app.appReady(unchangedLaunch());
-    await flush();
-
-    expect(fetchMock).not.toHaveBeenCalled();
-    expect(warn).toHaveBeenCalledWith(
-      "[HotUpdater] Insights needs the native app version; the UNCHANGED event was not sent.",
-    );
-  });
-});