lib/error-handler.js

import isObject from 'lodash/isObject'

/**
 * @typedef {ErrorResponse} ErrorResponse
 * @property {string} name - Error name. Usually refers to the sys.id returned on the
 * error server response. If that's not available or is unknown, it defaults to
 * the HTTP error code and status text.
 * @property {string} message - Stringified JSON object with request information,
 * HTTP response details and error details payload (if available). The `requestId`
 * property is internal to Contentful and it can be used when contacting support
 * about unusual errors.
 */

/**
 * Handles errors received from the server. Parses the error into a more useful
 * format, places it in an exception and throws it.
 * See https://www.contentful.com/developers/docs/references/content-management-api/#/introduction/errors
 * for more details on the data received on the errorResponse.data property
 * and the expected error codes.
 * @private
 * @param {Object} errorResponse - Error received from an axios request
 * @throws {ErrorResponse}
 */
export default function errorHandler (errorResponse) {
  const {config, response} = errorResponse
  let errorName

  if (!isObject(response) || !isObject(config)) {
    throw errorResponse
  }

  const { data } = response

  const errorData = {
    status: response.status,
    statusText: response.statusText,
    message: '',
    details: {}
  }

  // Obscure the Management token
  if (config.headers && config.headers['Authorization']) {
    config.headers['Authorization'] = 'Bearer ACCESS_TOKEN'
  }
  if (isObject(config)) {
    errorData.request = {
      url: config.url,
      headers: config.headers,
      method: config.method,
      payloadData: config.data
    }
  }
  if (isObject(data)) {
    if ('requestId' in data) {
      errorData.requestId = data.requestId || 'UNKNOWN'
    }
    if ('message' in data) {
      errorData.message = data.message || ''
    }
    if ('details' in data) {
      errorData.details = data.details || {}
    }
    if ('sys' in data) {
      if ('id' in data.sys) {
        errorName = data.sys.id
      }
    }
  }

  const error = new Error()
  error.name = errorName && errorName !== 'Unknown' ? errorName : `${response.status} ${response.statusText}`
  error.message = JSON.stringify(errorData, null, '  ')
  throw error
}