shields/services/github/github-api-provider.integration.js

'use strict'

const { expect } = require('chai')
const config = require('config').util.toObject()
const GithubApiProvider = require('./github-api-provider')

describe('Github API provider', function () {
  const baseUrl = process.env.GITHUB_URL || 'https://api.github.com'
  const reserveFraction = 0.333

  let token
  before(function () {
    token = config.private.gh_token
    if (!token) {
      throw Error('The integration tests require a gh_token to be set')
    }
  })

  let githubApiProvider

  context('without token pool', function () {
    before(function () {
      githubApiProvider = new GithubApiProvider({
        baseUrl,
        withPooling: false,
        globalToken: token,
        reserveFraction,
      })
    })

    it('should be able to run 10 requests', async function () {
      this.timeout('20s')
      for (let i = 0; i < 10; ++i) {
        await githubApiProvider.requestAsPromise(
          require('request'),
          '/repos/rust-lang/rust',
          {}
        )
      }
    })
  })

  context('with token pool', function () {
    let githubApiProvider
    before(function () {
      githubApiProvider = new GithubApiProvider({
        baseUrl,
        withPooling: true,
        reserveFraction,
      })
      githubApiProvider.addToken(token)
    })

    const headers = []
    async function performOneRequest() {
      const { res } = await githubApiProvider.requestAsPromise(
        require('request'),
        '/repos/rust-lang/rust',
        {}
      )
      expect(res.statusCode).to.equal(200)
      headers.push(res.headers)
    }

    before('should be able to run 10 requests', async function () {
      this.timeout('20s')
      for (let i = 0; i < 10; ++i) {
        await performOneRequest()
      }
    })

    it('should decrement the limit remaining with each request', function () {
      for (let i = 1; i < headers.length; ++i) {
        const current = headers[i]
        const previous = headers[i - 1]
        expect(+current['x-ratelimit-remaining']).to.be.lessThan(
          +previous['x-ratelimit-remaining']
        )
      }
    })

    // Is this test failing? See https://github.com/badges/shields/pull/4590#issuecomment-708551801
    it('should update the token with the final limit remaining and reset time', function () {
      const lastHeaders = headers.slice(-1)[0]
      const reserve = reserveFraction * +lastHeaders['x-ratelimit-limit']
      const usesRemaining = +lastHeaders['x-ratelimit-remaining'] - reserve
      const nextReset = +lastHeaders['x-ratelimit-reset']

      const tokens = []
      githubApiProvider.standardTokens.forEach(t => {
        tokens.push(t)
      })

      // Confidence check.
      expect(tokens).to.have.lengthOf(1)

      const [token] = tokens
      expect(token.usesRemaining).to.equal(usesRemaining)
      expect(token.nextReset).to.equal(nextReset)
    })
  })
})