-
Notifications
You must be signed in to change notification settings - Fork 0
/
createComments.js
444 lines (394 loc) · 14 KB
/
createComments.js
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
const request = require('request-promise')
const fs = require('fs-extra')
const { sleep } = require('./utils')
const config = require('./config')
const createMessage = require('./createMessage')
const processImages = require('./processImages')
const api = `${config.target.baseUrl}/${config.target.org}/${config.target.repo}`
//dummy commit to use when the commit is not found
const dummyCommit = ``
/* This is setting up the headers for the request. */
const headers = {
'Accept': 'application/vnd.github.v3+json',
'User-Agent': 'node.js'
}
if (config.target.token) {
headers['Authorization'] = `token ${config.target.commentToken || config.target.token}`
}
/**
* It makes a POST request to the given url with the given body, and returns the response
* @param url - The URL to make the request to.
* @param body - The body of the request.
* @returns A promise
*/
const post = async (url, body) => {
return request({
method: 'POST',
headers,
url,
body,
json: true
})
}
let commits = []
/**
* It checks if a commit exists in the commits.json file
* @param sha - The commit SHA
* @returns A boolean value.
*/
const commitExists = async (sha) => {
if (!commits.length) {
commits = JSON.parse(await fs.readFile(`${config.source.repo}/commits.json`))
}
return !!commits.find(commit => commit.sha === sha)
}
/**
* It takes an ID and a boolean, and if the boolean is true, it adds the ID to the state file
* @param id - The id of the comment to set as processed
* @param [newId=true] - If the comment is a new comment, it will be set to true. If it's an edited
* comment, it will be set to false.
*/
const setCommentProcessed = async (id, newId = true) => {
console.log(`Setting ${id} as processed`)
const state = JSON.parse(await fs.readFile(`./${config.source.repo}/state.json`))
state.comments = state.comments || {}
state.comments[id] = newId
await fs.writeFile(`./${config.source.repo}/state.json`, JSON.stringify(state, null, ' '))
}
/**
* It takes an id and a boolean, and if the boolean is true, it sets the id as processed in the
* state.json file
* @param id - The id of the review.
* @param [newId=true] - If the review is a new review, then we'll set this to true. If it's an
* existing review, then we'll set this to false.
*/
const setReviewProcessed = async (id, newId = true) => {
console.log(`Setting ${id} as processed`)
const state = JSON.parse(await fs.readFile(`./${config.source.repo}/state.json`))
state.reviews = state.reviews || {}
state.reviews[id] = newId
await fs.writeFile(`./${config.source.repo}/state.json`, JSON.stringify(state, null, ' '))
}
/**
* It checks if a comment has already been processed
* @param id - The id of the comment to check
* @returns A boolean value.
*/
const isCommentProcessed = async (id) => {
const state = JSON.parse(await fs.readFile(`./${config.source.repo}/state.json`))
return !!(state.comments || {})[id]
}
/**
* It reads the state file, and returns true if the review with the given ID has already been processed
* @param id - The ID of the review.
* @returns A boolean value.
*/
const isReviewProcessed = async (id) => {
const state = JSON.parse(await fs.readFile(`./${config.source.repo}/state.json`))
return !!(state.reviews || {})[id]
}
/**
* If the comment has a state property, it's a review comment, if it has a pull_request_url property,
* it's a pull request comment, and if it has a commit_id property but no pull_request_url property,
* it's a commit comment
*/
const isReviewComment = comment => !!comment.state
const isPullRequestComment = comment => !!comment.pull_request_url
const isCommitComment = comment => !!comment.commit_id && !comment.pull_request_url
/**
* It logs an error message to the console
* @param comment - The comment object that was created
* @param err - The error message
*/
const logError = (comment, err) => {
console.log(`Could not create comment: ${comment.id}`)
console.log(`Message: ${err}`)
}
/**
* It creates a comment
* @param comment - The comment object from the GitHub API
* @param comments - The comments array from the GitHub API response
*/
const createComment = async (comment, comments) => {
const { id } = comment
if (isReviewComment(comment)) {
await createReview(comment)
} else if (isPullRequestComment(comment)) {
await createPullRequestComment(comment, comments)
} else if (isCommitComment(comment)) {
await createCommitComment(comment, comments)
} else {
await createIssueComment(comment)
}
}
/**
* It takes a state and returns an event
* @param state - The current state of the pull request.
* @returns The event that is being returned is the event that is being passed in.
*/
const getEvent = (state) => {
switch(state) {
case 'APPROVED':
return 'APPROVE'
case 'CHANGES_REQUESTED':
return 'REQUEST_CHANGES'
default:
return ''
}
}
/**
* It creates a review on a pull request if the review has not already been processed and the review is
* not a comment or a dismissed review
* @param comment - The comment object from the GitHub API
*/
const createReview = async (comment) => {
const { id } = comment
if (await isReviewProcessed(id)) {
console.log(`Review ${id} already processed`)
} else if (comment.state === 'COMMENTED') {
console.log(`Review ${id} is a comment - skipping`)
} else if (comment.state === 'DISMISSED') {
console.log(`Review ${id} was dismissed - skipping`)
} else {
const number = comment.pull_request_url.split('/').pop()
const url = `${api}/pulls/${number}/reviews`
const event = getEvent(comment.state)
if (event) {
const body = {
commit_id: comment.commit_id,
body: comment.body,
event,
comments: []
}
await post(url, body)
.then(async response => {
await setReviewProcessed(id, response.id)
return response
})
.catch(err => {
console.log(`Could not create review ${id}`)
logError(comment, err)
})
} else {
console.log(`Review ${id} has no event type ${comment} - skipping`)
}
}
}
/**
* It checks if a comment exists on a pull request
* @param pullRequestId - The ID of the pull request you want to check.
* @param commentId - The ID of the comment you want to check.
* @returns A boolean value
*/
const isPullRequestCommentMade = async (pullRequestId, commentId) => {
const url = `${api}/repos/${config.target.org}/${config.target.repo}/pulls/${pullRequestId}/comments/${commentId}`
let exists = true
try {
await request({
method: 'GET',
headers,
url,
json: true,
})
} catch (error) {
exists = false
}
return exists
}
/**
* It checks if the comment has already been processed, if not it processes the comment and adds it to
* the pull request
* @param comment - The comment object from the source repo
* @param [comments] - An array of comments that are replies to the comment being created.
*/
const createPullRequestComment = async (comment, comments = []) => {
const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
const { id } = comment
const issueNumber = comment.pull_request_url.split('/').pop()
const url = `${api}/pulls/${issueNumber}/comments`
if (await isCommentProcessed(id)) {
console.log(`Comment ${id} already processed`)
} else {
const commentBody = await processImages(comment.body)
console.log(`Adding comment ${id} to ${url}`)
let body
const reply = comments.find(c => c.original_commit_id === comment.original_commit_id && c.original_position === comment.original_position && c.diff_hunk === comment.diff_hunk)
if (reply) {
const state = JSON.parse(await fs.readFile(`./${config.source.repo}/state.json`))
body = {
body: `${createMessage(comment)}\n\n\n${commentBody}`,
in_reply_to: (state.comments || {})[reply.id],
}
} else {
body = {
body: `${createMessage(comment)}\n\n\n${commentBody}`,
commit_id: comment.original_commit_id,
path: comment.path,
position: comment.original_position,
}
}
await post(url, body)
.then(async response => {
await setCommentProcessed(id, response.id)
})
.catch(err => {
console.log(`Commit ${comment.original_commit_id} no longer exists`)
const body = {
body: `${createMessage(comment)}\n> **Outdated (history rewrite)** - original diff\n---\n\`\`\`diff\n${comment.diff_hunk}\n\`\`\`\n\n\n${commentBody}`,
commit_id: comment.commit_id,
path: comment.path,
position: comment.position == null ? comment.original_position : comment.position,
}
return post(url, body)
.then(async response => {
await setCommentProcessed(id, response.id)
})
.catch(async err => {
if (err.error && err.error && err.error.errors && err.error.errors[0].field) {
console.log(`Commit ${comment.commit_id} no longer exists (someone did a force push)`)
console.log('Skipping')
} else {
console.log('Error creating issue:', err);
await delay(10 * 60 * 500); // Delay for 5 minutes
console.log('Retrying...');
await createPullRequestComment(comment, comments);
}
await setCommentProcessed(id, true)
})
})
}
}
/**
* It checks if a comment exists on a commit
* @param commitSha - The commit SHA of the commit you want to check for a comment.
* @param commentId - The ID of the comment you want to check.
* @returns A boolean value.
*/
const isCommitCommentMade = async (commitSha, commentId) => {
const url = `${api}/repos/${config.target.org}/${config.target.repo}/commits/${commitSha}/comments/${commentId}`
let exists = true
try {
await request({
method: 'GET',
headers,
url,
json: true,
})
} catch (error) {
exists = false
}
return exists
}
/**
* It checks if the comment has already been processed, if not, it checks if the commit still exists,
* if it does, it adds the comment to the commit, if not, it adds the comment to a dummy commit
* @param comment - The comment object from the database
*/
const createCommitComment = async (comment) => {
const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
const { id } = comment
const sha = comment.commit_id;
const url = `${api}/commits/${sha}/comments`
const commentBody = await processImages(comment.body)
if (await isCommentProcessed(id)) {
console.log(`Comment ${id} already processed`)
} else if (!await commitExists(sha)) {
//console.log(`Commit ${sha} no longer exists`)
console.log(`Adding comment ${id} to ${url}`)
const body = {
body: `${createMessage(comment)}\n\n\n${commentBody}`,
dummyCommit,
path: comment.path,
position: comment.position
}
} else {
console.log(`Adding comment ${id} to ${url}`)
const body = {
body: `${createMessage(comment)}\n\n\n${commentBody}`,
sha,
path: comment.path,
position: comment.position
}
await post(url, body)
.then(async response => {
await setCommentProcessed(id, response.id)
return response
})
.catch(async err => {
console.log('Error creating issue:', err);
await delay(10 * 60 * 500); // Delay for 10 minutes
console.log('Retrying...');
await createCommitComment(comment);
})
}
}
/**
* It checks if a comment exists on an issue
* @param issue - the issue object from the GitHub API
* @param commentId - The ID of the comment you want to check for.
* @returns A boolean value.
*/
const isIssueCommentMade = async (issue, commentId) => {
const url = `${api}/repos/${config.target.org}/${config.target.repo}/issues/${issue.number}/comments/${commentId}`
let exists = true
try {
await request({
method: 'GET',
headers,
url,
json: true,
})
} catch (error) {
exists = false
}
return exists
}
/**
* It checks if the comment has already been processed, if not it adds it to the issue
* @param comment - The comment object from the GitHub API
*/
const createIssueComment = async (comment) => {
const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
const { id } = comment
const issueNumber = comment.issue_url.split('/').pop()
const url = `${api}/issues/${issueNumber}/comments`
const commentBody = await processImages(comment.body)
if (await isCommentProcessed(id)) {
console.log(`Comment ${id} already processed`)
} else {
console.log(`Adding comment ${id} to ${url}`)
const body = {
body: `${createMessage(comment)}\n\n\n${commentBody}`
}
await post(url, body)
.then(async response => {
await setCommentProcessed(id, response.id)
return response
})
.catch(async err => {
console.log('Error creating issue:', err);
await delay(10 * 60 * 500); // Delay for 5 minutes
console.log('Retrying...');
await createIssueComment(comment);
})
}
}
const main = async () => {
const issueComments = JSON.parse(await fs.readFile(`${config.source.repo}/issue-comments.json`))
const commitComments = JSON.parse(await fs.readFile(`${config.source.repo}/comments.json`))
const pullComments = JSON.parse(await fs.readFile(`${config.source.repo}/pull-comments.json`))
const reviewComments = JSON.parse(await fs.readFile(`${config.source.repo}/review-comments.json`))
const reviews = JSON.parse(await fs.readFile(`${config.source.repo}/reviews.json`))
const comments = []
.concat(issueComments, commitComments, pullComments, reviewComments, reviews)
.sort((a, b) => (a.created_at || a.submitted_at) > (b.created_at || b.submitted_at) ? 1 : -1)
console.log(`Comments to process: ${comments.length}`)
let processed = 0
for (let comment of comments) {
process.stdout.write(`\r Comments remaining:${((comments.length - processed) / comments.length).toFixed(2)}% `);
await createComment(comment, comments)
processed++
await sleep(1000)
}
}
main().catch(console.error)