@yoroi/common/src/api/fetchData.ts

The Common package of Yoroi SDK

import axios, {AxiosError, AxiosRequestConfig, AxiosResponse} from 'axios'
import {Api} from '@yoroi/types'

// Module augmentation to extend AxiosRequestConfig
declare module 'axios' {
  export interface AxiosRequestConfig {
    metadata?: {startTime: number; duration: number}
  }
}

type GetRequestConfig = {
  url: string
  method?: 'get'
  headers?: Record<string, string>
}

type OtherRequestConfig<D = any> = {
  url: string
  method: 'post' | 'put' | 'delete'
  data?: D
  headers?: Record<string, string>
}

export type RequestConfig<D = any> = GetRequestConfig | OtherRequestConfig<D>
export type FetchData = <T, D = any>(
  config: RequestConfig<D>,
  fetcherConfig?: AxiosRequestConfig<D>,
) => Promise<Api.Response<T>>

/**
 * Performs an HTTP request using Axios based on the specified configuration.
 * This function simplifies making HTTP requests by handling different
 * request methods and their respective data and headers.
 *
 * @param config - The configuration object for the request.
 *                 This includes the URL, HTTP method, optional data, and headers.
 *                 The type of `config` varies based on the HTTP method:
 *                 - For `GET` requests, `data` should not be provided.
 *                 - For `POST`, `PUT`, and `DELETE` requests, `data` is optional.
 *
 * @returns A `Promise` that resolves to the response data on a successful request
 *          or an error object on failure. The error object includes the HTTP status
 *          code and error message.
 *
 * @template T - The expected type of the response data.
 * @template D - The type of the data to be sent with the request (for `POST`, `PUT`, `DELETE`).
 *
 * @example
 * ```typescript
 * // Example of a GET request
 * fetchData<{ someDataType }>({
 *   url: 'https://example.com/data',
 * }).then(response => {
 *   // Handle response
 * }).catch(error => {
 *   // Handle error
 * })
 * ```
 *
 * @example
 * ```typescript
 * // Example of a POST request with data
 * fetchData<{ someDataType }, { somePayloadType }>({
 *   url: 'https://example.com/data',
 *   method: 'post',
 *   data: {...somePayload}
 * }).then(response => {
 *   // Handle response
 * }).catch(error => {
 *   // Handle error
 * })
 * ```
 */
export const fetchData: FetchData = <T, D = any>(
  config: RequestConfig<D>,
  fetcherConfig?: AxiosRequestConfig<D>,
): Promise<Api.Response<T>> => {
  const method = config.method ?? 'get'
  const isNotGet = method !== 'get'

  const axiosConfig: AxiosRequestConfig<D> = {
    ...fetcherConfig,
    url: config.url,
    method: method,
    headers: config.headers ?? {
      'Content-Type': 'application/json',
      'Cache-Control': 'no-cache, no-store, must-revalidate',
      'Pragma': 'no-cache',
      'Expires': '0',
    },
    ...(isNotGet && 'data' in config && {data: config.data}),

    // updated by the interceptors
    metadata: {startTime: new Date().getTime(), duration: 0},
  }

  return axios(axiosConfig)
    .then(({status, data}: AxiosResponse<T>) => {
      return {
        tag: 'right',
        value: {status, data},
      } as const
    })
    .catch((error: AxiosError) => {
      if (error.response) {
        const status = error.response.status
        const message = error.response.statusText
        const responseData = error.response.data

        return {
          tag: 'left',
          error: {status, message, responseData},
        } as const
      } else if (error.request) {
        return {
          tag: 'left',
          error: {
            status: -1,
            message: 'Network (no response)',
            responseData: null,
          },
        } as const
      } else {
        return {
          tag: 'left',
          error: {
            status: -2,
            message: `Invalid state: ${error.message}`,
            responseData: null,
          },
        } as const
      }
    })
}

/* istanbul ignore next */
axios.interceptors.request.use(
  (config) => {
    config.metadata = {startTime: new Date().getTime(), duration: 0}
    return config
  },
  (error) => {
    return Promise.reject(error)
  },
)

/* istanbul ignore next */
axios.interceptors.response.use(
  (response) => {
    if (response.config.metadata) {
      const endTime = new Date().getTime()
      const startTime = response.config.metadata.startTime
      const duration = endTime - startTime
      response.config.metadata.duration = duration
    }

    return response
  },
  (error) => {
    return Promise.reject(error)
  },
)