@algolia/client-common 4.14.2 → 5.0.0-alpha.3

package/src/cache/createMemoryCache.ts

@@ -0,0 +1,56 @@
+import type { Cache, CacheEvents, MemoryCacheOptions } from '../types';
+
+export function createMemoryCache(
+  options: MemoryCacheOptions = { serializable: true }
+): Cache {
+  let cache: Record<string, any> = {};
+
+  return {
+    get<TValue>(
+      key: Record<string, any> | string,
+      defaultValue: () => Promise<TValue>,
+      events: CacheEvents<TValue> = {
+        miss: (): Promise<void> => Promise.resolve(),
+      }
+    ): Promise<TValue> {
+      const keyAsString = JSON.stringify(key);
+
+      if (keyAsString in cache) {
+        return Promise.resolve(
+          options.serializable
+            ? JSON.parse(cache[keyAsString])
+            : cache[keyAsString]
+        );
+      }
+
+      const promise = defaultValue();
+
+      return promise
+        .then((value: TValue) => events.miss(value))
+        .then(() => promise);
+    },
+
+    set<TValue>(
+      key: Record<string, any> | string,
+      value: TValue
+    ): Promise<TValue> {
+      cache[JSON.stringify(key)] = options.serializable
+        ? JSON.stringify(value)
+        : value;
+
+      return Promise.resolve(value);
+    },
+
+    delete(key: Record<string, unknown> | string): Promise<void> {
+      delete cache[JSON.stringify(key)];
+
+      return Promise.resolve();
+    },
+
+    clear(): Promise<void> {
+      cache = {};
+
+      return Promise.resolve();
+    },
+  };
+}

package/src/cache/createNullCache.ts

@@ -0,0 +1,34 @@
+import type { Cache, CacheEvents } from '../types';
+
+export function createNullCache(): Cache {
+  return {
+    get<TValue>(
+      _key: Record<string, any> | string,
+      defaultValue: () => Promise<TValue>,
+      events: CacheEvents<TValue> = {
+        miss: (): Promise<void> => Promise.resolve(),
+      }
+    ): Promise<TValue> {
+      const value = defaultValue();
+
+      return value
+        .then((result) => Promise.all([result, events.miss(result)]))
+        .then(([result]) => result);
+    },
+
+    set<TValue>(
+      _key: Record<string, any> | string,
+      value: TValue
+    ): Promise<TValue> {
+      return Promise.resolve(value);
+    },
+
+    delete(_key: Record<string, any> | string): Promise<void> {
+      return Promise.resolve();
+    },
+
+    clear(): Promise<void> {
+      return Promise.resolve();
+    },
+  };
+}

package/src/cache/index.ts

@@ -0,0 +1,4 @@
+export * from './createBrowserLocalStorageCache';
+export * from './createFallbackableCache';
+export * from './createMemoryCache';
+export * from './createNullCache';

package/src/constants.ts

@@ -0,0 +1,7 @@
+export const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
+export const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
+export const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
+
+export const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
+export const DEFAULT_READ_TIMEOUT_NODE = 5000;
+export const DEFAULT_WRITE_TIMEOUT_NODE = 30000;

package/src/createAlgoliaAgent.ts

@@ -0,0 +1,20 @@
+import type { AlgoliaAgentOptions, AlgoliaAgent } from './types';
+
+export function createAlgoliaAgent(version: string): AlgoliaAgent {
+  const algoliaAgent = {
+    value: `Algolia for JavaScript (${version})`,
+    add(options: AlgoliaAgentOptions): AlgoliaAgent {
+      const addedAlgoliaAgent = `; ${options.segment}${
+        options.version !== undefined ? ` (${options.version})` : ''
+      }`;
+
+      if (algoliaAgent.value.indexOf(addedAlgoliaAgent) === -1) {
+        algoliaAgent.value = `${algoliaAgent.value}${addedAlgoliaAgent}`;
+      }
+
+      return algoliaAgent;
+    },
+  };
+
+  return algoliaAgent;
+}

package/src/createAuth.ts

@@ -0,0 +1,25 @@
+import type { AuthMode, Headers, QueryParameters } from './types';
+
+export function createAuth(
+  appId: string,
+  apiKey: string,
+  authMode: AuthMode = 'WithinHeaders'
+): {
+  readonly headers: () => Headers;
+  readonly queryParameters: () => QueryParameters;
+} {
+  const credentials = {
+    'x-algolia-api-key': apiKey,
+    'x-algolia-application-id': appId,
+  };
+
+  return {
+    headers(): Headers {
+      return authMode === 'WithinHeaders' ? credentials : {};
+    },
+
+    queryParameters(): QueryParameters {
+      return authMode === 'WithinQueryParameters' ? credentials : {};
+    },
+  };
+}

package/src/createEchoRequester.ts

@@ -0,0 +1,59 @@
+import type { EchoResponse, EndRequest, Requester, Response } from './types';
+
+export type EchoRequesterParams = {
+  getURL: (url: string) => URL;
+  status?: number;
+};
+
+function getUrlParams({
+  host,
+  searchParams: urlSearchParams,
+  pathname,
+}: URL): Pick<EchoResponse, 'algoliaAgent' | 'host' | 'path' | 'searchParams'> {
+  const algoliaAgent = urlSearchParams.get('x-algolia-agent') || '';
+  const searchParams = {};
+
+  for (const [k, v] of urlSearchParams) {
+    if (k === 'x-algolia-agent') {
+      continue;
+    }
+
+    searchParams[k] = v;
+  }
+
+  return {
+    host,
+    algoliaAgent,
+    searchParams:
+      Object.keys(searchParams).length === 0 ? undefined : searchParams,
+    path: pathname,
+  };
+}
+
+export function createEchoRequester({
+  getURL,
+  status = 200,
+}: EchoRequesterParams): Requester {
+  function send(request: EndRequest): Promise<Response> {
+    const { host, searchParams, algoliaAgent, path } = getUrlParams(
+      getURL(request.url)
+    );
+
+    const content: EchoResponse = {
+      ...request,
+      data: request.data ? JSON.parse(request.data) : undefined,
+      path,
+      host,
+      algoliaAgent: encodeURI(algoliaAgent),
+      searchParams,
+    };
+
+    return Promise.resolve({
+      content: JSON.stringify(content),
+      isTimedOut: false,
+      status,
+    });
+  }
+
+  return { send };
+}

package/src/createRetryablePromise.ts

@@ -0,0 +1,52 @@
+import type { CreateRetryablePromiseOptions } from './types/CreateRetryablePromise';
+
+export const DEFAULT_MAX_RETRIES = 50;
+export const DEFAULT_TIMEOUT = (retryCount: number): number =>
+  Math.min(retryCount * 200, 5000);
+
+/**
+ * Return a promise that retry a task until it meets the condition.
+ *
+ * @param createRetryablePromiseOptions - The createRetryablePromise options.
+ * @param createRetryablePromiseOptions.func - The function to run, which returns a promise.
+ * @param createRetryablePromiseOptions.validate - The validator function. It receives the resolved return of `func`.
+ * @param createRetryablePromiseOptions.maxRetries - The maximum number of retries. 50 by default.
+ * @param createRetryablePromiseOptions.timeout - The function to decide how long to wait between retries.
+ */
+export function createRetryablePromise<TResponse>({
+  func,
+  validate,
+  maxRetries = DEFAULT_MAX_RETRIES,
+  timeout = DEFAULT_TIMEOUT,
+}: CreateRetryablePromiseOptions<TResponse>): Promise<TResponse> {
+  let retryCount = 0;
+  const retry = (): Promise<TResponse> => {
+    return new Promise<TResponse>((resolve, reject) => {
+      func()
+        .then((response) => {
+          const isValid = validate(response);
+          if (isValid) {
+            resolve(response);
+          } else if (retryCount + 1 >= maxRetries) {
+            reject(
+              new Error(
+                `The maximum number of retries exceeded. (${
+                  retryCount + 1
+                }/${maxRetries})`
+              )
+            );
+          } else {
+            retryCount += 1;
+            setTimeout(() => {
+              retry().then(resolve).catch(reject);
+            }, timeout(retryCount));
+          }
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  };
+
+  return retry();
+}

package/src/getAlgoliaAgent.ts

@@ -0,0 +1,25 @@
+import { createAlgoliaAgent } from './createAlgoliaAgent';
+import type { AlgoliaAgentOptions, AlgoliaAgent } from './types';
+
+export type GetAlgoliaAgent = {
+  algoliaAgents: AlgoliaAgentOptions[];
+  client: string;
+  version: string;
+};
+
+export function getAlgoliaAgent({
+  algoliaAgents,
+  client,
+  version,
+}: GetAlgoliaAgent): AlgoliaAgent {
+  const defaultAlgoliaAgent = createAlgoliaAgent(version).add({
+    segment: client,
+    version,
+  });
+
+  algoliaAgents.forEach((algoliaAgent) =>
+    defaultAlgoliaAgent.add(algoliaAgent)
+  );
+
+  return defaultAlgoliaAgent;
+}

package/src/transporter/createStatefulHost.ts

@@ -0,0 +1,24 @@
+import type { Host, StatefulHost } from '../types';
+
+// By default, API Clients at Algolia have expiration delay of 5 mins.
+// In the JavaScript client, we have 2 mins.
+const EXPIRATION_DELAY = 2 * 60 * 1000;
+
+export function createStatefulHost(
+  host: Host,
+  status: StatefulHost['status'] = 'up'
+): StatefulHost {
+  const lastUpdate = Date.now();
+
+  function isUp(): boolean {
+    return status === 'up' || Date.now() - lastUpdate > EXPIRATION_DELAY;
+  }
+
+  function isTimedOut(): boolean {
+    return (
+      status === 'timed out' && Date.now() - lastUpdate <= EXPIRATION_DELAY
+    );
+  }
+
+  return { ...host, status, lastUpdate, isUp, isTimedOut };
+}

package/src/transporter/createTransporter.ts

@@ -0,0 +1,347 @@
+import type {
+  EndRequest,
+  Host,
+  Request,
+  RequestOptions,
+  Response,
+  StackFrame,
+  TransporterOptions,
+  Transporter,
+  QueryParameters,
+} from '../types';
+
+import { createStatefulHost } from './createStatefulHost';
+import { RetryError } from './errors';
+import {
+  deserializeFailure,
+  deserializeSuccess,
+  serializeData,
+  serializeHeaders,
+  serializeUrl,
+} from './helpers';
+import { isRetryable, isSuccess } from './responses';
+import {
+  stackTraceWithoutCredentials,
+  stackFrameWithoutCredentials,
+} from './stackTrace';
+
+type RetryableOptions = {
+  hosts: Host[];
+  getTimeout: (retryCount: number, timeout: number) => number;
+};
+
+export function createTransporter({
+  hosts,
+  hostsCache,
+  baseHeaders,
+  baseQueryParameters,
+  algoliaAgent,
+  timeouts,
+  requester,
+  requestsCache,
+  responsesCache,
+}: TransporterOptions): Transporter {
+  async function createRetryableOptions(
+    compatibleHosts: Host[]
+  ): Promise<RetryableOptions> {
+    const statefulHosts = await Promise.all(
+      compatibleHosts.map((compatibleHost) => {
+        return hostsCache.get(compatibleHost, () => {
+          return Promise.resolve(createStatefulHost(compatibleHost));
+        });
+      })
+    );
+    const hostsUp = statefulHosts.filter((host) => host.isUp());
+    const hostsTimedOut = statefulHosts.filter((host) => host.isTimedOut());
+
+    // Note, we put the hosts that previously timed out on the end of the list.
+    const hostsAvailable = [...hostsUp, ...hostsTimedOut];
+    const compatibleHostsAvailable =
+      hostsAvailable.length > 0 ? hostsAvailable : compatibleHosts;
+
+    return {
+      hosts: compatibleHostsAvailable,
+      getTimeout(timeoutsCount: number, baseTimeout: number): number {
+        /**
+         * Imagine that you have 4 hosts, if timeouts will increase
+         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
+         *
+         * Note that, the very next request, we start from the previous timeout.
+         *
+         *  5 (timed out) > 6 (timed out) > 7 ...
+         *
+         * This strategy may need to be reviewed, but is the strategy on the our
+         * current v3 version.
+         */
+        const timeoutMultiplier =
+          hostsTimedOut.length === 0 && timeoutsCount === 0
+            ? 1
+            : hostsTimedOut.length + 3 + timeoutsCount;
+
+        return timeoutMultiplier * baseTimeout;
+      },
+    };
+  }
+
+  async function retryableRequest<TResponse>(
+    request: Request,
+    requestOptions: RequestOptions,
+    isRead = true
+  ): Promise<TResponse> {
+    const stackTrace: StackFrame[] = [];
+
+    /**
+     * First we prepare the payload that do not depend from hosts.
+     */
+    const data = serializeData(request, requestOptions);
+    const headers = serializeHeaders(
+      baseHeaders,
+      request.headers,
+      requestOptions.headers
+    );
+
+    // On `GET`, the data is proxied to query parameters.
+    const dataQueryParameters: QueryParameters =
+      request.method === 'GET'
+        ? {
+            ...request.data,
+            ...requestOptions.data,
+          }
+        : {};
+
+    const queryParameters: QueryParameters = {
+      'x-algolia-agent': algoliaAgent.value,
+      ...baseQueryParameters,
+      ...request.queryParameters,
+      ...dataQueryParameters,
+    };
+
+    if (requestOptions && requestOptions.queryParameters) {
+      for (const key of Object.keys(requestOptions.queryParameters)) {
+        // We want to keep `undefined` and `null` values,
+        // but also avoid stringifying `object`s, as they are
+        // handled in the `serializeUrl` step right after.
+        if (
+          !requestOptions.queryParameters[key] ||
+          Object.prototype.toString.call(
+            requestOptions.queryParameters[key]
+          ) === '[object Object]'
+        ) {
+          queryParameters[key] = requestOptions.queryParameters[key];
+        } else {
+          queryParameters[key] = requestOptions.queryParameters[key].toString();
+        }
+      }
+    }
+
+    let timeoutsCount = 0;
+
+    const retry = async (
+      retryableHosts: Host[],
+      getTimeout: (timeoutsCount: number, timeout: number) => number
+    ): Promise<TResponse> => {
+      /**
+       * We iterate on each host, until there is no host left.
+       */
+      const host = retryableHosts.pop();
+      if (host === undefined) {
+        throw new RetryError(stackTraceWithoutCredentials(stackTrace));
+      }
+
+      let responseTimeout = requestOptions.timeout;
+      if (responseTimeout === undefined) {
+        responseTimeout = isRead ? timeouts.read : timeouts.write;
+      }
+
+      const payload: EndRequest = {
+        data,
+        headers,
+        method: request.method,
+        url: serializeUrl(host, request.path, queryParameters),
+        connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
+        responseTimeout: getTimeout(timeoutsCount, responseTimeout),
+      };
+
+      /**
+       * The stackFrame is pushed to the stackTrace so we
+       * can have information about onRetry and onFailure
+       * decisions.
+       */
+      const pushToStackTrace = (response: Response): StackFrame => {
+        const stackFrame: StackFrame = {
+          request: payload,
+          response,
+          host,
+          triesLeft: retryableHosts.length,
+        };
+
+        stackTrace.push(stackFrame);
+
+        return stackFrame;
+      };
+
+      const response = await requester.send(payload);
+
+      if (isRetryable(response)) {
+        const stackFrame = pushToStackTrace(response);
+
+        // If response is a timeout, we increase the number of timeouts so we can increase the timeout later.
+        if (response.isTimedOut) {
+          timeoutsCount++;
+        }
+        /**
+         * Failures are individually sent to the logger, allowing
+         * the end user to debug / store stack frames even
+         * when a retry error does not happen.
+         */
+        // eslint-disable-next-line no-console -- this will be fixed by exposing a `logger` to the transporter
+        console.log(
+          'Retryable failure',
+          stackFrameWithoutCredentials(stackFrame)
+        );
+
+        /**
+         * We also store the state of the host in failure cases. If the host, is
+         * down it will remain down for the next 2 minutes. In a timeout situation,
+         * this host will be added end of the list of hosts on the next request.
+         */
+        await hostsCache.set(
+          host,
+          createStatefulHost(host, response.isTimedOut ? 'timed out' : 'down')
+        );
+
+        return retry(retryableHosts, getTimeout);
+      }
+
+      if (isSuccess(response)) {
+        return deserializeSuccess(response);
+      }
+
+      pushToStackTrace(response);
+      throw deserializeFailure(response, stackTrace);
+    };
+
+    /**
+     * Finally, for each retryable host perform request until we got a non
+     * retryable response. Some notes here:
+     *
+     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
+     * 2. We also get from the retryable options a timeout multiplier that is tailored
+     * for the current context.
+     */
+    const compatibleHosts = hosts.filter(
+      (host) =>
+        host.accept === 'readWrite' ||
+        (isRead ? host.accept === 'read' : host.accept === 'write')
+    );
+    const options = await createRetryableOptions(compatibleHosts);
+
+    return retry([...options.hosts].reverse(), options.getTimeout);
+  }
+
+  function createRequest<TResponse>(
+    request: Request,
+    requestOptions: RequestOptions = {}
+  ): Promise<TResponse> {
+    /**
+     * A read request is either a `GET` request, or a request that we make
+     * via the `read` transporter (e.g. `search`).
+     */
+    const isRead = request.useReadTransporter || request.method === 'GET';
+    if (!isRead) {
+      /**
+       * On write requests, no cache mechanisms are applied, and we
+       * proxy the request immediately to the requester.
+       */
+      return retryableRequest<TResponse>(request, requestOptions, isRead);
+    }
+
+    const createRetryableRequest = (): Promise<TResponse> => {
+      /**
+       * Then, we prepare a function factory that contains the construction of
+       * the retryable request. At this point, we may *not* perform the actual
+       * request. But we want to have the function factory ready.
+       */
+      return retryableRequest<TResponse>(request, requestOptions);
+    };
+
+    /**
+     * Once we have the function factory ready, we need to determine of the
+     * request is "cacheable" - should be cached. Note that, once again,
+     * the user can force this option.
+     */
+    const cacheable = requestOptions.cacheable || request.cacheable;
+
+    /**
+     * If is not "cacheable", we immediately trigger the retryable request, no
+     * need to check cache implementations.
+     */
+    if (cacheable !== true) {
+      return createRetryableRequest();
+    }
+
+    /**
+     * If the request is "cacheable", we need to first compute the key to ask
+     * the cache implementations if this request is on progress or if the
+     * response already exists on the cache.
+     */
+    const key = {
+      request,
+      requestOptions,
+      transporter: {
+        queryParameters: baseQueryParameters,
+        headers: baseHeaders,
+      },
+    };
+
+    /**
+     * With the computed key, we first ask the responses cache
+     * implementation if this request was been resolved before.
+     */
+    return responsesCache.get(
+      key,
+      () => {
+        /**
+         * If the request has never resolved before, we actually ask if there
+         * is a current request with the same key on progress.
+         */
+        return requestsCache.get(key, () =>
+          /**
+           * Finally, if there is no request in progress with the same key,
+           * this `createRetryableRequest()` will actually trigger the
+           * retryable request.
+           */
+          requestsCache
+            .set(key, createRetryableRequest())
+            .then(
+              (response) => Promise.all([requestsCache.delete(key), response]),
+              (err) =>
+                Promise.all([requestsCache.delete(key), Promise.reject(err)])
+            )
+            .then(([_, response]) => response)
+        );
+      },
+      {
+        /**
+         * Of course, once we get this response back from the server, we
+         * tell response cache to actually store the received response
+         * to be used later.
+         */
+        miss: (response) => responsesCache.set(key, response),
+      }
+    );
+  }
+
+  return {
+    hostsCache,
+    requester,
+    timeouts,
+    algoliaAgent,
+    baseHeaders,
+    baseQueryParameters,
+    hosts,
+    request: createRequest,
+    requestsCache,
+    responsesCache,
+  };
+}