@smileid/usesmileid 12.0.2 → 12.1.0

package/src/metadata/__tests__/use_smile_id_metadata.test.ts

@@ -1,430 +0,0 @@
-import { describe, expect, it, vi, beforeEach } from "vitest";
-
-vi.mock("react-native", () => ({
-  Platform: { OS: "ios", Version: "17.4" },
-  Dimensions: {
-    get: (kind: "screen" | "window") =>
-      kind === "screen"
-        ? { width: 390, height: 844, scale: 3 }
-        : { width: 390, height: 844, scale: 3 },
-  },
-}));
-
-import {
-  UseSmileIDMetadata,
-  type UseSmileIDMetadataFields,
-} from "../use_smile_id_metadata";
-import { UseSmileIDMetadataFactory } from "../use_smile_id_metadata_factory";
-import type { SdkConfig } from "../../data/model/sdk_config";
-import { SdkConfigSource } from "../../data/model/sdk_config_source";
-
-// Minimum baseline — every conditional field empty / zero and the measured
-// booleans (proxy, proximitySensor) left undefined. The only fields that
-// survive `toEntries()` from this fixture are the truly-always-present ones
-// (SDK constants, sessionId, sdk_config_source).
-const baseFields: UseSmileIDMetadataFields = Object.freeze({
-  sdkVersion: "12.0.2",
-  sdk: "react-native-expo",
-  deviceOs: "",
-  deviceModel: "",
-  appName: "",
-  sessionId: "abc-123",
-  clientIp: "",
-  networkConnection: "",
-  carrierInfo: "",
-  timezone: "",
-  locale: "",
-  screenResolution: "",
-  memoryInfoMb: 0,
-  deviceOrientation: "",
-  systemArchitecture: "",
-  numberOfCameras: 0,
-  hostApplication: "",
-  securityPolicyVersion: "12.0.0",
-  // sdk_config provenance — always-present (non-empty by construction).
-  sdkConfigSource: SdkConfigSource.defaultSource,
-  // Dimensions — zero in baseline fixture → omitted from entries.
-  imageWidth: 0,
-  imageHeight: 0,
-  livenessImageWidth: 0,
-  livenessImageHeight: 0,
-});
-
-describe("UseSmileIDMetadata.toEntries — standardized multipart wire format", () => {
-  it("always emits the always-present fields, including device_os / device_model / app_name even when empty", () => {
-    // `device_os`, `device_model`, and `app_name` are part of the
-    // always-present field set: they are emitted unconditionally (even
-    // when empty), alongside the SDK constants and the session UUID.
-    // `sdk_config_source` is also always-present. The measured booleans
-    // (proxy, proximity_sensor) are undefined in the baseline → omitted.
-    const meta = new UseSmileIDMetadata(baseFields);
-    const names = meta.toEntries().map((e) => e.name);
-    expect(names).toEqual([
-      "sdk_version",
-      "sdk",
-      "device_os",
-      "device_model",
-      "app_name",
-      "session_id",
-      "security_policy_version",
-      "sdk_config_source",
-    ]);
-  });
-
-  it("emits device_os / device_model / app_name when populated", () => {
-    // Same fields that drop on empty must appear when populated —
-    // exact placement preserved (between `sdk` and `session_id`).
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      deviceOs: "iOS 17.4",
-      deviceModel: "Apple iPhone",
-      appName: "AcmeApp",
-    });
-    const names = meta.toEntries().map((e) => e.name);
-    expect(names).toEqual([
-      "sdk_version",
-      "sdk",
-      "device_os",
-      "device_model",
-      "app_name",
-      "session_id",
-      "security_policy_version",
-      "sdk_config_source",
-    ]);
-  });
-
-  it("omits empty conditional strings (concrete scenario: emulator with no carrier)", () => {
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      timezone: "",
-      locale: "",
-      carrierInfo: "",
-    });
-    const names = meta.toEntries().map((e) => e.name);
-    expect(names).not.toContain("timezone");
-    expect(names).not.toContain("locale");
-    expect(names).not.toContain("carrier_info");
-  });
-
-  it("omits zero-valued conditional integers (memory_info, number_of_cameras)", () => {
-    // Concrete scenario: RN can't read `memory_info` without
-    // `expo-device` so the default is 0. The wire format must NOT
-    // ship `memory_info: 0` — it should be absent. Pin the contract.
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      memoryInfoMb: 0,
-      numberOfCameras: 0,
-    });
-    const names = meta.toEntries().map((e) => e.name);
-    expect(names).not.toContain("memory_info");
-    expect(names).not.toContain("number_of_cameras");
-  });
-
-  it("emits non-empty conditionals between the identity block and the trailer", () => {
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      // Populate the upper-conditional triple so the canonical
-      // "fully populated" order shows.
-      deviceOs: "iOS 17.4",
-      deviceModel: "Apple iPhone",
-      appName: "AcmeApp",
-      timezone: "America/New_York",
-      locale: "en-US",
-      memoryInfoMb: 4096,
-      numberOfCameras: 2,
-    });
-    const names = meta.toEntries().map((e) => e.name);
-    expect(names).toEqual([
-      "sdk_version",
-      "sdk",
-      "device_os",
-      "device_model",
-      "app_name",
-      "session_id",
-      "timezone",
-      "locale",
-      "memory_info",
-      "number_of_cameras",
-      "security_policy_version",
-      "sdk_config_source",
-    ]);
-  });
-
-  it('stringifies booleans as "true" / "false" (wire-format contract)', () => {
-    // Concrete scenario: a JSON parser receiving native bool would
-    // need a different schema than other entries. The wire contract
-    // is `value: string` for every entry; booleans are stringified.
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      proxy: true,
-      proximitySensor: false,
-    });
-    const entries = meta.toEntries();
-    expect(entries.find((e) => e.name === "proxy")).toEqual({
-      name: "proxy",
-      value: "true",
-    });
-    expect(entries.find((e) => e.name === "proximity_sensor")).toEqual({
-      name: "proximity_sensor",
-      value: "false",
-    });
-  });
-
-  it("returns a frozen array — partners can`t mutate the snapshot", () => {
-    const meta = new UseSmileIDMetadata(baseFields);
-    const entries = meta.toEntries();
-    expect(Object.isFrozen(entries)).toBe(true);
-  });
-});
-
-describe("UseSmileIDMetadataFactory", () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  it("caches sessionId across make() calls — one session per factory", () => {
-    // Concrete scenario: a flow makes auth → submit → status calls in
-    // sequence. All three must carry the SAME session_id so partner
-    // analytics can correlate them.
-    const factory = new UseSmileIDMetadataFactory();
-    const a = factory.make().toFields().sessionId;
-    const b = factory.make().toFields().sessionId;
-    expect(a).toBe(b);
-    expect(a).toMatch(/[0-9a-f-]{8,}/);
-  });
-
-  it("mints a new sessionId for a new factory instance", () => {
-    const f1 = new UseSmileIDMetadataFactory();
-    const f2 = new UseSmileIDMetadataFactory();
-    expect(f1.make().toFields().sessionId).not.toBe(
-      f2.make().toFields().sessionId,
-    );
-  });
-
-  it("resolves device_os from Platform.OS + Platform.Version", () => {
-    const factory = new UseSmileIDMetadataFactory();
-    expect(factory.make().toFields().deviceOs).toBe("iOS 17.4");
-  });
-
-  it('always emits sdk = "react-native-expo" — matches the auth header `smileid-source-sdk`', () => {
-    // Concrete scenario: partner analytics groups submissions by
-    // SDK identifier. Drift on this value would split the RN bucket
-    // across multiple identifiers (e.g. metadata says `react_native`
-    // while the auth header says `react-native-expo` — same fleet,
-    // two buckets).
-    const factory = new UseSmileIDMetadataFactory();
-    expect(factory.make().toFields().sdk).toBe("react-native-expo");
-  });
-
-  it("resolves screen_resolution as physical pixels with the × separator", () => {
-    // Format: `<w> × <h>` with the U+00D7 multiplication sign
-    // (not ASCII `x`). Pin so a future refactor doesn't accidentally
-    // use ASCII.
-    const factory = new UseSmileIDMetadataFactory();
-    expect(factory.make().toFields().screenResolution).toBe("1170 × 2532");
-  });
-
-  it("resolves device_orientation from Dimensions(window) aspect", () => {
-    const factory = new UseSmileIDMetadataFactory();
-    expect(factory.make().toFields().deviceOrientation).toBe("Portrait");
-  });
-
-  it("passes appName / hostApplication through from constructor options", () => {
-    const factory = new UseSmileIDMetadataFactory({
-      appName: "AcmeApp",
-      hostApplication: "AcmeApp v2.0.1",
-    });
-    const f = factory.make().toFields();
-    expect(f.appName).toBe("AcmeApp");
-    expect(f.hostApplication).toBe("AcmeApp v2.0.1");
-  });
-
-  it("produces a wire-format array that drops empty / zero fields", () => {
-    // End-to-end: the factory's defaults leave several fields empty
-    // (no native-bridge access). Those must NOT appear in the wire
-    // payload. Concrete scenario: a partner running RN inside an
-    // emulator would otherwise send a payload with empty
-    // `device_model`, `host_application`, `client_ip`, etc.
-    const factory = new UseSmileIDMetadataFactory();
-    const names = factory
-      .make()
-      .toEntries()
-      .map((e) => e.name);
-    expect(names).not.toContain("client_ip");
-    expect(names).not.toContain("network_connection");
-    expect(names).not.toContain("carrier_info");
-    expect(names).not.toContain("memory_info");
-    expect(names).not.toContain("number_of_cameras");
-    expect(names).not.toContain("host_application");
-    // device_os / device_model / app_name are always-present and emitted
-    // even at their empty factory defaults.
-    expect(names).toContain("device_os");
-    expect(names).toContain("device_model");
-    expect(names).toContain("app_name");
-    // sdk_config_source is always-present (non-empty string by construction).
-    expect(names).toContain("sdk_config_source");
-    // Selfie + liveness dimensions are emitted as "WxH" when both sides > 0.
-    // Factory defaults to 480 × 640 so they appear without an sdkConfig override.
-    expect(names).toContain("selfie_image_dimensions");
-    expect(names).toContain("liveness_image_dimensions");
-  });
-});
-
-describe("UseSmileIDMetadata.toEntries — device-integrity fields", () => {
-  const valueByName = (meta: UseSmileIDMetadata): Record<string, string> =>
-    Object.fromEntries(meta.toEntries().map((e) => [e.name, e.value]));
-
-  it("omits every attestation field before the warm-up resolves", () => {
-    const names = new UseSmileIDMetadata(baseFields)
-      .toEntries()
-      .map((e) => e.name);
-    expect(names).not.toContain("supports_hardware_attestation");
-    expect(names).not.toContain("attestation_certificate_chain");
-    expect(names).not.toContain("supports_app_attest");
-  });
-
-  it("emits supports_hardware_attestation as the security-level integer", () => {
-    // StrongBox-backed key → KeyInfo.getSecurityLevel() === 2.
-    const values = valueByName(
-      new UseSmileIDMetadata({
-        ...baseFields,
-        hardwareAttestationSecurityLevel: 2,
-      }),
-    );
-    expect(values.supports_hardware_attestation).toBe("2");
-  });
-
-  it("emits security level -2 (unknown) for an unsupported device", () => {
-    const values = valueByName(
-      new UseSmileIDMetadata({
-        ...baseFields,
-        hardwareAttestationSecurityLevel: -2,
-      }),
-    );
-    expect(values.supports_hardware_attestation).toBe("-2");
-  });
-
-  it("serialises the certificate chain as a JSON-array string", () => {
-    const values = valueByName(
-      new UseSmileIDMetadata({
-        ...baseFields,
-        hardwareAttestationSecurityLevel: 1,
-        attestationCertificateChain: ["certA", "certB"],
-      }),
-    );
-    expect(values.attestation_certificate_chain).toBe('["certA","certB"]');
-  });
-
-  it("omits the certificate chain when empty even if level present", () => {
-    const names = new UseSmileIDMetadata({
-      ...baseFields,
-      hardwareAttestationSecurityLevel: 0,
-      attestationCertificateChain: [],
-    })
-      .toEntries()
-      .map((e) => e.name);
-    expect(names).toContain("supports_hardware_attestation");
-    expect(names).not.toContain("attestation_certificate_chain");
-  });
-
-  it("emits supports_app_attest as a boolean string", () => {
-    expect(
-      valueByName(
-        new UseSmileIDMetadata({ ...baseFields, supportsAppAttest: true }),
-      ).supports_app_attest,
-    ).toBe("true");
-    expect(
-      valueByName(
-        new UseSmileIDMetadata({ ...baseFields, supportsAppAttest: false }),
-      ).supports_app_attest,
-    ).toBe("false");
-  });
-});
-
-describe("UseSmileIDMetadata.toEntries — sdk_config provenance", () => {
-  const valueByName = (meta: UseSmileIDMetadata): Record<string, string> =>
-    Object.fromEntries(meta.toEntries().map((e) => [e.name, e.value]));
-
-  it("always emits sdk_config_source — the backend gates its dimension-consistency check on this", () => {
-    const names = new UseSmileIDMetadata(baseFields)
-      .toEntries()
-      .map((e) => e.name);
-    expect(names).toContain("sdk_config_source");
-  });
-
-  it('emits sdk_config_source = "default" from the baseline fixture', () => {
-    expect(
-      valueByName(new UseSmileIDMetadata(baseFields)).sdk_config_source,
-    ).toBe("default");
-  });
-
-  it('emits sdk_config_source = "sdk_config" when the field is set', () => {
-    const meta = new UseSmileIDMetadata({
-      ...baseFields,
-      sdkConfigSource: SdkConfigSource.sdkConfig,
-      imageWidth: 640,
-      imageHeight: 480,
-    });
-    expect(valueByName(meta).sdk_config_source).toBe("sdk_config");
-  });
-
-  it("emits selfie_image_dimensions as WxH when both sides > 0", () => {
-    const values = valueByName(
-      new UseSmileIDMetadata({
-        ...baseFields,
-        sdkConfigSource: SdkConfigSource.sdkConfig,
-        imageWidth: 640,
-        imageHeight: 480,
-      }),
-    );
-    expect(values["selfie_image_dimensions"]).toBe("640x480");
-  });
-
-  it("omits selfie_image_dimensions when a side is zero (fallback to SDK defaults not set)", () => {
-    // baseFields has imageWidth: 0 / imageHeight: 0 — the "WxH" key must be absent
-    // from the wire payload so the server doesn't see an explicit zero.
-    const names = new UseSmileIDMetadata(baseFields)
-      .toEntries()
-      .map((e) => e.name);
-    expect(names).not.toContain("selfie_image_dimensions");
-  });
-});
-
-describe("UseSmileIDMetadataFactory — sdk_config provenance", () => {
-  it('defaults to sdk_config_source = "default" when make() is called without sdkConfig', () => {
-    const factory = new UseSmileIDMetadataFactory();
-    const fields = factory.make().toFields();
-    expect(fields.sdkConfigSource).toBe(SdkConfigSource.defaultSource);
-  });
-
-  it("defaults image_width / image_height to the SDK defaults (480 × 640) when make() has no sdkConfig", () => {
-    const factory = new UseSmileIDMetadataFactory();
-    const fields = factory.make().toFields();
-    // SDK defaults: 480 × 640 — the canonical selfie capture size.
-    expect(fields.imageWidth).toBe(480);
-    expect(fields.imageHeight).toBe(640);
-  });
-
-  it('emits sdk_config_source = "sdk_config" when sdkConfig is supplied with valid selfie dimensions', () => {
-    const factory = new UseSmileIDMetadataFactory();
-    const sdkConfig: SdkConfig = {
-      selfie: { width: 640, height: 480 },
-    };
-    const fields = factory.make(sdkConfig).toFields();
-    expect(fields.sdkConfigSource).toBe(SdkConfigSource.sdkConfig);
-    expect(fields.imageWidth).toBe(640);
-    expect(fields.imageHeight).toBe(480);
-  });
-
-  it('emits sdk_config_source = "sdk_config" and falls back to defaults when pair rule fails', () => {
-    // Pair rule: both width AND height must be > 0; width-only fails.
-    // sdkConfig is still defined so source = "sdk_config", but dims fall back.
-    const factory = new UseSmileIDMetadataFactory();
-    const sdkConfig: SdkConfig = { selfie: { width: 640 } };
-    const fields = factory.make(sdkConfig).toFields();
-    expect(fields.sdkConfigSource).toBe(SdkConfigSource.sdkConfig);
-    // SDK default dimensions should apply when pair rule fails.
-    expect(fields.imageWidth).toBe(480);
-    expect(fields.imageHeight).toBe(640);
-  });
-});