@internetarchive/fetch-handler 1.0.1 → 1.1.0-webdev-7731.2

package/test/fetch-retrier.test.ts

@@ -1,17 +1,16 @@
 import { expect } from '@open-wc/testing';
 import sinon from 'sinon';
-import { FetchRetrier } from '../src/utils/fetch-retrier';
+import { FetchRetrier } from '../src/fetch-retry/fetch-retrier';
 import { MockAnalyticsHandler } from './mocks/mock-analytics-handler';
+import { MockRetryConfig } from './mocks/mock-retry-config';
 
 describe('FetchRetrier', () => {
   let fetchStub: sinon.SinonStub;
-  let sleepStub: sinon.SinonStub;
   let analytics: MockAnalyticsHandler;
 
   beforeEach(() => {
     analytics = new MockAnalyticsHandler();
     fetchStub = sinon.stub(globalThis, 'fetch');
-    sleepStub = sinon.stub().resolves(); // stubbed promisedSleep
   });
 
   afterEach(() => {
@@ -22,30 +21,57 @@ describe('FetchRetrier', () => {
     fetchStub.resolves(new Response('ok', { status: 200 }));
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      sleepFn: sleepStub,
+      retryConfiguration: new MockRetryConfig(),
     });
 
     const res = await retrier.fetchRetry('https://foo.org/data');
 
     expect(res.status).to.equal(200);
     expect(fetchStub.callCount).to.equal(1);
-    expect(sleepStub.callCount).to.equal(0);
     expect(analytics.events.length).to.equal(0);
   });
 
+  it('does not retry on 4xx and logs event', async () => {
+    fetchStub.resolves(new Response('forbidden', { status: 403 }));
+    const retrier = new FetchRetrier({
+      analyticsHandler: analytics,
+    });
+
+    const res = await retrier.fetchRetry('https://foo.org/403');
+
+    expect(res.status).to.equal(403);
+    expect(fetchStub.callCount).to.equal(1);
+    expect(analytics.events[0].action).to.equal('status4xxResponse');
+  });
+
   it('does not retry on 404 and logs event', async () => {
     fetchStub.resolves(new Response('not found', { status: 404 }));
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      sleepFn: sleepStub,
     });
 
     const res = await retrier.fetchRetry('https://foo.org/404');
 
     expect(res.status).to.equal(404);
     expect(fetchStub.callCount).to.equal(1);
-    expect(sleepStub.callCount).to.equal(0);
-    expect(analytics.events[0].action).to.equal('status404NotRetrying');
+    expect(analytics.events[0].action).to.equal('status4xxResponse');
+  });
+
+  it('retries on 4xx if shouldRetry is true in ApiRequestInit', async () => {
+    fetchStub.onCall(0).resolves(new Response('bad request', { status: 400 }));
+    fetchStub.onCall(1).resolves(new Response('ok', { status: 200 }));
+
+    const retrier = new FetchRetrier({
+      analyticsHandler: analytics,
+    });
+
+    const res = await retrier.fetchRetry('https://foo.org/should-retry', {
+      retryConfig: new MockRetryConfig(),
+    });
+
+    expect(res.status).to.equal(200);
+    expect(fetchStub.callCount).to.equal(2);
+    expect(analytics.events.some(e => e.action === 'retryingFetch')).to.be.true;
   });
 
   it('retries on 500 and logs retry/failure events', async () => {
@@ -55,16 +81,13 @@ describe('FetchRetrier', () => {
 
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 2,
-      retryDelay: 1,
-      sleepFn: sleepStub,
+      retryConfiguration: new MockRetryConfig(),
     });
 
     const res = await retrier.fetchRetry('https://foo.org/fail');
 
     expect(res.status).to.equal(500);
     expect(fetchStub.callCount).to.equal(3);
-    expect(sleepStub.callCount).to.equal(2);
     expect(analytics.events.some(e => e.action === 'retryingFetch')).to.be.true;
     expect(analytics.events.some(e => e.action === 'fetchFailed')).to.be.true;
   });
@@ -75,16 +98,13 @@ describe('FetchRetrier', () => {
 
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 1,
-      retryDelay: 1,
-      sleepFn: sleepStub,
+      retryConfiguration: new MockRetryConfig(),
     });
 
     const res = await retrier.fetchRetry('https://foo.org/retry');
 
     expect(res.status).to.equal(200);
     expect(fetchStub.callCount).to.equal(2);
-    expect(sleepStub.calledOnce).to.be.true;
     expect(analytics.events.some(e => e.action === 'retryingFetch')).to.be.true;
   });
 
@@ -93,20 +113,17 @@ describe('FetchRetrier', () => {
 
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 1,
-      retryDelay: 1,
-      sleepFn: sleepStub,
+      retryConfiguration: new MockRetryConfig(),
     });
 
     try {
       await retrier.fetchRetry('https://foo.org/networkfail');
       throw new Error('Should have thrown');
-    } catch (err: any) {
-      expect(err.message).to.equal('Boom');
+    } catch (err: unknown) {
+      expect((err as Error).message).to.equal('Boom');
     }
 
-    expect(fetchStub.callCount).to.equal(2);
-    expect(sleepStub.callCount).to.equal(1);
+    expect(fetchStub.callCount).to.equal(3);
     expect(analytics.events.some(e => e.action === 'fetchFailed')).to.be.true;
   });
 
@@ -116,19 +133,16 @@ describe('FetchRetrier', () => {
 
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 2,
-      sleepFn: sleepStub,
     });
 
     try {
       await retrier.fetchRetry('https://foo.org/blocked');
       throw new Error('Should have thrown');
-    } catch (err: any) {
+    } catch (err: unknown) {
       expect(err).to.equal(blockerError);
     }
 
     expect(fetchStub.callCount).to.equal(1);
-    expect(sleepStub.callCount).to.equal(0);
     expect(
       analytics.events.some(
         e => e.action === 'contentBlockerDetectedNotRetrying',
@@ -136,38 +150,65 @@ describe('FetchRetrier', () => {
     ).to.be.true;
   });
 
-  it('calls sleepFn on retry with correct delay', async () => {
-    fetchStub.onCall(0).resolves(new Response(null, { status: 500 }));
-    fetchStub.onCall(1).resolves(new Response('ok', { status: 200 }));
+  it('sleeps for each retry attempt', async () => {
+    const retryConfig = new MockRetryConfig();
+    const retryDelaySpy = sinon.spy(retryConfig, 'retryDelay');
+    fetchStub.resolves(new Response(null, { status: 500 }));
 
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 2,
-      retryDelay: 1234,
-      sleepFn: sleepStub,
+      retryConfiguration: retryConfig,
     });
 
-    const res = await retrier.fetchRetry('https://foo.org/retry-with-sleep');
+    const res = await retrier.fetchRetry('https://foo.org/retry-fail');
 
-    expect(res.status).to.equal(200);
-    expect(sleepStub.calledOnce).to.be.true;
-    expect(sleepStub.calledWith(1234)).to.be.true;
+    expect(res.status).to.equal(500);
+    expect(fetchStub.callCount).to.equal(3);
+    expect(retryDelaySpy.callCount).to.equal(2);
   });
 
-  it('sleeps for each retry attempt', async () => {
-    fetchStub.resolves(new Response(null, { status: 500 }));
+  it('does not retry 5xx when NoRetryConfiguration is used', async () => {
+    fetchStub.resolves(new Response('server error', { status: 500 }));
+    const retrier = new FetchRetrier({
+      analyticsHandler: analytics,
+      retryConfiguration: new (class {
+        shouldRetry() {
+          return false;
+        }
+        retryDelay() {
+          return 0;
+        }
+      })(),
+    });
 
+    const res = await retrier.fetchRetry('https://foo.org/no-retry-500');
+    expect(res.status).to.equal(500);
+    expect(fetchStub.callCount).to.equal(1);
+    expect(analytics.events.some(e => e.action === 'fetchFailed')).to.be.true;
+  });
+
+  it('does not retry on error when configuration disables retries', async () => {
+    fetchStub.rejects(new Error('Immediate failure'));
     const retrier = new FetchRetrier({
       analyticsHandler: analytics,
-      retryCount: 2,
-      retryDelay: 300,
-      sleepFn: sleepStub,
+      retryConfiguration: new (class {
+        shouldRetry() {
+          return false;
+        }
+        retryDelay() {
+          return 0;
+        }
+      })(),
     });
 
-    const res = await retrier.fetchRetry('https://foo.org/retry-fail');
+    try {
+      await retrier.fetchRetry('https://foo.org/no-retry-error');
+      throw new Error('Should have thrown');
+    } catch (err: unknown) {
+      expect((err as Error).message).to.equal('Immediate failure');
+    }
 
-    expect(res.status).to.equal(500);
-    expect(sleepStub.callCount).to.equal(2);
-    expect(sleepStub.alwaysCalledWith(300)).to.be.true;
+    expect(fetchStub.callCount).to.equal(1);
+    expect(analytics.events.some(e => e.action === 'fetchFailed')).to.be.true;
   });
 });

package/test/legacy-args.test.ts

@@ -0,0 +1,24 @@
+import { expect } from '@open-wc/testing';
+import { legacyArgsAsFetchOptions } from '../src/fetch-retry/legacy-args';
+import type { FetchOptions } from '../src/fetch-options';
+
+describe('legacyArgsAsFetchOptions', () => {
+  it('wraps RequestInit into FetchOptions', () => {
+    const init: RequestInit = { method: 'PUT' };
+    const fo = legacyArgsAsFetchOptions(init);
+    expect(fo).to.deep.equal({ requestInit: init });
+  });
+
+  it('returns FetchOptions unchanged', () => {
+    const options: FetchOptions = {
+      requestInit: { headers: { foo: 'bar' } },
+    };
+    const fo = legacyArgsAsFetchOptions(options);
+    expect(fo).to.equal(options);
+  });
+
+  it('returns undefined when no options provided', () => {
+    const fo = legacyArgsAsFetchOptions(undefined);
+    expect(fo).to.equal(undefined);
+  });
+});

package/test/mocks/mock-fetch-retrier.ts

@@ -0,0 +1,22 @@
+import type { FetchOptions } from '../../src/fetch-options';
+import type { FetchRetrierInterface } from '../../src/fetch-retry/fetch-retrier';
+import type { RetryConfiguring } from '../../src/fetch-retry/configuration/retry-configuring';
+import { legacyArgsAsFetchOptions } from '../../src/fetch-retry/legacy-args';
+
+export class MockFetchRetrier implements FetchRetrierInterface {
+  requestInfo?: RequestInfo;
+  init?: RequestInit;
+  retries?: number;
+  retryConfig?: RetryConfiguring;
+
+  async fetchRetry(
+    request: RequestInfo,
+    options?: RequestInit | FetchOptions,
+  ): Promise<Response> {
+    const fetchOptions = legacyArgsAsFetchOptions(options);
+    this.init = fetchOptions?.requestInit;
+    this.retryConfig = fetchOptions?.retryConfig;
+    this.requestInfo = request;
+    return new Response(JSON.stringify({ boop: 'snoot' }), { status: 200 });
+  }
+}

package/test/mocks/mock-retry-config.ts

@@ -0,0 +1,19 @@
+import type { RetryConfiguring } from '../../src/fetch-retry/configuration/retry-configuring';
+
+export class MockRetryConfig implements RetryConfiguring {
+  mockRetryCount: number = 2;
+
+  mockRetryDelay: number = 0;
+
+  shouldRetry(
+    response: Response | null,
+    retryNumber: number,
+    error?: unknown,
+  ): boolean {
+    return retryNumber < this.mockRetryCount;
+  }
+
+  retryDelay(): number {
+    return this.mockRetryDelay;
+  }
+}

package/test/no-retry-config.test.ts

@@ -0,0 +1,14 @@
+import { expect } from '@open-wc/testing';
+import { NoRetryConfiguration } from '../src/fetch-retry/configuration/no-retry-configuration';
+
+describe('NoRetryConfiguration', () => {
+  it('should not retry', async () => {
+    const config = new NoRetryConfiguration();
+    expect(config.shouldRetry()).to.be.false;
+  });
+
+  it('has no delay', async () => {
+    const config = new NoRetryConfiguration();
+    expect(config.retryDelay()).to.equal(0);
+  });
+});

package/test/retrier-legacy-args.test.ts

@@ -0,0 +1,28 @@
+import { expect } from '@open-wc/testing';
+import { legacyArgsAsFetchOptions } from '../src/fetch-retry/legacy-args';
+import { MockRetryConfig } from './mocks/mock-retry-config';
+
+describe('FetchRetrier Legacy Args', () => {
+  it('can convert RequestInit to FetchOptions', async () => {
+    const options = legacyArgsAsFetchOptions({ method: 'GET' });
+    expect(options).to.deep.equal({
+      requestInit: {
+        method: 'GET',
+      },
+    });
+  });
+
+  it('leaves FetchOptions unchanged', async () => {
+    const retryConfig = new MockRetryConfig();
+    const options = legacyArgsAsFetchOptions({
+      requestInit: { method: 'POST' },
+      retryConfig: retryConfig,
+    });
+    expect(options).to.deep.equal({
+      requestInit: {
+        method: 'POST',
+      },
+      retryConfig: retryConfig,
+    });
+  });
+});

package/web-test-runner.config.mjs

@@ -7,9 +7,11 @@ export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
   files: 'dist/test/**/*.test.js',
 
   /** Resolve bare module imports */
-  nodeResolve: {
-    exportConditions: ['browser', 'development'],
-  },
+  nodeResolve: { exportConditions: ['browser', 'development'] },
+
+  coverageConfig: { include: ['**/src/**'] },
+
+  testsFinishTimeout: 5000,
 
   /** Filter out lit dev mode logs */
   filterBrowserLogs(log) {

package/dist/src/ia-fetch-handler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ia-fetch-handler.js","sourceRoot":"","sources":["../../src/ia-fetch-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAyB,MAAM,uBAAuB,CAAC;AAG5E;;;;;GAKG;AACH,MAAM,OAAO,cAAc;IAOzB,YAAY,OAIX;QARO,iBAAY,GAA0B,IAAI,YAAY,EAAE,CAAC;QAS/D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACpE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACpE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY,EAAE,CAAC;YAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QAC3C,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,kBAAkB,CACtB,IAAY,EACZ,OAEC;QAED,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,gBAAgB,CACpB,GAAW,EACX,OAKC;QAED,MAAM,WAAW,GAAgB,EAAE,CAAC;QACpC,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB;YAAE,WAAW,CAAC,WAAW,GAAG,SAAS,CAAC;QACrE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;YAAE,WAAW,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACzD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI;YAAE,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACnD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;YAAE,WAAW,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC5D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAS,CAAC;IACnB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,KAAK,CAAC,KAAkB,EAAE,IAAkB;QAChD,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,SAAS,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,IAAI,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,GAAG,EAAE,CAAC;YACrC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACK,eAAe,CACrB,KAAkB,EAClB,MAA8B;QAE9B,MAAM,SAAS,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;QAChE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAErD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACnC,CAAC;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,GAAG,CAAC,IAAI,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,UAAU,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAChD,OAAO,UAAU,CAAC;QACpB,CAAC;IACH,CAAC;CACF","sourcesContent":["import { FetchRetrier, FetchRetrierInterface } from './utils/fetch-retrier';\nimport type { FetchHandlerInterface } from './fetch-handler-interface';\n\n/**\n * The FetchHandler adds some common helpers:\n * - retry the request if it fails\n * - add `reCache=1` to the request if it's in the current url so the backend sees it\n * - add convenience method for fetching/decoding an API response by just the path\n */\nexport class IaFetchHandler implements FetchHandlerInterface {\n  private iaApiBaseUrl?: string;\n\n  private fetchRetrier: FetchRetrierInterface = new FetchRetrier();\n\n  private searchParams?: string;\n\n  constructor(options?: {\n    iaApiBaseUrl?: string;\n    fetchRetrier?: FetchRetrierInterface;\n    searchParams?: string;\n  }) {\n    if (options?.iaApiBaseUrl) this.iaApiBaseUrl = options.iaApiBaseUrl;\n    if (options?.fetchRetrier) this.fetchRetrier = options.fetchRetrier;\n    if (options?.searchParams) {\n      this.searchParams = options.searchParams;\n    } else {\n      this.searchParams = window.location.search;\n    }\n  }\n\n  /** @inheritdoc */\n  async fetchIAApiResponse<T>(\n    path: string,\n    options?: {\n      includeCredentials?: boolean;\n    },\n  ): Promise<T> {\n    const url = `${this.iaApiBaseUrl}${path}`;\n    return this.fetchApiResponse(url, options);\n  }\n\n  /** @inheritdoc */\n  async fetchApiResponse<T>(\n    url: string,\n    options?: {\n      includeCredentials?: boolean;\n      method?: string;\n      body?: BodyInit;\n      headers?: HeadersInit;\n    },\n  ): Promise<T> {\n    const requestInit: RequestInit = {};\n    if (options?.includeCredentials) requestInit.credentials = 'include';\n    if (options?.method) requestInit.method = options.method;\n    if (options?.body) requestInit.body = options.body;\n    if (options?.headers) requestInit.headers = options.headers;\n    const response = await this.fetch(url, requestInit);\n    const json = await response.json();\n    return json as T;\n  }\n\n  /** @inheritdoc */\n  async fetch(input: RequestInfo, init?: RequestInit): Promise<Response> {\n    let finalInput = input;\n    const urlParams = new URLSearchParams(this.searchParams);\n    if (urlParams.get('reCache') === '1') {\n      finalInput = this.addSearchParams(input, { reCache: '1' });\n    }\n    return this.fetchRetrier.fetchRetry(finalInput, init);\n  }\n\n  /**\n   * Since RequestInfo can be either a `Request` or `string`, we need to change\n   * the way we add search params to it depending on the input.\n   */\n  private addSearchParams(\n    input: RequestInfo,\n    params: Record<string, string>,\n  ): RequestInfo {\n    const urlString = typeof input === 'string' ? input : input.url;\n    const url = new URL(urlString, window.location.href);\n\n    for (const [key, value] of Object.entries(params)) {\n      url.searchParams.set(key, value);\n    }\n\n    if (typeof input === 'string') {\n      return url.href;\n    } else {\n      const newRequest = new Request(url.href, input);\n      return newRequest;\n    }\n  }\n}\n"]}

package/dist/src/utils/fetch-retrier.js

@@ -1,94 +0,0 @@
-import { AnalyticsHandler } from '@internetarchive/analytics-manager';
-import { promisedSleep } from './promised-sleep';
-/** @inheritdoc */
-export class FetchRetrier {
-    constructor(options) {
-        this.analyticsHandler = new AnalyticsHandler({ enableAnalytics: true });
-        this.sleep = promisedSleep; // default sleep function
-        this.retryCount = 2;
-        this.retryDelay = 1000;
-        this.eventCategory = 'offshootFetchRetry';
-        if (options === null || options === void 0 ? void 0 : options.analyticsHandler)
-            this.analyticsHandler = options.analyticsHandler;
-        if (options === null || options === void 0 ? void 0 : options.retryCount)
-            this.retryCount = options.retryCount;
-        if (options === null || options === void 0 ? void 0 : options.retryDelay)
-            this.retryDelay = options.retryDelay;
-        if (options === null || options === void 0 ? void 0 : options.sleepFn)
-            this.sleep = options.sleepFn; // override if provided
-    }
-    /** @inheritdoc */
-    async fetchRetry(requestInfo, init, retries = this.retryCount) {
-        const urlString = typeof requestInfo === 'string' ? requestInfo : requestInfo.url;
-        const retryNumber = this.retryCount - retries + 1;
-        try {
-            const response = await fetch(requestInfo, init);
-            if (response.ok)
-                return response;
-            // don't retry on a 404 since this will never succeed
-            if (response.status === 404) {
-                this.log404Event(urlString);
-                return response;
-            }
-            if (retries > 0) {
-                await this.sleep(this.retryDelay);
-                this.logRetryEvent(urlString, retryNumber, response.statusText, response.status);
-                return this.fetchRetry(requestInfo, init, retries - 1);
-            }
-            this.logFailureEvent(urlString, response.status);
-            return response;
-        }
-        catch (error) {
-            // if a content blocker is detected, log it and don't retry
-            if (this.isContentBlockerError(error)) {
-                this.logContentBlockingEvent(urlString, error);
-                throw error;
-            }
-            if (retries > 0) {
-                await this.sleep(this.retryDelay);
-                // intentionally duplicating the error message here since we want something
-                // in the status code even though we won't have an actual code
-                this.logRetryEvent(urlString, retryNumber, error, error);
-                return this.fetchRetry(requestInfo, init, retries - 1);
-            }
-            this.logFailureEvent(urlString, error);
-            throw error;
-        }
-    }
-    isContentBlockerError(error) {
-        // all of the content blocker errors are `TypeError`
-        if (!(error instanceof TypeError))
-            return false;
-        const message = error.message.toLowerCase();
-        return message.includes('content blocker');
-    }
-    logRetryEvent(urlString, retryNumber, status, code) {
-        this.analyticsHandler.sendEvent({
-            category: this.eventCategory,
-            action: 'retryingFetch',
-            label: `retryNumber: ${retryNumber} / ${this.retryCount}, code: ${code}, status: ${status}, url: ${urlString}`,
-        });
-    }
-    logFailureEvent(urlString, error) {
-        this.analyticsHandler.sendEvent({
-            category: this.eventCategory,
-            action: 'fetchFailed',
-            label: `error: ${error}, url: ${urlString}`,
-        });
-    }
-    log404Event(urlString) {
-        this.analyticsHandler.sendEvent({
-            category: this.eventCategory,
-            action: 'status404NotRetrying',
-            label: `url: ${urlString}`,
-        });
-    }
-    logContentBlockingEvent(urlString, error) {
-        this.analyticsHandler.sendEvent({
-            category: this.eventCategory,
-            action: 'contentBlockerDetectedNotRetrying',
-            label: `error: ${error}, url: ${urlString}`,
-        });
-    }
-}
-//# sourceMappingURL=fetch-retrier.js.map

package/dist/src/utils/fetch-retrier.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetch-retrier.js","sourceRoot":"","sources":["../../../src/utils/fetch-retrier.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAqBjD,kBAAkB;AAClB,MAAM,OAAO,YAAY;IAQvB,YAAY,OAKX;QAZO,qBAAgB,GAAG,IAAI,gBAAgB,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;QACnE,UAAK,GAAG,aAAa,CAAC,CAAC,yBAAyB;QAEhD,eAAU,GAAG,CAAC,CAAC;QAEf,eAAU,GAAG,IAAI,CAAC;QAwET,kBAAa,GAAG,oBAAoB,CAAC;QAhEpD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB;YAC3B,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACnD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;YAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAC9D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;YAAE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAC9D,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;YAAE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,uBAAuB;IAC7E,CAAC;IAED,kBAAkB;IACX,KAAK,CAAC,UAAU,CACrB,WAAwB,EACxB,IAAkB,EAClB,UAAkB,IAAI,CAAC,UAAU;QAEjC,MAAM,SAAS,GACb,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC;QAClE,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,GAAG,OAAO,GAAG,CAAC,CAAC;QAElD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAChD,IAAI,QAAQ,CAAC,EAAE;gBAAE,OAAO,QAAQ,CAAC;YACjC,qDAAqD;YACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC5B,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC5B,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAClC,IAAI,CAAC,aAAa,CAChB,SAAS,EACT,WAAW,EACX,QAAQ,CAAC,UAAU,EACnB,QAAQ,CAAC,MAAM,CAChB,CAAC;gBACF,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YACjD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,2DAA2D;YAC3D,IAAI,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,uBAAuB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAC/C,MAAM,KAAK,CAAC;YACd,CAAC;YAED,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAClC,2EAA2E;gBAC3E,8DAA8D;gBAC9D,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;YACzD,CAAC;YAED,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACvC,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,KAAc;QAC1C,oDAAoD;QACpD,IAAI,CAAC,CAAC,KAAK,YAAY,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAChD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QAC5C,OAAO,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IAC7C,CAAC;IAIO,aAAa,CACnB,SAAiB,EACjB,WAAmB,EACnB,MAAe,EACf,IAAa;QAEb,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,eAAe;YACvB,KAAK,EAAE,gBAAgB,WAAW,MAAM,IAAI,CAAC,UAAU,WAAW,IAAI,aAAa,MAAM,UAAU,SAAS,EAAE;SAC/G,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAC,SAAiB,EAAE,KAAc;QACvD,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,aAAa;YACrB,KAAK,EAAE,UAAU,KAAK,UAAU,SAAS,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAEO,WAAW,CAAC,SAAiB;QACnC,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,sBAAsB;YAC9B,KAAK,EAAE,QAAQ,SAAS,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAEO,uBAAuB,CAAC,SAAiB,EAAE,KAAc;QAC/D,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAC9B,QAAQ,EAAE,IAAI,CAAC,aAAa;YAC5B,MAAM,EAAE,mCAAmC;YAC3C,KAAK,EAAE,UAAU,KAAK,UAAU,SAAS,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import type { AnalyticsHandlerInterface } from '@internetarchive/analytics-manager';\nimport { AnalyticsHandler } from '@internetarchive/analytics-manager';\nimport { promisedSleep } from './promised-sleep';\n\n/**\n * A class that retries a fetch request.\n */\nexport interface FetchRetrierInterface {\n  /**\n   * Execute a fetch with retry.\n   *\n   * @param requestInfo RequestInfo\n   * @param init Optional RequestInit\n   * @param retries Optional number of retries to attempt\n   * @returns Promise<Response>\n   */\n  fetchRetry(\n    requestInfo: RequestInfo,\n    init?: RequestInit,\n    retries?: number,\n  ): Promise<Response>;\n}\n\n/** @inheritdoc */\nexport class FetchRetrier implements FetchRetrierInterface {\n  private analyticsHandler = new AnalyticsHandler({ enableAnalytics: true });\n  private sleep = promisedSleep; // default sleep function\n\n  private retryCount = 2;\n\n  private retryDelay = 1000;\n\n  constructor(options?: {\n    analyticsHandler?: AnalyticsHandlerInterface;\n    retryCount?: number;\n    retryDelay?: number;\n    sleepFn?: (ms: number) => Promise<void>; // <-- add this!\n  }) {\n    if (options?.analyticsHandler)\n      this.analyticsHandler = options.analyticsHandler;\n    if (options?.retryCount) this.retryCount = options.retryCount;\n    if (options?.retryDelay) this.retryDelay = options.retryDelay;\n    if (options?.sleepFn) this.sleep = options.sleepFn; // override if provided\n  }\n\n  /** @inheritdoc */\n  public async fetchRetry(\n    requestInfo: RequestInfo,\n    init?: RequestInit,\n    retries: number = this.retryCount,\n  ): Promise<Response> {\n    const urlString =\n      typeof requestInfo === 'string' ? requestInfo : requestInfo.url;\n    const retryNumber = this.retryCount - retries + 1;\n\n    try {\n      const response = await fetch(requestInfo, init);\n      if (response.ok) return response;\n      // don't retry on a 404 since this will never succeed\n      if (response.status === 404) {\n        this.log404Event(urlString);\n        return response;\n      }\n      if (retries > 0) {\n        await this.sleep(this.retryDelay);\n        this.logRetryEvent(\n          urlString,\n          retryNumber,\n          response.statusText,\n          response.status,\n        );\n        return this.fetchRetry(requestInfo, init, retries - 1);\n      }\n      this.logFailureEvent(urlString, response.status);\n      return response;\n    } catch (error) {\n      // if a content blocker is detected, log it and don't retry\n      if (this.isContentBlockerError(error)) {\n        this.logContentBlockingEvent(urlString, error);\n        throw error;\n      }\n\n      if (retries > 0) {\n        await this.sleep(this.retryDelay);\n        // intentionally duplicating the error message here since we want something\n        // in the status code even though we won't have an actual code\n        this.logRetryEvent(urlString, retryNumber, error, error);\n        return this.fetchRetry(requestInfo, init, retries - 1);\n      }\n\n      this.logFailureEvent(urlString, error);\n      throw error;\n    }\n  }\n\n  private isContentBlockerError(error: unknown): boolean {\n    // all of the content blocker errors are `TypeError`\n    if (!(error instanceof TypeError)) return false;\n    const message = error.message.toLowerCase();\n    return message.includes('content blocker');\n  }\n\n  private readonly eventCategory = 'offshootFetchRetry';\n\n  private logRetryEvent(\n    urlString: string,\n    retryNumber: number,\n    status: unknown,\n    code: unknown,\n  ) {\n    this.analyticsHandler.sendEvent({\n      category: this.eventCategory,\n      action: 'retryingFetch',\n      label: `retryNumber: ${retryNumber} / ${this.retryCount}, code: ${code}, status: ${status}, url: ${urlString}`,\n    });\n  }\n\n  private logFailureEvent(urlString: string, error: unknown) {\n    this.analyticsHandler.sendEvent({\n      category: this.eventCategory,\n      action: 'fetchFailed',\n      label: `error: ${error}, url: ${urlString}`,\n    });\n  }\n\n  private log404Event(urlString: string) {\n    this.analyticsHandler.sendEvent({\n      category: this.eventCategory,\n      action: 'status404NotRetrying',\n      label: `url: ${urlString}`,\n    });\n  }\n\n  private logContentBlockingEvent(urlString: string, error: unknown) {\n    this.analyticsHandler.sendEvent({\n      category: this.eventCategory,\n      action: 'contentBlockerDetectedNotRetrying',\n      label: `error: ${error}, url: ${urlString}`,\n    });\n  }\n}\n"]}

package/dist/test/ia-fetch-handler.test.js

@@ -1,50 +0,0 @@
-import { expect } from '@open-wc/testing';
-import { IaFetchHandler } from '../src/ia-fetch-handler';
-class MockFetchRetrier {
-    async fetchRetry(requestInfo, init, retries) {
-        this.init = init;
-        this.requestInfo = requestInfo;
-        this.retries = retries;
-        return new Response(JSON.stringify({ boop: 'snoot' }), { status: 200 });
-    }
-}
-describe('Fetch Handler', () => {
-    describe('fetch', () => {
-        it('adds reCache=1 if it is in the current url', async () => {
-            const fetchRetrier = new MockFetchRetrier();
-            const fetchHandler = new IaFetchHandler({
-                fetchRetrier: fetchRetrier,
-                searchParams: '?reCache=1',
-            });
-            await fetchHandler.fetch('https://foo.org/api/v1/snoot');
-            expect(fetchRetrier.requestInfo).to.equal('https://foo.org/api/v1/snoot?reCache=1');
-        });
-    });
-    describe('fetchIAApiResponse', () => {
-        it('prepends the IA basehost to the url when making a request', async () => {
-            const endpoint = '/foo/service/endpoint.php';
-            const fetchRetrier = new MockFetchRetrier();
-            const fetchHandler = new IaFetchHandler({
-                iaApiBaseUrl: 'www.example.com',
-                fetchRetrier: fetchRetrier,
-            });
-            await fetchHandler.fetchIAApiResponse(endpoint);
-            expect(fetchRetrier.requestInfo).to.equal('www.example.com/foo/service/endpoint.php');
-        });
-    });
-    describe('fetchApiResponse', () => {
-        it('adds credentials: include if requested', async () => {
-            const endpoint = '/foo/service/endpoint.php';
-            const fetchRetrier = new MockFetchRetrier();
-            const fetchHandler = new IaFetchHandler({
-                iaApiBaseUrl: 'www.example.com',
-                fetchRetrier: fetchRetrier,
-            });
-            await fetchHandler.fetchApiResponse(endpoint, {
-                includeCredentials: true,
-            });
-            expect(fetchRetrier.init).to.deep.equal({ credentials: 'include' });
-        });
-    });
-});
-//# sourceMappingURL=ia-fetch-handler.test.js.map

package/dist/test/ia-fetch-handler.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ia-fetch-handler.test.js","sourceRoot":"","sources":["../../test/ia-fetch-handler.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAGzD,MAAM,gBAAgB;IAKpB,KAAK,CAAC,UAAU,CACd,WAAwB,EACxB,IAAkB,EAClB,OAAgB;QAEhB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1E,CAAC;CACF;AAED,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,YAAY,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;gBACtC,YAAY,EAAE,YAAY;gBAC1B,YAAY,EAAE,YAAY;aAC3B,CAAC,CAAC;YACH,MAAM,YAAY,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;YACzD,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CACvC,wCAAwC,CACzC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YACzE,MAAM,QAAQ,GAAG,2BAA2B,CAAC;YAC7C,MAAM,YAAY,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;gBACtC,YAAY,EAAE,iBAAiB;gBAC/B,YAAY,EAAE,YAAY;aAC3B,CAAC,CAAC;YACH,MAAM,YAAY,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;YAChD,MAAM,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CACvC,0CAA0C,CAC3C,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,QAAQ,GAAG,2BAA2B,CAAC;YAC7C,MAAM,YAAY,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAC5C,MAAM,YAAY,GAAG,IAAI,cAAc,CAAC;gBACtC,YAAY,EAAE,iBAAiB;gBAC/B,YAAY,EAAE,YAAY;aAC3B,CAAC,CAAC;YACH,MAAM,YAAY,CAAC,gBAAgB,CAAC,QAAQ,EAAE;gBAC5C,kBAAkB,EAAE,IAAI;aACzB,CAAC,CAAC;YACH,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expect } from '@open-wc/testing';\nimport { IaFetchHandler } from '../src/ia-fetch-handler';\nimport { FetchRetrierInterface } from '../src/utils/fetch-retrier';\n\nclass MockFetchRetrier implements FetchRetrierInterface {\n  requestInfo?: RequestInfo;\n  init?: RequestInit;\n  retries?: number;\n\n  async fetchRetry(\n    requestInfo: RequestInfo,\n    init?: RequestInit,\n    retries?: number,\n  ): Promise<Response> {\n    this.init = init;\n    this.requestInfo = requestInfo;\n    this.retries = retries;\n    return new Response(JSON.stringify({ boop: 'snoot' }), { status: 200 });\n  }\n}\n\ndescribe('Fetch Handler', () => {\n  describe('fetch', () => {\n    it('adds reCache=1 if it is in the current url', async () => {\n      const fetchRetrier = new MockFetchRetrier();\n      const fetchHandler = new IaFetchHandler({\n        fetchRetrier: fetchRetrier,\n        searchParams: '?reCache=1',\n      });\n      await fetchHandler.fetch('https://foo.org/api/v1/snoot');\n      expect(fetchRetrier.requestInfo).to.equal(\n        'https://foo.org/api/v1/snoot?reCache=1',\n      );\n    });\n  });\n\n  describe('fetchIAApiResponse', () => {\n    it('prepends the IA basehost to the url when making a request', async () => {\n      const endpoint = '/foo/service/endpoint.php';\n      const fetchRetrier = new MockFetchRetrier();\n      const fetchHandler = new IaFetchHandler({\n        iaApiBaseUrl: 'www.example.com',\n        fetchRetrier: fetchRetrier,\n      });\n      await fetchHandler.fetchIAApiResponse(endpoint);\n      expect(fetchRetrier.requestInfo).to.equal(\n        'www.example.com/foo/service/endpoint.php',\n      );\n    });\n  });\n\n  describe('fetchApiResponse', () => {\n    it('adds credentials: include if requested', async () => {\n      const endpoint = '/foo/service/endpoint.php';\n      const fetchRetrier = new MockFetchRetrier();\n      const fetchHandler = new IaFetchHandler({\n        iaApiBaseUrl: 'www.example.com',\n        fetchRetrier: fetchRetrier,\n      });\n      await fetchHandler.fetchApiResponse(endpoint, {\n        includeCredentials: true,\n      });\n      expect(fetchRetrier.init).to.deep.equal({ credentials: 'include' });\n    });\n  });\n});\n"]}