yosh-plugin-manager 0.2.6

Plugin manager for yosh shell
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
use std::fs;
use std::io::{Read, Write};
use std::path::Path;

use ureq::Agent;
use ureq::tls::{RootCerts, TlsConfig};

/// Error type for GitHub API requests made through `get_json`.
#[derive(Debug)]
enum GitHubApiError {
    /// HTTP response with non-2xx status code (excluding 403/429).
    HttpStatus(u16),
    /// HTTP 403 or 429 — likely rate-limited, or auth-rejected when a
    /// token is set. Surfaced separately so callers can attach a
    /// "set YOSH_GITHUB_TOKEN" hint when no token is configured.
    RateLimited(u16),
    /// Network/transport error (DNS, connection, timeout).
    Network(String),
    /// Response body could not be read or parsed as JSON.
    Parse(String),
}

impl std::fmt::Display for GitHubApiError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::HttpStatus(code) => write!(f, "HTTP {}", code),
            Self::RateLimited(code) => write!(f, "HTTP {} (rate-limited or unauthorized)", code),
            Self::Network(msg) => write!(f, "request failed: {}", msg),
            Self::Parse(msg) => write!(f, "{}", msg),
        }
    }
}

const RATE_LIMIT_HINT: &str =
    "hint: set YOSH_GITHUB_TOKEN or GITHUB_TOKEN to raise the rate limit (60 -> 5000 req/hour)";

/// Build a ureq `Agent` that delegates certificate verification to the
/// platform's trust store. The platform verifier (`rustls-platform-verifier`)
/// performs AIA fetching on macOS/Windows, which is required to complete
/// the chain for GitHub release assets that redirect to Azure Blob
/// endpoints. See https://github.com/k-ymmt/yosh/issues/2.
fn build_agent() -> Agent {
    ureq::Agent::config_builder()
        .tls_config(
            TlsConfig::builder()
                .root_certs(RootCerts::PlatformVerifier)
                .build(),
        )
        .build()
        .new_agent()
}

/// GitHub API client for fetching release information and downloading assets.
pub struct GitHubClient {
    base_url: String,
    token: Option<String>,
    agent: Agent,
}

impl GitHubClient {
    /// Create a new client, reading auth token from `YOSH_GITHUB_TOKEN`
    /// (preferred) or `GITHUB_TOKEN`. The legacy `KISH_GITHUB_TOKEN` env
    /// var was removed as part of the kish→yosh rename cleanup in
    /// v0.2.0.
    pub fn new() -> Self {
        let token = std::env::var("YOSH_GITHUB_TOKEN")
            .ok()
            .or_else(|| std::env::var("GITHUB_TOKEN").ok());
        Self {
            base_url: "https://api.github.com".to_string(),
            token,
            agent: build_agent(),
        }
    }

    fn get_json(&self, url: &str) -> Result<serde_json::Value, GitHubApiError> {
        let mut req = self
            .agent
            .get(url)
            .header("User-Agent", "yosh-plugin-manager")
            .header("Accept", "application/vnd.github.v3+json");
        if let Some(token) = &self.token {
            req = req.header("Authorization", format!("Bearer {}", token));
        }
        let body = req
            .call()
            .map_err(|e| match &e {
                ureq::Error::StatusCode(code) if *code == 403 || *code == 429 => {
                    GitHubApiError::RateLimited(*code)
                }
                ureq::Error::StatusCode(code) => GitHubApiError::HttpStatus(*code),
                _ => GitHubApiError::Network(e.to_string()),
            })?
            .body_mut()
            .read_to_string()
            .map_err(|e| GitHubApiError::Parse(format!("failed to read body: {}", e)))?;
        serde_json::from_str(&body)
            .map_err(|e| GitHubApiError::Parse(format!("failed to parse JSON: {}", e)))
    }

    fn release_json(
        &self,
        owner: &str,
        repo: &str,
        tag: &str,
    ) -> Result<serde_json::Value, GitHubApiError> {
        let url = format!(
            "{}/repos/{}/{}/releases/tags/{}",
            self.base_url, owner, repo, tag
        );
        self.get_json(&url)
    }

    /// Look up a GitHub release by tag, trying `v{version}` first then `{version}`.
    /// Returns the download URL of the named asset.
    pub fn find_asset_url(
        &self,
        owner: &str,
        repo: &str,
        version: &str,
        asset_name: &str,
    ) -> Result<String, String> {
        let v_tag = format!("v{}", version);
        let release = match self.release_json(owner, repo, &v_tag) {
            Ok(r) => r,
            Err(_) => {
                // Fallback to bare version tag
                self.release_json(owner, repo, version)
                    .map_err(|e| match e {
                        GitHubApiError::HttpStatus(404) => format!(
                            "release not found for {}/{} (tried tags '{}' and '{}')",
                            owner, repo, v_tag, version
                        ),
                        other @ GitHubApiError::RateLimited(_) if self.token.is_none() => format!(
                            "failed to fetch release for {}/{} (tried tags '{}' and '{}'): {}\n  {}",
                            owner, repo, v_tag, version, other, RATE_LIMIT_HINT
                        ),
                        other => format!(
                            "failed to fetch release for {}/{} (tried tags '{}' and '{}'): {}",
                            owner, repo, v_tag, version, other
                        ),
                    })?
            }
        };

        let assets = release["assets"]
            .as_array()
            .ok_or_else(|| "release has no assets array".to_string())?;

        for asset in assets {
            if asset["name"].as_str() == Some(asset_name) {
                let url = asset["browser_download_url"]
                    .as_str()
                    .ok_or_else(|| "asset has no browser_download_url".to_string())?;
                return Ok(url.to_string());
            }
        }

        Err(format!("asset '{}' not found in release", asset_name))
    }

    /// Download a file from an HTTPS URL to a local path. Rejects non-HTTPS URLs.
    pub fn download(&self, url: &str, dest: &Path) -> Result<(), String> {
        if !url.starts_with("https://") {
            return Err(format!("refusing non-HTTPS URL: {}", url));
        }

        let mut req = self
            .agent
            .get(url)
            .header("User-Agent", "yosh-plugin-manager")
            .header("Accept", "application/vnd.github.v3+json");
        if let Some(token) = &self.token {
            req = req.header("Authorization", format!("Bearer {}", token));
        }
        let mut response = req
            .call()
            .map_err(|e| format!("download request failed: {}", e))?;

        let mut file = fs::File::create(dest)
            .map_err(|e| format!("failed to create {}: {}", dest.display(), e))?;

        let mut reader = response.body_mut().as_reader();
        let mut buf = [0u8; 8192];
        loop {
            let n = reader
                .read(&mut buf)
                .map_err(|e| format!("failed to read response body: {}", e))?;
            if n == 0 {
                break;
            }
            file.write_all(&buf[..n])
                .map_err(|e| format!("failed to write to {}: {}", dest.display(), e))?;
        }

        Ok(())
    }

    /// Get the latest release tag for a repo, stripping a leading `v` prefix.
    pub fn latest_version(&self, owner: &str, repo: &str) -> Result<String, String> {
        let url = format!("{}/repos/{}/{}/releases/latest", self.base_url, owner, repo);
        let json = self.get_json(&url).map_err(|e| match e {
            GitHubApiError::HttpStatus(404) => format!(
                "no releases found for {}/{}: publish a GitHub Release first",
                owner, repo
            ),
            other @ GitHubApiError::RateLimited(_) if self.token.is_none() => format!(
                "failed to fetch latest release for {}/{}: {}\n  {}",
                owner, repo, other, RATE_LIMIT_HINT
            ),
            other => format!(
                "failed to fetch latest release for {}/{}: {}",
                owner, repo, other
            ),
        })?;

        let tag = json["tag_name"]
            .as_str()
            .ok_or_else(|| "release has no tag_name".to_string())?;

        Ok(tag.trim_start_matches('v').to_string())
    }
}

impl Default for GitHubClient {
    fn default() -> Self {
        Self::new()
    }
}

/// Test-only client that uses a custom base URL (for mockito tests).
#[cfg(test)]
pub struct GitHubClientWithBase {
    inner: GitHubClient,
}

#[cfg(test)]
impl GitHubClientWithBase {
    pub fn new(base_url: &str) -> Self {
        Self {
            inner: GitHubClient {
                base_url: base_url.to_string(),
                token: None,
                agent: build_agent(),
            },
        }
    }

    pub fn with_token(base_url: &str, token: &str) -> Self {
        Self {
            inner: GitHubClient {
                base_url: base_url.to_string(),
                token: Some(token.to_string()),
                agent: build_agent(),
            },
        }
    }

    pub fn find_asset_url(
        &self,
        owner: &str,
        repo: &str,
        version: &str,
        asset_name: &str,
    ) -> Result<String, String> {
        self.inner.find_asset_url(owner, repo, version, asset_name)
    }

    pub fn latest_version(&self, owner: &str, repo: &str) -> Result<String, String> {
        self.inner.latest_version(owner, repo)
    }

    pub fn download(&self, url: &str, dest: &Path) -> Result<(), String> {
        self.inner.download(url, dest)
    }

    /// Unwrap to a plain `GitHubClient` so callers that need the
    /// concrete type (e.g. `update::update`'s signature) can be driven
    /// against a mockito server in tests.
    pub fn into_client(self) -> GitHubClient {
        self.inner
    }
}

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

    fn make_release_json(assets: &[(&str, &str)]) -> String {
        let assets_json: Vec<String> = assets
            .iter()
            .map(|(name, url)| {
                format!(
                    r#"{{"name": "{}", "browser_download_url": "{}"}}"#,
                    name, url
                )
            })
            .collect();
        format!(
            r#"{{"tag_name": "v1.2.3", "assets": [{}]}}"#,
            assets_json.join(", ")
        )
    }

    #[test]
    fn parse_release_json_finds_asset() {
        let json: serde_json::Value = serde_json::from_str(&make_release_json(&[(
            "libfoo-linux-x86_64.so",
            "https://example.com/libfoo-linux-x86_64.so",
        )]))
        .unwrap();
        let url = json["assets"][0]["browser_download_url"].as_str().unwrap();
        assert_eq!(url, "https://example.com/libfoo-linux-x86_64.so");
    }

    #[test]
    fn parse_release_json_asset_not_found() {
        let json: serde_json::Value = serde_json::from_str(&make_release_json(&[(
            "other-asset.so",
            "https://example.com/other.so",
        )]))
        .unwrap();
        let assets = json["assets"].as_array().unwrap();
        let found = assets
            .iter()
            .any(|a| a["name"].as_str() == Some("libfoo-linux-x86_64.so"));
        assert!(!found);
    }

    #[test]
    fn download_rejects_non_https() {
        let client = GitHubClient::new();
        let tmp = tempfile::NamedTempFile::new().unwrap();
        let err = client
            .download("http://example.com/file", tmp.path())
            .unwrap_err();
        assert!(
            err.contains("non-HTTPS"),
            "expected non-HTTPS error, got: {}",
            err
        );
    }

    #[test]
    fn download_rejects_ftp_url() {
        let client = GitHubClient::new();
        let tmp = tempfile::NamedTempFile::new().unwrap();
        let err = client
            .download("ftp://example.com/file", tmp.path())
            .unwrap_err();
        assert!(
            err.contains("non-HTTPS"),
            "expected non-HTTPS error, got: {}",
            err
        );
    }

    #[test]
    fn find_asset_url_v_prefix_fallback() {
        let mut server = mockito::Server::new();
        let base = server.url();

        // v-prefixed tag returns 404
        let _m1 = server
            .mock("GET", "/repos/owner/repo/releases/tags/v1.0.0")
            .with_status(404)
            .with_body(r#"{"message": "Not Found"}"#)
            .create();

        // bare version tag succeeds
        let body = make_release_json(&[("myasset.so", "https://dl.example.com/myasset.so")]);
        let _m2 = server
            .mock("GET", "/repos/owner/repo/releases/tags/1.0.0")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(&body)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let url = client
            .find_asset_url("owner", "repo", "1.0.0", "myasset.so")
            .unwrap();
        assert_eq!(url, "https://dl.example.com/myasset.so");
    }

    #[test]
    fn find_asset_url_v_prefix_succeeds() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let body = make_release_json(&[("myasset.so", "https://dl.example.com/myasset.so")]);
        let _m = server
            .mock("GET", "/repos/owner/repo/releases/tags/v2.0.0")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(&body)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let url = client
            .find_asset_url("owner", "repo", "2.0.0", "myasset.so")
            .unwrap();
        assert_eq!(url, "https://dl.example.com/myasset.so");
    }

    #[test]
    fn find_asset_url_asset_not_found() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let body = make_release_json(&[("other.so", "https://dl.example.com/other.so")]);
        let _m = server
            .mock("GET", "/repos/owner/repo/releases/tags/v3.0.0")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(&body)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let err = client
            .find_asset_url("owner", "repo", "3.0.0", "nonexistent.so")
            .unwrap_err();
        assert!(
            err.contains("not found"),
            "expected not found error, got: {}",
            err
        );
    }

    #[test]
    fn latest_version_strips_v_prefix() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m = server
            .mock("GET", "/repos/owner/repo/releases/latest")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"tag_name": "v4.5.6"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let version = client.latest_version("owner", "repo").unwrap();
        assert_eq!(version, "4.5.6");
    }

    #[test]
    fn latest_version_no_v_prefix() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m = server
            .mock("GET", "/repos/owner/repo/releases/latest")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"tag_name": "1.0.0"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let version = client.latest_version("owner", "repo").unwrap();
        assert_eq!(version, "1.0.0");
    }

    #[test]
    fn latest_version_no_releases_gives_helpful_error() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m = server
            .mock("GET", "/repos/owner/repo/releases/latest")
            .with_status(404)
            .with_body(r#"{"message": "Not Found"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let err = client.latest_version("owner", "repo").unwrap_err();
        assert!(
            err.contains("no releases found for owner/repo"),
            "expected helpful error, got: {}",
            err
        );
        assert!(
            err.contains("publish a GitHub Release first"),
            "expected hint about publishing a release, got: {}",
            err
        );
    }

    #[test]
    fn find_asset_url_both_tags_404_gives_helpful_error() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m1 = server
            .mock("GET", "/repos/owner/repo/releases/tags/v1.0.0")
            .with_status(404)
            .with_body(r#"{"message": "Not Found"}"#)
            .create();

        let _m2 = server
            .mock("GET", "/repos/owner/repo/releases/tags/1.0.0")
            .with_status(404)
            .with_body(r#"{"message": "Not Found"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let err = client
            .find_asset_url("owner", "repo", "1.0.0", "myasset.so")
            .unwrap_err();
        assert!(
            err.contains("release not found for owner/repo"),
            "expected helpful error, got: {}",
            err
        );
        assert!(
            err.contains("v1.0.0"),
            "expected tried tags in error, got: {}",
            err
        );
    }

    #[test]
    fn latest_version_403_without_token_includes_hint() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m = server
            .mock("GET", "/repos/owner/repo/releases/latest")
            .with_status(403)
            .with_body(r#"{"message": "API rate limit exceeded"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let err = client.latest_version("owner", "repo").unwrap_err();
        assert!(
            err.contains("YOSH_GITHUB_TOKEN"),
            "expected hint mentioning YOSH_GITHUB_TOKEN, got: {}",
            err
        );
    }

    #[test]
    fn latest_version_403_with_token_no_hint() {
        let mut server = mockito::Server::new();
        let base = server.url();

        let _m = server
            .mock("GET", "/repos/owner/repo/releases/latest")
            .with_status(403)
            .with_body(r#"{"message": "Bad credentials"}"#)
            .create();

        let client = GitHubClientWithBase::with_token(&base, "fake-token");
        let err = client.latest_version("owner", "repo").unwrap_err();
        assert!(
            !err.contains("YOSH_GITHUB_TOKEN"),
            "should not suggest setting a token when one is already set, got: {}",
            err
        );
        assert!(
            err.contains("HTTP 403"),
            "should still surface the HTTP status, got: {}",
            err
        );
    }

    #[test]
    fn find_asset_url_429_with_token_no_hint() {
        let mut server = mockito::Server::new();
        let base = server.url();

        // Both v-prefix and bare-version tag attempts return 429.
        let _m1 = server
            .mock("GET", "/repos/owner/repo/releases/tags/v1.0.0")
            .with_status(429)
            .with_body(r#"{"message": "Too many requests"}"#)
            .create();
        let _m2 = server
            .mock("GET", "/repos/owner/repo/releases/tags/1.0.0")
            .with_status(429)
            .with_body(r#"{"message": "Too many requests"}"#)
            .create();

        let client = GitHubClientWithBase::with_token(&base, "fake-token");
        let err = client
            .find_asset_url("owner", "repo", "1.0.0", "asset.wasm")
            .unwrap_err();
        assert!(
            !err.contains("YOSH_GITHUB_TOKEN"),
            "should not suggest setting a token when one is already set, got: {}",
            err
        );
        assert!(
            err.contains("HTTP 429"),
            "should still surface the HTTP status, got: {}",
            err
        );
    }

    #[test]
    fn find_asset_url_429_without_token_includes_hint() {
        let mut server = mockito::Server::new();
        let base = server.url();

        // Both v-prefix and bare-version tag attempts return 429 (rate-limited).
        let _m1 = server
            .mock("GET", "/repos/owner/repo/releases/tags/v1.0.0")
            .with_status(429)
            .with_body(r#"{"message": "Too many requests"}"#)
            .create();
        let _m2 = server
            .mock("GET", "/repos/owner/repo/releases/tags/1.0.0")
            .with_status(429)
            .with_body(r#"{"message": "Too many requests"}"#)
            .create();

        let client = GitHubClientWithBase::new(&base);
        let err = client
            .find_asset_url("owner", "repo", "1.0.0", "asset.wasm")
            .unwrap_err();
        assert!(
            err.contains("YOSH_GITHUB_TOKEN"),
            "expected rate-limit hint, got: {}",
            err
        );
    }
}