Skip to main content

interprex_github/
releases.rs

1//! Release and asset operations owned by the releases domain.
2//!
3//! Release metadata is normalized into the shared model. Downloads return
4//! Octocrab's response chunks directly. Uploads accept a declared length and a
5//! one-shot stream, use GitHub's upload host, and deliberately bypass request
6//! retries: a partially consumed stream cannot be replayed safely. A caller may
7//! retry the whole operation only by constructing a fresh stream.
8
9use async_trait::async_trait;
10use futures_util::TryStreamExt;
11use http::{Request, header};
12use http_body::Frame;
13use http_body_util::StreamBody;
14use interprex::{
15    AssetId, AssetStream, AssetStreamError, AssetUpload, NewRelease, ProviderError, Release,
16    ReleaseAsset, ReleaseId, ReleasesProvider, Repository, Result,
17};
18use octocrab::{FromResponse, OctoBody};
19use percent_encoding::{NON_ALPHANUMERIC, utf8_percent_encode};
20use serde::Deserialize;
21use serde_json::json;
22
23use crate::{GithubProvider, client::external};
24
25#[derive(Deserialize)]
26struct GithubRelease {
27    id: u64,
28    tag_name: String,
29    name: Option<String>,
30    body: Option<String>,
31    draft: bool,
32    prerelease: bool,
33    #[serde(default)]
34    assets: Vec<GithubAsset>,
35}
36
37#[derive(Deserialize)]
38struct GithubAsset {
39    id: u64,
40    name: String,
41    label: Option<String>,
42    size: i64,
43    browser_download_url: String,
44}
45
46fn normalize_asset(value: GithubAsset) -> Result<ReleaseAsset> {
47    Ok(ReleaseAsset {
48        id: AssetId::new(value.id).map_err(|error| ProviderError::Unrepresentable {
49            provider: "github",
50            fact: error.to_string(),
51        })?,
52        name: value.name,
53        label: value.label,
54        size: u64::try_from(value.size).map_err(|error| ProviderError::Unrepresentable {
55            provider: "github",
56            fact: error.to_string(),
57        })?,
58        download_url: value.browser_download_url,
59    })
60}
61
62fn normalize_release(value: GithubRelease) -> Result<Release> {
63    Ok(Release {
64        id: ReleaseId::new(value.id).map_err(|error| ProviderError::Unrepresentable {
65            provider: "github",
66            fact: error.to_string(),
67        })?,
68        tag: value.tag_name,
69        name: value.name,
70        body: value.body,
71        draft: value.draft,
72        prerelease: value.prerelease,
73        assets: value
74            .assets
75            .into_iter()
76            .map(normalize_asset)
77            .collect::<Result<_>>()?,
78    })
79}
80
81#[async_trait]
82impl ReleasesProvider for GithubProvider {
83    async fn release_by_tag(&self, repository: &Repository, tag: &str) -> Result<Release> {
84        let response: GithubRelease = self
85            .user()?
86            .get(
87                format!("/repos/{repository}/releases/tags/{tag}"),
88                None::<&()>,
89            )
90            .await
91            .map_err(|error| {
92                crate::client::read_error(
93                    "read release by tag",
94                    format!("release {tag} in {repository}"),
95                    error,
96                )
97            })?;
98        normalize_release(response)
99    }
100
101    async fn create_release(
102        &self,
103        repository: &Repository,
104        release: &NewRelease,
105    ) -> Result<Release> {
106        let response: GithubRelease = self
107            .user()?
108            .post(
109                format!("/repos/{repository}/releases"),
110                Some(&json!({
111                    "tag_name": release.tag,
112                    "name": release.name,
113                    "body": release.body,
114                    "target_commitish": release.target,
115                    "draft": release.draft,
116                    "prerelease": release.prerelease,
117                })),
118            )
119            .await
120            .map_err(|error| external("create release", error))?;
121        normalize_release(response)
122    }
123
124    async fn upload_asset(
125        &self,
126        repository: &Repository,
127        release_id: ReleaseId,
128        name: &str,
129        label: Option<&str>,
130        upload: AssetUpload,
131    ) -> Result<ReleaseAsset> {
132        let handler = self.user()?.repos(repository.owner(), repository.name());
133        let releases = handler.releases();
134        let release = releases
135            .get(release_id.get())
136            .await
137            .map_err(|error| external("read release for asset upload", error))?;
138        let mut upload_url = format!(
139            "{}?name={}",
140            release.upload_url.replace("{?name,label}", ""),
141            utf8_percent_encode(name, NON_ALPHANUMERIC)
142        );
143        if let Some(label) = label {
144            upload_url.push_str("&label=");
145            upload_url.push_str(&utf8_percent_encode(label, NON_ALPHANUMERIC).to_string());
146        }
147        let (content_length, chunks) = upload.into_parts();
148        let frames = chunks.map_ok(Frame::data);
149        let request = Request::builder()
150            .method(http::Method::POST)
151            .uri(upload_url)
152            .header(header::CONTENT_TYPE, "application/octet-stream")
153            .header(header::CONTENT_LENGTH, content_length)
154            .body(OctoBody::new(StreamBody::new(frames)))
155            .map_err(|error| external("construct release asset upload", error))?;
156        let response = self
157            .streaming_user()?
158            .execute(request)
159            .await
160            .map_err(|error| external("upload release asset", error))?;
161        let response = octocrab::map_github_error(response)
162            .await
163            .map_err(|error| external("upload release asset", error))?;
164        let response = GithubAsset::from_response(response)
165            .await
166            .map_err(|error| external("decode release asset upload", error))?;
167        normalize_asset(response)
168    }
169
170    async fn download_asset(
171        &self,
172        repository: &Repository,
173        asset_id: AssetId,
174    ) -> Result<AssetStream> {
175        let handler = self.user()?.repos(repository.owner(), repository.name());
176        let stream = handler
177            .release_assets()
178            .stream(asset_id.get())
179            .await
180            .map_err(|error| external("open release asset stream", error))?;
181        Ok(Box::pin(
182            stream.map_err(|error| AssetStreamError::new(error.to_string())),
183        ))
184    }
185}
186
187#[cfg(test)]
188mod tests {
189    use super::{GithubRelease, normalize_release};
190
191    #[test]
192    fn release_fixture_normalizes_assets() {
193        let response: GithubRelease =
194            serde_json::from_str(include_str!("../tests/fixtures/release.json")).expect("fixture");
195        let release = normalize_release(response).expect("normalizes");
196        assert_eq!(release.tag, "v0.1.0");
197        assert_eq!(release.assets[0].name, "interprex.tar.gz");
198    }
199}