Skip to main content

lfsx_server/
lib.rs

1pub mod auth;
2pub mod config;
3pub mod dashboard;
4pub mod error;
5pub mod locks;
6pub mod metrics;
7pub mod model;
8pub mod namespace;
9pub mod page;
10pub mod range;
11pub mod routes;
12pub mod state;
13pub mod storage;
14pub mod tls;
15
16use std::sync::Arc;
17
18use axum::Router;
19
20use crate::auth::Authorizer;
21use crate::config::Config;
22use crate::locks::LockStore;
23use crate::metrics::Metrics;
24use crate::state::AppState;
25use crate::storage::s3::{S3Config, S3Store};
26use crate::storage::{LocalStore, Store};
27
28pub fn app(config: Config) -> Router {
29    let (store, locks) = backends(&config);
30    let authorizer = Authorizer::new(&config.auth);
31
32    routes::router(Arc::new(AppState {
33        store,
34        locks,
35        config,
36        authorizer,
37        metrics: Metrics::new(),
38    }))
39}
40
41// Everything an interrupted upload left behind, wherever it left it: a staging
42// file on the volume, or bytes under an upload key nobody ever reported. Built
43// from the same construction the server uses, so a bucket deployment does not
44// end up sweeping only half of itself.
45pub async fn reclaim(config: &Config) {
46    let reclaimed = backends(config).0.reclaim(config.staging_max_age).await;
47
48    if reclaimed.files > 0 {
49        tracing::info!(
50            files = reclaimed.files,
51            bytes = reclaimed.bytes,
52            "reclaimed what interrupted uploads left behind"
53        );
54    }
55}
56
57fn backends(config: &Config) -> (Store, LockStore) {
58    // Refusing to start beats starting without it. A server that silently wrote
59    // plaintext because a Secret failed to mount is the one failure this feature
60    // must never have: nothing downstream would notice, and the objects written
61    // in the meantime are the ones the operator believed were covered.
62    let keys = config.encryption_key_file.as_deref().map(|path| {
63        std::sync::Arc::new(
64            crate::storage::crypt::Keyring::load(path)
65                .expect("the encryption key file is not usable"),
66        )
67    });
68
69    let local = LocalStore::new(config.storage_root.clone())
70        .with_max_object_size(config.max_object_size)
71        .with_compression(config.compression)
72        .with_encryption(keys);
73
74    // The two backends are chosen together and the lock policy is applied once,
75    // to both. Deciding it per arm is how `LFSX_LOCK_MAX_AGE` came to be silently
76    // ignored in bucket mode: the arms are far apart, only one of them had it,
77    // and nothing failed.
78    let (store, lock_backend) = match &config.storage {
79        crate::config::Storage::Local => (
80            Store::local(local),
81            LockStore::local(config.storage_root.clone()),
82        ),
83        crate::config::Storage::Bucket {
84            endpoint,
85            bucket,
86            region,
87            access_key,
88            secret_key,
89            path_style,
90            presign,
91        } => {
92            let bucket = S3Store::new(&S3Config {
93                endpoint: endpoint.clone(),
94                bucket: bucket.clone(),
95                region: region.clone(),
96                access_key: access_key.clone(),
97                secret_key: secret_key.clone(),
98                path_style: *path_style,
99                redirect: *presign,
100                lifetime: std::time::Duration::from_secs(config.action_lifetime.into()),
101            })
102            .expect("the bucket configuration is not usable");
103
104            tracing::warn!(
105                "objects and locks are stored in a bucket: collection, deduplication, rewriting                  and verification answer 501, and the lfsx_objects_stored and lfsx_store_bytes                  gauges are not measured — read capacity from the bucket itself"
106            );
107
108            if *presign {
109                tracing::warn!(
110                    "LFSX_S3_PRESIGN=true — downloads are redirected to the bucket, so                      lfsx_downloaded_bytes stops counting them and the bucket serves the ranges"
111                );
112
113                if config.encryption_key_file.is_some() {
114                    tracing::warn!(
115                        "LFSX_ENCRYPTION_KEY_FILE is set, so uploads keep coming through this                          server rather than going straight to the bucket: an object a client                          writes itself would arrive unencrypted"
116                    );
117                } else if config.compression.is_some() {
118                    tracing::warn!(
119                        "LFSX_COMPRESSION is set, and objects clients upload straight to the                          bucket arrive uncompressed — only what passes through this server is                          compressed"
120                    );
121                }
122            }
123
124            // The locks go with the objects. Left on the volume they would make
125            // the bucket a half measure: capacity would be shared and the one
126            // piece of state a second replica must agree on would not be.
127            (
128                Store::bucket(bucket.clone(), local),
129                LockStore::bucket(bucket),
130            )
131        }
132    };
133    (store, lock_backend.with_max_age(config.lock_max_age))
134}