shields/core/base-service/base-graphql.js

/**
 * @module
 */

import { print } from 'graphql/language/printer.js'
import BaseService from './base.js'
import { InvalidResponse, ShieldsRuntimeError } from './errors.js'
import { parseJson } from './json.js'

function defaultTransformErrors(errors) {
  return new InvalidResponse({ prettyMessage: errors[0].message })
}

/**
 * Services which query a GraphQL endpoint should extend BaseGraphqlService
 *
 * @abstract
 */
class BaseGraphqlService extends BaseService {
  /**
   * Parse data from JSON endpoint
   *
   * @param {string} buffer JSON repsonse from upstream API
   * @returns {object} Parsed response
   */
  _parseJson(buffer) {
    return parseJson(buffer)
  }

  /**
   * Request data from an upstream GraphQL API,
   * parse it and validate against a schema
   *
   * @param {object} attrs Refer to individual attrs
   * @param {Joi} attrs.schema Joi schema to validate the response against
   * @param {string} attrs.url URL to request
   * @param {object} attrs.query Parsed GraphQL object
   *    representing the query clause of GraphQL POST body
   *    e.g. gql`{ query { ... } }`
   * @param {object} attrs.variables Variables clause of GraphQL POST body
   * @param {object} [attrs.options={}] Options to pass to got. See
   *    [documentation](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md)
   * @param {object} [attrs.httpErrorMessages={}] Key-value map of HTTP status codes
   *    and custom error messages e.g: `{ 404: 'package not found' }`.
   *    This can be used to extend or override the
   *    [default](https://github.com/badges/shields/blob/master/core/base-service/check-error-response.js#L5)
   * @param {object} [attrs.systemErrors={}] Key-value map of got network exception codes
   *    and an object of params to pass when we construct an Inaccessible exception object
   *    e.g: `{ ECONNRESET: { prettyMessage: 'connection reset' } }`.
   *    See {@link https://github.com/sindresorhus/got/blob/main/documentation/7-retry.md#errorcodes got error codes}
   *    for allowed keys
   *    and {@link module:core/base-service/errors~RuntimeErrorProps} for allowed values
   * @param {Function} [attrs.transformJson=data => data] Function which takes the raw json and transforms it before
   * further procesing. In case of multiple query in a single graphql call and few of them
   * throw error, partial data might be used ignoring the error.
   * @param {Function} [attrs.transformErrors=defaultTransformErrors]
   *    Function which takes an errors object from a GraphQL
   *    response and returns an instance of ShieldsRuntimeError.
   *    The default is to return the first entry of the `errors` array as
   *    an InvalidResponse.
   * @returns {object} Parsed response
   * @see https://github.com/sindresorhus/got/blob/main/documentation/2-options.md
   */
  async _requestGraphql({
    schema,
    url,
    query,
    variables = {},
    options = {},
    httpErrorMessages = {},
    systemErrors = {},
    transformJson = data => data,
    transformErrors = defaultTransformErrors,
  }) {
    const mergedOptions = {
      ...{ headers: { Accept: 'application/json' } },
      ...options,
    }
    mergedOptions.method = 'POST'
    mergedOptions.body = JSON.stringify({ query: print(query), variables })
    const { buffer } = await this._request({
      url,
      options: mergedOptions,
      httpErrors: httpErrorMessages,
      systemErrors,
    })
    const json = transformJson(this._parseJson(buffer))
    if (json.errors) {
      const exception = transformErrors(json.errors)
      if (exception instanceof ShieldsRuntimeError) {
        throw exception
      } else {
        throw Error(
          `transformErrors() must return a ShieldsRuntimeError; got ${exception}`,
        )
      }
    }
    return this.constructor._validate(json, schema)
  }
}

export default BaseGraphqlService