Skip to content

Commit 77924a0

Browse files
mscharleyclaude
mscharley
and
claude
committed
fix(forge): adapt GitHub client to octocrab 0.51 model changes
octocrab 0.51 made PullRequest.html_url non-optional, introduced the SimplePullRequest model returned by pulls().list(), and made many model fields required. Drop the now-dead Option handling on html_url in the create/find/update PR paths and expand the test fixtures to satisfy the stricter deserialisers, restoring a clean build for the 0.51.0 bump. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 3656047 commit 77924a0

4 files changed

Lines changed: 121 additions & 16 deletions

File tree

‎packages/cursus/src/forge/github/octocrab_client.rs‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,7 @@ impl CodeForgeClient for OctocrabGitHubClient {
114114
.send()
115115
.await
116116
.with_context(|| format!("Failed to create pull request '{title}'"))?;
117-
let url = pr
118-
.html_url
119-
.context("GitHub API response missing html_url for created pull request")?
120-
.to_string();
117+
let url = pr.html_url.to_string();
121118
info!("Created pull request: {url}");
122119
Ok(url)
123120
}
@@ -135,7 +132,7 @@ impl CodeForgeClient for OctocrabGitHubClient {
135132
.await
136133
.with_context(|| format!("Failed to list pull requests for branch '{head}'"))?;
137134
Ok(page.items.into_iter().next().map(|pr| {
138-
let html_url = pr.html_url.map_or_else(String::new, |u| u.to_string());
135+
let html_url = pr.html_url.to_string();
139136
PullRequest {
140137
number: pr.number,
141138
html_url,
@@ -159,10 +156,7 @@ impl CodeForgeClient for OctocrabGitHubClient {
159156
.send()
160157
.await
161158
.with_context(|| format!("Failed to update pull request #{pull_number}"))?;
162-
let url = pr
163-
.html_url
164-
.context("GitHub API response missing html_url for updated pull request")?
165-
.to_string();
159+
let url = pr.html_url.to_string();
166160
info!("Updated pull request: {url}");
167161
Ok(url)
168162
}

‎packages/cursus/src/forge/github/tests/octocrab_client.rs‎

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,60 @@ fn asset_body(name: &str) -> Value {
7171
})
7272
}
7373

74-
/// Returns a JSON body that satisfies octocrab's [`PullRequest`] deserialiser.
74+
/// Returns a JSON body that satisfies octocrab's user deserialisers
75+
/// ([`Author`]/`SimpleUser`), both of which require a full set of URL fields.
76+
fn user_body() -> Value {
77+
json!({
78+
"login": "octocat",
79+
"id": 1,
80+
"node_id": "U_1",
81+
"avatar_url": "https://github.com/images/avatar.png",
82+
"gravatar_id": "",
83+
"url": "https://api.github.com/users/octocat",
84+
"html_url": "https://github.com/octocat",
85+
"followers_url": "https://api.github.com/users/octocat/followers",
86+
"following_url": "https://api.github.com/users/octocat/following",
87+
"gists_url": "https://api.github.com/users/octocat/gists",
88+
"starred_url": "https://api.github.com/users/octocat/starred",
89+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
90+
"organizations_url": "https://api.github.com/users/octocat/orgs",
91+
"repos_url": "https://api.github.com/users/octocat/repos",
92+
"events_url": "https://api.github.com/users/octocat/events",
93+
"received_events_url": "https://api.github.com/users/octocat/received_events",
94+
"type": "User",
95+
"site_admin": false,
96+
})
97+
}
98+
99+
/// Returns a JSON body that deserialises as either octocrab's
100+
/// [`PullRequest`] (returned by create/update) or `SimplePullRequest`
101+
/// (returned by list). The body is a superset of both models' required
102+
/// fields; serde ignores the fields the narrower type does not declare.
75103
fn pull_request_body(number: u64, html_url: &str) -> Value {
76104
json!({
77-
"url": "https://example.com/api/pull",
105+
"url": "https://api.github.com/repos/owner/repo/pulls/1",
78106
"id": 1,
107+
"node_id": "PR_1",
79108
"html_url": html_url,
109+
"diff_url": "https://github.com/owner/repo/pull/1.diff",
110+
"patch_url": "https://github.com/owner/repo/pull/1.patch",
111+
"issue_url": "https://api.github.com/repos/owner/repo/issues/1",
112+
"commits_url": "https://api.github.com/repos/owner/repo/pulls/1/commits",
113+
"review_comments_url": "https://api.github.com/repos/owner/repo/pulls/1/comments",
114+
"review_comment_url": "https://api.github.com/repos/owner/repo/pulls/comments{/number}",
115+
"comments_url": "https://api.github.com/repos/owner/repo/issues/1/comments",
116+
"statuses_url": "https://api.github.com/repos/owner/repo/statuses/deadbeef",
80117
"number": number,
118+
"state": "open",
119+
"title": "Release",
120+
"user": user_body(),
121+
"labels": [],
122+
"created_at": "2024-01-01T00:00:00Z",
123+
"updated_at": "2024-01-01T00:00:00Z",
124+
"merged": false,
125+
"assignees": [],
126+
"requested_reviewers": [],
127+
"requested_teams": [],
81128
"head": {
82129
"ref": "release",
83130
"sha": "deadbeef",
@@ -86,6 +133,14 @@ fn pull_request_body(number: u64, html_url: &str) -> Value {
86133
"ref": "main",
87134
"sha": "cafebabe",
88135
},
136+
"_links": {},
137+
"author_association": "OWNER",
138+
"additions": 0,
139+
"deletions": 0,
140+
"changed_files": 0,
141+
"commits": 0,
142+
"review_comments": 0,
143+
"comments": 0,
89144
})
90145
}
91146

‎packages/cursus/tests/github_http.rs‎

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,62 @@ const RELEASE_JSON: &str = r#"{
4242
"assets": []
4343
}"#;
4444

45-
// Minimal JSON for a PR response.
45+
// JSON for a PR response. octocrab 0.51's `PullRequest`/`SimplePullRequest`
46+
// models require a full set of fields (URLs, a user object, diff stats), so
47+
// this body is a superset that satisfies both deserialisers.
4648
const PR_JSON: &str = r#"{
4749
"url": "https://api.github.com/repos/owner/repo/pulls/7",
4850
"id": 1,
51+
"node_id": "PR_7",
4952
"number": 7,
5053
"html_url": "https://github.com/owner/repo/pull/7",
54+
"diff_url": "https://github.com/owner/repo/pull/7.diff",
55+
"patch_url": "https://github.com/owner/repo/pull/7.patch",
56+
"issue_url": "https://api.github.com/repos/owner/repo/issues/7",
57+
"commits_url": "https://api.github.com/repos/owner/repo/pulls/7/commits",
58+
"review_comments_url": "https://api.github.com/repos/owner/repo/pulls/7/comments",
59+
"review_comment_url": "https://api.github.com/repos/owner/repo/pulls/comments",
60+
"comments_url": "https://api.github.com/repos/owner/repo/issues/7/comments",
61+
"statuses_url": "https://api.github.com/repos/owner/repo/statuses/abc123",
62+
"state": "open",
63+
"title": "Release",
64+
"user": {
65+
"login": "octocat",
66+
"id": 1,
67+
"node_id": "U_1",
68+
"avatar_url": "https://github.com/images/avatar.png",
69+
"gravatar_id": "",
70+
"url": "https://api.github.com/users/octocat",
71+
"html_url": "https://github.com/octocat",
72+
"followers_url": "https://api.github.com/users/octocat/followers",
73+
"following_url": "https://api.github.com/users/octocat/following",
74+
"gists_url": "https://api.github.com/users/octocat/gists",
75+
"starred_url": "https://api.github.com/users/octocat/starred",
76+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
77+
"organizations_url": "https://api.github.com/users/octocat/orgs",
78+
"repos_url": "https://api.github.com/users/octocat/repos",
79+
"events_url": "https://api.github.com/users/octocat/events",
80+
"received_events_url": "https://api.github.com/users/octocat/received_events",
81+
"type": "User",
82+
"site_admin": false
83+
},
84+
"labels": [],
85+
"created_at": "2024-01-01T00:00:00Z",
86+
"updated_at": "2024-01-01T00:00:00Z",
87+
"merged": false,
88+
"assignees": [],
89+
"requested_reviewers": [],
90+
"requested_teams": [],
5191
"head": {"ref": "feature", "sha": "abc123"},
52-
"base": {"ref": "main", "sha": "def456"}
92+
"base": {"ref": "main", "sha": "def456"},
93+
"_links": {},
94+
"author_association": "OWNER",
95+
"additions": 0,
96+
"deletions": 0,
97+
"changed_files": 0,
98+
"commits": 0,
99+
"review_comments": 0,
100+
"comments": 0
53101
}"#;
54102

55103
// ── create_release ────────────────────────────────────────────────────────────

‎packages/cursus/tests/prepare_git.rs‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -762,8 +762,16 @@ async fn prepare_branch_strategy_rerun_is_idempotent() {
762762
);
763763
}
764764

765-
const PR_JSON: &str = r#"{"url": "https://api.github.com/repos/acme/app/pulls/7", "id": 1, "number": 7, "html_url": "https://github.com/acme/app/pull/7", "head": {"ref": "cursus-release/main", "sha": "abc123"}, "base": {"ref": "main", "sha": "def456"}}"#;
766-
const PR_LIST_JSON: &str = r#"[{"url": "https://api.github.com/repos/acme/app/pulls/7", "id": 1, "number": 7, "html_url": "https://github.com/acme/app/pull/7", "head": {"ref": "cursus-release/main", "sha": "abc123"}, "base": {"ref": "main", "sha": "def456"}}]"#;
765+
// A PR object that satisfies octocrab 0.51's `PullRequest`/`SimplePullRequest`
766+
// deserialisers, both of which require a full set of URLs, a user object, and
767+
// diff stats. Written once and reused for the single and list responses.
768+
const PR_OBJECT: &str = r#"{"url": "https://api.github.com/repos/acme/app/pulls/7", "id": 1, "node_id": "PR_7", "number": 7, "html_url": "https://github.com/acme/app/pull/7", "diff_url": "https://github.com/acme/app/pull/7.diff", "patch_url": "https://github.com/acme/app/pull/7.patch", "issue_url": "https://api.github.com/repos/acme/app/issues/7", "commits_url": "https://api.github.com/repos/acme/app/pulls/7/commits", "review_comments_url": "https://api.github.com/repos/acme/app/pulls/7/comments", "review_comment_url": "https://api.github.com/repos/acme/app/pulls/comments", "comments_url": "https://api.github.com/repos/acme/app/issues/7/comments", "statuses_url": "https://api.github.com/repos/acme/app/statuses/abc123", "state": "open", "title": "Release", "user": {"login": "octocat", "id": 1, "node_id": "U_1", "avatar_url": "https://github.com/images/avatar.png", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following", "gists_url": "https://api.github.com/users/octocat/gists", "starred_url": "https://api.github.com/users/octocat/starred", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false}, "labels": [], "created_at": "2024-01-01T00:00:00Z", "updated_at": "2024-01-01T00:00:00Z", "merged": false, "assignees": [], "requested_reviewers": [], "requested_teams": [], "head": {"ref": "cursus-release/main", "sha": "abc123"}, "base": {"ref": "main", "sha": "def456"}, "_links": {}, "author_association": "OWNER", "additions": 0, "deletions": 0, "changed_files": 0, "commits": 0, "review_comments": 0, "comments": 0}"#;
769+
const PR_JSON: &str = PR_OBJECT;
770+
771+
/// Builds a single-element list response wrapping [`PR_OBJECT`].
772+
fn pr_list_json() -> String {
773+
format!("[{PR_OBJECT}]")
774+
}
767775

768776
fn make_github_test_env(api_url: &str, dir: &std::path::Path) -> cursus::Env {
769777
use std::sync::Arc;
@@ -875,7 +883,7 @@ async fn prepare_branch_strategy_with_github_upserts_pr_on_rerun() {
875883
.query_param("state", "open");
876884
then.status(200)
877885
.header("Content-Type", "application/json")
878-
.body(PR_LIST_JSON);
886+
.body(pr_list_json());
879887
});
880888
let mock_update = server.mock(|when, then| {
881889
when.method(PATCH).path("/repos/acme/app/pulls/7");

0 commit comments

Comments
 (0)