ComputerSurge/shields
3
0
Fork 0
Code Pull Requests 1 Activity

When a global gh_token is configured, always use it (#1118)

Browse Source 
If I configure a global gh_token, I expect it to be used all the time. I expect to see predictable failures when that token is exhausted.
This commit is contained in:
Paul Melnikow
2017-10-29 22:36:39 -04:00
committed by GitHub
parent 090454a828
commit b16122d9a4
2 changed files with 22 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
lib/github-auth.js
View File

@@ -4,13 +4,7 @@ const log = require('./log');
const queryString = require('query-string');
const request = require('request');
const autosave = require('json-autosave');
let serverSecrets;
const baseUrl = process.env.BASE_URL || 'https://img.shields.io';
try {
// Everything that cannot be checked in but is useful server-side
// is stored in this JSON data.
serverSecrets = require('../private/secret.json');
} catch(e) {}
const serverSecrets = require('./server-secrets');
// This is an initial value which makes the code work while the initial data
// is loaded. In the then() callback of scheduleAutosaving(), it's reassigned
@@ -44,6 +38,8 @@ function cancelAutosaving() {
}
function setRoutes(server) {
const baseUrl = process.env.BASE_URL || 'https://shields.io';
server.route(/^\/github-auth$/, function(data, match, end, ask) {
if (!(serverSecrets && serverSecrets.gh_client_id)) {
return end('This server is missing GitHub client secrets.');
@@ -229,6 +225,13 @@ function rmGithubToken(token) {
}
}
// When a global gh_token is configured, use that in place of our shields.io
// token-cycling logic. This produces more predictable behavior when a token
// is provided, and more predictable failures if that token is exhausted.
//
// You can manage your personal GitHub token at https://github.com/settings/tokens
const globalToken = (serverSecrets || {}).gh_token;
// Act like request(), but tweak headers and query to avoid hitting a rate
// limit.
function githubRequest(request, url, query, cb) {
@@ -239,7 +242,8 @@ function githubRequest(request, url, query, cb) {
'User-Agent': 'Shields.io',
'Accept': 'application/vnd.github.v3+json',
};
const githubToken = getReqRemainingToken();
const githubToken = globalToken === null ? getReqRemainingToken() : globalToken;
if (githubToken != null) {
// Typically, GitHub user tokens grants us 12500 req/hour.
@@ -253,8 +257,9 @@ function githubRequest(request, url, query, cb) {
const qs = queryString.stringify(query);
if (qs) { url += '?' + qs; }
request(url, {headers: headers}, function(err, res, buffer) {
if (githubToken != null && err === null) {
if (globalToken !== null && githubToken !== null && err === null) {
if (res.statusCode === 401) { // Unauthorized.
rmGithubToken(githubToken);
} else {