@remit/web-client 0.0.7 → 0.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/web-client",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "type": "module",
   "description": "Remit web client, published as composable primitives — the app shell, auth shells, and runtime config. A distributor imports what it composes and bundles it.",
   "exports": {

package/src/hooks/useStaleAccountSync.test.ts

@@ -7,7 +7,9 @@ import {
 	__resetStaleAccountSyncGuard,
 	handleBackgroundSyncFailure,
 	hasPollIntervalElapsed,
+	MIN_POLL_INTERVAL_MS,
 	POLL_INTERVAL_MS,
+	resolvePollIntervalMs,
 	STALENESS_THRESHOLD_MS,
 	selectPollableAccountIds,
 	selectStaleAccountIds,
@@ -104,6 +106,35 @@ describe("POLL_INTERVAL_MS", () => {
 	});
 });
 
+describe("resolvePollIntervalMs", () => {
+	// This poll shares POST /sync with the refresh control, and that endpoint's
+	// triggers skip the server's per-mailbox freshness gate
+	// (MAILBOX_FRESHNESS_MS in imap-worker's sync-mailboxes fan-out). A timer is
+	// not a person: without this floor, configuring a sub-window interval turns
+	// every tick into a full folder-by-folder re-enumeration for every open
+	// account, which is exactly the fan-out storm the gate prevents. The floor
+	// is what stops a config value from reintroducing it.
+	test("never returns less than the server's freshness window", () => {
+		assert.equal(resolvePollIntervalMs("10"), MIN_POLL_INTERVAL_MS);
+		assert.equal(resolvePollIntervalMs("59"), MIN_POLL_INTERVAL_MS);
+	});
+
+	test("matches the freshness window the fan-out gate uses", () => {
+		// Keep in step with MAILBOX_FRESHNESS_MS in
+		// packages/imap-worker/src/handlers/sync-mailboxes.ts.
+		assert.equal(MIN_POLL_INTERVAL_MS, 60_000);
+	});
+
+	test("honours a configured interval above the floor", () => {
+		assert.equal(resolvePollIntervalMs("900"), 900_000);
+	});
+
+	test("falls back to the default when unset or unparseable", () => {
+		assert.equal(resolvePollIntervalMs(undefined), 5 * 60 * 1000);
+		assert.equal(resolvePollIntervalMs("not-a-number"), 5 * 60 * 1000);
+	});
+});
+
 describe("hasPollIntervalElapsed", () => {
 	test("is false immediately after a poll", () => {
 		assert.equal(hasPollIntervalElapsed(NOW, NOW, 60_000), false);

package/src/hooks/useStaleAccountSync.ts

@@ -25,16 +25,42 @@ const parsePositiveIntSeconds = (
 	return Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
 };
 
+/**
+ * Floor for the poll interval, matching `MAILBOX_FRESHNESS_MS` in the
+ * imap-worker's sync-mailboxes fan-out.
+ *
+ * This poll uses POST /sync, the same endpoint as a person pressing refresh,
+ * and that endpoint's triggers skip the server's per-mailbox freshness gate.
+ * A timer is not a person: polling faster than the gate's own window would
+ * make every tick a full folder-by-folder re-enumeration for every open
+ * account — the fan-out storm the gate exists to prevent, reintroduced by a
+ * config value. `mailboxPollIntervalSeconds` can lengthen the interval, never
+ * shorten it past this: below the window there is nothing to gain, since no
+ * mailbox can have become stale in the meantime.
+ */
+export const MIN_POLL_INTERVAL_MS = 60 * 1000;
+
+/**
+ * Resolve the configured poll interval, never returning less than
+ * {@link MIN_POLL_INTERVAL_MS}.
+ */
+export const resolvePollIntervalMs = (
+	configuredSeconds: string | undefined,
+): number =>
+	Math.max(
+		parsePositiveIntSeconds(configuredSeconds, DEFAULT_POLL_INTERVAL_SECONDS) *
+			1000,
+		MIN_POLL_INTERVAL_MS,
+	);
+
 /**
  * Client-side online-poll interval (#1251): while an account's mail is open,
  * the tab re-triggers the same sync the pull-to-refresh path uses on this
  * cadence — the replacement for the server's removed "online tier".
  */
-export const POLL_INTERVAL_MS =
-	parsePositiveIntSeconds(
-		getRuntimeConfig().mailboxPollIntervalSeconds,
-		DEFAULT_POLL_INTERVAL_SECONDS,
-	) * 1000;
+export const POLL_INTERVAL_MS = resolvePollIntervalMs(
+	getRuntimeConfig().mailboxPollIntervalSeconds,
+);
 
 /**
  * Bounded concurrency for the per-poll fan-out across open accounts —