/
github.ts
307 lines (278 loc) · 8.49 KB
/
github.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
import URL from 'url';
import { GotError } from 'got';
import pAll from 'p-all';
import parseLinkHeader from 'parse-link-header';
import {
PLATFORM_BAD_CREDENTIALS,
PLATFORM_INTEGRATION_UNAUTHORIZED,
PLATFORM_RATE_LIMIT_EXCEEDED,
REPOSITORY_CHANGED,
} from '../../constants/error-messages';
import { PLATFORM_TYPE_GITHUB } from '../../constants/platforms';
import { logger } from '../../logger';
import { ExternalHostError } from '../../types/errors/external-host-error';
import { maskToken } from '../mask';
import { Http, HttpPostOptions, HttpResponse, InternalHttpOptions } from '.';
let baseUrl = 'https://api.github.com/';
export const setBaseUrl = (url: string): void => {
baseUrl = url;
};
type GotRequestError<E = unknown, T = unknown> = GotError & {
body: {
message?: string;
errors?: E[];
};
headers?: Record<string, T>;
};
interface GithubInternalOptions extends InternalHttpOptions {
body?: string;
}
export interface GithubHttpOptions extends InternalHttpOptions {
paginate?: boolean | string;
pageLimit?: number;
token?: string;
}
interface GithubGraphqlResponse<T = unknown> {
data?: {
repository?: T;
};
errors?: { message: string; locations: unknown }[];
}
export function handleGotError(
err: GotRequestError,
url: string | URL,
opts: GithubHttpOptions
): never {
const path = url.toString();
let message = err.message || '';
if (err.body?.message) {
message = err.body.message;
}
if (
err.name === 'RequestError' &&
(err.code === 'ENOTFOUND' ||
err.code === 'ETIMEDOUT' ||
err.code === 'EAI_AGAIN')
) {
logger.debug({ err }, 'GitHub failure: RequestError');
throw new ExternalHostError(err, PLATFORM_TYPE_GITHUB);
}
if (err.name === 'ParseError') {
logger.debug({ err }, '');
throw new ExternalHostError(err, PLATFORM_TYPE_GITHUB);
}
if (err.statusCode >= 500 && err.statusCode < 600) {
logger.debug({ err }, 'GitHub failure: 5xx');
throw new ExternalHostError(err, PLATFORM_TYPE_GITHUB);
}
if (
err.statusCode === 403 &&
message.startsWith('You have triggered an abuse detection mechanism')
) {
logger.debug({ err }, 'GitHub failure: abuse detection');
throw new Error(PLATFORM_RATE_LIMIT_EXCEEDED);
}
if (err.statusCode === 403 && message.includes('Upgrade to GitHub Pro')) {
logger.debug({ path }, 'Endpoint needs paid GitHub plan');
throw err;
}
if (err.statusCode === 403 && message.includes('rate limit exceeded')) {
logger.debug({ err }, 'GitHub failure: rate limit');
throw new Error(PLATFORM_RATE_LIMIT_EXCEEDED);
}
if (
err.statusCode === 403 &&
message.startsWith('Resource not accessible by integration')
) {
logger.debug(
{ err },
'GitHub failure: Resource not accessible by integration'
);
throw new Error(PLATFORM_INTEGRATION_UNAUTHORIZED);
}
if (err.statusCode === 401 && message.includes('Bad credentials')) {
const rateLimit = err.headers ? err.headers['x-ratelimit-limit'] : -1;
logger.debug(
{
token: maskToken(opts.token),
err,
},
'GitHub failure: Bad credentials'
);
if (rateLimit === '60') {
throw new ExternalHostError(err, PLATFORM_TYPE_GITHUB);
}
throw new Error(PLATFORM_BAD_CREDENTIALS);
}
if (err.statusCode === 422) {
if (
message.includes('Review cannot be requested from pull request author')
) {
throw err;
} else if (
err.body &&
err.body.errors &&
err.body.errors.find((e: any) => e.code === 'invalid')
) {
throw new Error(REPOSITORY_CHANGED);
}
logger.debug({ err }, '422 Error thrown from GitHub');
throw new ExternalHostError(err, PLATFORM_TYPE_GITHUB);
}
if (err.statusCode === 404) {
logger.debug({ url: err.url }, 'GitHub 404');
} else {
logger.debug({ err }, 'Unknown GitHub error');
}
throw err;
}
interface GraphqlOptions {
paginate?: boolean;
count?: number;
acceptHeader?: string;
fromEnd?: boolean;
}
export class GithubHttp extends Http<GithubHttpOptions, GithubHttpOptions> {
constructor(options?: GithubHttpOptions) {
super(PLATFORM_TYPE_GITHUB, options);
}
protected async request<T>(
url: string | URL,
options?: GithubInternalOptions & GithubHttpOptions,
okToRetry = true
): Promise<HttpResponse<T> | null> {
let result = null;
const opts = {
baseUrl,
...options,
throwHttpErrors: true,
};
const method = opts.method || 'get';
if (method.toLowerCase() === 'post' && url === 'graphql') {
// GitHub Enterprise uses unversioned graphql path
opts.baseUrl = opts.baseUrl.replace('/v3/', '/');
}
const accept = global.appMode
? 'application/vnd.github.machine-man-preview+json'
: 'application/vnd.github.v3+json';
opts.headers = {
accept,
...opts.headers,
};
const optsAccept = opts.headers.accept;
if (typeof optsAccept === 'string' && !optsAccept.includes(accept)) {
opts.headers.accept = `${accept}, ${optsAccept}`;
}
try {
result = await super.request<T>(url, opts);
if (result !== null) {
if (opts.paginate) {
// Check if result is paginated
const pageLimit = opts.pageLimit || 10;
const linkHeader =
result?.headers?.link &&
parseLinkHeader(result.headers.link as string);
if (linkHeader && linkHeader.next && linkHeader.last) {
let lastPage = +linkHeader.last.page;
if (!process.env.RENOVATE_PAGINATE_ALL && opts.paginate !== 'all') {
lastPage = Math.min(pageLimit, lastPage);
}
const pageNumbers = Array.from(
new Array(lastPage),
(x, i) => i + 1
).slice(1);
const queue = pageNumbers.map((page) => (): Promise<
HttpResponse
> => {
const nextUrl = URL.parse(linkHeader.next.url, true);
delete nextUrl.search;
nextUrl.query.page = page.toString();
return this.request(
URL.format(nextUrl),
{ ...opts, paginate: false },
okToRetry
);
});
const pages = await pAll(queue, { concurrency: 5 });
result.body = result.body.concat(
...pages.filter(Boolean).map((page) => page.body)
);
}
}
}
} catch (err) {
handleGotError(err, url, opts);
}
return result;
}
private async getGraphql<T = unknown>(
query: string,
accept = 'application/vnd.github.merge-info-preview+json'
): Promise<GithubGraphqlResponse<T>> {
let result = null;
const path = 'graphql';
const opts: HttpPostOptions = {
body: { query },
headers: { accept },
};
logger.trace(`Performing Github GraphQL request`);
try {
const res = await this.postJson('graphql', opts);
result = res?.body;
} catch (gotErr) {
handleGotError(gotErr, path, opts);
}
return result;
}
async getGraphqlNodes<T = Record<string, unknown>>(
queryOrig: string,
fieldName: string,
options: GraphqlOptions = {}
): Promise<T[]> {
const result: T[] = [];
const regex = new RegExp(`(\\W)${fieldName}(\\s*)\\(`);
const { paginate = true, acceptHeader } = options;
let count = options.count || 100;
let cursor = null;
let isIterating = true;
while (isIterating) {
let query = queryOrig;
if (paginate) {
let replacement = `$1${fieldName}$2(first: ${count}`;
replacement += cursor ? `, after: "${cursor}", ` : ', ';
query = query.replace(regex, replacement);
}
const gqlRes = await this.getGraphql<T>(query, acceptHeader);
if (
gqlRes &&
gqlRes.data &&
gqlRes.data.repository &&
gqlRes.data.repository[fieldName]
) {
const { nodes = [], edges = [], pageInfo } = gqlRes.data.repository[
fieldName
];
result.push(...nodes);
result.push(...edges);
if (paginate && pageInfo) {
const { hasNextPage, endCursor } = pageInfo;
if (hasNextPage && endCursor) {
cursor = endCursor;
} else {
isIterating = false;
}
}
} else {
count = Math.floor(count / 2);
if (count === 0) {
logger.error({ gqlRes }, 'Error fetching GraphQL nodes');
isIterating = false;
}
}
if (!paginate) {
isIterating = false;
}
}
return result;
}
}