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

package/src/utils/fetch-retrier.ts

@@ -1,141 +0,0 @@
-import type { AnalyticsHandlerInterface } from '@internetarchive/analytics-manager';
-import { AnalyticsHandler } from '@internetarchive/analytics-manager';
-import { promisedSleep } from './promised-sleep';
-
-/**
- * A class that retries a fetch request.
- */
-export interface FetchRetrierInterface {
-  /**
-   * Execute a fetch with retry.
-   *
-   * @param requestInfo RequestInfo
-   * @param init Optional RequestInit
-   * @param retries Optional number of retries to attempt
-   * @returns Promise<Response>
-   */
-  fetchRetry(
-    requestInfo: RequestInfo,
-    init?: RequestInit,
-    retries?: number,
-  ): Promise<Response>;
-}
-
-/** @inheritdoc */
-export class FetchRetrier implements FetchRetrierInterface {
-  private analyticsHandler = new AnalyticsHandler({ enableAnalytics: true });
-  private sleep = promisedSleep; // default sleep function
-
-  private retryCount = 2;
-
-  private retryDelay = 1000;
-
-  constructor(options?: {
-    analyticsHandler?: AnalyticsHandlerInterface;
-    retryCount?: number;
-    retryDelay?: number;
-    sleepFn?: (ms: number) => Promise<void>; // <-- add this!
-  }) {
-    if (options?.analyticsHandler)
-      this.analyticsHandler = options.analyticsHandler;
-    if (options?.retryCount) this.retryCount = options.retryCount;
-    if (options?.retryDelay) this.retryDelay = options.retryDelay;
-    if (options?.sleepFn) this.sleep = options.sleepFn; // override if provided
-  }
-
-  /** @inheritdoc */
-  public async fetchRetry(
-    requestInfo: RequestInfo,
-    init?: RequestInit,
-    retries: number = this.retryCount,
-  ): Promise<Response> {
-    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;
-    }
-  }
-
-  private isContentBlockerError(error: unknown): boolean {
-    // all of the content blocker errors are `TypeError`
-    if (!(error instanceof TypeError)) return false;
-    const message = error.message.toLowerCase();
-    return message.includes('content blocker');
-  }
-
-  private readonly eventCategory = 'offshootFetchRetry';
-
-  private logRetryEvent(
-    urlString: string,
-    retryNumber: number,
-    status: unknown,
-    code: unknown,
-  ) {
-    this.analyticsHandler.sendEvent({
-      category: this.eventCategory,
-      action: 'retryingFetch',
-      label: `retryNumber: ${retryNumber} / ${this.retryCount}, code: ${code}, status: ${status}, url: ${urlString}`,
-    });
-  }
-
-  private logFailureEvent(urlString: string, error: unknown) {
-    this.analyticsHandler.sendEvent({
-      category: this.eventCategory,
-      action: 'fetchFailed',
-      label: `error: ${error}, url: ${urlString}`,
-    });
-  }
-
-  private log404Event(urlString: string) {
-    this.analyticsHandler.sendEvent({
-      category: this.eventCategory,
-      action: 'status404NotRetrying',
-      label: `url: ${urlString}`,
-    });
-  }
-
-  private logContentBlockingEvent(urlString: string, error: unknown) {
-    this.analyticsHandler.sendEvent({
-      category: this.eventCategory,
-      action: 'contentBlockerDetectedNotRetrying',
-      label: `error: ${error}, url: ${urlString}`,
-    });
-  }
-}

package/test/ia-fetch-handler.test.ts

@@ -1,66 +0,0 @@
-import { expect } from '@open-wc/testing';
-import { IaFetchHandler } from '../src/ia-fetch-handler';
-import { FetchRetrierInterface } from '../src/utils/fetch-retrier';
-
-class MockFetchRetrier implements FetchRetrierInterface {
-  requestInfo?: RequestInfo;
-  init?: RequestInit;
-  retries?: number;
-
-  async fetchRetry(
-    requestInfo: RequestInfo,
-    init?: RequestInit,
-    retries?: number,
-  ): Promise<Response> {
-    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' });
-    });
-  });
-});