obelisk 0.35.1

Deterministic workflow engine
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
480
481
482
use anyhow::{Context, bail};
use concepts::ContentDigest;
use serde::Deserialize;
use std::{
    fmt::{self, Display},
    path::{Path, PathBuf},
    str::FromStr,
    time::Duration,
};
use tokio::io::AsyncWriteExt;
use tracing::{debug, info, instrument, warn};
use utils::sha256sum::calculate_sha256_file;

pub(crate) const GH_SCHEMA_PREFIX: &str = "gh://";
const GITHUB_CLIENT_RETRIES: u64 = 10;

/// Reference to a GitHub release asset.
/// Format: `gh://owner/repo@tag/asset-name.wasm` or `gh://owner/repo@latest/asset-name.wasm`
#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub(crate) struct GitHubReleaseReference {
    pub owner: String,
    pub repo: String,
    pub tag: GitHubReleaseTag,
    pub asset_name: String,
}

#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub(crate) enum GitHubReleaseTag {
    Specific(String),
    Latest,
}

impl Display for GitHubReleaseTag {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            GitHubReleaseTag::Specific(tag) => write!(f, "{tag}"),
            GitHubReleaseTag::Latest => write!(f, "latest"),
        }
    }
}

impl Display for GitHubReleaseReference {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{GH_SCHEMA_PREFIX}{}/{}@{}/{}",
            self.owner, self.repo, self.tag, self.asset_name
        )
    }
}

impl FromStr for GitHubReleaseReference {
    type Err = anyhow::Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        // Expected format: owner/repo@tag/asset-name.wasm
        // The gh:// prefix should already be stripped before calling this

        // Split by '@' to get owner/repo and tag/asset
        let (owner_repo, tag_asset) = s
            .split_once('@')
            .ok_or_else(|| anyhow::anyhow!("missing '@' in GitHub reference: {s}"))?;

        // Parse owner/repo
        let (owner, repo) = owner_repo
            .split_once('/')
            .ok_or_else(|| anyhow::anyhow!("missing '/' between owner and repo: {owner_repo}"))?;

        if owner.is_empty() {
            bail!("owner cannot be empty in GitHub reference");
        }
        if repo.is_empty() {
            bail!("repo cannot be empty in GitHub reference");
        }

        // Parse tag/asset-name
        let (tag_str, asset_name) = tag_asset.split_once('/').ok_or_else(|| {
            anyhow::anyhow!("missing '/' between tag and asset name: {tag_asset}")
        })?;

        if tag_str.is_empty() {
            bail!("tag cannot be empty in GitHub reference");
        }
        if asset_name.is_empty() {
            bail!("asset name cannot be empty in GitHub reference");
        }

        let tag = if tag_str == "latest" {
            GitHubReleaseTag::Latest
        } else {
            GitHubReleaseTag::Specific(tag_str.to_string())
        };

        Ok(GitHubReleaseReference {
            owner: owner.to_string(),
            repo: repo.to_string(),
            tag,
            asset_name: asset_name.to_string(),
        })
    }
}

/// GitHub API response for a release
#[derive(Debug, Deserialize)]
struct GitHubRelease {
    tag_name: String,
    assets: Vec<GitHubAsset>,
}

/// GitHub API response for a release asset
#[derive(Debug, Deserialize)]
struct GitHubAsset {
    name: String,
    browser_download_url: String,
}

pub(crate) fn content_digest_to_wasm_file(
    wasm_cache_dir: &Path,
    content_digest: &ContentDigest,
) -> PathBuf {
    wasm_cache_dir.join(format!("{}.wasm", content_digest.with_infix("_")))
}

/// Pull a WASM file from a GitHub release to the cache directory.
///
/// If `expected_content_digest` is provided and the file exists in cache, returns immediately.
/// Otherwise fetches from GitHub API and downloads the asset.
#[instrument(skip_all, fields(github_ref = %github_ref) err)]
pub(crate) async fn pull_to_cache_dir(
    github_ref: &GitHubReleaseReference,
    wasm_cache_dir: &Path,
) -> Result<(ContentDigest, PathBuf), anyhow::Error> {
    // Need to fetch from GitHub
    let client = GitHubClient::new(GITHUB_CLIENT_RETRIES);

    // Get release info (resolves "latest" to actual tag)
    info!("Fetching GitHub release metadata");
    let release = client.get_release(github_ref).await?;
    debug!("Resolved tag: {}", release.tag_name);

    // Find the asset
    let asset = release
        .assets
        .iter()
        .find(|a| a.name == github_ref.asset_name)
        .ok_or_else(|| {
            let available: Vec<_> = release.assets.iter().map(|a| &a.name).collect();
            anyhow::anyhow!(
                "asset '{}' not found in release '{}'. Available assets: {:?}",
                github_ref.asset_name,
                release.tag_name,
                available
            )
        })?;

    // Download the asset to a unique temporary file first to avoid race conditions
    // when multiple processes download the same asset concurrently.
    info!("Downloading asset from GitHub release");
    let temp_file = tempfile::NamedTempFile::new_in(wasm_cache_dir)?;
    let temp_path = temp_file.path().to_path_buf();
    temp_file.keep()?;
    client
        .download_asset(&asset.browser_download_url, &temp_path)
        .await?;

    // Calculate the actual content digest
    let actual_content_digest = calculate_sha256_file(&temp_path)
        .await
        .context("failed to calculate sha256 of downloaded file")?;

    // Atomic rename to final location based on content digest.
    // Rename is atomic on the same filesystem, which is guaranteed since temp file is in wasm_cache_dir.
    let wasm_path = content_digest_to_wasm_file(wasm_cache_dir, &actual_content_digest);
    tokio::fs::rename(&temp_path, &wasm_path)
        .await
        .with_context(|| format!("failed to rename {temp_path:?} to {wasm_path:?}"))?;

    Ok((actual_content_digest, wasm_path))
}

struct GitHubClient {
    client: reqwest::Client,
    retries: u64,
}

impl GitHubClient {
    fn new(retries: u64) -> Self {
        let mut headers = reqwest::header::HeaderMap::new();
        headers.insert(
            reqwest::header::ACCEPT,
            "application/vnd.github+json".parse().expect("valid header"),
        );
        headers.insert(
            "X-GitHub-Api-Version",
            "2022-11-28".parse().expect("valid header"),
        );
        headers.insert(
            reqwest::header::USER_AGENT,
            "obelisk".parse().expect("valid header"),
        );

        // Add authorization if GITHUB_TOKEN is set
        if let Ok(token) = std::env::var("GITHUB_TOKEN") {
            let mut headers = headers;
            headers.insert(
                reqwest::header::AUTHORIZATION,
                format!("Bearer {token}").parse().expect("valid header"),
            );
            Self {
                client: reqwest::Client::builder()
                    .default_headers(headers)
                    .build()
                    .expect("failed to build HTTP client"),
                retries,
            }
        } else {
            Self {
                client: reqwest::Client::builder()
                    .default_headers(headers)
                    .build()
                    .expect("failed to build HTTP client"),
                retries,
            }
        }
    }

    async fn retry<T, F, Fut>(&self, what: F, reason: &'static str) -> Result<T, anyhow::Error>
    where
        F: Fn() -> Fut,
        Fut: std::future::Future<Output = Result<T, anyhow::Error>>,
    {
        let mut tries = 0;
        loop {
            match what().await {
                Ok(ok) => return Ok(ok),
                Err(err) if tries == self.retries => return Err(err),
                Err(err) => {
                    tries += 1;
                    let duration = Duration::from_secs(tries);
                    debug!("Error {reason}: {err:?}");
                    warn!("Retrying after {duration:?}");
                    tokio::time::sleep(duration).await;
                }
            }
        }
    }

    #[instrument(skip(self))]
    async fn get_release(
        &self,
        github_ref: &GitHubReleaseReference,
    ) -> Result<GitHubRelease, anyhow::Error> {
        self.retry(
            || async {
                let url = match &github_ref.tag {
                    GitHubReleaseTag::Latest => {
                        format!(
                            "https://api.github.com/repos/{}/{}/releases/latest",
                            github_ref.owner, github_ref.repo
                        )
                    }
                    GitHubReleaseTag::Specific(tag) => {
                        format!(
                            "https://api.github.com/repos/{}/{}/releases/tags/{tag}",
                            github_ref.owner, github_ref.repo
                        )
                    }
                };

                let response = self.client.get(&url).send().await.with_context(|| {
                    format!("failed to fetch release info from GitHub: {url}")
                })?;

                let status = response.status();
                if status == reqwest::StatusCode::NOT_FOUND {
                    bail!(
                        "release not found: {}/{}@{}",
                        github_ref.owner,
                        github_ref.repo,
                        github_ref.tag
                    );
                }
                if status == reqwest::StatusCode::FORBIDDEN {
                    let rate_limit_remaining = response
                        .headers()
                        .get("x-ratelimit-remaining")
                        .and_then(|v| v.to_str().ok());
                    if rate_limit_remaining == Some("0") {
                        bail!(
                            "GitHub API rate limit exceeded. Set GITHUB_TOKEN environment variable to increase the limit."
                        );
                    }
                    bail!("access forbidden to GitHub release. If this is a private repo, set GITHUB_TOKEN environment variable.");
                }
                if !status.is_success() {
                    let body = response.text().await.unwrap_or_default();
                    bail!("GitHub API error (status {status}): {body}");
                }

                response
                    .json::<GitHubRelease>()
                    .await
                    .context("failed to parse GitHub release response")
            },
            "fetching release info",
        )
        .await
    }

    #[instrument(skip(self, url))]
    async fn download_asset(&self, url: &str, dest: &Path) -> Result<(), anyhow::Error> {
        self.retry(
            || async {
                let response = self
                    .client
                    .get(url)
                    .header(reqwest::header::ACCEPT, "application/octet-stream")
                    .send()
                    .await
                    .with_context(|| format!("failed to download asset from {url}"))?;

                let status = response.status();
                if !status.is_success() {
                    bail!("failed to download asset (status {status})");
                }

                let bytes = response
                    .bytes()
                    .await
                    .context("failed to read asset bytes")?;

                let file = tokio::fs::File::create(dest).await?;
                let mut buffer = tokio::io::BufWriter::new(file);
                buffer.write_all(&bytes).await?;
                buffer.flush().await?;

                Ok(())
            },
            "downloading asset",
        )
        .await
    }
}

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

    #[test]
    fn parse_github_ref_specific_tag() {
        let input = "obeli-sk/obelisk@v0.34.1/my-component.wasm";
        let parsed: GitHubReleaseReference = input.parse().unwrap();
        assert_eq!(parsed.owner, "obeli-sk");
        assert_eq!(parsed.repo, "obelisk");
        assert_eq!(
            parsed.tag,
            GitHubReleaseTag::Specific("v0.34.1".to_string())
        );
        assert_eq!(parsed.asset_name, "my-component.wasm");
    }

    #[test]
    fn parse_github_ref_latest() {
        let input = "obeli-sk/obelisk@latest/my-component.wasm";
        let parsed: GitHubReleaseReference = input.parse().unwrap();
        assert_eq!(parsed.owner, "obeli-sk");
        assert_eq!(parsed.repo, "obelisk");
        assert_eq!(parsed.tag, GitHubReleaseTag::Latest);
        assert_eq!(parsed.asset_name, "my-component.wasm");
    }

    #[test]
    fn display_github_ref() {
        let gh_ref = GitHubReleaseReference {
            owner: "obeli-sk".to_string(),
            repo: "obelisk".to_string(),
            tag: GitHubReleaseTag::Specific("v0.34.1".to_string()),
            asset_name: "my-component.wasm".to_string(),
        };
        assert_eq!(
            gh_ref.to_string(),
            "gh://obeli-sk/obelisk@v0.34.1/my-component.wasm"
        );
    }

    #[test]
    fn display_github_ref_latest() {
        let gh_ref = GitHubReleaseReference {
            owner: "owner".to_string(),
            repo: "repo".to_string(),
            tag: GitHubReleaseTag::Latest,
            asset_name: "asset.wasm".to_string(),
        };
        assert_eq!(gh_ref.to_string(), "gh://owner/repo@latest/asset.wasm");
    }

    #[test]
    fn parse_error_missing_at() {
        let input = "obeli-sk/obelisk/v0.34.1/my-component.wasm";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(result.unwrap_err().to_string().contains("missing '@'"));
    }

    #[test]
    fn parse_error_missing_owner_repo_slash() {
        let input = "obelisk@v0.34.1/my-component.wasm";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("missing '/' between owner and repo")
        );
    }

    #[test]
    fn parse_error_empty_owner() {
        let input = "/obelisk@v0.34.1/my-component.wasm";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("owner cannot be empty")
        );
    }

    #[test]
    fn parse_error_empty_repo() {
        let input = "obeli-sk/@v0.34.1/my-component.wasm";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("repo cannot be empty")
        );
    }

    #[test]
    fn parse_error_missing_asset() {
        let input = "obeli-sk/obelisk@v0.34.1";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("missing '/' between tag and asset")
        );
    }

    #[test]
    fn parse_error_empty_tag() {
        let input = "obeli-sk/obelisk@/my-component.wasm";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("tag cannot be empty")
        );
    }

    #[test]
    fn parse_error_empty_asset_name() {
        let input = "obeli-sk/obelisk@v0.34.1/";
        let result: Result<GitHubReleaseReference, _> = input.parse();
        assert!(result.is_err());
        assert!(
            result
                .unwrap_err()
                .to_string()
                .contains("asset name cannot be empty")
        );
    }
}