@repzo/widget-react-native 1.4.0 → 1.5.0

package/lib/module/state/user-update-queue.js

@@ -0,0 +1,163 @@
+"use strict";
+
+/**
+ * Paces `updateUser()` the way Intercom paces its web `update` (20 calls per
+ * 30 minutes), so a host that calls it on a timer or on every GPS fix can't
+ * flood Workstation.
+ *
+ * - Values that match what Workstation already has are not sent again.
+ * - Up to `burst` sends go out straight away; after that one more is allowed
+ *   every `windowMs / burst` (90 s by default).
+ * - While a send is in flight, rate limited or out of budget, new values wait
+ *   and merge into one bag, newest value per key. Nothing is lost: the latest
+ *   of every key goes out on the next allowed send. Workstation merges the bag
+ *   into the saved attributes per key, so sending only what changed is enough.
+ * - A 429 holds sends until its `Retry-After`. A failed connection or a 5xx
+ *   keeps the values and tries again later.
+ */
+
+import { RepzoWidgetError } from "../api/client.js";
+export const USER_UPDATE_BURST = 20;
+export const USER_UPDATE_WINDOW_MS = 30 * 60 * 1000;
+/** Wait after a 429 without a usable `Retry-After`, or after a failed connection / 5xx. */
+const DEFAULT_HOLD_MS = 60 * 1000;
+export class UserUpdateQueue {
+  /** Values Workstation accepted for the current identity. */
+  sent = {};
+  /** Values waiting for the next allowed send. */
+  pending = null;
+  inFlight = false;
+  holdUntil = 0;
+  timer = null;
+  /** Bumped by reset(): a send that settles after it writes nothing back. */
+  generation = 0;
+  constructor(send, options = {}) {
+    this.send = send;
+    this.burst = Math.max(1, options.burst ?? USER_UPDATE_BURST);
+    this.refillMs = (options.windowMs ?? USER_UPDATE_WINDOW_MS) / this.burst;
+    this.now = options.now ?? Date.now;
+    this.tokens = this.burst;
+    this.refilledAt = this.now();
+  }
+
+  /**
+   * Resolves once the values are sent, or straight away when nothing changed
+   * or they were held for a later send. Rejects only when a send made right
+   * now fails with something other than a 429, as `updateUser()` always has.
+   */
+  update(attributes) {
+    const changes = {};
+    for (const [key, value] of Object.entries(attributes)) {
+      const known = this.pending && key in this.pending ? this.pending[key] : this.sent[key];
+      if (known !== value) changes[key] = value;
+    }
+    if (Object.keys(changes).length === 0) return Promise.resolve();
+    this.pending = {
+      ...this.pending,
+      ...changes
+    };
+    if (this.inFlight || this.now() < this.holdUntil || !this.takeToken()) {
+      this.schedule();
+      return Promise.resolve();
+    }
+    return this.sendPending();
+  }
+
+  /** The visitor's identity changed (anonymous → signed in): Workstation may hold other values now. */
+  forgetSent() {
+    this.sent = {};
+  }
+
+  /** Sign-out or a different user: drop everything waiting so it can't reach the next visitor. */
+  reset() {
+    this.generation += 1;
+    this.clearTimer();
+    this.sent = {};
+    this.pending = null;
+    this.inFlight = false;
+    this.holdUntil = 0;
+  }
+  destroy() {
+    this.reset();
+  }
+
+  /** The send budget is per device, not per visitor, so reset() leaves it alone. */
+  takeToken() {
+    this.refill();
+    if (this.tokens < 1) return false;
+    this.tokens -= 1;
+    return true;
+  }
+  refill() {
+    const now = this.now();
+    if (this.tokens >= this.burst) {
+      this.refilledAt = now;
+      return;
+    }
+    const earned = Math.floor((now - this.refilledAt) / this.refillMs);
+    if (earned <= 0) return;
+    this.tokens = Math.min(this.burst, this.tokens + earned);
+    this.refilledAt = this.tokens === this.burst ? now : this.refilledAt + earned * this.refillMs;
+  }
+  async sendPending() {
+    const attributes = this.pending ?? {};
+    const generation = this.generation;
+    this.pending = null;
+    this.inFlight = true;
+    try {
+      await this.send(attributes);
+      if (generation !== this.generation) return;
+      this.sent = {
+        ...this.sent,
+        ...attributes
+      };
+    } catch (error) {
+      if (generation !== this.generation) throw error;
+      const status = error instanceof RepzoWidgetError ? error.status : 0;
+      const retryable = status === 429 || status === 0 || status >= 500;
+      if (retryable) {
+        // Newer values that arrived meanwhile win over the ones that failed.
+        this.pending = {
+          ...attributes,
+          ...(this.pending ?? {})
+        };
+        const retryAfter = error instanceof RepzoWidgetError ? error.retryAfter : undefined;
+        const holdMs = status === 429 && retryAfter && retryAfter > 0 ? retryAfter * 1000 : DEFAULT_HOLD_MS;
+        this.holdUntil = Math.max(this.holdUntil, this.now() + holdMs);
+      }
+      // Rate limited: the values are kept and go out later, so the call succeeded.
+      if (status !== 429) throw error;
+    } finally {
+      if (generation === this.generation) {
+        this.inFlight = false;
+        if (this.pending) this.schedule();
+      }
+    }
+  }
+  schedule() {
+    if (this.timer || this.inFlight || !this.pending) return;
+    this.refill();
+    const now = this.now();
+    const tokenAt = this.tokens >= 1 ? now : this.refilledAt + this.refillMs;
+    const delay = Math.max(0, this.holdUntil - now, tokenAt - now);
+    this.timer = setTimeout(() => {
+      this.timer = null;
+      this.flush();
+    }, delay);
+  }
+  flush() {
+    if (this.inFlight || !this.pending) return;
+    if (this.now() < this.holdUntil || !this.takeToken()) {
+      this.schedule();
+      return;
+    }
+    this.sendPending().catch(error => {
+      console.warn('[repzo-widget] updateUser failed', error);
+    });
+  }
+  clearTimer() {
+    if (this.timer) clearTimeout(this.timer);
+    this.timer = null;
+  }
+}
+//# sourceMappingURL=user-update-queue.js.map

package/lib/module/state/user-update-queue.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["RepzoWidgetError","USER_UPDATE_BURST","USER_UPDATE_WINDOW_MS","DEFAULT_HOLD_MS","UserUpdateQueue","sent","pending","inFlight","holdUntil","timer","generation","constructor","send","options","burst","Math","max","refillMs","windowMs","now","Date","tokens","refilledAt","update","attributes","changes","key","value","Object","entries","known","keys","length","Promise","resolve","takeToken","schedule","sendPending","forgetSent","reset","clearTimer","destroy","refill","earned","floor","min","error","status","retryable","retryAfter","undefined","holdMs","tokenAt","delay","setTimeout","flush","catch","console","warn","clearTimeout"],"sourceRoot":"../../../src","sources":["state/user-update-queue.ts"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,gBAAgB,QAAQ,kBAAe;AAGhD,OAAO,MAAMC,iBAAiB,GAAG,EAAE;AACnC,OAAO,MAAMC,qBAAqB,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;AACnD;AACA,MAAMC,eAAe,GAAG,EAAE,GAAG,IAAI;AAUjC,OAAO,MAAMC,eAAe,CAAC;EAO3B;EACQC,IAAI,GAAe,CAAC,CAAC;EAC7B;EACQC,OAAO,GAAsB,IAAI;EACjCC,QAAQ,GAAG,KAAK;EAChBC,SAAS,GAAG,CAAC;EACbC,KAAK,GAAyC,IAAI;EAC1D;EACQC,UAAU,GAAG,CAAC;EAEtBC,WAAWA,CACQC,IAA+C,EAChEC,OAA+B,GAAG,CAAC,CAAC,EACpC;IAAA,KAFiBD,IAA+C,GAA/CA,IAA+C;IAGhE,IAAI,CAACE,KAAK,GAAGC,IAAI,CAACC,GAAG,CAAC,CAAC,EAAEH,OAAO,CAACC,KAAK,IAAIb,iBAAiB,CAAC;IAC5D,IAAI,CAACgB,QAAQ,GAAG,CAACJ,OAAO,CAACK,QAAQ,IAAIhB,qBAAqB,IAAI,IAAI,CAACY,KAAK;IACxE,IAAI,CAACK,GAAG,GAAGN,OAAO,CAACM,GAAG,IAAIC,IAAI,CAACD,GAAG;IAClC,IAAI,CAACE,MAAM,GAAG,IAAI,CAACP,KAAK;IACxB,IAAI,CAACQ,UAAU,GAAG,IAAI,CAACH,GAAG,CAAC,CAAC;EAC9B;;EAEA;AACF;AACA;AACA;AACA;EACEI,MAAMA,CAACC,UAAsB,EAAiB;IAC5C,MAAMC,OAAmB,GAAG,CAAC,CAAC;IAC9B,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACL,UAAU,CAAC,EAAE;MACrD,MAAMM,KAAK,GAAG,IAAI,CAACxB,OAAO,IAAIoB,GAAG,IAAI,IAAI,CAACpB,OAAO,GAAG,IAAI,CAACA,OAAO,CAACoB,GAAG,CAAC,GAAG,IAAI,CAACrB,IAAI,CAACqB,GAAG,CAAC;MACtF,IAAII,KAAK,KAAKH,KAAK,EAAEF,OAAO,CAACC,GAAG,CAAC,GAAGC,KAAK;IAC3C;IACA,IAAIC,MAAM,CAACG,IAAI,CAACN,OAAO,CAAC,CAACO,MAAM,KAAK,CAAC,EAAE,OAAOC,OAAO,CAACC,OAAO,CAAC,CAAC;IAE/D,IAAI,CAAC5B,OAAO,GAAG;MAAE,GAAG,IAAI,CAACA,OAAO;MAAE,GAAGmB;IAAQ,CAAC;IAC9C,IAAI,IAAI,CAAClB,QAAQ,IAAI,IAAI,CAACY,GAAG,CAAC,CAAC,GAAG,IAAI,CAACX,SAAS,IAAI,CAAC,IAAI,CAAC2B,SAAS,CAAC,CAAC,EAAE;MACrE,IAAI,CAACC,QAAQ,CAAC,CAAC;MACf,OAAOH,OAAO,CAACC,OAAO,CAAC,CAAC;IAC1B;IACA,OAAO,IAAI,CAACG,WAAW,CAAC,CAAC;EAC3B;;EAEA;EACAC,UAAUA,CAAA,EAAS;IACjB,IAAI,CAACjC,IAAI,GAAG,CAAC,CAAC;EAChB;;EAEA;EACAkC,KAAKA,CAAA,EAAS;IACZ,IAAI,CAAC7B,UAAU,IAAI,CAAC;IACpB,IAAI,CAAC8B,UAAU,CAAC,CAAC;IACjB,IAAI,CAACnC,IAAI,GAAG,CAAC,CAAC;IACd,IAAI,CAACC,OAAO,GAAG,IAAI;IACnB,IAAI,CAACC,QAAQ,GAAG,KAAK;IACrB,IAAI,CAACC,SAAS,GAAG,CAAC;EACpB;EAEAiC,OAAOA,CAAA,EAAS;IACd,IAAI,CAACF,KAAK,CAAC,CAAC;EACd;;EAEA;EACQJ,SAASA,CAAA,EAAY;IAC3B,IAAI,CAACO,MAAM,CAAC,CAAC;IACb,IAAI,IAAI,CAACrB,MAAM,GAAG,CAAC,EAAE,OAAO,KAAK;IACjC,IAAI,CAACA,MAAM,IAAI,CAAC;IAChB,OAAO,IAAI;EACb;EAEQqB,MAAMA,CAAA,EAAS;IACrB,MAAMvB,GAAG,GAAG,IAAI,CAACA,GAAG,CAAC,CAAC;IACtB,IAAI,IAAI,CAACE,MAAM,IAAI,IAAI,CAACP,KAAK,EAAE;MAC7B,IAAI,CAACQ,UAAU,GAAGH,GAAG;MACrB;IACF;IACA,MAAMwB,MAAM,GAAG5B,IAAI,CAAC6B,KAAK,CAAC,CAACzB,GAAG,GAAG,IAAI,CAACG,UAAU,IAAI,IAAI,CAACL,QAAQ,CAAC;IAClE,IAAI0B,MAAM,IAAI,CAAC,EAAE;IACjB,IAAI,CAACtB,MAAM,GAAGN,IAAI,CAAC8B,GAAG,CAAC,IAAI,CAAC/B,KAAK,EAAE,IAAI,CAACO,MAAM,GAAGsB,MAAM,CAAC;IACxD,IAAI,CAACrB,UAAU,GAAG,IAAI,CAACD,MAAM,KAAK,IAAI,CAACP,KAAK,GAAGK,GAAG,GAAG,IAAI,CAACG,UAAU,GAAGqB,MAAM,GAAG,IAAI,CAAC1B,QAAQ;EAC/F;EAEA,MAAcoB,WAAWA,CAAA,EAAkB;IACzC,MAAMb,UAAU,GAAG,IAAI,CAAClB,OAAO,IAAI,CAAC,CAAC;IACrC,MAAMI,UAAU,GAAG,IAAI,CAACA,UAAU;IAClC,IAAI,CAACJ,OAAO,GAAG,IAAI;IACnB,IAAI,CAACC,QAAQ,GAAG,IAAI;IACpB,IAAI;MACF,MAAM,IAAI,CAACK,IAAI,CAACY,UAAU,CAAC;MAC3B,IAAId,UAAU,KAAK,IAAI,CAACA,UAAU,EAAE;MACpC,IAAI,CAACL,IAAI,GAAG;QAAE,GAAG,IAAI,CAACA,IAAI;QAAE,GAAGmB;MAAW,CAAC;IAC7C,CAAC,CAAC,OAAOsB,KAAK,EAAE;MACd,IAAIpC,UAAU,KAAK,IAAI,CAACA,UAAU,EAAE,MAAMoC,KAAK;MAC/C,MAAMC,MAAM,GAAGD,KAAK,YAAY9C,gBAAgB,GAAG8C,KAAK,CAACC,MAAM,GAAG,CAAC;MACnE,MAAMC,SAAS,GAAGD,MAAM,KAAK,GAAG,IAAIA,MAAM,KAAK,CAAC,IAAIA,MAAM,IAAI,GAAG;MACjE,IAAIC,SAAS,EAAE;QACb;QACA,IAAI,CAAC1C,OAAO,GAAG;UAAE,GAAGkB,UAAU;UAAE,IAAI,IAAI,CAAClB,OAAO,IAAI,CAAC,CAAC;QAAE,CAAC;QACzD,MAAM2C,UAAU,GAAGH,KAAK,YAAY9C,gBAAgB,GAAG8C,KAAK,CAACG,UAAU,GAAGC,SAAS;QACnF,MAAMC,MAAM,GAAGJ,MAAM,KAAK,GAAG,IAAIE,UAAU,IAAIA,UAAU,GAAG,CAAC,GAAGA,UAAU,GAAG,IAAI,GAAG9C,eAAe;QACnG,IAAI,CAACK,SAAS,GAAGO,IAAI,CAACC,GAAG,CAAC,IAAI,CAACR,SAAS,EAAE,IAAI,CAACW,GAAG,CAAC,CAAC,GAAGgC,MAAM,CAAC;MAChE;MACA;MACA,IAAIJ,MAAM,KAAK,GAAG,EAAE,MAAMD,KAAK;IACjC,CAAC,SAAS;MACR,IAAIpC,UAAU,KAAK,IAAI,CAACA,UAAU,EAAE;QAClC,IAAI,CAACH,QAAQ,GAAG,KAAK;QACrB,IAAI,IAAI,CAACD,OAAO,EAAE,IAAI,CAAC8B,QAAQ,CAAC,CAAC;MACnC;IACF;EACF;EAEQA,QAAQA,CAAA,EAAS;IACvB,IAAI,IAAI,CAAC3B,KAAK,IAAI,IAAI,CAACF,QAAQ,IAAI,CAAC,IAAI,CAACD,OAAO,EAAE;IAClD,IAAI,CAACoC,MAAM,CAAC,CAAC;IACb,MAAMvB,GAAG,GAAG,IAAI,CAACA,GAAG,CAAC,CAAC;IACtB,MAAMiC,OAAO,GAAG,IAAI,CAAC/B,MAAM,IAAI,CAAC,GAAGF,GAAG,GAAG,IAAI,CAACG,UAAU,GAAG,IAAI,CAACL,QAAQ;IACxE,MAAMoC,KAAK,GAAGtC,IAAI,CAACC,GAAG,CAAC,CAAC,EAAE,IAAI,CAACR,SAAS,GAAGW,GAAG,EAAEiC,OAAO,GAAGjC,GAAG,CAAC;IAC9D,IAAI,CAACV,KAAK,GAAG6C,UAAU,CAAC,MAAM;MAC5B,IAAI,CAAC7C,KAAK,GAAG,IAAI;MACjB,IAAI,CAAC8C,KAAK,CAAC,CAAC;IACd,CAAC,EAAEF,KAAK,CAAC;EACX;EAEQE,KAAKA,CAAA,EAAS;IACpB,IAAI,IAAI,CAAChD,QAAQ,IAAI,CAAC,IAAI,CAACD,OAAO,EAAE;IACpC,IAAI,IAAI,CAACa,GAAG,CAAC,CAAC,GAAG,IAAI,CAACX,SAAS,IAAI,CAAC,IAAI,CAAC2B,SAAS,CAAC,CAAC,EAAE;MACpD,IAAI,CAACC,QAAQ,CAAC,CAAC;MACf;IACF;IACA,IAAI,CAACC,WAAW,CAAC,CAAC,CAACmB,KAAK,CAAEV,KAAK,IAAK;MAClCW,OAAO,CAACC,IAAI,CAAC,kCAAkC,EAAEZ,KAAK,CAAC;IACzD,CAAC,CAAC;EACJ;EAEQN,UAAUA,CAAA,EAAS;IACzB,IAAI,IAAI,CAAC/B,KAAK,EAAEkD,YAAY,CAAC,IAAI,CAAClD,KAAK,CAAC;IACxC,IAAI,CAACA,KAAK,GAAG,IAAI;EACnB;AACF","ignoreList":[]}

package/lib/module/state/widget-store.js

@@ -24,9 +24,10 @@ import { clearRetainedState } from "../ui/hooks/use-retained-state.js";
 import { canRetryMessage, isLocalMessage } from "../ui/utils/conversations.js";
 import { stripHtml } from "../ui/utils/html.js";
 import { setOpenUrlHandler } from "../ui/utils/safe-url.js";
+import { UserUpdateQueue } from "./user-update-queue.js";
 
 /** Sent on every init; must match `package.json` (tests/version.test.js checks). */
-const SDK_VERSION = '@repzo/widget-react-native@1.4.0';
+const SDK_VERSION = '@repzo/widget-react-native@1.5.0';
 
 /** The platform this session reports — mobile sessions get the Mobile SDKs overrides. */
 function sessionPlatform() {
@@ -124,6 +125,11 @@ const USER_SCOPED_STATE = {
 };
 export class WidgetStore {
   client = new WidgetApiClient();
+
+  /** Paces `updateUser()` — see `boot({ throttleUpdateUser })`. */
+  userUpdates = new UserUpdateQueue(customAttributes => this.client.identify({
+    customAttributes
+  }));
   events = new EventEmitter();
   push = new PushManager(this.client, conversationId => {
     void this.openConversation(conversationId);
@@ -144,6 +150,8 @@ export class WidgetStore {
   photoAlbumsEnabled = true;
   /** `boot({ youPrefix })` — "You:" before the visitor's own newest message in the lists. */
   youPrefixEnabled = true;
+  /** `boot({ throttleUpdateUser })` — skip unchanged `updateUser()` values and pace the rest. */
+  throttleUpdateUserEnabled = true;
 
   /** Posts whose view was reported this session (the server also dedupes per day). */
   viewedPostIds = new Set();
@@ -356,6 +364,9 @@ export class WidgetStore {
     }
     if (options.photoAlbums !== undefined) this.photoAlbumsEnabled = options.photoAlbums !== false;
     if (options.youPrefix !== undefined) this.youPrefixEnabled = options.youPrefix !== false;
+    if (options.throttleUpdateUser !== undefined) {
+      this.throttleUpdateUserEnabled = options.throttleUpdateUser !== false;
+    }
     if (options.posts !== undefined) {
       const wasEnabled = this.postsEnabled;
       this.postsEnabled = options.posts !== false;
@@ -526,6 +537,10 @@ export class WidgetStore {
     const onScreenId = this.state.activeConversationId;
     if (onScreenId && this.isThreadOnScreen(onScreenId)) delete unreadByConversation[onScreenId];
     this.persistUnread(unreadByConversation);
+
+    // A new identity (anonymous → signed in) may hold other attributes, so
+    // nothing is skipped as "already sent" for it.
+    if (result.identityId !== this.state.identityId) this.userUpdates.forgetSent();
     this.setState(current => ({
       booted: true,
       loading: false,
@@ -754,9 +769,13 @@ export class WidgetStore {
     if (!this.state.booted) await this.bootPromise;
     const customAttributes = sanitizeAttributes(attributes);
     if (Object.keys(customAttributes).length === 0) return;
-    await this.client.identify({
-      customAttributes
-    });
+    if (!this.throttleUpdateUserEnabled) {
+      await this.client.identify({
+        customAttributes
+      });
+      return;
+    }
+    await this.userUpdates.update(customAttributes);
   }
 
   /**
@@ -768,6 +787,7 @@ export class WidgetStore {
     this.loggedOut = true;
     this.currentUser = null;
     this.pendingConversationId = null;
+    this.userUpdates.reset();
     this.realtime.close();
     this.clearTypingTimer();
     this.resetThreadTracking();
@@ -799,6 +819,8 @@ export class WidgetStore {
   }
   async wipeSessionUnguarded() {
     this.realtime.close();
+    // Attributes waiting for the old visitor must never reach the next one.
+    this.userUpdates.reset();
     this.clearTypingTimer();
     this.resetThreadTracking();
     this.appStateSubscription?.remove();
@@ -2609,6 +2631,7 @@ export class WidgetStore {
   // ─── Teardown (tests / hot reload) ──────────────────────────────────────
 
   destroy() {
+    this.userUpdates.destroy();
     this.clearPostRecheck();
     this.clearPostThanks();
     this.realtime.close();