ferrflow 5.28.1

Universal semantic versioning for monorepos and classic repos
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use anyhow::{Context, Result};

use super::{Forge, MergeRequestResult, ReleaseResult};
use crate::error_code::{self, ErrorCodeExt};

/// Per-page size for paginated GitHub list endpoints. 100 is the API
/// maximum (smaller values just multiply round-trips).
const PER_PAGE: u32 = 100;

/// Hard ceiling on how many pages we'll fetch before bailing. 100 pages
/// × 100 items = 10,000 items, well past anything a release-tagging
/// path needs to scan. The guard is here to prevent a misbehaving API
/// (one that keeps returning a full page) from looping forever. See
/// #524.
const MAX_PAGES: u32 = 100;

pub struct GitHubForge {
    pub token: String,
    pub slug: String,
    pub api_base: String,
    pub agent: ureq::Agent,
}

impl GitHubForge {
    /// Fetch every page of a GitHub list endpoint and return the items
    /// concatenated. Stops as soon as a page returns fewer than
    /// `PER_PAGE` items (the universal end-of-pagination signal, used
    /// by GitHub, GitLab, Forgejo, Bitbucket alike). `base_url` must
    /// already include the path; we append `?per_page=&page=` ourselves.
    ///
    /// Short-circuit: most release-time calls hit small lists (a few
    /// recent releases / comments on a release PR), so the typical path
    /// is one HTTP round-trip.
    fn paginated_json_array(&self, base_url: &str, what: &str) -> Result<Vec<serde_json::Value>> {
        let mut all = Vec::new();
        for page in 1..=MAX_PAGES {
            let url = format!("{base_url}?per_page={PER_PAGE}&page={page}");
            let body: serde_json::Value = self
                .agent
                .get(&url)
                .header("Authorization", &format!("Bearer {}", self.token))
                .header("Accept", "application/vnd.github+json")
                .header("X-GitHub-Api-Version", "2022-11-28")
                .header("User-Agent", "ferrflow")
                .call()
                .with_context(|| format!("Failed to list {what}"))?
                .body_mut()
                .read_json()
                .with_context(|| format!("Failed to parse {what} response"))?;
            let page_items = match body.as_array() {
                Some(arr) if !arr.is_empty() => arr.clone(),
                _ => return Ok(all),
            };
            let len = page_items.len();
            all.extend(page_items);
            if (len as u32) < PER_PAGE {
                return Ok(all);
            }
        }
        Ok(all)
    }
}

impl Forge for GitHubForge {
    fn create_release(
        &self,
        tag: &str,
        body: &str,
        prerelease: bool,
        draft: bool,
        target_commitish: Option<&str>,
    ) -> Result<ReleaseResult> {
        let url = format!("{}/repos/{}/releases", self.api_base, self.slug);

        let mut payload = serde_json::json!({
            "tag_name": tag,
            "name": tag,
            "body": body,
            "draft": draft,
            "prerelease": prerelease,
        });
        if let Some(sha) = target_commitish.filter(|s| !s.is_empty()) {
            payload["target_commitish"] = serde_json::Value::String(sha.to_string());
        }

        let response: serde_json::Value = self
            .agent
            .post(&url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("Accept", "application/vnd.github+json")
            .header("X-GitHub-Api-Version", "2022-11-28")
            .header("User-Agent", "ferrflow")
            .send_json(payload)
            .with_context(|| format!("Failed to create GitHub release for {tag}"))
            .error_code(error_code::GITHUB_CREATE_RELEASE)?
            .body_mut()
            .read_json()
            .unwrap_or(serde_json::Value::Null);

        Ok(ReleaseResult {
            id: response["id"].as_u64(),
            url: response["html_url"].as_str().map(str::to_string),
        })
    }

    fn find_draft_release(&self, tag: &str) -> Result<Option<u64>> {
        let base_url = format!("{}/repos/{}/releases", self.api_base, self.slug);
        // Paginate so repos with >30 (the GitHub default page size) or
        // even >100 releases still find the matching draft. See #524.
        let releases = self
            .paginated_json_array(&base_url, "GitHub releases")
            .error_code(error_code::GITHUB_LIST_RELEASES)?;
        for release in releases {
            if release["draft"].as_bool() == Some(true)
                && release["tag_name"].as_str() == Some(tag)
                && let Some(id) = release["id"].as_u64()
            {
                return Ok(Some(id));
            }
        }
        Ok(None)
    }

    fn publish_release(&self, release_id: u64) -> Result<()> {
        let url = format!(
            "{}/repos/{}/releases/{release_id}",
            self.api_base, self.slug
        );

        let payload = serde_json::json!({
            "draft": false,
        });

        self.agent
            .patch(&url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("Accept", "application/vnd.github+json")
            .header("X-GitHub-Api-Version", "2022-11-28")
            .header("User-Agent", "ferrflow")
            .send_json(payload)
            .with_context(|| format!("Failed to publish GitHub release {release_id}"))
            .error_code(error_code::GITHUB_PUBLISH_RELEASE)?;

        Ok(())
    }

    fn create_merge_request(
        &self,
        head: &str,
        base: &str,
        title: &str,
        body: &str,
    ) -> Result<MergeRequestResult> {
        let url = format!("{}/repos/{}/pulls", self.api_base, self.slug);

        let payload = serde_json::json!({
            "title": title,
            "body": body,
            "head": head,
            "base": base,
        });

        let response: serde_json::Value = self
            .agent
            .post(&url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("Accept", "application/vnd.github+json")
            .header("X-GitHub-Api-Version", "2022-11-28")
            .header("User-Agent", "ferrflow")
            .send_json(payload)
            .with_context(|| format!("Failed to create PR from {head} to {base}"))
            .error_code(error_code::GITHUB_CREATE_PR)?
            .body_mut()
            .read_json()
            .with_context(|| "Failed to parse PR response")
            .error_code(error_code::GITHUB_PARSE_PR)?;

        let number = response["number"]
            .as_u64()
            .ok_or_else(|| anyhow::anyhow!("PR response missing number field"))
            .error_code(error_code::GITHUB_PR_MISSING_FIELD)?;

        let node_id = response["node_id"]
            .as_str()
            .ok_or_else(|| anyhow::anyhow!("PR response missing node_id field"))
            .error_code(error_code::GITHUB_PR_MISSING_FIELD)?
            .to_string();

        Ok(MergeRequestResult {
            id: number,
            auto_merge_key: node_id,
        })
    }

    fn enable_auto_merge(&self, mr: &MergeRequestResult) -> Result<()> {
        let query = serde_json::json!({
            "query": "mutation($prId: ID!) { enablePullRequestAutoMerge(input: { pullRequestId: $prId, mergeMethod: SQUASH }) { pullRequest { number } } }",
            "variables": { "prId": mr.auto_merge_key },
        });

        let graphql_url = format!("{}/graphql", self.api_base);
        let response: serde_json::Value = self
            .agent
            .post(&graphql_url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("User-Agent", "ferrflow")
            .send_json(query)
            .with_context(|| format!("Failed to enable auto-merge on PR #{}", mr.id))
            .error_code(error_code::GITHUB_AUTO_MERGE)?
            .body_mut()
            .read_json()
            .with_context(|| "Failed to parse GraphQL response")
            .error_code(error_code::GITHUB_GRAPHQL_PARSE)?;

        if let Some(errors) = response.get("errors") {
            let msg = errors[0]["message"]
                .as_str()
                .unwrap_or("unknown GraphQL error");
            return Err(anyhow::anyhow!("Auto-merge failed on PR #{}: {msg}", mr.id))
                .error_code(error_code::GITHUB_AUTO_MERGE_FAILED);
        }

        Ok(())
    }

    fn mr_noun(&self) -> &'static str {
        "PR"
    }

    fn release_noun(&self) -> &'static str {
        "GitHub Release"
    }

    fn find_comment(&self, pr_id: u64, marker: &str) -> Result<Option<u64>> {
        let base_url = format!(
            "{}/repos/{}/issues/{}/comments",
            self.api_base, self.slug, pr_id
        );
        // Paginate so a long-lived release PR with hundreds of comments
        // still finds the marker comment. See #524.
        let comments = self.paginated_json_array(&base_url, "PR comments")?;
        for comment in comments {
            if let Some(body) = comment["body"].as_str()
                && body.contains(marker)
                && let Some(id) = comment["id"].as_u64()
            {
                return Ok(Some(id));
            }
        }
        Ok(None)
    }

    fn create_comment(&self, pr_id: u64, body: &str) -> Result<()> {
        let url = format!(
            "{}/repos/{}/issues/{}/comments",
            self.api_base, self.slug, pr_id
        );
        self.agent
            .post(&url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("Accept", "application/vnd.github+json")
            .header("User-Agent", "ferrflow")
            .send_json(serde_json::json!({ "body": body }))
            .with_context(|| "Failed to create PR comment")?;
        Ok(())
    }

    fn update_comment(&self, _pr_id: u64, comment_id: u64, body: &str) -> Result<()> {
        let url = format!(
            "{}/repos/{}/issues/comments/{}",
            self.api_base, self.slug, comment_id
        );
        self.agent
            .patch(&url)
            .header("Authorization", &format!("Bearer {}", self.token))
            .header("Accept", "application/vnd.github+json")
            .header("User-Agent", "ferrflow")
            .send_json(serde_json::json!({ "body": body }))
            .with_context(|| "Failed to update PR comment")?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_forge() -> GitHubForge {
        GitHubForge {
            token: "test-token".to_string(),
            slug: "owner/repo".to_string(),
            api_base: "https://api.github.com".to_string(),
            agent: ureq::Agent::new_with_defaults(),
        }
    }

    #[test]
    fn mr_noun_returns_pr() {
        assert_eq!(make_forge().mr_noun(), "PR");
    }

    #[test]
    fn release_noun_returns_github_release() {
        assert_eq!(make_forge().release_noun(), "GitHub Release");
    }

    #[test]
    fn struct_fields_accessible() {
        let forge = make_forge();
        assert_eq!(forge.token, "test-token");
        assert_eq!(forge.slug, "owner/repo");
    }

    #[test]
    fn find_draft_release_parses_empty_array() {
        let response: serde_json::Value = serde_json::json!([]);
        let releases = response.as_array().unwrap();
        let found = releases.iter().find(|r| {
            r["draft"].as_bool() == Some(true) && r["tag_name"].as_str() == Some("v1.0.0")
        });
        assert!(found.is_none());
    }

    #[test]
    fn find_draft_release_parses_draft() {
        let response: serde_json::Value = serde_json::json!([
            {"id": 1, "tag_name": "v1.0.0", "draft": false},
            {"id": 2, "tag_name": "v1.1.0", "draft": true},
            {"id": 3, "tag_name": "v1.2.0", "draft": true},
        ]);
        let releases = response.as_array().unwrap();
        let found = releases
            .iter()
            .find(|r| {
                r["draft"].as_bool() == Some(true) && r["tag_name"].as_str() == Some("v1.1.0")
            })
            .and_then(|r| r["id"].as_u64());
        assert_eq!(found, Some(2));
    }

    #[test]
    fn find_draft_release_ignores_non_draft() {
        let response: serde_json::Value = serde_json::json!([
            {"id": 1, "tag_name": "v1.0.0", "draft": false},
        ]);
        let releases = response.as_array().unwrap();
        let found = releases
            .iter()
            .find(|r| {
                r["draft"].as_bool() == Some(true) && r["tag_name"].as_str() == Some("v1.0.0")
            })
            .and_then(|r| r["id"].as_u64());
        assert!(found.is_none());
    }

    #[test]
    fn find_draft_release_matches_exact_tag() {
        let response: serde_json::Value = serde_json::json!([
            {"id": 10, "tag_name": "v2.0.0", "draft": true},
            {"id": 20, "tag_name": "v2.0.0-beta.1", "draft": true},
        ]);
        let releases = response.as_array().unwrap();
        let found = releases
            .iter()
            .find(|r| {
                r["draft"].as_bool() == Some(true) && r["tag_name"].as_str() == Some("v2.0.0")
            })
            .and_then(|r| r["id"].as_u64());
        assert_eq!(found, Some(10));
    }

    #[test]
    fn create_release_payload_structure() {
        let payload = serde_json::json!({
            "tag_name": "v1.0.0",
            "name": "v1.0.0",
            "body": "Release notes",
            "draft": true,
            "prerelease": false,
        });
        assert_eq!(payload["tag_name"], "v1.0.0");
        assert_eq!(payload["draft"], true);
        assert_eq!(payload["prerelease"], false);
        assert_eq!(payload["body"], "Release notes");
    }

    #[test]
    fn publish_release_payload_structure() {
        let payload = serde_json::json!({"draft": false});
        assert_eq!(payload["draft"], false);
    }

    #[test]
    fn create_pr_payload_structure() {
        let payload = serde_json::json!({
            "title": "chore(release): v1.0.0",
            "body": "Release PR",
            "head": "release/v1.0.0",
            "base": "main",
        });
        assert_eq!(payload["head"], "release/v1.0.0");
        assert_eq!(payload["base"], "main");
    }

    #[test]
    fn auto_merge_graphql_payload() {
        let query = serde_json::json!({
            "query": "mutation($prId: ID!) { enablePullRequestAutoMerge(input: { pullRequestId: $prId, mergeMethod: SQUASH }) { pullRequest { number } } }",
            "variables": { "prId": "PR_abc123" },
        });
        assert!(
            query["query"]
                .as_str()
                .unwrap()
                .contains("enablePullRequestAutoMerge")
        );
        assert_eq!(query["variables"]["prId"], "PR_abc123");
    }

    #[test]
    fn graphql_error_detection() {
        let response: serde_json::Value = serde_json::json!({
            "errors": [{"message": "Some error"}]
        });
        let errors = response.get("errors");
        assert!(errors.is_some());
        let msg = errors.unwrap()[0]["message"].as_str().unwrap();
        assert_eq!(msg, "Some error");
    }

    #[test]
    fn graphql_no_errors() {
        let response: serde_json::Value = serde_json::json!({
            "data": {"enablePullRequestAutoMerge": {"pullRequest": {"number": 42}}}
        });
        assert!(response.get("errors").is_none());
    }

    #[test]
    fn pr_response_parsing() {
        let response: serde_json::Value = serde_json::json!({
            "number": 42,
            "node_id": "PR_kwDOabc123"
        });
        let number = response["number"].as_u64().unwrap();
        let node_id = response["node_id"].as_str().unwrap();
        assert_eq!(number, 42);
        assert_eq!(node_id, "PR_kwDOabc123");
    }

    #[test]
    fn pr_response_missing_number() {
        let response: serde_json::Value = serde_json::json!({"node_id": "PR_abc"});
        assert!(response["number"].as_u64().is_none());
    }

    #[test]
    fn pr_response_missing_node_id() {
        let response: serde_json::Value = serde_json::json!({"number": 1});
        assert!(response["node_id"].as_str().is_none());
    }

    #[test]
    fn api_base_github_com() {
        let forge = make_forge();
        assert_eq!(forge.api_base, "https://api.github.com");
    }

    #[test]
    fn api_base_github_enterprise() {
        let forge = GitHubForge {
            token: "tok".to_string(),
            slug: "owner/repo".to_string(),
            api_base: "https://github.corp.com/api/v3".to_string(),
            agent: ureq::Agent::new_with_defaults(),
        };
        assert_eq!(forge.api_base, "https://github.corp.com/api/v3");
    }
}