fetcher/graphql.js

  1. /*
  2. Copyright 2023 Yarmo Mackenbach
  4. Licensed under the Apache License, Version 2.0 (the "License");
  5. you may not use this file except in compliance with the License.
  6. You may obtain a copy of the License at
  8. http://www.apache.org/licenses/LICENSE-2.0
  10. Unless required by applicable law or agreed to in writing, software
  11. distributed under the License is distributed on an "AS IS" BASIS,
  12. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. See the License for the specific language governing permissions and
  14. limitations under the License.
  15. */
  16. /**
  17.  * Fetch proofs using GraphQL queries
  18.  * @module fetcher/graphql
  19.  * @example
  20.  * import { fetcher } from 'doipjs';
  21.  * const data = await fetcher.graphql.fn({ url: 'https://domain.example/graphql/v2', query: '{ "query": "..." }' });
  22.  */
  24. import axios from 'axios'
  25. import { version } from '../constants.js'
  27. /**
  28.  * Default timeout after which the fetch is aborted
  29.  * @constant
  30.  * @type {number}
  31.  * @default 5000
  32.  */
  33. export const timeout = 5000
  35. /**
  36.  * Execute a GraphQL query via HTTP request
  37.  * @function
  38.  * @param {object} data - Data used in the request
  39.  * @param {string} data.url - The URL pointing at the GraphQL HTTP endpoint
  40.  * @param {string} data.query - The GraphQL query to fetch the data containing the proof
  41.  * @param {number} [data.fetcherTimeout] - Optional timeout for the fetcher
  42.  * @param {import('../types').VerificationConfig} [opts] - Options used to enable the request
  43.  * @returns {Promise<object>} The fetched GraphQL object
  44.  */
  45. export async function fn (data, opts) {
  46.   let timeoutHandle
  47.   const timeoutPromise = new Promise((resolve, reject) => {
  48.     timeoutHandle = setTimeout(
  49.       () => reject(new Error('Request was timed out')),
  50.       data.fetcherTimeout ? data.fetcherTimeout : timeout
  51.     )
  52.   })
  54.   const fetchPromise = new Promise((resolve, reject) => {
  55.     if (!data.url) {
  56.       reject(new Error('No valid URI provided'))
  57.       return
  58.     }
  60.     let jsonData
  61.     try {
  62.       jsonData = JSON.parse(data.query)
  63.     } catch (error) {
  64.       reject(new Error('Invalid GraphQL query object'))
  65.     }
  67.     axios.post(data.url, jsonData, {
  68.       headers: {
  69.         'Content-Type': 'application/json',
  70.         // @ts-ignore
  71.         'User-Agent': `doipjs/${version}`
  72.       },
  73.       validateStatus: function (status) {
  74.         return status >= 200 && status < 400
  75.       }
  76.     })
  77.       .then(res => {
  78.         resolve(res.data)
  79.       })
  80.       .catch(e => {
  81.         reject(e)
  82.       })
  83.   })
  85.   return Promise.race([fetchPromise, timeoutPromise]).finally(() => {
  86.     clearTimeout(timeoutHandle)
  87.   })
  88. }