feat: GraphQL Support

Author: Simon Grondin

lib/index.js

@@ -85,17 +85,19 @@ function throttlingPlugin (octokit, octokitOptions = {}) {
   events.on('error', e => console.warn('Error in throttling-plugin limit handler', e))
 
   state.retryLimiter.on('failed', async function (error, info) {
-    if (error.status !== 403) {
+    const options = info.args[info.args.length - 1]
+    const isGraphQL = options.url.startsWith('/graphql')
+
+    if (!(isGraphQL || error.status === 403)) {
       return
     }
 
-    const options = info.args[info.args.length - 1]
     const retryCount = ~~options.request.retryCount
     options.request.retryCount = retryCount
 
     const { wantRetry, retryAfter } = await (async function () {
       if (/\babuse\b/i.test(error.message)) {
-        // The user has hit the abuse rate limit.
+        // The user has hit the abuse rate limit. (REST only)
         // https://developer.github.com/v3/#abuse-rate-limits
 
         // The Retry-After header can sometimes be blank when hitting an abuse limit,
@@ -105,7 +107,7 @@ function throttlingPlugin (octokit, octokitOptions = {}) {
         return { wantRetry, retryAfter }
       }
       if (error.headers['x-ratelimit-remaining'] === '0') {
-        // The user has used all their allowed calls for the current time period
+        // The user has used all their allowed calls for the current time period (REST and GraphQL)
         // https://developer.github.com/v3/#rate-limiting
 
         const rateLimitReset = new Date(~~error.headers['x-ratelimit-reset'] * 1000).getTime()

lib/wrap-request.js

@@ -9,6 +9,7 @@ function wrapRequest (state, request, options) {
 async function doRequest (state, request, options) {
   const isWrite = options.method !== 'GET' && options.method !== 'HEAD'
   const isSearch = options.method === 'GET' && options.url.startsWith('/search/')
+  const isGraphQL = options.url.startsWith('/graphql')
 
   const retryCount = ~~options.request.retryCount
   const jobOptions = retryCount > 0 ? { priority: 0, weight: 0 } : {}
@@ -19,7 +20,8 @@ async function doRequest (state, request, options) {
   }
 
   // Guarantee at least 1000ms between writes
-  if (isWrite) {
+  // GraphQL can also trigger writes
+  if (isWrite || isGraphQL) {
     await state.write.key(state.id).schedule(jobOptions, noop)
   }
 
@@ -28,9 +30,20 @@ async function doRequest (state, request, options) {
     await state.notifications.key(state.id).schedule(jobOptions, noop)
   }
 
+  // Guarantee at least 2000ms between search requests
   if (isSearch) {
     await state.search.key(state.id).schedule(jobOptions, noop)
   }
 
-  return state.global.key(state.id).schedule(jobOptions, request, options)
+  const req = state.global.key(state.id).schedule(jobOptions, request, options)
+  if (isGraphQL) {
+    const res = await req
+    if (res.data.errors != null && res.data.errors.some((err) => err.type === 'RATE_LIMITED')) {
+      const err = new Error('GraphQL Rate Limit Exceeded')
+      err.headers = res.headers
+      err.data = res.data
+      throw err
+    }
+  }
+  return req
 }