kellnr-http 7.2.0

Kellnr is a self-hosted registry for Rust crates with support for rustdocs and crates.io caching.
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

use std::sync::Arc;

use axum::extract::FromRef;
use axum_extra::extract::cookie::Key;
use flume::Sender;
use kellnr_common::background_tasks::BackgroundTasks;
use kellnr_common::cratesio_prefetch_msg::CratesioPrefetchMsg;
use kellnr_cratesio_sync::CratesioSync;
use kellnr_db::DbProvider;
use kellnr_db::download_counter::DownloadCounter;
use kellnr_filter::{DownloadFilters, IndexFilters};
use kellnr_settings::{Settings, SettingsProv};
use kellnr_storage::cratesio_crate_storage::CratesIoCrateStorage;
use kellnr_storage::docs_storage::DocsStorage;
use kellnr_storage::kellnr_crate_storage::KellnrCrateStorage;
use kellnr_storage::toolchain_storage::ToolchainStorage;
use reqwest::Client;

use crate::login_throttle::LoginThrottle;
use crate::token_cache::TokenCacheManager;

pub type AppState = axum::extract::State<AppStateData>;

// Substates
pub type DbState = axum::extract::State<Arc<dyn DbProvider>>;
pub type SettingsState = axum::extract::State<Arc<Settings>>;
pub type SettingsProvState = axum::extract::State<Arc<SettingsProv>>;
pub type DocsStorageState = axum::extract::State<Arc<DocsStorage>>;
pub type CratesIoPrefetchSenderState = axum::extract::State<Sender<CratesioPrefetchMsg>>;
pub type TokenCacheState = axum::extract::State<Arc<TokenCacheManager>>;
pub type LoginThrottleState = axum::extract::State<Arc<LoginThrottle>>;
pub type ToolchainStorageState = axum::extract::State<Option<Arc<ToolchainStorage>>>;
pub type ProxyClientState = axum::extract::State<Client>;
pub type BackgroundTasksState = axum::extract::State<BackgroundTasks>;
pub type IndexFiltersState = axum::extract::State<Arc<IndexFilters>>;

#[derive(Clone, FromRef)]
pub struct AppStateData {
    pub db: Arc<dyn DbProvider>,
    // key that is used for signing cookies
    pub signing_key: Key,
    pub settings: Arc<Settings>,
    /// Per-leaf provenance for the merged `settings`. Only the `/settings`
    /// web-ui handler reads this; everything else uses the plain `Settings`.
    pub settings_prov: Arc<SettingsProv>,
    pub crate_storage: Arc<KellnrCrateStorage>,
    pub cratesio_storage: Arc<CratesIoCrateStorage>,
    /// Always present, unlike `toolchain_storage`: `/docs/*` serving and
    /// manual doc publishing are mounted regardless of `settings.docs.enabled`
    /// (that flag only gates the automatic generation queue).
    pub docs_storage: Arc<DocsStorage>,
    pub cratesio_prefetch_sender: Sender<CratesioPrefetchMsg>,
    pub token_cache: Arc<TokenCacheManager>,
    /// Per-username throttle for password authentication attempts.
    pub login_throttle: Arc<LoginThrottle>,
    pub toolchain_storage: Option<Arc<ToolchainStorage>>,
    pub download_counter: Arc<DownloadCounter>,
    pub proxy_client: Client,
    pub cratesio_sync: CratesioSync,
    pub download_filters: Arc<DownloadFilters>,
    pub index_filters: Arc<IndexFilters>,
    /// Work that outlives a request, e.g. processing an upload, runs here so
    /// shutdown waits for it.
    pub background_tasks: BackgroundTasks,
}

/// Build a defaults-only `SettingsProv`, every leaf reports
/// `Category::Default`. Convenient for ad-hoc test `AppStateData`
/// construction where the `settings_prov` field isn't otherwise relevant.
#[must_use]
pub fn default_settings_prov() -> Arc<SettingsProv> {
    Arc::new(
        provcfg::Config::new()
            .build::<SettingsProv>()
            .expect("default SettingsProv build is infallible"),
    )
}