-
-
Notifications
You must be signed in to change notification settings - Fork 367
/
GitHubAPI.ts
496 lines (426 loc) · 15.6 KB
/
GitHubAPI.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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
import { Octokit as GitHubNodeAPI } from "@octokit/rest"
import { debug } from "../../debug"
import * as node_fetch from "node-fetch"
import parse from "parse-link-header"
import pLimit from "p-limit"
import { GitHubPRDSL, GitHubIssueComment, GitHubUser } from "../../dsl/GitHubDSL"
import { dangerIDToString } from "../../runner/templates/githubIssueTemplate"
import { api as fetch } from "../../api/fetch"
import { RepoMetaData } from "../../dsl/BitBucketServerDSL"
import { CheckOptions } from "./comms/checks/resultsToCheck"
// The Handle the API specific parts of the github
export type APIToken = string
const limit = pLimit(25)
// Note that there are parts of this class which don't seem to be
// used by Danger, they are exposed for Peril support.
/** This represent the GitHub API */
export class GitHubAPI {
fetch: typeof fetch
additionalHeaders: any
private readonly d = debug("GitHubAPI")
private pr: GitHubPRDSL | undefined
constructor(public readonly repoMetadata: RepoMetaData, public readonly token?: APIToken) {
// This allows Peril to DI in a new Fetch function
// which can handle unique API edge-cases around integrations
this.fetch = fetch
this.additionalHeaders = {}
}
/**
* Bit weird, yes, but we want something that can be exposed to an end-user.
* I wouldn't have a problem with moving this to use this API under the hood
* but for now that's just a refactor someone can try.
*/
getExternalAPI = (accessTokenForApp?: string): GitHubNodeAPI => {
// A token should have been set by this point
const token = accessTokenForApp || this.token!
const host = process.env["DANGER_GITHUB_API_BASE_URL"] || process.env["GITHUB_URL"] || undefined
const options: ConstructorParameters<typeof GitHubNodeAPI>[0] & { debug: boolean } = {
debug: !!process.env.LOG_FETCH_REQUESTS,
baseUrl: host,
auth: `token ${token}`,
}
if (this.additionalHeaders) {
options.headers = this.additionalHeaders
}
return new GitHubNodeAPI(options)
}
/**
* Grabs the contents of an individual file on GitHub
*
* @param {string} path path to the file
* @param {string} [ref] an optional sha
* @returns {Promise<string>} text contents
*
*/
fileContents = async (path: string, repoSlug?: string, ref?: string): Promise<string> => {
// Use the current state of PR if no repo/ref is passed
if (!repoSlug || !ref) {
const prJSON = await this.getPullRequestInfo()
repoSlug = prJSON.head.repo.full_name
ref = prJSON.head.ref
}
const data = await this.getFileContents(path, repoSlug, ref)
const buffer = Buffer.from(data.content, "base64")
return buffer.toString()
}
// The above is the API for Platform
getDangerCommentIDs = async (dangerID: string): Promise<string[]> => {
const userID = await this.getUserID()
const allComments = await this.getPullRequestComments()
const dangerIDMessage = dangerIDToString(dangerID)
this.d(`User ID: ${userID}`)
this.d(`Looking at ${allComments.length} comments for ${dangerIDMessage}`)
return allComments
.filter((comment) => comment.body.includes(dangerIDMessage)) // does it contain the right danger ID?
.filter((comment) => comment.user.id === userID) // Does it have the right user ID?
.filter((comment) => comment.body.includes("Generated by")) // Does it look like a danger message?
.map((comment) => comment.id) // only return IDs
}
updateCommentWithID = async (id: string, comment: string): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const res = await this.patch(
`repos/${repo}/issues/comments/${id}`,
{},
{
body: comment,
}
)
return res.json()
}
deleteCommentWithID = async (id: string): Promise<boolean> => {
const repo = this.repoMetadata.repoSlug
const res = await this.api(`repos/${repo}/issues/comments/${id}`, {}, null, "DELETE")
//https://developer.github.com/v3/issues/comments/#response-5
return Promise.resolve(res.status === 204)
}
deleteInlineCommentWithID = async (id: string): Promise<boolean> => {
const repo = this.repoMetadata.repoSlug
const res = await this.api(`repos/${repo}/pulls/comments/${id}`, {}, null, "DELETE", false)
//https://developer.github.com/v3/pulls/comments/#response-5
return Promise.resolve(res.status === 204)
}
getUserID = async (): Promise<number | undefined> => {
const perilID = process.env["PERIL_BOT_USER_ID"]
if (perilID) {
return parseInt(perilID)
}
const useGitHubActionsID = process.env["GITHUB_WORKFLOW"]
if (useGitHubActionsID) {
// This is the user.id of the github-actions app (https://github.com/apps/github-actions)
// that is used to comment when using danger in a GitHub Action
// with GITHUB_TOKEN (https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)
return 41898282
}
const info = await this.getUserInfo()
if (info.id) {
return info.id
}
return undefined
}
postPRComment = async (comment: string): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.post(
`repos/${repo}/issues/${prID}/comments`,
{},
{
body: comment,
}
)
return res.json()
}
postInlinePRComment = async (comment: string, commitId: string, path: string, position: number) => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.post(
`repos/${repo}/pulls/${prID}/comments`,
{},
{
body: comment,
commit_id: commitId,
path: path,
position: position,
},
false
)
if (res.ok) {
return res.json()
} else {
throw await res.json()
}
}
postInlinePRReview = async (commitId: string, comments: { comment: string; path: string; position: number }[]) => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.post(
`repos/${repo}/pulls/${prID}/reviews`,
{},
{
body: "",
event: "COMMENT",
commit_id: commitId,
comments: comments.map(({ comment, path, position }) => ({
body: comment,
path,
position,
})),
},
false
)
if (res.ok) {
return res.json()
} else {
throw await res.json()
}
}
updateInlinePRComment = async (comment: string, commentId: string) => {
const repo = this.repoMetadata.repoSlug
const res = await this.patch(
`repos/${repo}/pulls/comments/${commentId}`,
{},
{
body: comment,
},
false
)
if (res.ok) {
return res.json()
} else {
throw await res.json()
}
}
getPullRequestInfo = async (): Promise<GitHubPRDSL> => {
if (this.pr) {
return this.pr
}
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.get(`repos/${repo}/pulls/${prID}`)
const prDSL = (await res.json()) as GitHubPRDSL
this.pr = prDSL
if (res.ok) {
return prDSL
} else {
throw `Could not get PR Metadata for repos/${repo}/pulls/${prID}`
}
}
getPullRequestCommits = async (): Promise<any[]> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
return await this.getAllOfResource(`repos/${repo}/pulls/${prID}/commits`)
}
/**
* Get list of commits in pull requests. This'll try to iterate all available pages
* Until it reaches hard limit of api itself (250 commits).
* https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
*
*/
getAllOfResource = async (path: string): Promise<any> => {
const ret: Array<any> = []
/**
* Read response header and locate next page for pagination via link header.
* If not found, will return -1.
*
* @param response Github API response sent via node-fetch
*/
const getNextPageFromLinkHeader = (response: node_fetch.Response): number => {
const linkHeader = response.headers.get("link")
if (!linkHeader) {
this.d(`getNextPageFromLinkHeader:: Given response does not contain link header for pagination`)
return -1
}
const parsedHeader = parse(linkHeader)
this.d(`getNextPageFromLinkHeader:: Link header found`, parsedHeader)
if (!!parsedHeader.next && !!parsedHeader.next.page) {
return parsedHeader.next.page
}
return -1
}
//iterates commit request pages until next page's not available, or response failed for some reason.
let page = 0
while (page >= 0) {
const requestUrl = `${path}${page > 0 ? `?page=${page}` : ""}`
this.d(`getPullRequestCommits:: Sending pull request commit request for ${page === 0 ? "first" : `${page}`} page`)
this.d(`getPullRequestCommits:: Request url generated "${requestUrl}"`)
const response = await this.get(requestUrl)
if (response.ok) {
ret.push(...(await response.json()))
page = getNextPageFromLinkHeader(response)
} else {
this.d(
`getPullRequestCommits:: Failed to get response while traverse page ${page} with ${response.status}, bailing rest of pages if exists`
)
page = -1
}
}
return ret
}
getUserInfo = async (): Promise<GitHubUser> => {
const response = await this.get("user")
return response.json()
}
getPullRequestComments = async (): Promise<GitHubIssueComment[]> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
return await this.getAllOfResource(`repos/${repo}/issues/${prID}/comments`)
}
getPullRequestInlineComments = async (
dangerID: string
): Promise<(GitHubIssueComment & { ownedByDanger: boolean })[]> => {
const userID = await this.getUserID()
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const dangerIDMessage = dangerIDToString(dangerID)
return await this.getAllOfResource(`repos/${repo}/pulls/${prID}/comments`).then((v: GitHubIssueComment[]) => {
return v
.filter(Boolean)
.map((i) => {
return { ...i, ownedByDanger: i.user.id == userID && i.body.includes(dangerIDMessage) }
})
.filter((i) => i.ownedByDanger)
})
}
getPullRequestDiff = async () => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.get(`repos/${repo}/pulls/${prID}`, {
Accept: "application/vnd.github.v3.diff",
})
return res.ok ? res.text() : ""
}
getFileContents = async (path: string, repoSlug: string, ref: string): Promise<any> => {
const res = await this.get(`repos/${repoSlug}/contents/${path}?ref=${ref}`)
return res.ok ? res.json() : { content: "" }
}
getPullRequests = async (): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const res = await this.get(`repos/${repo}/pulls`)
return res.ok ? res.json() : []
}
getReviewerRequests = async (): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.get(`repos/${repo}/pulls/${prID}/requested_reviewers`, {
Accept: "application/vnd.github.v3+json",
})
return res.ok ? res.json() : []
}
getReviews = async (): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.get(`repos/${repo}/pulls/${prID}/reviews`, {
Accept: "application/vnd.github.v3+json",
})
return res.ok ? res.json() : []
}
getIssue = async (): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const prID = this.repoMetadata.pullRequestID
const res = await this.get(`repos/${repo}/issues/${prID}`)
return res.ok ? res.json() : { labels: [] }
}
updateStatus = async (
passed: boolean | "pending",
message: string,
url?: string,
dangerID?: string,
ciCommitHash?: string
): Promise<any> => {
const repo = this.repoMetadata.repoSlug
const prJSON = await this.getPullRequestInfo()
const ref = ciCommitHash || prJSON.head.sha
let state = passed ? "success" : "failure"
if (passed === "pending") {
state = "pending"
}
// This is the bold bit of the status message, it kinda feels like
// the name of the service.
let context = dangerID || "Danger"
// Suppress errors, because in OSS
// this failure could be due to access rights.
//
// So only error when it's a real message.
const statusURL = `repos/${repo}/statuses/${ref}`
try {
const res = await this.post(
statusURL,
{},
{
state: state,
context: context,
target_url: url || "http://danger.systems/js",
description: message,
},
true
)
if (!res.ok) {
this.d(`Got a non-OK (${res.status} ${res.statusText}) response from ${statusURL}:`)
this.d(JSON.stringify(res, null, " "))
}
return res.ok
} catch (error) {
this.d(`Posting a status to: ${statusURL} failed, this is the response:`)
this.d((error && (error as Error).message) || error)
}
}
postCheckRun = async (check: CheckOptions, token: string) => {
const repo = this.repoMetadata.repoSlug
const res = await this.post(
`repos/${repo}/check-runs`,
{
Accept: "application/vnd.github.antiope-preview+json,application/vnd.github.machine-man-preview+json",
Authorization: `token ${token}`,
},
check
)
if (res.ok) {
return res.json()
} else {
throw await res.json()
}
}
// API Helpers
private api = (path: string, headers: any = {}, body: any = {}, method: string, suppressErrors?: boolean) => {
if (this.token && !headers["Authorization"]) {
headers["Authorization"] = `token ${this.token}`
}
const containsBase = path.startsWith("http")
const baseUrl = process.env["DANGER_GITHUB_API_BASE_URL"] || process.env["GITHUB_URL"] || "https://api.github.com"
const url = containsBase ? path : `${baseUrl}/${path}`
let customAccept = {}
if (headers.Accept && this.additionalHeaders.Accept) {
// We need to merge the accepts which are comma separated according to the HTML spec
// e.g. https://gist.github.com/LTe/5270348
// But make sure it doesn't already include it
if (headers.Accept.includes(this.additionalHeaders.Accept)) {
// If it's already a subset, ignore
customAccept = { Accept: headers.Accept }
} else {
customAccept = { Accept: `${this.additionalHeaders.Accept}, ${headers.Accept}` }
}
}
const finalHeaders = {
"Content-Type": "application/json",
...headers,
...this.additionalHeaders,
...customAccept,
}
this.d("Sending: ", url, finalHeaders)
return limit(() =>
this.fetch(
url,
{
method,
body,
headers: finalHeaders,
},
suppressErrors
)
)
}
get = (path: string, headers: any = {}): Promise<node_fetch.Response> => this.api(path, headers, null, "GET")
post = (path: string, headers: any = {}, body: any = {}, suppressErrors?: boolean): Promise<node_fetch.Response> =>
this.api(path, headers, JSON.stringify(body), "POST", suppressErrors)
patch = (path: string, headers: any = {}, body: any = {}, suppressErrors?: boolean): Promise<node_fetch.Response> =>
this.api(path, headers, JSON.stringify(body), "PATCH", suppressErrors)
}