@rebasepro/client 0.13.0 → 0.13.1-canary.g18cfeb7

package/dist/offline-query.d.ts

@@ -1,7 +1,14 @@
 import { FilterValues, FindResult, LogicalCondition, FilterCondition, OrderByTuple, WhereFilterOp } from "@rebasepro/types";
 import { FindParams } from "./transport";
-/** The server's page size when the caller does not ask for one. */
-export declare const DEFAULT_PAGE_SIZE = 20;
+/**
+ * The server's page size when the caller does not ask for one.
+ *
+ * Re-exported rather than redeclared. This was its own `= 20` — a third
+ * constant of this name in the workspace, next to `@rebasepro/common`'s 200 and
+ * the 50 the REST layer actually applies — and a local copy of a number that
+ * belongs to another process is a number that goes stale silently.
+ */
+export { DEFAULT_LIST_LIMIT as DEFAULT_PAGE_SIZE } from "@rebasepro/types";
 /**
  * Three-way compare with SQL's type coercion but not its collation. Returns
  * `undefined` when the two values are not ordered relative to each other,
@@ -33,7 +40,15 @@ export declare function matchesParams(row: Record<string, unknown>, params?: Fin
  * not shuffle rows between pages.
  */
 export declare function sortRows<M extends Record<string, unknown>>(rows: M[], orderBy?: OrderByTuple): M[];
-/** Resolve `page`/`offset`/`limit` the way the server does. */
+/**
+ * Resolve `page`/`offset`/`limit` the way the server does.
+ *
+ * It did not: this defaulted an absent limit to 20 while `/api/data` pages by
+ * 50, so the same `observe()` answered with 20 rows from the local database and
+ * 50 from the network — a list that changed length depending on which side
+ * answered, with `page` striding differently on each. Delegated now, so the
+ * sentence above is true by construction rather than by agreement.
+ */
 export declare function resolvePagination(params?: FindParams): {
     limit: number;
     offset: number;

package/dist/offline-store.d.ts

@@ -48,9 +48,16 @@ export interface PendingMutation {
     /** Unique, lexicographically sortable identity — also the queue key suffix. */
     mutationId: string;
     collection: string;
-    type: "create" | "createMany" | "update" | "delete";
+    type: "create" | "createMany" | "update" | "updateMany" | "delete" | "deleteMany";
     /** Target row id for update/delete, and the (client-generated) id of an offline create. */
     id?: string | number;
+    /** Target row ids for `deleteMany`. */
+    ids?: (string | number)[];
+    /** `{ id, data }` entries for `updateMany`. */
+    updates?: {
+        id: string | number;
+        data: Record<string, unknown>;
+    }[];
     /**
      * True when the SDK minted this create's id itself. Only such creates may
      * cancel out against a later offline delete: a freshly generated UUID

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/client",
   "type": "module",
-  "version": "0.13.0",
+  "version": "0.13.1-canary.g18cfeb7",
   "description": "HTTP SDK client for the Rebase custom backend",
   "funding": {
     "url": "https://github.com/sponsors/rebaseco"
@@ -29,9 +29,9 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@rebasepro/common": "0.13.0",
-    "@rebasepro/utils": "0.13.0",
-    "@rebasepro/types": "0.13.0"
+    "@rebasepro/common": "0.13.1-canary.g18cfeb7",
+    "@rebasepro/utils": "0.13.1-canary.g18cfeb7",
+    "@rebasepro/types": "0.13.1-canary.g18cfeb7"
   },
   "devDependencies": {
     "@jest/globals": "^30.4.1",

package/src/auth-listener-errors.test.ts

@@ -0,0 +1,57 @@
+import { jest } from "@jest/globals";
+import { createAuth } from "./auth";
+import type { Transport } from "./transport";
+
+/**
+ * What happens to an error thrown by the app's own auth listener.
+ *
+ * `emit` isolates listeners from each other, which is right — one bad handler
+ * must not stop the rest from being told about a sign-in. It also discarded the
+ * error entirely, which is not: the throw came from the *caller's* code, and it
+ * vanished with nothing in the console, so a broken `onAuthStateChange` handler
+ * looked like an event that never fired.
+ *
+ * The socket in this same package already reports these
+ * ("Error in channel handler:"). This was the one listener loop that did not.
+ */
+function transport(): Transport {
+    return {
+        request: jest.fn<any>().mockResolvedValue({}),
+        setToken: jest.fn(),
+        setAuthTokenGetter: jest.fn(),
+        setOnUnauthorized: jest.fn(),
+        baseUrl: "http://localhost:3000",
+        apiPath: "/api",
+        fetchFn: globalThis.fetch,
+        getHeaders: () => ({}),
+        resolveToken: jest.fn<any>().mockResolvedValue(null)
+    } as unknown as Transport;
+}
+
+describe("auth state listeners", () => {
+    let error: ReturnType<typeof jest.spyOn>;
+
+    beforeEach(() => { error = jest.spyOn(console, "error").mockImplementation(() => { /* quiet */ }); });
+    afterEach(() => error.mockRestore());
+
+    it("keeps telling the other listeners when one throws", () => {
+        const auth = createAuth(transport());
+        const second = jest.fn();
+
+        auth.onAuthStateChange(() => { throw new Error("handler blew up"); });
+        auth.onAuthStateChange(second);
+        auth.signOut();
+
+        expect(second).toHaveBeenCalled();
+    });
+
+    it("reports the throw instead of discarding it", () => {
+        const auth = createAuth(transport());
+        auth.onAuthStateChange(() => { throw new Error("handler blew up"); });
+
+        auth.signOut();
+
+        const said = error.mock.calls.map((c: unknown[]) => c.map(String).join(" ")).join("\n");
+        expect(said).toMatch(/handler blew up/);
+    });
+});

package/src/auth-refresh-overflow.test.ts

@@ -0,0 +1,89 @@
+import { jest } from "@jest/globals";
+import { createAuth, createMemoryStorage } from "./auth";
+import type { Transport } from "./transport";
+
+/**
+ * How far ahead the token refresh is allowed to be scheduled.
+ *
+ * `scheduleRefresh` computes `(expiresAt - REFRESH_BUFFER_MS) - Date.now()` and
+ * hands it to `setTimeout`, with a floor for the past and no ceiling. Node and
+ * every browser store that delay in a **32-bit signed integer**: hand them more
+ * than 2,147,483,647 ms — about 24.8 days — and the timer does not wait, it
+ * clamps to 1 ms and fires immediately.
+ *
+ * `auth.accessExpiresIn` is configurable and defaults to `"1h"`, so this is
+ * dormant on a default deployment. Set it to `"30d"` — an ordinary choice for an
+ * internal tool or a kiosk — and every signed-in browser refreshes at once,
+ * receives a token expiring another 30 days out, schedules again, overflows
+ * again: a hot loop against `/auth/refresh`, one per open tab.
+ *
+ * A floor without a ceiling is the tell. Someone already knew the input was
+ * untrusted and bounded one side of it. (Class 23.)
+ */
+const MAX_DELAY = 2_147_483_647;
+
+function transport(): Transport {
+    return {
+        request: jest.fn<any>().mockResolvedValue({}),
+        setToken: jest.fn(),
+        setAuthTokenGetter: jest.fn(),
+        setOnUnauthorized: jest.fn(),
+        baseUrl: "http://localhost:3000",
+        apiPath: "/api",
+        fetchFn: jest.fn<any>().mockResolvedValue({ ok: true, status: 200, json: async () => ({}) }),
+        getHeaders: () => ({}),
+        resolveToken: jest.fn<any>().mockResolvedValue(null)
+    } as unknown as Transport;
+}
+
+/** Storage already holding a session expiring `days` from now. */
+function storageWithSession(days: number) {
+    const storage = createMemoryStorage();
+    storage.setItem("rebase_auth", JSON.stringify({
+        accessToken: "at",
+        refreshToken: "rt",
+        expiresAt: Date.now() + days * 24 * 60 * 60 * 1000,
+        user: { uid: "u1" }
+    }));
+    return storage;
+}
+
+describe("scheduled token refresh", () => {
+    let delays: number[];
+    let realSetTimeout: typeof setTimeout;
+
+    beforeEach(() => {
+        delays = [];
+        realSetTimeout = globalThis.setTimeout;
+        globalThis.setTimeout = ((fn: () => void, ms?: number) => {
+            if (typeof ms === "number") delays.push(ms);
+            return realSetTimeout(() => { /* never run in this test */ }, 0);
+        }) as unknown as typeof setTimeout;
+    });
+
+    afterEach(() => { globalThis.setTimeout = realSetTimeout; });
+
+    it("schedules a normal one-hour token in the ordinary way", () => {
+        createAuth(transport(), { storage: storageWithSession(1 / 24) });
+
+        const scheduled = delays.filter(d => d > 1000);
+        expect(scheduled.length).toBeGreaterThan(0);
+        expect(Math.max(...scheduled)).toBeLessThanOrEqual(MAX_DELAY);
+    });
+
+    it("never asks setTimeout for a delay it cannot hold", () => {
+        // 30 days: 2,592,000,000 ms, past the 32-bit ceiling.
+        createAuth(transport(), { storage: storageWithSession(30) });
+
+        for (const d of delays) expect(d).toBeLessThanOrEqual(MAX_DELAY);
+    });
+
+    it("does not schedule a refresh for one millisecond from now", () => {
+        // The symptom of the overflow: the clamp makes it immediate, and the
+        // refresh that follows schedules another one just as far out.
+        createAuth(transport(), { storage: storageWithSession(90) });
+
+        const immediate = delays.filter(d => d > 0 && d < 1000);
+        expect(immediate).toEqual([]);
+    });
+});

package/src/auth.ts

@@ -89,6 +89,11 @@ export function createAuth(transport: Transport, options?: CreateAuthOptions) {
 
     const STORAGE_KEY = "rebase_auth";
     const REFRESH_BUFFER_MS = 120000;
+    /**
+     * The largest delay `setTimeout` can hold — 2^31 - 1 ms, about 24.8 days.
+     * Anything larger is silently clamped to 1ms by Node and every browser.
+     */
+    const MAX_TIMER_DELAY_MS = 2_147_483_647;
     // Auto-refresh resilience: retry transient failures with exponential backoff
     // (1s, 2s, 4s, … capped) before giving up and signing out.
     const MAX_REFRESH_RETRIES = 5;
@@ -129,7 +134,16 @@ export function createAuth(transport: Transport, options?: CreateAuthOptions) {
 
     function emit(event: AuthChangeEvent, session: RebaseSession | null) {
         for (const fn of listeners) {
-            try { fn(event, session); } catch (e) { /* ignore */ }
+            try {
+                fn(event, session);
+            } catch (e) {
+                // Isolated so one bad handler cannot stop the rest being told —
+                // but reported, because the throw came from the caller's own
+                // code and discarding it made a broken `onAuthStateChange`
+                // handler look like an event that never fired. The socket in
+                // this package already reports handler errors this way.
+                console.error("Error in auth state change listener:", e);
+            }
         }
     }
 
@@ -260,6 +274,21 @@ export function createAuth(transport: Transport, options?: CreateAuthOptions) {
             return;
         }
 
+        // `setTimeout` holds its delay in a 32-bit signed integer. Past
+        // ~24.8 days it does not wait — it clamps to 1ms and fires at once. The
+        // refresh would then land, receive a token expiring just as far out,
+        // schedule again and overflow again: a hot loop against
+        // `/auth/refresh`, one per open tab.
+        //
+        // `auth.accessExpiresIn` is configurable and defaults to "1h", so this
+        // is dormant on a default deployment and immediate on `"30d"` — an
+        // ordinary setting for an internal tool. Re-arm instead of refreshing:
+        // sleep the maximum, then work out again how long is left.
+        if (delay > MAX_TIMER_DELAY_MS) {
+            refreshTimeout = setTimeout(() => scheduleRefresh(expiresAt), MAX_TIMER_DELAY_MS);
+            return;
+        }
+
         refreshTimeout = setTimeout(() => { void attemptScheduledRefresh(0); }, delay);
     }
 

package/src/collection-listen-meta.test.ts

@@ -0,0 +1,105 @@
+import { jest } from "@jest/globals";
+import { DEFAULT_LIST_LIMIT } from "@rebasepro/types";
+import { createCollectionClient } from "./collection";
+import type { FindResult } from "@rebasepro/types";
+import type { Transport } from "./transport";
+import type { RebaseWebSocketClient } from "./websocket";
+
+type Row = { id: string };
+
+/**
+ * `listen()` gets rows off the socket and has to describe the window they came
+ * from itself. Everything it reports is therefore something it decided, and
+ * these tests are about which of those decisions are claims it can support.
+ */
+
+const flush = () => new Promise<void>((r) => setTimeout(r, 0));
+
+function createWs() {
+    let push: ((rows: Record<string, unknown>[]) => void) | undefined;
+    const ws = {
+        listenCollection: (_p: unknown, onUpdate: (rows: Record<string, unknown>[]) => void) => {
+            push = onUpdate;
+            return () => { push = undefined; };
+        }
+    } as unknown as RebaseWebSocketClient;
+    return { ws, push: (rows: Record<string, unknown>[]) => push?.(rows) };
+}
+
+function createTransport(count: () => Promise<unknown>): Transport {
+    return {
+        request: jest.fn<any>((url: string) => {
+            if (url.includes("/count")) return count();
+            return Promise.resolve({ data: [], meta: {} });
+        }),
+        setToken: jest.fn(),
+        setAuthTokenGetter: jest.fn(),
+        setOnUnauthorized: jest.fn(),
+        baseUrl: "http://localhost:3000",
+        apiPath: "/api",
+        fetchFn: globalThis.fetch,
+        getHeaders: () => ({}),
+        resolveToken: jest.fn<any>().mockResolvedValue(null)
+    } as unknown as Transport;
+}
+
+describe("listen() pagination metadata", () => {
+    it("reports the page size the server actually applies when none was requested", async () => {
+        const transport = createTransport(() => Promise.resolve({ count: 3 }));
+        const { ws, push } = createWs();
+        const client = createCollectionClient<Row>(transport, "products", ws);
+
+        const updates: FindResult<Row>[] = [];
+        const stop = client.listen!(undefined, (r) => updates.push(r));
+        push([{ id: "1" }, { id: "2" }, { id: "3" }]);
+        await flush();
+
+        // Not 20. A caller who names no limit gets `DEFAULT_LIST_LIMIT` rows
+        // from the REST layer, so any other number here describes a window the
+        // rows did not come from.
+        expect(updates.at(-1)?.meta.limit).toBe(DEFAULT_LIST_LIMIT);
+        stop!();
+    });
+
+    it("does not shrink the total to one page when the count request fails", async () => {
+        let counts = 0;
+        const transport = createTransport(() => {
+            counts += 1;
+            return counts === 1
+                ? Promise.resolve({ count: 500 })
+                : Promise.reject(new Error("count unavailable"));
+        });
+        const { ws, push } = createWs();
+        const client = createCollectionClient<Row>(transport, "products", ws);
+
+        const updates: FindResult<Row>[] = [];
+        const stop = client.listen!({ limit: 2 }, (r) => updates.push(r));
+
+        push([{ id: "1" }, { id: "2" }]);
+        await flush();
+        expect(updates.at(-1)?.meta.total).toBe(500);
+
+        // The collection did not lose 498 rows because a count request failed.
+        push([{ id: "1" }, { id: "2" }]);
+        await flush();
+        expect(updates.at(-1)?.meta.total).toBe(500);
+        expect(updates.at(-1)?.meta.hasMore).toBe(true);
+        stop!();
+    });
+
+    it("never claims a total below the rows already skipped", async () => {
+        const transport = createTransport(() => Promise.reject(new Error("nope")));
+        const { ws, push } = createWs();
+        const client = createCollectionClient<Row>(transport, "products", ws);
+
+        const updates: FindResult<Row>[] = [];
+        const stop = client.listen!({ limit: 2, offset: 10 }, (r) => updates.push(r));
+        push([{ id: "11" }, { id: "12" }]);
+        await flush();
+
+        // With no count ever obtained the total is unknown, but it cannot be 2:
+        // ten rows were paged past to reach these.
+        expect(updates.at(-1)?.meta.total).toBe(12);
+        stop!();
+    });
+});

package/src/collection-observe.test.ts

@@ -0,0 +1,138 @@
+import { jest } from "@jest/globals";
+import { createCollectionClient, type LiveResult } from "./collection";
+import type { Transport } from "./transport";
+import type { RebaseWebSocketClient } from "./websocket";
+
+type Row = { id: string; name: string };
+
+/**
+ * `observe()` on a client without the offline layer is two sources feeding one
+ * callback: a one-shot `find()` and a realtime subscription. Neither of these
+ * tests is about the sources — they are about what the callback is allowed to
+ * be told, which is the part an app actually depends on.
+ */
+
+function deferred<T>() {
+    let resolve!: (value: T) => void;
+    let reject!: (error: unknown) => void;
+    const promise = new Promise<T>((res, rej) => {
+        resolve = res;
+        reject = rej;
+    });
+    return { promise, resolve, reject };
+}
+
+/** Let every already-queued microtask run. */
+const flush = () => new Promise<void>((r) => setTimeout(r, 0));
+
+function createTransport(handlers: {
+    find?: () => Promise<unknown>;
+    count?: () => Promise<unknown>;
+}): Transport {
+    return {
+        request: jest.fn<any>((url: string) => {
+            if (url.includes("/count")) return handlers.count?.() ?? Promise.resolve({ count: 0 });
+            return handlers.find?.() ?? Promise.resolve({ data: [], meta: {} });
+        }),
+        setToken: jest.fn(),
+        setAuthTokenGetter: jest.fn(),
+        setOnUnauthorized: jest.fn(),
+        baseUrl: "http://localhost:3000",
+        apiPath: "/api",
+        fetchFn: globalThis.fetch,
+        getHeaders: () => ({}),
+        resolveToken: jest.fn<any>().mockResolvedValue(null)
+    } as unknown as Transport;
+}
+
+/** A socket whose collection updates this test drives by hand. */
+function createWs() {
+    let push: ((rows: Record<string, unknown>[]) => void) | undefined;
+    const ws = {
+        listenCollection: (
+            _props: unknown,
+            onUpdate: (rows: Record<string, unknown>[]) => void
+        ) => {
+            push = onUpdate;
+            return () => { push = undefined; };
+        }
+    } as unknown as RebaseWebSocketClient;
+    return {
+        ws,
+        push: (rows: Record<string, unknown>[]) => push?.(rows)
+    };
+}
+
+describe("observe() without the offline layer", () => {
+    it("does not replace a live update with the initial fetch that resolved after it", async () => {
+        // The initial `find()` is in flight for the whole test; the socket
+        // answers first. This is not exotic — `listenCollection` replays cached
+        // rows synchronously when another observer already holds the same
+        // subscription, so a second component observing the same query hits it
+        // every time.
+        const find = deferred<unknown>();
+        const transport = createTransport({
+            find: () => find.promise,
+            count: () => Promise.resolve({ count: 1 })
+        });
+        const { ws, push } = createWs();
+        const client = createCollectionClient<Row>(transport, "products", ws);
+
+        const results: LiveResult<Row>[] = [];
+        const stop = client.observe(undefined, (r) => results.push(r));
+
+        push([{ id: "1", name: "live" }]);
+        await flush();
+
+        find.resolve({ data: [{ id: "1", name: "stale" }], meta: { total: 1 } });
+        await flush();
+
+        expect(results.at(-1)?.data).toEqual([{ id: "1", name: "live" }]);
+        stop();
+    });
+
+    it("de-duplicates emissions, as the contract on observe() states", async () => {
+        const transport = createTransport({
+            find: () => Promise.resolve({ data: [{ id: "1", name: "a" }], meta: { total: 1 } }),
+            count: () => Promise.resolve({ count: 1 })
+        });
+        const { ws, push } = createWs();
+        const client = createCollectionClient<Row>(transport, "products", ws);
+
+        const results: LiveResult<Row>[] = [];
+        const stop = client.observe(undefined, (r) => results.push(r));
+        await flush();
+
+        const afterInitial = results.length;
+
+        // Two socket updates carrying exactly the rows the app already has.
+        push([{ id: "1", name: "a" }]);
+        await flush();
+        push([{ id: "1", name: "a" }]);
+        await flush();
+
+        expect(results.length).toBe(afterInitial);
+
+        // A real change still gets through.
+        push([{ id: "1", name: "b" }]);
+        await flush();
+        expect(results.length).toBe(afterInitial + 1);
+        expect(results.at(-1)?.data).toEqual([{ id: "1", name: "b" }]);
+        stop();
+    });
+
+    it("stops emitting once unsubscribed, including for a fetch still in flight", async () => {
+        const find = deferred<unknown>();
+        const transport = createTransport({ find: () => find.promise });
+        const client = createCollectionClient<Row>(transport, "products");
+
+        const results: LiveResult<Row>[] = [];
+        const stop = client.observe(undefined, (r) => results.push(r));
+        stop();
+
+        find.resolve({ data: [{ id: "1", name: "a" }], meta: { total: 1 } });
+        await flush();
+
+        expect(results).toHaveLength(0);
+    });
+});