@dl2app/react-native 0.1.0 → 0.2.0

package/src/core.ts

@@ -11,13 +11,16 @@ import type {
   DL2TrackOptions,
 } from "./types";
 
-export const SDK_VERSION = "0.1.0";
+export const SDK_VERSION = "0.2.0";
 
 const K_ID = "install_id";
 const K_DONE = "first_launch_done";
 const K_ATTEMPTS = "open_attempts";
 const K_QUEUE = "event_queue";
 const K_REFERRER = "install_referrer";
+const K_INSTALLED_AT = "installed_at";
+// Everything that belongs to one install. Dropped when storage turns out to come from another.
+const INSTALL_KEYS = [K_ID, K_DONE, K_ATTEMPTS, K_QUEUE, K_REFERRER];
 
 const RESOLVE_TIMEOUT_MS = 3000;
 const EVENT_TIMEOUT_MS = 5000;
@@ -28,9 +31,13 @@ const MAX_PENDING_LINKS = 20;
 const MAX_OPEN_ATTEMPTS = 3;
 const RETRY_BASE_MS = 2000;
 const RETRY_MAX_MS = 300000;
+// The server's longest fingerprint window. An older install can only be matched exactly.
+const MAX_MATCH_WINDOW_MS = 24 * 60 * 60 * 1000;
 
 type Listener = (event: DL2LinkEvent) => void;
-type QueuedEvent = { name: string; value?: number; currency?: string; props?: Record<string, unknown> };
+// event_id is made once, when the event is queued: a retry of a request that did arrive sends
+// the same id, so the server can count the event once.
+type QueuedEvent = { event_id?: string; name: string; value?: number; currency?: string; props?: Record<string, unknown> };
 type Parsed = { scheme: string; host: string; path: string; params: Record<string, string> };
 type Payload = {
   source?: string;
@@ -123,11 +130,14 @@ export function createDL2(deps: DL2Deps) {
   let gen = 0;
   let installId: string | null = null;
   let firstLaunch = false;
+  let skipFingerprint = false;
   let storageOk = true;
   let matched = false;
   let info: DL2DeviceInfo | null = null;
   let ready: Promise<void> | null = null;
   let initial: Promise<DL2LinkEvent | null> | null = null;
+  // The first-launch check that runs beside a launch link in the app's own scheme.
+  let recording: Promise<void> | null = null;
   let sub: { remove(): void } | null = null;
   const listeners = new Set<Listener>();
   let pending: DL2LinkEvent[] = [];
@@ -373,7 +383,7 @@ export function createDL2(deps: DL2Deps) {
     return info;
   }
 
-  /** Request body of POST /v1/sdk/open. Every field is always present. */
+  /** Request body of POST /v1/sdk/open. Every field is always present, except skip_fingerprint. */
   async function openBody(extra: { install_referrer?: string | null; clipboard_token?: string | null; launch_url?: string | null }) {
     const d = await deviceInfo();
     let screen = { w: 0, h: 0, dpr: 1 };
@@ -382,7 +392,7 @@ export function createDL2(deps: DL2Deps) {
     } catch {
       /* keep defaults */
     }
-    return {
+    const body = {
       install_id: installId,
       is_first_launch: firstLaunch,
       platform: deps.platform,
@@ -397,11 +407,15 @@ export function createDL2(deps: DL2Deps) {
       clipboard_token: extra.clipboard_token || null,
       launch_url: extra.launch_url || null,
     };
+    return skipFingerprint ? { ...body, skip_fingerprint: true } : body;
   }
 
-  /** True when the server answered, so there is no point asking again on the next launch. */
+  /**
+   * True when the server gave a final answer, so there is no point asking again on the next
+   * launch. A 429 or 5xx is not one: like the native SDKs, the check is tried on a later launch.
+   */
   function answered(e: unknown): boolean {
-    return !(isErr(e) && (e.code === "network" || e.code === "timeout"));
+    return !retryable(e);
   }
 
   async function finishFirstLaunch(serverAnswered: boolean) {
@@ -411,7 +425,7 @@ export function createDL2(deps: DL2Deps) {
       await setItem(K_DONE, "1");
       await removeItem(K_ATTEMPTS);
     } else {
-      // Offline on first launch: ask again next launch, a few times at most.
+      // Offline or the server is struggling: ask again next launch, a few times at most.
       await setItem(K_ATTEMPTS, String(attempts));
     }
   }
@@ -432,6 +446,14 @@ export function createDL2(deps: DL2Deps) {
     lastHandled = (async () => {
       if (ready) await ready;
       const first = isInitial && firstLaunch;
+      if (source === "uri_scheme") {
+        // The server only knows https links: the event comes from the URL, with no round trip.
+        // On a first launch runInitial() still records the install.
+        if (g !== gen) return null;
+        const event = toEvent(null, url, source, first);
+        emit(event);
+        return event;
+      }
       let payload: Payload | null = null;
       let ok = false;
       try {
@@ -441,7 +463,7 @@ export function createDL2(deps: DL2Deps) {
           payload = (r && r.match) || null;
           ok = true;
         } else {
-          payload = await call("/v1/sdk/resolve", { url, source }, RESOLVE_TIMEOUT_MS);
+          payload = await call("/v1/sdk/resolve", { url, source, install_id: installId }, RESOLVE_TIMEOUT_MS);
           lastResolveResponse = payload;
         }
       } catch (e) {
@@ -461,7 +483,30 @@ export function createDL2(deps: DL2Deps) {
     return lastHandled;
   }
 
+  /** Install time from the native module, in ms since epoch. Null when it cannot be read. */
+  async function installedAt(): Promise<number | null> {
+    try {
+      const t = deps.native && deps.native.getInstalledAt ? await deps.native.getInstalledAt() : null;
+      return typeof t === "number" && isFinite(t) && t > 0 ? t : null;
+    } catch {
+      return null;
+    }
+  }
+
   async function init(g: number) {
+    const installed = await installedAt();
+    // Android backup and device transfer restore the SDK's storage into a new install. The
+    // install time gives that away: start over, or the deferred link is lost and two devices
+    // share one install_id. iOS has no real install time, only a directory date, so it is not
+    // trusted for this.
+    if (installed !== null && deps.platform === "android") {
+      const stamp = await getItem(K_INSTALLED_AT);
+      if (stamp !== null && stamp !== String(installed)) {
+        log("storage was restored from another install: starting fresh");
+        for (const k of INSTALL_KEYS) await removeItem(k);
+      }
+      if (stamp !== String(installed) && storageOk) await setItem(K_INSTALLED_AT, String(installed));
+    }
     let id = await getItem(K_ID);
     if (!id) {
       try {
@@ -484,10 +529,18 @@ export function createDL2(deps: DL2Deps) {
     // Without working storage every launch would look like the first one and could claim
     // someone else's link, so deferred matching is skipped.
     firstLaunch = storageOk && !!deps.native && done !== "1";
-    if (Array.isArray(stored)) queue = (stored as QueuedEvent[]).concat(queue).slice(-MAX_QUEUED_EVENTS);
+    // Installed long ago and only now running the SDK (it shipped in an app update): a
+    // fingerprint match could only be somebody else's click. Exact matches still apply.
+    skipFingerprint = installed !== null && now() - installed > MAX_MATCH_WINDOW_MS;
+    if (Array.isArray(stored)) {
+      const old = (stored as QueuedEvent[]).filter((e) => !!e && typeof e === "object" && typeof e.name === "string");
+      // Events stored by a version that had no event_id get one now.
+      for (const e of old) if (typeof e.event_id !== "string" || !e.event_id) e.event_id = fallbackUuid(random);
+      queue = old.concat(queue).slice(-MAX_QUEUED_EVENTS);
+    }
     if (!deps.native) {
       report(
-        mkErr("unknown", "DL2 native module not found. Rebuild the app (Expo Go is not supported); deferred links are off."),
+        mkErr("unknown", "DL2 native module not found. Rebuild the app (on iOS run pod install first; Expo Go is not supported); deferred links are off."),
         "configure",
       );
     }
@@ -503,9 +556,36 @@ export function createDL2(deps: DL2Deps) {
       report(mkErr("unknown", "Linking.getInitialURL failed", e), "configure");
     }
     if (g !== gen || !cfg) return null;
+    if (url && deps.platform === "android" && deps.native && deps.native.isLaunchedFromHistory) {
+      // Reopened from Recents after the process died: Android hands back the intent of the
+      // original launch, and its link was already delivered then.
+      try {
+        if (await deps.native.isLaunchedFromHistory()) url = null;
+      } catch {
+        /* unknown: treat the URL as new */
+      }
+      if (g !== gen || !cfg) return null;
+    }
+    const parsed = url ? parseUrl(url) : null;
     const handled = url ? handleUrl(url, true) : undefined;
-    if (handled) return handled;
+    if (handled) {
+      if (firstLaunch && parsed && sourceOf(parsed) === "uri_scheme") {
+        // Handled without the server, so the install is recorded by the usual first-launch
+        // call. The app already has its link: a deferred match is not delivered on top of it.
+        recording = firstOpen(g, false).then(
+          () => undefined,
+          (e) => report(e, "configure"),
+        );
+      }
+      return handled;
+    }
     if (!firstLaunch) return null;
+    return firstOpen(g, true);
+  }
+
+  /** The first-launch POST /v1/sdk/open without a launch URL: records the install and asks for a deferred link. */
+  async function firstOpen(g: number, deliver: boolean): Promise<DL2LinkEvent | null> {
+    if (!cfg) return null;
     if (!cfg.deferred) {
       await finishFirstLaunch(true);
       return null;
@@ -529,7 +609,8 @@ export function createDL2(deps: DL2Deps) {
       ok = true;
       if (g === gen && r && r.match) {
         matched = true;
-        event = toEvent(r.match, null, "deferred", true);
+        if (deliver) event = toEvent(r.match, null, "deferred", true);
+        else log("deferred match not delivered: the app was opened by a link");
       }
     } catch (e) {
       ok = answered(e);
@@ -567,6 +648,7 @@ export function createDL2(deps: DL2Deps) {
     flushing = (async () => {
       // Wait for the launch check so the server knows this install before its first event.
       if (initial) await initial;
+      if (recording) await recording;
       while (queue.length && g === gen && cfg) {
         const e = queue[0];
         try {
@@ -698,7 +780,9 @@ export function createDL2(deps: DL2Deps) {
       const p = parseUrl(url);
       if (!p) throw mkErr("link_not_found", "resolve() needs a full URL such as https://myapp.dl2.app/abc");
       const source = sourceOf(p);
-      const payload = await call("/v1/sdk/resolve", { url, source }, RESOLVE_TIMEOUT_MS);
+      // The app's own scheme never reaches the server: it has no such links.
+      if (source === "uri_scheme" && isOurs(p)) return toEvent(null, url, source, false);
+      const payload = await call("/v1/sdk/resolve", { url, source, install_id: installId }, RESOLVE_TIMEOUT_MS);
       lastResolveResponse = payload;
       return toEvent(payload, url, source, false);
     });
@@ -709,14 +793,15 @@ export function createDL2(deps: DL2Deps) {
       if (!cfg) throw mkErr("not_configured", "Call DL2.configure() before track()");
       if (typeof name !== "string" || !name.trim()) throw mkErr("unknown", "track() needs an event name");
       const o = options || {};
-      const e: QueuedEvent = { name: name.trim() };
+      const e: QueuedEvent = { event_id: fallbackUuid(random), name: name.trim() };
       if (typeof o.value === "number" && isFinite(o.value)) e.value = o.value;
       if (typeof o.currency === "string" && o.currency) e.currency = o.currency.toUpperCase();
       if (o.props && typeof o.props === "object") e.props = JSON.parse(JSON.stringify(o.props));
       queue.push(e);
       if (queue.length > MAX_QUEUED_EVENTS) queue.shift(); // bounded: the oldest event goes first
       persistQueue();
-      flush().catch(() => undefined);
+      // While a retry is waiting, the new event goes out with it: the backoff holds.
+      if (!retryTimer) flush().catch(() => undefined);
     });
   }
 
@@ -724,7 +809,15 @@ export function createDL2(deps: DL2Deps) {
     return guardAsync("createLink", null, async () => {
       if (!cfg) throw mkErr("not_configured", "Call DL2.configure() before createLink()");
       if (!input || typeof input.path !== "string") throw mkErr("unknown", "createLink() needs a path");
-      const r = await call("/v1/sdk/links", input, EVENT_TIMEOUT_MS);
+      // The API takes the preview fields flat (og_title, …), not as the nested `og` object.
+      const { og, ...rest } = input;
+      const body: Record<string, unknown> = { ...rest };
+      if (og && typeof og === "object") {
+        if (og.title) body.og_title = og.title;
+        if (og.description) body.og_description = og.description;
+        if (og.image) body.og_image_url = og.image;
+      }
+      const r = await call("/v1/sdk/links", body, EVENT_TIMEOUT_MS);
       if (!r || typeof r.url !== "string") throw mkErr("unknown", "The server did not return a link URL");
       return { url: r.url };
     });
@@ -770,8 +863,10 @@ export function createDL2(deps: DL2Deps) {
       cfg = null;
       ready = null;
       initial = null;
+      recording = null;
       installId = null;
       firstLaunch = false;
+      skipFingerprint = false;
       storageOk = true;
       matched = false;
       info = null;
@@ -782,7 +877,7 @@ export function createDL2(deps: DL2Deps) {
       lastHandled = null;
       lastOpenResponse = null;
       lastResolveResponse = null;
-      for (const k of [K_ID, K_DONE, K_ATTEMPTS, K_QUEUE, K_REFERRER]) await removeItem(k);
+      for (const k of [...INSTALL_KEYS, K_INSTALLED_AT]) await removeItem(k);
     });
   }
 

package/src/index.ts

@@ -1,11 +1,11 @@
-import { Dimensions, Linking, PixelRatio, Platform } from "react-native";
-import { requireOptionalNativeModule } from "expo-modules-core";
+import { Dimensions, Linking, NativeModules, PixelRatio, Platform } from "react-native";
 import { createDL2 } from "./core";
 import type { DL2Native } from "./types";
 
+// A plain React Native module, linked by autolinking in bare React Native and in Expo alike.
 function loadNative(): DL2Native | null {
   try {
-    return requireOptionalNativeModule<DL2Native>("DL2");
+    return (NativeModules.DL2 as DL2Native | undefined) || null;
   } catch {
     return null;
   }

package/src/types.ts

@@ -84,7 +84,7 @@ export type DL2DeviceInfo = {
   tz?: string;
 };
 
-/** The native module (Expo Modules API). Every function is asynchronous. */
+/** The native module (a plain React Native module). Every function is asynchronous. */
 export interface DL2Native {
   getItem(key: string): Promise<string | null>;
   setItem(key: string, value: string): Promise<void>;
@@ -92,6 +92,16 @@ export interface DL2Native {
   /** Android: Play Install Referrer string. iOS: always null. */
   getInstallReferrer(): Promise<string | null>;
   getDeviceInfo(): Promise<DL2DeviceInfo>;
+  /**
+   * When the app was installed, in ms since epoch, or null when unknown. Android: the package's
+   * firstInstallTime. iOS: the creation date of the app's data container.
+   */
+  getInstalledAt?(): Promise<number | null>;
+  /**
+   * Android: true when the activity was reopened from Recents, so its intent (and the URL in it)
+   * is the one from the original launch. iOS does not have it.
+   */
+  isLaunchedFromHistory?(): Promise<boolean>;
   uuid?(): Promise<string>;
 }
 

package/expo-module.config.json

@@ -1,5 +0,0 @@
-{
-  "platforms": ["ios", "android"],
-  "ios": { "modules": ["DL2Module"] },
-  "android": { "modules": ["app.dl2.reactnative.DL2Module"] }
-}

package/ios/DL2.podspec

@@ -1,22 +0,0 @@
-require 'json'
-
-package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
-
-Pod::Spec.new do |s|
-  s.name           = 'DL2'
-  s.version        = package['version']
-  s.summary        = package['description']
-  s.description    = package['description']
-  s.license        = package['license']
-  s.author         = 'DL2'
-  s.homepage       = 'https://dl2.app'
-  s.platforms      = { :ios => '13.4' }
-  s.swift_version  = '5.4'
-  s.source         = { :git => 'https://github.com/dl2app/dl2-react-native.git', :tag => "v#{s.version}" }
-  s.static_framework = true
-
-  s.dependency 'ExpoModulesCore'
-
-  s.source_files = '*.swift'
-  s.resource_bundles = { 'DL2_Privacy' => ['PrivacyInfo.xcprivacy'] }
-end