svelte-ag 1.0.56 → 1.0.57

package/dist/lib/api/query/query.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query.svelte.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/query.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAInH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAEnE,qBAAa,KAAK,CAChB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBAyBzC,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,SAAS,EACT,KAAK,EACN,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,CAAC,EAAE;YACL,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C,CAAC;KACH;IAgBK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IA+BxD,IAAI,QAAQ,WAEX;IACD,IAAI,QAAQ,YAEX;IACD,UAAU;IAMV,IAAI,MAAM,gBAET;IACD,IAAI,IAAI,IAAI,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnD;IACD,IAAI,SAAS,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEtD;CACF;AAED,qBAAa,SAAS,CACpB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBA6BnD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAChC,MAAM,EAAE,KAAK,EACb,YAAY,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC;YAmBlC,KAAK;IAOnB;;;OAGG;YACW,eAAe;IAqBvB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;CAkB3F"}
+{"version":3,"file":"query.svelte.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/query.svelte.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAGnH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAGxD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAEnE,qBAAa,KAAK,CAChB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBAyBzC,EACV,IAAI,EACJ,MAAM,EACN,KAAK,EACL,SAAS,EACT,KAAK,EACN,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,SAAS,EAAE,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxC,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,CAAC,EAAE;YACL,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C,CAAC;KACH;IAgBK,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IA+BxD,IAAI,QAAQ,WAEX;IACD,IAAI,QAAQ,YAEX;IACD,UAAU;IAMV,IAAI,MAAM,gBAET;IACD,IAAI,IAAI,IAAI,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEnD;IACD,IAAI,SAAS,IAAI,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,IAAI,CAEtD;CACF;AAED,qBAAa,SAAS,CACpB,GAAG,SAAS,YAAY,EACxB,IAAI,SAAS,GAAG,CAAC,MAAM,CAAC,EACxB,MAAM,SAAS,OAAO,CAAC,GAAG,EAAE;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,CAAC,CAAC,QAAQ,CAAC;;gBA6BnD,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAChC,MAAM,EAAE,KAAK,EACb,YAAY,CAAC,EAAE,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC;YAelC,KAAK;IAOnB;;;OAGG;YACW,eAAe;IAqBvB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;CAkB3F"}

package/dist/lib/api/query/query.svelte.js

@@ -1,6 +1,6 @@
 import { stringify } from 'devalue';
-import PQueue from 'p-queue';
 import { cacheKey } from './utils.svelte.js';
+import { RateLimiter } from './rate.svelte';
 export class Query {
     // -------- Constants --------
     #TIMEOUT = 1000 * 60 * 5; // 5 minutes
@@ -97,11 +97,7 @@ export class Requestor {
         this.#path = path;
         this.#method = method;
         this.#request = request;
-        this.#limiter = new PQueue({
-            concurrency: 5,
-            interval: 100,
-            intervalCap: 1
-        });
+        this.#limiter = new RateLimiter();
         // this.#cache = cache;
         // TODO
         this.#canBatch = batchDetails ? batchDetails.canBatch : () => false;

package/dist/lib/api/query/rate.svelte.d.ts

@@ -0,0 +1,5 @@
+export declare class RateLimiter {
+    #private;
+    add<T>(fn: () => Promise<T>): Promise<T>;
+}
+//# sourceMappingURL=rate.svelte.d.ts.map

package/dist/lib/api/query/rate.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate.svelte.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/rate.svelte.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAW;;IAItB,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAezC"}

package/dist/lib/api/query/rate.svelte.js

@@ -0,0 +1,16 @@
+export class RateLimiter {
+    #nextStart = 0;
+    #interval = 100;
+    add(fn) {
+        const now = Date.now();
+        const startAt = Math.max(now, this.#nextStart);
+        this.#nextStart = startAt + this.#interval;
+        return (async () => {
+            const wait = Math.max(0, startAt - Date.now());
+            if (wait > 0) {
+                await new Promise((resolve) => setTimeout(resolve, wait));
+            }
+            return await fn();
+        })();
+    }
+}

package/dist/lib/api/query/rate.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=rate.unit.test.d.ts.map

package/dist/lib/api/query/rate.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate.unit.test.d.ts","sourceRoot":"","sources":["../../../../src/lib/api/query/rate.unit.test.ts"],"names":[],"mappings":""}

package/dist/lib/api/query/rate.unit.test.js

@@ -0,0 +1,109 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { sleep } from 'radash';
+import { RateLimiter } from './rate.svelte.js';
+describe('RateLimiter', () => {
+    beforeEach(() => {
+        vi.useFakeTimers();
+        vi.setSystemTime(0);
+    });
+    afterEach(() => {
+        vi.useRealTimers();
+        vi.restoreAllMocks();
+    });
+    it('starts the first request immediately', async () => {
+        const limiter = new RateLimiter();
+        const fn = vi.fn().mockResolvedValue('ok');
+        const promise = limiter.add(fn);
+        await Promise.resolve();
+        expect(fn).toHaveBeenCalledTimes(1);
+        await expect(promise).resolves.toBe('ok');
+    });
+    it('spaces simultaneous requests by at least 100ms', async () => {
+        const limiter = new RateLimiter();
+        const starts = [];
+        const makeTask = (label) => vi.fn().mockImplementation(async () => {
+            starts.push(Date.now());
+            await sleep(105);
+            return label;
+        });
+        const p1 = limiter.add(makeTask('a'));
+        const p2 = limiter.add(makeTask('b'));
+        const p3 = limiter.add(makeTask('c'));
+        const p4 = limiter.add(makeTask('d'));
+        const p5 = limiter.add(makeTask('e'));
+        await Promise.resolve();
+        expect(starts).toEqual([0]);
+        await vi.advanceTimersByTimeAsync(99);
+        expect(starts).toEqual([0]);
+        await vi.advanceTimersByTimeAsync(1);
+        expect(starts).toEqual([0, 100]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100, 200]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100, 200, 300]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100, 200, 300, 400]);
+        await vi.runAllTimersAsync();
+        await expect(Promise.all([p1, p2, p3, p4, p5])).resolves.toEqual(['a', 'b', 'c', 'd', 'e']);
+    });
+    it('does not bunch requests together after waiting', async () => {
+        const limiter = new RateLimiter();
+        const starts = [];
+        const task = () => limiter.add(async () => {
+            starts.push(Date.now());
+            await sleep(105);
+        });
+        const p1 = task();
+        const p2 = task();
+        const p3 = task();
+        await Promise.resolve();
+        expect(starts).toEqual([0]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100, 200]);
+        await vi.runAllTimersAsync();
+        await Promise.all([p1, p2, p3]);
+    });
+    it('keeps working after a request fails', async () => {
+        const limiter = new RateLimiter();
+        const starts = [];
+        const p1 = limiter.add(async () => {
+            starts.push(Date.now());
+            await sleep(200);
+            throw new Error('boom');
+        });
+        const p1Expectation = expect(p1).rejects.toThrow('boom');
+        const p2 = limiter.add(async () => {
+            starts.push(Date.now());
+            return 'ok';
+        });
+        await Promise.resolve();
+        expect(starts).toEqual([0]);
+        await vi.advanceTimersByTimeAsync(100);
+        expect(starts).toEqual([0, 100]);
+        await vi.advanceTimersByTimeAsync(100);
+        await p1Expectation;
+        await expect(p2).resolves.toBe('ok');
+    });
+    it('only limits start time, not completion time', async () => {
+        const limiter = new RateLimiter();
+        const starts = [];
+        const p1 = limiter.add(async () => {
+            starts.push(Date.now());
+            await new Promise((r) => setTimeout(r, 1000));
+            return 'slow';
+        });
+        const p2 = limiter.add(async () => {
+            starts.push(Date.now());
+            return 'fast';
+        });
+        await Promise.resolve();
+        expect(starts).toEqual([0]);
+        await vi.advanceTimersByTimeAsync(200);
+        expect(starts).toEqual([0, 100]);
+        await vi.advanceTimersByTimeAsync(900);
+        await expect(p2).resolves.toBe('fast');
+        await expect(p1).resolves.toBe('slow');
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-ag",
-  "version": "1.0.56",
+  "version": "1.0.57",
   "description": "Useful svelte components",
   "bugs": "https://github.com/ageorgeh/svelte-ag/issues",
   "repository": {
@@ -39,6 +39,7 @@
     "lint:fix": "eslint --fix",
     "prepare": "husky",
     "svelte:sync": "svelte-kit sync",
+    "test": "vitest --run",
     "test:e2e": "playwright test",
     "test:e2e:ui": "playwright test --ui",
     "test:e2e:update": "playwright test --update-snapshots",
@@ -53,7 +54,6 @@
     "devalue": "^5.6.4",
     "embla-carousel-svelte": "8.6.0",
     "formsnap": "2.0.1",
-    "p-queue": "^9.1.0",
     "radash": "12.1.1",
     "runed": "0.37.1",
     "svelte-toolbelt": "^0.10.6",

package/src/lib/api/query/query.svelte.ts

@@ -1,11 +1,11 @@
 import type { ApiEndpoints, ApiInput, ApiRequestFunction, ApiSuccessBody, ApiErrorBody, ApiResponse } from 'ts-ag';
 
 import { stringify } from 'devalue';
-import PQueue from 'p-queue';
 import type { Cache } from './cache.svelte';
 
 import { cacheKey } from './utils.svelte.js';
 import type { BatchDetails } from './entrypoint.svelte';
+import { RateLimiter } from './rate.svelte';
 
 export type QueryStatus = 'idle' | 'loading' | 'success' | 'error';
 
@@ -139,7 +139,7 @@ export class Requestor<
   #batchInput: BatchDetails<API, Path, Method>['batchInput'];
   #unBatchOutput: BatchDetails<API, Path, Method>['unBatchOutput'];
 
-  #limiter: PQueue;
+  #limiter: RateLimiter;
   // #cache: Cache;
 
   // -------- State --------
@@ -163,11 +163,7 @@ export class Requestor<
     this.#path = path;
     this.#method = method;
     this.#request = request;
-    this.#limiter = new PQueue({
-      concurrency: 5,
-      interval: 100,
-      intervalCap: 1
-    });
+    this.#limiter = new RateLimiter();
     // this.#cache = cache;
 
     // TODO

package/src/lib/api/query/rate.svelte.ts

@@ -0,0 +1,20 @@
+export class RateLimiter {
+  #nextStart = 0;
+  #interval = 100;
+
+  add<T>(fn: () => Promise<T>): Promise<T> {
+    const now = Date.now();
+    const startAt = Math.max(now, this.#nextStart);
+    this.#nextStart = startAt + this.#interval;
+
+    return (async () => {
+      const wait = Math.max(0, startAt - Date.now());
+
+      if (wait > 0) {
+        await new Promise((resolve) => setTimeout(resolve, wait));
+      }
+
+      return await fn();
+    })();
+  }
+}

package/src/lib/api/query/rate.unit.test.ts

@@ -0,0 +1,149 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { sleep } from 'radash';
+import { RateLimiter } from './rate.svelte.js';
+
+describe('RateLimiter', () => {
+  beforeEach(() => {
+    vi.useFakeTimers();
+    vi.setSystemTime(0);
+  });
+
+  afterEach(() => {
+    vi.useRealTimers();
+    vi.restoreAllMocks();
+  });
+
+  it('starts the first request immediately', async () => {
+    const limiter = new RateLimiter();
+    const fn = vi.fn().mockResolvedValue('ok');
+
+    const promise = limiter.add(fn);
+
+    await Promise.resolve();
+
+    expect(fn).toHaveBeenCalledTimes(1);
+
+    await expect(promise).resolves.toBe('ok');
+  });
+
+  it('spaces simultaneous requests by at least 100ms', async () => {
+    const limiter = new RateLimiter();
+    const starts: number[] = [];
+
+    const makeTask = (label: string) =>
+      vi.fn().mockImplementation(async () => {
+        starts.push(Date.now());
+        await sleep(105);
+        return label;
+      });
+
+    const p1 = limiter.add(makeTask('a'));
+    const p2 = limiter.add(makeTask('b'));
+    const p3 = limiter.add(makeTask('c'));
+    const p4 = limiter.add(makeTask('d'));
+    const p5 = limiter.add(makeTask('e'));
+
+    await Promise.resolve();
+    expect(starts).toEqual([0]);
+
+    await vi.advanceTimersByTimeAsync(99);
+    expect(starts).toEqual([0]);
+
+    await vi.advanceTimersByTimeAsync(1);
+    expect(starts).toEqual([0, 100]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100, 200]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100, 200, 300]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100, 200, 300, 400]);
+
+    await vi.runAllTimersAsync();
+    await expect(Promise.all([p1, p2, p3, p4, p5])).resolves.toEqual(['a', 'b', 'c', 'd', 'e']);
+  });
+
+  it('does not bunch requests together after waiting', async () => {
+    const limiter = new RateLimiter();
+    const starts: number[] = [];
+
+    const task = () =>
+      limiter.add(async () => {
+        starts.push(Date.now());
+        await sleep(105);
+      });
+
+    const p1 = task();
+    const p2 = task();
+    const p3 = task();
+
+    await Promise.resolve();
+    expect(starts).toEqual([0]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100, 200]);
+
+    await vi.runAllTimersAsync();
+    await Promise.all([p1, p2, p3]);
+  });
+
+  it('keeps working after a request fails', async () => {
+    const limiter = new RateLimiter();
+    const starts: number[] = [];
+
+    const p1 = limiter.add(async () => {
+      starts.push(Date.now());
+      await sleep(200);
+      throw new Error('boom');
+    });
+    const p1Expectation = expect(p1).rejects.toThrow('boom');
+
+    const p2 = limiter.add(async () => {
+      starts.push(Date.now());
+      return 'ok';
+    });
+
+    await Promise.resolve();
+    expect(starts).toEqual([0]);
+
+    await vi.advanceTimersByTimeAsync(100);
+    expect(starts).toEqual([0, 100]);
+
+    await vi.advanceTimersByTimeAsync(100);
+
+    await p1Expectation;
+    await expect(p2).resolves.toBe('ok');
+  });
+
+  it('only limits start time, not completion time', async () => {
+    const limiter = new RateLimiter();
+    const starts: number[] = [];
+
+    const p1 = limiter.add(async () => {
+      starts.push(Date.now());
+      await new Promise((r) => setTimeout(r, 1000));
+      return 'slow';
+    });
+
+    const p2 = limiter.add(async () => {
+      starts.push(Date.now());
+      return 'fast';
+    });
+
+    await Promise.resolve();
+    expect(starts).toEqual([0]);
+
+    await vi.advanceTimersByTimeAsync(200);
+    expect(starts).toEqual([0, 100]);
+
+    await vi.advanceTimersByTimeAsync(900);
+
+    await expect(p2).resolves.toBe('fast');
+    await expect(p1).resolves.toBe('slow');
+  });
+});