interprex-github 7.0.0

GitHub provider for all Interprex development-platform domains
Documentation
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
//! Code-review operations implemented with GitHub pull-request APIs.
//!
//! The read combines pull-request facts, formal reviews, inline threads,
//! unanchored comments and outstanding requests into one provider-neutral
//! observation. GitHub's REST review and issue-comment records identify
//! reviews, apps and unanchored comments; GraphQL supplies thread locations,
//! resolution, complete comment sequences and outstanding requests. The
//! provider joins them here so callers never correlate GitHub entities.
//!
//! Checks are read separately, per commit, from GitHub's check-runs endpoint,
//! which reports the current run of each check within each check suite on that
//! commit. Runs sharing a name across suites all remain. GitHub's legacy commit
//! statuses are a different mechanism with its own endpoint and are not read
//! here.

use async_trait::async_trait;
use interprex::{
    ChangeRequest, ChangeRequestCommentsProvider, ChangeRequestHead, ChangeRequestNumber,
    CheckOutcome, CheckRun, CodeReviewsProvider, FindingResolution, FindingResolutionRecord,
    FindingResolutionReply, ProviderError, Repository, Result, ReviewCommentId,
    ReviewRequestTarget, ReviewRequestTargetInspection, ReviewTargetsProvider, ReviewThreadId,
    ReviewThreadStatus, ReviewerApplicationsProvider,
};
use octocrab::Page;
use serde::Deserialize;
use serde_json::json;

use crate::{GithubProvider, client::external};

mod actors;
mod branch_updates;
mod change_requests;
pub(crate) mod checks;
mod finding_resolutions;
mod review_publications;
mod review_requests;
mod review_threads;
mod reviewer_applications;
mod target_inspections;
mod text_records;

use change_requests::{
    GithubPullRequestNumber, head_filter, normalize_change_request, number, observed_head,
    thread_references_missing_review,
};
use checks::{conclusion, normalize_check_run};
use finding_resolutions::{
    ADD_THREAD_REPLY, AddThreadReplyData, RESOLVE_THREAD, ResolveThreadData,
    github_resolution_reply,
};
use review_requests::REQUEST_REVIEWS_BY_LOGIN;

#[derive(Deserialize)]
struct CreatedUnanchoredComment {
    node_id: String,
}

const MARK_READY: &str = r#"
mutation MarkReady($pullRequestId: ID!) {
  markPullRequestReadyForReview(input: {pullRequestId: $pullRequestId}) {
    pullRequest { id isDraft }
  }
}"#;

#[derive(Default, Deserialize, PartialEq)]
struct PageInfo {
    #[serde(rename = "hasNextPage")]
    has_next_page: bool,
    #[serde(rename = "endCursor")]
    end_cursor: Option<String>,
}

fn continuation_cursor(
    page_info: &PageInfo,
    operation: &'static str,
    collection: &str,
) -> Result<Option<String>> {
    if !page_info.has_next_page {
        return Ok(None);
    }
    page_info
        .end_cursor
        .clone()
        .map(Some)
        .ok_or_else(|| ProviderError::External {
            provider: "github",
            operation,
            message: format!("GitHub reported another {collection} page without an end cursor"),
        })
}

#[async_trait]
impl CodeReviewsProvider for GithubProvider {
    #[tracing::instrument(
        name = "interprex.provider.code_reviews.change_request",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn change_request(
        &self,
        repository: &Repository,
        number: ChangeRequestNumber,
    ) -> Result<ChangeRequest> {
        let pull_request = self.github_pull_request(repository, number).await?;
        let mut reviews = self.github_reviews(repository, number).await?;
        let mut threads = self.github_review_threads(repository, number).await?;
        if thread_references_missing_review(&reviews, &threads) {
            reviews = self.github_reviews(repository, number).await?;
            threads = self.github_review_threads(repository, number).await?;
        }
        let requests = self.github_review_requests(repository, number).await?;
        // The timeline is a whole paginated read on its own and the request
        // times it carries describe outstanding requests only, so it is read
        // when at least one outstanding request names a reviewer to match.
        let request_events = if requests
            .iter()
            .any(|request| request.target_key().is_some())
        {
            self.github_review_request_events(repository, number)
                .await?
        } else {
            Vec::new()
        };
        let unanchored_comments = self.github_unanchored_comments(repository, number).await?;
        let mut pull_request = pull_request;
        if pull_request.is_open() {
            let target = self
                .target_branch_revision(repository, &pull_request.base.branch)
                .await?;
            pull_request.observe_target(target);
        }
        normalize_change_request(
            pull_request,
            reviews,
            threads,
            requests,
            request_events,
            unanchored_comments,
        )
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.open_change_requests",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn open_change_requests(
        &self,
        repository: &Repository,
        head: &ChangeRequestHead,
    ) -> Result<Vec<ChangeRequestNumber>> {
        let filter = head_filter(head);
        let page: Page<GithubPullRequestNumber> = self
            .user()?
            .get(
                format!("/repos/{repository}/pulls"),
                Some(&[
                    ("head", filter.as_str()),
                    ("state", "open"),
                    ("per_page", "100"),
                ]),
            )
            .await
            .map_err(|error| external("list open change requests", error))?;
        let listed = self
            .user()?
            .all_pages(page)
            .await
            .map_err(|error| external("list open change requests", error))?;
        let mut numbers = Vec::new();
        for pull_request in listed {
            match observed_head(&pull_request.head)? {
                Some(observed) if &observed == head => numbers.push(number(pull_request.number)?),
                // The filter addresses an owner and a branch, so another
                // repository of the same owner can answer it.
                Some(_) => {}
                None => {
                    return Err(ProviderError::Unrepresentable {
                        provider: "github",
                        fact: format!(
                            "change request {} proposes branch {} from a repository GitHub no longer identifies, so whether it proposes {} cannot be established",
                            pull_request.number,
                            pull_request.head.branch,
                            head.repository()
                        ),
                    });
                }
            }
        }
        Ok(numbers)
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.resolve_thread",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn resolve_thread(
        &self,
        _repository: &Repository,
        _number: ChangeRequestNumber,
        thread_id: &ReviewThreadId,
    ) -> Result<()> {
        let response: ResolveThreadData = self
            .user()?
            .graphql(&json!({
                "query": RESOLVE_THREAD,
                "variables": { "threadId": thread_id.as_str() }
            }))
            .await
            .map_err(|error| external("resolve review thread", error))?;
        let resolved = response.resolve_review_thread.thread;
        if resolved.id == thread_id.as_str() && resolved.is_resolved {
            Ok(())
        } else {
            Err(ProviderError::External {
                provider: "github",
                operation: "resolve review thread",
                message: format!(
                    "GitHub returned thread {} with isResolved={} for requested thread {}",
                    resolved.id,
                    resolved.is_resolved,
                    thread_id.as_str()
                ),
            })
        }
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.resolve_finding",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn resolve_finding(
        &self,
        repository: &Repository,
        number: ChangeRequestNumber,
        thread_id: &ReviewThreadId,
        resolution: FindingResolution,
        reply: &FindingResolutionReply,
    ) -> Result<()> {
        let change_request = self.change_request(repository, number).await?;
        let finding = change_request
            .reviews
            .iter()
            .flat_map(|review| &review.findings)
            .find(|finding| &finding.id == thread_id)
            .ok_or_else(|| ProviderError::NotFound {
                entity: format!("finding thread {}", thread_id.as_str()),
            })?;
        if let Some(FindingResolutionRecord::Unsupported {
            metadata_format, ..
        }) = &finding.resolution
        {
            return Err(ProviderError::Unrepresentable {
                provider: "github",
                fact: format!(
                    "finding thread {} contains unsupported resolution metadata format {metadata_format}",
                    thread_id.as_str()
                ),
            });
        }
        if matches!(
            &finding.resolution,
            Some(FindingResolutionRecord::Supported {
                resolution: recorded,
                ..
            }) if *recorded == resolution
        ) {
            return if finding.status == ReviewThreadStatus::Resolved {
                Ok(())
            } else {
                self.resolve_thread(repository, number, thread_id).await
            };
        }
        let already_resolved = finding.status == ReviewThreadStatus::Resolved;
        let body = github_resolution_reply(resolution, reply.as_str());
        let response: AddThreadReplyData = self
            .user()?
            .graphql(&json!({
                "query": ADD_THREAD_REPLY,
                "variables": { "threadId": thread_id.as_str(), "body": body }
            }))
            .await
            .map_err(|error| external("record finding resolution", error))?;
        if response
            .add_pull_request_review_thread_reply
            .comment
            .id
            .is_empty()
        {
            return Err(ProviderError::External {
                provider: "github",
                operation: "record finding resolution",
                message: "GitHub returned an empty reply identifier".to_owned(),
            });
        }
        if already_resolved {
            Ok(())
        } else {
            self.resolve_thread(repository, number, thread_id).await
        }
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.request_reviewers",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn request_reviewers(
        &self,
        repository: &Repository,
        number: ChangeRequestNumber,
        reviewers: &[ReviewRequestTarget],
    ) -> Result<()> {
        let pull_request = self.github_pull_request(repository, number).await?;
        let mut user_logins = Vec::new();
        let mut bot_logins = Vec::new();
        let mut team_slugs = Vec::new();
        for reviewer in reviewers {
            match reviewer {
                ReviewRequestTarget::User(login) => user_logins.push(login.as_str()),
                ReviewRequestTarget::Bot(login) => bot_logins.push(if login.ends_with("[bot]") {
                    login.clone()
                } else {
                    format!("{login}[bot]")
                }),
                ReviewRequestTarget::Team(identifier) => team_slugs.push(identifier.as_str()),
            }
        }
        let _: serde_json::Value = self
            .user()?
            .graphql(&json!({
                "query": REQUEST_REVIEWS_BY_LOGIN,
                "variables": {
                    "pullRequestId": pull_request.node_id,
                    "userLogins": user_logins,
                    "botLogins": bot_logins,
                    "teamSlugs": team_slugs,
                }
            }))
            .await
            .map_err(|error| external("request code reviewers", error))?;
        Ok(())
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.mark_ready",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn mark_ready(&self, repository: &Repository, number: ChangeRequestNumber) -> Result<()> {
        let pull_request = self.github_pull_request(repository, number).await?;
        let _: serde_json::Value = self
            .user()?
            .graphql(&json!({
                "query": MARK_READY,
                "variables": { "pullRequestId": pull_request.node_id }
            }))
            .await
            .map_err(|error| external("mark change request ready", error))?;
        Ok(())
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.checks",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn checks(&self, repository: &Repository, head_sha: &str) -> Result<Vec<CheckRun>> {
        self.github_check_runs(repository, head_sha)
            .await?
            .into_iter()
            .map(normalize_check_run)
            .collect()
    }

    #[tracing::instrument(
        name = "interprex.provider.code_reviews.publish_check",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn publish_check(
        &self,
        repository: &Repository,
        app_name: &str,
        outcome: &CheckOutcome,
    ) -> Result<()> {
        let _: serde_json::Value = self
            .app(app_name)?
            .post(
                format!("/repos/{repository}/check-runs"),
                Some(&json!({
                    "name": outcome.name,
                    "head_sha": outcome.head_sha,
                    "status": "completed",
                    "conclusion": conclusion(&outcome.conclusion),
                    "output": { "title": outcome.name, "summary": outcome.summary }
                })),
            )
            .await
            .map_err(|error| external("publish change request check", error))?;
        Ok(())
    }
}

#[async_trait]
impl ChangeRequestCommentsProvider for GithubProvider {
    #[tracing::instrument(
        name = "interprex.provider.code_reviews.create_unanchored_comment",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn create_unanchored_comment(
        &self,
        repository: &Repository,
        number: ChangeRequestNumber,
        body: &str,
    ) -> Result<ReviewCommentId> {
        let response: CreatedUnanchoredComment = self
            .user()?
            .post(
                format!("/repos/{repository}/issues/{}/comments", number.get()),
                Some(&json!({ "body": body })),
            )
            .await
            .map_err(|error| external("create unanchored comment", error))?;
        ReviewCommentId::new(response.node_id).map_err(|error| ProviderError::Unrepresentable {
            provider: "github",
            fact: error.to_string(),
        })
    }
}

#[async_trait]
impl ReviewTargetsProvider for GithubProvider {
    #[tracing::instrument(
        name = "interprex.provider.code_reviews.inspect_review_request_target",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn inspect_review_request_target(
        &self,
        repository: &Repository,
        target: &ReviewRequestTarget,
    ) -> Result<ReviewRequestTargetInspection> {
        self.github_review_request_target(repository, target).await
    }
}

#[async_trait]
impl ReviewerApplicationsProvider for GithubProvider {
    #[tracing::instrument(
        name = "interprex.provider.code_reviews.resolve_reviewer_application",
        skip_all,
        fields(interprex.provider.name = "github")
    )]
    async fn resolve_reviewer_application(
        &self,
        repository: &Repository,
        slug: &str,
    ) -> Result<interprex::ReviewerApplication> {
        self.github_reviewer_application(repository, slug).await
    }
}