octocrab を 0.49 に上げる

[zaimy]

Summary

octocrab 0.8.13 から 0.49.x へのバージョンアップです。前段の #23 のマージ後に適用することを想定しています。

Changes

依存関係

• reqwest への直接依存を削除しました。octocrab が内部で reqwest を使わなくなり、 reqwest::Url を介して型を共有する必要がなくなったためです
• url を features = ["serde"] で直接依存に追加しました
• http 1 系を直接依存に追加しました ( Page::next が Option<http::Uri> 型になったため)

コード

• models::User が models::Author に改名されたため、各 fetcher の import を Author as User でエイリアスしたり、直接 Author に切り替えたりして追従しました
• UserId, IssueId, LabelId, CommentId, WorkflowId, JobId, RunId などの id フィールドが pub struct XxxId(pub u64) の newtype になったため、 from.id.0 as i64 のような形で既存レコードの i64 型との間を取り持っています
• Issue::state が IssueState enum、 Issue::author_association が Option<AuthorAssociation> に変更されたので、 IssueRec 側もそれぞれ型を差し替えました
• Job::status / Step::status が workflows::Status enum、 Job::conclusion / Step::conclusion が Option<Conclusion> enum に変更されたので、CSV 出力の snake_case 文字列を維持するため enum_to_string ヘルパ経由で変換しています
• Step::started_at が Option<DateTime> に変更されたので、 JobStepRec::started_at も Option 化しました
• Job::check_run_url が Url から String に変更されたので、 JobRec::check_run_url と JobStepRec::check_run_url も String にしました
• OctocrabBuilder::base_url(&Url) が base_uri(impl TryInto<Uri>) に改名されたので、 src/main.rs の呼び出しを差し替えました

Review points

• CSV 出力のフォーマット互換を維持することを最優先にしています。数値 id は i64 のまま、enum は serde 経由で snake_case 文字列にしています
• Cargo.lock の差分が大きいですが、hyper / rustls / tokio など依存グラフが大きく変わるためです
• 既存テスト ( src/issues.rs::test_convert_issue_model ) が無改修で通過することを確認しました

Context

octx に GitHub App installation token 認証を追加する準備として、3 本に分割した PR のうちの 2 本目です。3 本目で App 認証を追加します。

本 PR では Cargo.toml の version は上げません。3 本マージ完了後にまとめて bump する想定です。

[n01e0]

#23 では repos/{owner}/... のように先頭 / を付けない方針が正しかったと理解しています。あの時点では octocrab 0.8.13 の Octocrab::get が absolute_url(route) を呼び、その中で base_url.join(...) していました。

• octocrab 0.8.13 の get: https://github.com/XAMPPRocky/octocrab/blob/v0.8.13/src/lib.rs#L511-L518
• octocrab 0.8.13 の absolute_url: https://github.com/XAMPPRocky/octocrab/blob/v0.8.13/src/lib.rs#L648-L652

そのため、GHES の GITHUB_API_URL=https://git.example.com/api/v3/ のような base URL では、/repos/... にすると url::Url::join の semantics で /api/v3/ prefix が落ちる、という #23 のコメントは妥当です。

ただ、この PR で octocrab 0.49 に上がることで前提が変わっています。0.49.7 の Octocrab::get は get_with_headers -> parameterized_uri 経由で、渡された route をまず http::Uri::from_str に通しています。

• octocrab 0.49.7 の get / parameterized_uri: https://github.com/XAMPPRocky/octocrab/blob/v0.49.7/src/lib.rs#L1480-L1523

このため、repos/{owner}/{repo}/issues?... や users?... は API リクエストに到達する前に InvalidUri(InvalidFormat) になります。ローカルでも IssueFetcher::fetch を呼ぶ最小テストで octocrab::Error::Uri が返ることを確認しました。

一方で、octocrab 0.49 の BaseUriLayer は base URI の path を保持して request path と結合する実装になっています。

• octocrab 0.49.7 の BaseUriLayer: https://github.com/XAMPPRocky/octocrab/blob/v0.49.7/src/service/middleware/base_uri.rs#L66-L105

なので、#23 の Url::join 前提では repos/... が正しく、#24 の octocrab 0.49 前提では /repos/... のような http::Uri として valid な path が必要、という整理だと思います。

#25 は bump-octocrab を base にした GitHub App 認証追加で、fetcher の route 生成には触れていないため、この問題は #25 では解消されません。この PR の段階で、手動生成している repos/... と users?... の route を 0.49 向けに修正する必要がありそうです。

[zaimy]

@n01e0
ご指摘ありがとうございます。調査いただいたとおり、octocrab 0.49 では Octocrab::get が内部で parameterized_uri 経由で http::Uri::from_str(route) を通していて、 path-only URI は先頭 / が無いと InvalidUri { kind: InvalidFormat } で失敗するため、 repos/... のままではランタイムで Error::Uri になることを確認しました。

BaseUriLayer は base URI の path を trim_end_matches('/') した上で request path に prepend するので、 path-only の /repos/... を渡しておけば GHES の /api/v3/ prefix も正しく保持されることが確認できました。

整理いただいたとおり、 #23 (octocrab 0.8.13) は base_url.join 経由で repos/... が正しく、 この PR では Uri::from_str + BaseUriLayer 経由になるため /repos/... が必要、という前提の違いがありました。
すべての fetcher の route リテラルに先頭 / を付ける修正を f5a8b6d にコミットしました。ご指摘助かりました。

[n01e0]

Looks Yosasou To Me

[zaimy]

ありがとうございまsu!