mfp-core 1.2.0

Shared catalog, configuration, path, and wire-protocol types for the musicforprogramming player
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

//! The episode catalog: the authoritative feed, its best-effort enrichment, the disk
//! cache that lets the player start without a network, and query over the result.
//!
//! Resolution order is [`feed`] then [`enrich`], behind the cache in [`cache`]. A feed
//! failure fails the catalog; any enrichment failure still yields it, without track
//! listings.
//!
//! Nothing fetches on a timer or in the background: every request here is reached from
//! [`cache::load`], called only when a user action needs data the cache cannot satisfy.

pub mod cache;
pub mod enrich;
pub mod feed;
pub mod query;

/// The authoritative episode list.
pub const FEED_URL: &str = "https://musicforprogramming.net/rss.xml";

/// The shell document the content-hashed client bundle path is discovered from.
pub const SITE_URL: &str = "https://musicforprogramming.net/";

/// A GET carrying the User-Agent every upstream request identifies itself with.
///
/// Set per request rather than on the client, so the header holds whatever client the
/// caller supplies.
pub(crate) fn request(client: &reqwest::Client, url: &str) -> reqwest::RequestBuilder {
    client
        .get(url)
        .header(reqwest::header::USER_AGENT, crate::USER_AGENT)
}

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

    #[test]
    fn every_upstream_request_names_the_application() {
        let client = reqwest::Client::new();
        for url in [
            FEED_URL,
            SITE_URL,
            "https://musicforprogramming.net/client/client.a.js",
        ] {
            let built = request(&client, url).build().unwrap();
            let agent = built
                .headers()
                .get(reqwest::header::USER_AGENT)
                .expect("no User-Agent")
                .to_str()
                .unwrap();
            assert_eq!(agent, crate::USER_AGENT);
            assert!(
                agent.contains("mfp"),
                "{agent} does not name the application"
            );
        }
    }
}