lgtm-cli 0.7.1

Run LGTM code reviews with a bundled web UI and gRPC server.
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

//! Provider-agnostic `RemoteForge` trait and remote forge implementations.

pub mod github;
pub mod models;

pub use github::GitHubForge;
pub use models::{
    ForgeCommentUpdate, ForgeDraftCommentInput, ForgeDraftCommentReceipt, ForgePullRequest,
    ForgePullRequestBundle, ForgeReviewComment, ForgeReviewReceipt, ForgeReviewSession,
};

use crate::backend::{
    error::Result, extensions::gitoxide::HeadCommitPayload, models::ReviewOutcome,
};

/// Provider-agnostic interface for synchronizing pull/merge requests, pending reviews, comments, and viewed-file states with a remote forge.
#[async_trait::async_trait]
pub trait RemoteForge: Send + Sync {
    /// Push a committed head tree and commit to `refs/heads/<branch>` on the remote forge when supported via API.
    async fn push_branch(
        &self,
        _repository_url: &str,
        _branch: &str,
        _payload: &HeadCommitPayload,
    ) -> Result<Option<String>> {
        Ok(None)
    }

    /// Pull the latest pull request metadata, review sessions, and comments for `branch_or_pr`.
    async fn get_pull_request_bundle(
        &self,
        repository_url: &str,
        branch_or_pr: &str,
    ) -> Result<ForgePullRequestBundle>;

    /// Create a pending review session on the remote forge for `pr_number` at `head_sha`.
    async fn create_pending_review(
        &self,
        repository_url: &str,
        pr_number: u64,
        head_sha: &str,
    ) -> Result<String>;

    /// Create a draft comment on a remote pull request (creating a pending review first if `pending_review_id` is `None`).
    async fn create_remote_draft_comment(
        &self,
        repository_url: &str,
        pr_number: u64,
        pending_review_id: Option<&str>,
        comment: &ForgeDraftCommentInput,
    ) -> Result<ForgeDraftCommentReceipt>;

    /// Update an existing comment's body, anchor, or thread resolution state on the remote forge.
    async fn update_remote_comment(
        &self,
        repository_url: &str,
        forge_id: &str,
        update: &ForgeCommentUpdate,
    ) -> Result<()>;

    /// Delete a comment from the remote forge.
    async fn delete_remote_comment(&self, repository_url: &str, forge_id: &str) -> Result<()>;

    /// Mark or unmark `file_path` as viewed on the remote pull request.
    async fn set_remote_file_viewed(
        &self,
        repository_url: &str,
        pr_forge_id: Option<&str>,
        pr_number: u64,
        file_path: &str,
        viewed: bool,
    ) -> Result<()>;

    /// Submit a pending review session with `outcome` and optional summary `body` on the remote forge.
    async fn submit_pending_review(
        &self,
        repository_url: &str,
        pr_number: u64,
        pending_review_id: Option<&str>,
        outcome: ReviewOutcome,
        body: Option<&str>,
    ) -> Result<ForgeReviewReceipt>;
}