Skip to main content

IssueRun

Struct IssueRun 

Source
pub struct IssueRun {
    pub issue: i64,
    pub title: String,
    pub status: Status,
    pub pr: Option<String>,
    pub rounds: u32,
    pub disputes: Vec<Dispute>,
    pub filed: Vec<String>,
    pub notes: Vec<String>,
}
Expand description

The outcome of working one issue, or resuming one PR.

Fields§

§issue: i64§title: String§status: Status§pr: Option<String>§rounds: u32§disputes: Vec<Dispute>§filed: Vec<String>§notes: Vec<String>

Implementations§

Source§

impl IssueRun

Source

pub fn new(issue: i64, title: impl Into<String>) -> Self

Examples found in repository?
examples/preview.rs (line 160)
34fn main() {
35    let loose = std::env::args().any(|a| a == "--loose");
36    let style = if loose {
37        Style {
38            terse: false,
39            ..Style::default()
40        }
41    } else {
42        Style::default()
43    };
44    if loose {
45        println!("(concision gate OFF: this is what a model would post unedited)");
46    }
47
48    rule("A clean review");
49    println!(
50        "{}",
51        review_comment(
52            "codex",
53            1,
54            &Review {
55                verdict: Verdict::Approve,
56                next_action: NextAction::Merge,
57                summary: "I reviewed the changes on this branch carefully and I am happy to \
58                          report that the retry path is correct, the backoff calculation is \
59                          sound, and the new test covers the 429 case that the issue described. \
60                          I have no objections to this change landing as it stands."
61                    .into(),
62                findings: vec![],
63            },
64            &style
65        )
66    );
67
68    rule("A review with real work in it");
69    println!(
70        "{}",
71        review_comment(
72            "codex",
73            2,
74            &Review {
75                verdict: Verdict::ChangesRequested,
76                next_action: NextAction::HandBack,
77                summary: "There is one genuine defect here that should block, along with a \
78                          couple of improvements that I do not think need to gate this \
79                          particular pull request, and one pre-existing problem I noticed \
80                          while reading the surrounding code."
81                    .into(),
82                findings: vec![
83                    finding(
84                        "blocking",
85                        "Retry loop never terminates when max_attempts is unset",
86                        "I confirmed this by running the 429 test with max_attempts left at its \
87                         default of None: the loop spins forever because the guard on line 91 \
88                         compares against Some(0) rather than checking for None first. This is \
89                         not a theoretical concern, the test hangs and I had to kill it.",
90                        "src/net.rs:88",
91                        true,
92                    ),
93                    finding(
94                        "non-blocking",
95                        "The request timeout is hard coded to thirty seconds",
96                        "It would be better if this were configurable, since a slow upstream \
97                         will now fail rather than wait, but the previous code had the same \
98                         limitation so this is not a regression introduced by the change.",
99                        "src/net.rs:44",
100                        true,
101                    ),
102                    finding(
103                        "nit",
104                        "Log line says \"retrying\" without saying how many attempts remain",
105                        "Purely a readability point for whoever is reading the logs at 3am.",
106                        "src/net.rs:102",
107                        true,
108                    ),
109                    finding(
110                        "blocking",
111                        "Config loader swallows a parse error",
112                        "Unrelated to this PR, but load_config discards the error from serde and \
113                         returns Default::default(), so a typo in the config file is silently \
114                         ignored.",
115                        "src/config.rs:210",
116                        false,
117                    ),
118                ],
119            },
120            &style
121        )
122    );
123
124    rule("Answering that review");
125    println!(
126        "{}",
127        disposition_comment(
128            "claude",
129            &ResponseDoc {
130                summary: "One of the two blocking points was right and I have fixed it. I do not \
131                          agree with the other and have explained why below rather than changing \
132                          working code to make the review go away."
133                    .into(),
134                dispositions: vec![],
135            },
136            &["Retry loop never terminates when max_attempts is unset".to_string()],
137            &[
138                "Config loader swallows a parse error. The caller already validates the file \
139               against the schema before load_config is reached, so the discarded error is \
140               unreachable in practice."
141                    .to_string()
142            ],
143            &["https://github.com/you/thing/issues/512".to_string()],
144            &style
145        )
146        .unwrap_or_default()
147    );
148
149    rule("The pull request body");
150    println!(
151        "{}",
152        pr_body(
153            478,
154            "Retry a 429 with exponential backoff instead of failing the request.",
155            &style
156        )
157    );
158
159    rule("What a whole run leaves on the PR (the default, one comment)");
160    let mut ended = IssueRun::new(482, "t");
161    ended.disputes = vec![Dispute {
162        title: "Config loader swallows a parse error".into(),
163        reasoning: "the caller validates against the schema before load_config is reached".into(),
164    }];
165    ended.filed = vec![
166        "https://github.com/you/thing/issues/485".into(),
167        "https://github.com/you/thing/issues/486".into(),
168    ];
169    println!(
170        "{}",
171        outcome_comment(
172            &ended,
173            &spar::model::Ledger::new(),
174            &Ending::OutOfRounds,
175            &style
176        )
177        .unwrap_or_default()
178    );
179    println!("\n  (and a clean run that filed nothing posts no comment at all)");
180
181    rule("A review of somebody else's pull request (spar review)");
182    let judged = |standing, severity, title: &str, detail: &str, file: &str, by: &str| Judged {
183        finding: finding(severity, title, detail, file, true),
184        raised_by: by.to_string(),
185        standing,
186        counterpoint: None,
187        defence: None,
188    };
189    let mut disputed = judged(
190        Standing::Disputed,
191        "blocking",
192        "Config loader swallows a parse error",
193        "load_config discards the error from serde and returns a default.",
194        "src/config.rs:210",
195        "claude",
196    );
197    disputed.counterpoint =
198        Some("the caller validates against the schema before load_config is reached".into());
199    println!(
200        "{}",
201        verdict_comment(
202            &[
203                judged(
204                    Standing::Corroborated,
205                    "blocking",
206                    "Retry loop never terminates when max_attempts is unset",
207                    "Both reviewers reproduced this: the guard on line 91 compares against \
208                     Some(0) rather than checking for None, so the 429 test hangs.",
209                    "src/net.rs:88",
210                    "claude and codex",
211                ),
212                judged(
213                    Standing::Confirmed,
214                    "non-blocking",
215                    "The request timeout is hard coded",
216                    "Not a regression, the previous code had the same limitation.",
217                    "src/net.rs:44",
218                    "codex",
219                ),
220                judged(
221                    Standing::Unverified,
222                    "nit",
223                    "Log line does not say how many attempts remain",
224                    "Readability for whoever reads the logs at 3am.",
225                    "src/net.rs:102",
226                    "claude",
227                ),
228                disputed,
229                judged(
230                    Standing::Withdrawn,
231                    "blocking",
232                    "Off by one in the backoff",
233                    "Withdrawn after the other reviewer pointed at the test that covers it.",
234                    "src/net.rs:70",
235                    "codex",
236                ),
237            ],
238            &style
239        )
240    );
241
242    rule("An issue both reviewers declined");
243    println!(
244        "{}",
245        skip_comment(
246            &SkippedItem {
247                issue: 91,
248                title: "Add a dark mode".into(),
249                reasons: [
250                    (
251                        "claude".to_string(),
252                        "This was already implemented in 1.4 and shipped behind the theme \
253                         setting, so there is nothing left to do here."
254                            .to_string()
255                    ),
256                    (
257                        "codex".to_string(),
258                        "Duplicate of #62, which is still open and has the full discussion."
259                            .to_string()
260                    ),
261                ]
262                .into_iter()
263                .collect(),
264            },
265            &style
266        )
267    );
268    println!();
269}
Source

pub fn succeeded(&self) -> bool

Whether this outcome counts as the run having done its job.

A review that produced findings did its job: the findings are the product, and a PR needing work is not a failure of the reviewer.

Trait Implementations§

Source§

impl Clone for IssueRun

Source§

fn clone(&self) -> IssueRun

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IssueRun

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for IssueRun

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for IssueRun

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.