-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Expand file tree
/
Copy pathcreate_pr_review.ts
More file actions
307 lines (284 loc) · 9.43 KB
/
Copy pathcreate_pr_review.ts
File metadata and controls
307 lines (284 loc) · 9.43 KB
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 {
isRecord,
nullableNonEmptyString,
optionalNonEmptyString,
readGitHubErrorMessage,
requiredNonEmptyString,
requiredNumber,
requiredString,
} from '@/tools/github/response-parsers'
import {
parseReviewComments,
REVIEW_BODY_MAX_LENGTH,
reviewCommentSchema,
} from '@/tools/github/review-schema'
import type {
CreatePRReviewComment,
CreatePRReviewParams,
PRReviewResponse,
} from '@/tools/github/types'
import { USER_OUTPUT } from '@/tools/github/types'
import type { ToolConfig, ToolResponse } from '@/tools/types'
const COMMIT_SHA_PATTERN = /^[0-9a-f]{40}(?:[0-9a-f]{24})?$/i
interface GitHubReviewUser {
login: string
id: number
avatar_url: string
html_url: string
type: string
}
interface GitHubReview {
id: number
user: GitHubReviewUser | null
body: string
state: string
html_url: string
pull_request_url: string
commit_id: string | null
submitted_at?: string
}
interface CreatePRReviewV2Response extends ToolResponse {
output: GitHubReview
}
interface CreatePRReviewRequestBody {
event: CreatePRReviewParams['event']
body?: string
commit_id?: string
comments?: CreatePRReviewComment[]
}
const REVIEW_RESPONSE_CONTEXT = 'GitHub review response'
function parseReviewUser(value: unknown): GitHubReviewUser | null {
if (value === null) return null
if (!isRecord(value)) throw new Error('GitHub review response has an invalid user')
const context = `${REVIEW_RESPONSE_CONTEXT}.user`
return {
login: requiredNonEmptyString(value, 'login', context),
id: requiredNumber(value, 'id', context),
avatar_url: requiredNonEmptyString(value, 'avatar_url', context),
html_url: requiredNonEmptyString(value, 'html_url', context),
type: requiredNonEmptyString(value, 'type', context),
}
}
function parseGitHubReview(value: unknown): GitHubReview {
if (!isRecord(value)) throw new Error('GitHub review response must be an object')
const submittedAt = optionalNonEmptyString(value, 'submitted_at', REVIEW_RESPONSE_CONTEXT)
return {
id: requiredNumber(value, 'id', REVIEW_RESPONSE_CONTEXT),
user: parseReviewUser(value.user),
body: requiredString(value, 'body', REVIEW_RESPONSE_CONTEXT),
state: requiredNonEmptyString(value, 'state', REVIEW_RESPONSE_CONTEXT),
html_url: requiredNonEmptyString(value, 'html_url', REVIEW_RESPONSE_CONTEXT),
pull_request_url: requiredNonEmptyString(value, 'pull_request_url', REVIEW_RESPONSE_CONTEXT),
commit_id: nullableNonEmptyString(value, 'commit_id', REVIEW_RESPONSE_CONTEXT),
...(submittedAt ? { submitted_at: submittedAt } : {}),
}
}
function parseReviewEvent(value: unknown): CreatePRReviewParams['event'] {
if (value === 'APPROVE' || value === 'REQUEST_CHANGES' || value === 'COMMENT') {
return value
}
throw new Error('event must be APPROVE, REQUEST_CHANGES, or COMMENT')
}
function parseCommitId(value: unknown): string | undefined {
if (value === undefined) return undefined
if (typeof value !== 'string' || !COMMIT_SHA_PATTERN.test(value.trim())) {
throw new Error('commit_id must be a full 40- or 64-character commit SHA')
}
return value.trim()
}
export const createPRReviewTool: ToolConfig<CreatePRReviewParams, PRReviewResponse> = {
id: 'github_create_pr_review',
name: 'GitHub Create PR Review',
description:
'Submit a review for a pull request. Use APPROVE, REQUEST_CHANGES, or COMMENT. A body is required for REQUEST_CHANGES and COMMENT reviews.',
version: '1.0.0',
params: {
owner: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Repository owner',
},
repo: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Repository name',
},
pullNumber: {
type: 'number',
required: true,
visibility: 'user-or-llm',
description: 'Pull request number',
},
event: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'The review action to perform: APPROVE, REQUEST_CHANGES, or COMMENT',
},
body: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'The body text of the review (required for REQUEST_CHANGES and COMMENT)',
},
commit_id: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description:
'The SHA of the commit that needs a review (required when posting inline comments; defaults to the most recent commit otherwise)',
},
comments: {
type: 'array',
required: false,
visibility: 'user-or-llm',
description: 'Optional inline comments with required path, body, line, and side fields',
items: reviewCommentSchema,
},
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'GitHub API token',
},
},
request: {
url: (params) =>
`https://api.github.com/repos/${params.owner}/${params.repo}/pulls/${params.pullNumber}/reviews`,
method: 'POST',
headers: (params) => ({
Accept: 'application/vnd.github+json',
Authorization: `Bearer ${params.apiKey}`,
'X-GitHub-Api-Version': '2022-11-28',
}),
body: (params) => {
const comments = parseReviewComments(params.comments)
const commitId = parseCommitId(params.commit_id)
if (comments.length > 0 && !commitId) {
throw new Error('commit_id is required when posting inline review comments')
}
const event = parseReviewEvent(params.event)
const reviewBody = params.body?.trim()
if ((event === 'COMMENT' || event === 'REQUEST_CHANGES') && !reviewBody) {
throw new Error(`body is required for ${event} reviews`)
}
if (reviewBody && reviewBody.length > REVIEW_BODY_MAX_LENGTH) {
throw new Error(`body must not exceed ${REVIEW_BODY_MAX_LENGTH} characters`)
}
const body: CreatePRReviewRequestBody = {
event,
}
if (reviewBody) body.body = reviewBody
if (commitId) body.commit_id = commitId
if (comments.length > 0) body.comments = comments
return body
},
},
transformResponse: async (response) => {
if (!response.ok) {
return {
success: false,
error:
(await readGitHubErrorMessage(response)) ??
`Failed to submit PR review (HTTP ${response.status})`,
output: {
content: '',
metadata: { id: 0, state: '', body: '', html_url: '', commit_id: null },
},
}
}
const value: unknown = await response.json()
const review = parseGitHubReview(value)
const content = `Review submitted for PR #${review.pull_request_url.split('/').pop()}
State: ${review.state}
URL: ${review.html_url}`
return {
success: true,
output: {
content,
metadata: {
id: review.id,
state: review.state,
body: review.body,
html_url: review.html_url,
commit_id: review.commit_id,
},
},
}
},
outputs: {
content: { type: 'string', description: 'Human-readable review confirmation' },
metadata: {
type: 'object',
description: 'Review metadata',
properties: {
id: { type: 'number', description: 'Review ID' },
state: {
type: 'string',
description: 'Review state (APPROVED/CHANGES_REQUESTED/COMMENTED)',
},
body: { type: 'string', description: 'Review body text' },
html_url: { type: 'string', description: 'GitHub web URL for the review' },
commit_id: { type: 'string', description: 'SHA of the reviewed commit', nullable: true },
},
},
},
}
export const createPRReviewV2Tool: ToolConfig<CreatePRReviewParams, CreatePRReviewV2Response> = {
id: 'github_create_pr_review_v2',
name: createPRReviewTool.name,
description: createPRReviewTool.description,
version: '2.0.0',
params: createPRReviewTool.params,
request: createPRReviewTool.request,
transformResponse: async (response: Response) => {
if (!response.ok) {
return {
success: false,
error:
(await readGitHubErrorMessage(response)) ??
`Failed to submit PR review (HTTP ${response.status})`,
output: {
id: 0,
user: null,
body: '',
state: '',
html_url: '',
pull_request_url: '',
commit_id: null,
},
}
}
const value: unknown = await response.json()
const review = parseGitHubReview(value)
return {
success: true,
output: {
id: review.id,
user: review.user,
body: review.body,
state: review.state,
html_url: review.html_url,
pull_request_url: review.pull_request_url,
commit_id: review.commit_id,
...(review.submitted_at ? { submitted_at: review.submitted_at } : {}),
},
}
},
outputs: {
id: { type: 'number', description: 'Review ID' },
user: { ...USER_OUTPUT, nullable: true },
body: { type: 'string', description: 'Review body text' },
state: { type: 'string', description: 'Review state (APPROVED/CHANGES_REQUESTED/COMMENTED)' },
html_url: { type: 'string', description: 'GitHub web URL for the review' },
pull_request_url: { type: 'string', description: 'API URL of the reviewed pull request' },
commit_id: { type: 'string', description: 'SHA of the reviewed commit', nullable: true },
submitted_at: {
type: 'string',
description: 'Review submission timestamp',
optional: true,
},
},
}