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

package/src/notifyAppReadyInsights.transport.spec.ts

@@ -1,138 +0,0 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
-
-import type {
-  ActiveUpdateState,
-  NotifyAppReadyInsightsEvent,
-  NotifyAppReadyResult,
-} from "./native";
-import {
-  createNotifyReadResult,
-  stubNotifyFrame,
-} from "./notifyAppReadyInsights.test-utils";
-
-vi.mock("react-native", () => ({
-  Platform: { OS: "ios" },
-}));
-
-const failureCases = [
-  { label: "400", responseStatus: 400 },
-  { label: "404", responseStatus: 404 },
-  { label: "500", responseStatus: 500 },
-  {
-    error: Object.assign(new Error("request aborted"), { name: "AbortError" }),
-    label: "timeout",
-  },
-  { error: new Error("network unavailable"), label: "network" },
-] as const;
-
-const mocks = vi.hoisted(() => ({
-  addListener: vi.fn(() => () => {}),
-  checkForUpdate: vi.fn(),
-  getAppVersion: vi.fn(() => "1.0.0"),
-  getBundleId: vi.fn(() => "bundle-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<
-    () => {
-      insightsEvent: NotifyAppReadyInsightsEvent | null;
-      pending: boolean;
-      result: NotifyAppReadyResult;
-    }
-  >(() => createNotifyReadResult()),
-  reload: vi.fn(),
-}));
-
-vi.mock("./checkForUpdate", () => ({
-  checkForUpdate: mocks.checkForUpdate,
-}));
-
-vi.mock("./native", () => ({
-  addListener: mocks.addListener,
-  getAppVersion: mocks.getAppVersion,
-  getBundleId: mocks.getBundleId,
-  getChannel: mocks.getChannel,
-  getActiveUpdateState: mocks.getActiveUpdateState,
-  getCohort: mocks.getCohort,
-  getFingerprintHash: mocks.getFingerprintHash,
-  getInstallId: mocks.getInstallId,
-  getPersistedUserIdentity: mocks.getPersistedUserIdentity,
-  readNotifyAppReady: mocks.readNotifyAppReady,
-  reload: mocks.reload,
-}));
-
-describe("automatic notifyAppReady transport failures", () => {
-  beforeEach(() => {
-    vi.resetModules();
-    vi.unstubAllGlobals();
-    vi.useRealTimers();
-
-    for (const mock of Object.values(mocks)) {
-      mock.mockReset();
-    }
-
-    mocks.addListener.mockReturnValue(() => {});
-    mocks.getAppVersion.mockReturnValue("1.0.0");
-    mocks.getBundleId.mockReturnValue("bundle-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.getPersistedUserIdentity.mockReturnValue({});
-    mocks.readNotifyAppReady.mockReturnValue(createNotifyReadResult());
-  });
-
-  it.each(failureCases)(
-    "warns and preserves UNCHANGED readiness for a real HTTP client $label failure",
-    async (failureCase) => {
-      stubNotifyFrame();
-      const warn = vi.spyOn(console, "warn").mockImplementation(() => {});
-      const onError = vi.fn();
-      const onNotifyAppReady = vi.fn();
-      const fetchMock = vi.fn(async () => {
-        if ("error" in failureCase) {
-          throw failureCase.error;
-        }
-
-        return new Response(null, { status: failureCase.responseStatus });
-      });
-      vi.stubGlobal("fetch", fetchMock);
-      Reflect.set(globalThis, "HotUpdater", {
-        SDK_VERSION: "test-sdk-version",
-      });
-
-      try {
-        const [{ createHttpClient }, { init }] = await Promise.all([
-          import("./httpClient"),
-          import("./wrap"),
-        ]);
-        const client = createHttpClient(
-          "https://updates.example.test/hot-updater",
-        );
-
-        init({ insights: true, client, onError, onNotifyAppReady });
-        await vi.runOnlyPendingTimersAsync();
-
-        expect(fetchMock).toHaveBeenCalledTimes(1);
-        expect(onError).not.toHaveBeenCalled();
-        expect(onNotifyAppReady).toHaveBeenCalledWith({
-          status: "UNCHANGED",
-        });
-        expect(warn).toHaveBeenCalledWith(
-          "[HotUpdater] Automatic notifyAppReady insights failed:",
-          expect.any(Error),
-        );
-      } finally {
-        warn.mockRestore();
-      }
-    },
-  );
-});

package/src/notifyAppReadyInsights.ts

@@ -1,293 +0,0 @@
-import { Platform } from "react-native";
-
-import type { HotUpdaterError } from "./error";
-import type { InsightsEventParams, HotUpdaterHttpClient } from "./httpClient";
-import {
-  getActiveUpdateState,
-  getAppVersion,
-  getBundleId,
-  getChannel,
-  getCohort,
-  getFingerprintHash,
-  getInstallId,
-  getPersistedUserIdentity,
-  type NotifyAppReadyInsightsEvent,
-  type NotifyAppReadyResult,
-  readNotifyAppReady,
-} from "./native";
-
-export type NotifyAppReadyOptions = {
-  insights?: boolean;
-  client: HotUpdaterHttpClient;
-  requestHeaders?: Record<string, string>;
-  requestTimeout?: number;
-  reportUnchanged?: boolean;
-  onNotifyAppReady?: (result: NotifyAppReadyResult) => void;
-  onError?: (error: HotUpdaterError | Error | unknown) => void;
-};
-
-type RequestAnimationFrame = (callback: (timestamp: number) => void) => number;
-
-let didAttemptAutomaticInsights = false;
-let didDownload = false;
-let readinessPromise: Promise<NotifyAppReadyResult | undefined> | undefined;
-
-const waitForNextFrame = () =>
-  new Promise<void>((resolve) => {
-    const requestAnimationFrame = (
-      globalThis as typeof globalThis & {
-        requestAnimationFrame?: RequestAnimationFrame;
-      }
-    )?.requestAnimationFrame;
-
-    if (requestAnimationFrame) {
-      requestAnimationFrame(() => resolve());
-      return;
-    }
-
-    void Promise.resolve().then(resolve);
-  });
-
-const assertNever = (value: never): never => {
-  throw new Error(`[HotUpdater] Unexpected notifyAppReady status: ${value}`);
-};
-
-const buildNotifyAppReadyInsightsParams = (
-  nativeResult: NotifyAppReadyResult,
-  insightsEvent: NotifyAppReadyInsightsEvent | null,
-  options: Pick<NotifyAppReadyOptions, "requestHeaders" | "requestTimeout">,
-): InsightsEventParams => {
-  const appVersion = getAppVersion();
-
-  if (!appVersion) {
-    throw new Error(
-      "[HotUpdater] Automatic insights requires a non-null native app version.",
-    );
-  }
-
-  const { userId, username } = getPersistedUserIdentity();
-  const installId = getInstallId();
-
-  if (!installId) {
-    throw new Error(
-      "[HotUpdater] Automatic insights requires a non-null native install id.",
-    );
-  }
-
-  const platform: "ios" | "android" =
-    Platform.OS === "android" ? "android" : "ios";
-
-  const commonParams = {
-    appVersion,
-    channel: getChannel(),
-    cohort: getCohort(),
-    fingerprintHash: getFingerprintHash(),
-    fromReleaseId: insightsEvent?.fromReleaseId ?? null,
-    installId,
-    platform,
-    requestHeaders: options.requestHeaders,
-    requestTimeout: options.requestTimeout,
-    toReleaseId: insightsEvent?.toReleaseId ?? null,
-    ...(userId != null ? { userId } : {}),
-    ...(username != null ? { username } : {}),
-  };
-
-  switch (nativeResult.status) {
-    case "UNCHANGED": {
-      const bundleId = getBundleId();
-
-      if (!bundleId) {
-        throw new Error(
-          "[HotUpdater] Automatic insights requires a non-null current bundle id.",
-        );
-      }
-
-      const state = getActiveUpdateState();
-      const runningSelection = [
-        state.activeSelection,
-        state.stableSelection,
-      ].find(
-        (selection) =>
-          selection?.bundleId === bundleId &&
-          selection.channel === commonParams.channel,
-      );
-
-      return {
-        ...commonParams,
-        fromBundleId: null,
-        toBundleId: bundleId,
-        toReleaseId: runningSelection?.releaseId ?? null,
-        type: "UNCHANGED",
-        updateStrategy: null,
-      };
-    }
-    case "UPDATE_APPLIED":
-    case "RECOVERED":
-      if (!insightsEvent) {
-        throw new Error(
-          "[HotUpdater] Native launch report is missing persisted metadata required for automatic insights.",
-        );
-      }
-
-      switch (insightsEvent.type) {
-        case "UPDATE_APPLIED":
-          return {
-            ...commonParams,
-            fromBundleId: insightsEvent.fromBundleId,
-            toBundleId: insightsEvent.toBundleId,
-            type: "UPDATE_APPLIED",
-            updateStrategy: insightsEvent.updateStrategy,
-          };
-        case "RECOVERED":
-          return {
-            ...commonParams,
-            fromBundleId: insightsEvent.fromBundleId,
-            toBundleId: insightsEvent.toBundleId,
-            type: "RECOVERED",
-            updateStrategy: insightsEvent.updateStrategy,
-          };
-        default:
-          return assertNever(insightsEvent.type);
-      }
-    default:
-      return assertNever(nativeResult);
-  }
-};
-
-let lastInsightsReport = Promise.resolve();
-const sendInsights = (
-  options: Pick<NotifyAppReadyOptions, "client">,
-  params: InsightsEventParams,
-): Promise<void> => {
-  lastInsightsReport = lastInsightsReport
-    .catch(() => {})
-    .then(async () => {
-      const session = await options.client.createSession();
-      await session.sendInsightsEvent(params);
-    });
-  return lastInsightsReport;
-};
-
-const maybeSendAutomaticInsights = async (
-  options: NotifyAppReadyOptions,
-  nativeResult: NotifyAppReadyResult,
-  insightsEvent: NotifyAppReadyInsightsEvent | null,
-): Promise<void> => {
-  if (
-    !options.insights ||
-    didAttemptAutomaticInsights ||
-    (nativeResult.status === "UNCHANGED" &&
-      (options.reportUnchanged === false || didDownload))
-  ) {
-    return;
-  }
-
-  didAttemptAutomaticInsights = true;
-
-  if (nativeResult.status !== "UNCHANGED" && !insightsEvent) {
-    throw new Error(
-      "[HotUpdater] Native launch report is missing persisted metadata required for automatic insights.",
-    );
-  }
-
-  await sendInsights(
-    options,
-    buildNotifyAppReadyInsightsParams(nativeResult, insightsEvent, options),
-  );
-};
-
-const notifyAppReady = async (
-  options: NotifyAppReadyOptions,
-): Promise<NotifyAppReadyResult | undefined> => {
-  try {
-    let nativeReadResult: ReturnType<typeof readNotifyAppReady>;
-    do {
-      await waitForNextFrame();
-      nativeReadResult = readNotifyAppReady();
-    } while (nativeReadResult.pending);
-
-    const { insightsEvent, result: nativeResult } = nativeReadResult;
-
-    try {
-      await maybeSendAutomaticInsights(options, nativeResult, insightsEvent);
-    } catch (error) {
-      const warning = error instanceof Error ? error : new Error(String(error));
-      console.warn(
-        "[HotUpdater] Automatic notifyAppReady insights failed:",
-        warning,
-      );
-    }
-
-    options.onNotifyAppReady?.(nativeResult);
-    return nativeResult;
-  } catch (error) {
-    const normalizedError =
-      error instanceof Error ? error : new Error(String(error));
-    options.onError?.(error);
-    console.warn("[HotUpdater] Failed to notify app ready:", normalizedError);
-    return undefined;
-  }
-};
-
-export const handleNotifyAppReady = (
-  options: NotifyAppReadyOptions,
-): Promise<NotifyAppReadyResult | undefined> => {
-  readinessPromise = notifyAppReady(options);
-  return readinessPromise;
-};
-
-/** Called after an automatic update check finds no download or transition. */
-export const reportNoChange = async (
-  options: NotifyAppReadyOptions,
-): Promise<void> => {
-  try {
-    await maybeSendAutomaticInsights(options, { status: "UNCHANGED" }, null);
-  } catch (error) {
-    console.warn("[HotUpdater] Automatic no-change insights failed:", error);
-  }
-};
-
-let lastDownloadedSelection: string | undefined;
-
-/** Report only after the manifest update has been verified and staged successfully. */
-export const reportBundleDownloaded = async (
-  options: Pick<
-    NotifyAppReadyOptions,
-    "insights" | "client" | "requestHeaders" | "requestTimeout"
-  >,
-  transition: {
-    readonly fromBundleId: string;
-    readonly fromReleaseId: string | null;
-    readonly toBundleId: string;
-    readonly toReleaseId: string | null;
-    readonly channel: string;
-    readonly updateStrategy: "fingerprint" | "appVersion";
-  },
-): Promise<void> => {
-  if (!options.insights || transition.fromBundleId === transition.toBundleId)
-    return;
-  const key = JSON.stringify([
-    transition.channel,
-    transition.toReleaseId,
-    transition.toBundleId,
-  ]);
-  if (lastDownloadedSelection === key) return;
-  lastDownloadedSelection = key;
-  // A later init/mount in this JS runtime must not overwrite pending apply with UNCHANGED.
-  didDownload = true;
-  try {
-    await readinessPromise;
-    const common = buildNotifyAppReadyInsightsParams(
-      { status: "UNCHANGED" },
-      null,
-      options,
-    );
-    await sendInsights(options, {
-      ...common,
-      ...transition,
-      type: "UPDATE_DOWNLOADED",
-    });
-  } catch (error) {
-    console.warn("[HotUpdater] Download insights failed:", error);
-  }
-};