src/lib.rs

   1 pub mod api_routes_http;
   2 pub mod api_routes_websocket;
   3 pub mod code_migrations;
   4 pub mod root_span_builder;
   5 pub mod scheduled_tasks;
   6 #[cfg(feature = "console")]
   7 pub mod telemetry;
   8
   9 use crate::{code_migrations::run_advanced_migrations, root_span_builder::QuieterRootSpanBuilder};
  10 use actix_web::{middleware, web::Data, App, HttpServer, Result};
  11 use doku::json::{AutoComments, CommentsStyle, Formatting, ObjectsStyle};
  12 use lemmy_api_common::{
  13   context::LemmyContext,
  14   lemmy_db_views::structs::SiteView,
  15   request::build_user_agent,
  16   utils::{
  17     check_private_instance_and_federation_enabled,
  18     local_site_rate_limit_to_rate_limit_config,
  19   },
  20   websocket::chat_server::ChatServer,
  21 };
  22 use lemmy_db_schema::{
  23   source::secret::Secret,
  24   utils::{build_db_pool, get_database_url, run_migrations},
  25 };
  26 use lemmy_routes::{feeds, images, nodeinfo, webfinger};
  27 use lemmy_utils::{
  28   error::LemmyError,
  29   rate_limit::RateLimitCell,
  30   settings::{structs::Settings, SETTINGS},
  31 };
  32 use reqwest::Client;
  33 use reqwest_middleware::ClientBuilder;
  34 use reqwest_retry::{policies::ExponentialBackoff, RetryTransientMiddleware};
  35 use reqwest_tracing::TracingMiddleware;
  36 use std::{env, sync::Arc, thread, time::Duration};
  37 use tracing::subscriber::set_global_default;
  38 use tracing_actix_web::TracingLogger;
  39 use tracing_error::ErrorLayer;
  40 use tracing_log::LogTracer;
  41 use tracing_subscriber::{filter::Targets, layer::SubscriberExt, Layer, Registry};
  42 use url::Url;
  43
  44 /// Max timeout for http requests
  45 pub(crate) const REQWEST_TIMEOUT: Duration = Duration::from_secs(10);
  46
  47 /// Placing the main function in lib.rs allows other crates to import it and embed Lemmy
  48 pub async fn start_lemmy_server() -> Result<(), LemmyError> {
  49   let args: Vec<String> = env::args().collect();
  50   if args.get(1) == Some(&"--print-config-docs".to_string()) {
  51     let fmt = Formatting {
  52       auto_comments: AutoComments::none(),
  53       comments_style: CommentsStyle {
  54         separator: "#".to_owned(),
  55       },
  56       objects_style: ObjectsStyle {
  57         surround_keys_with_quotes: false,
  58         use_comma_as_separator: false,
  59       },
  60       ..Default::default()
  61     };
  62     println!("{}", doku::to_json_fmt_val(&fmt, &Settings::default()));
  63     return Ok(());
  64   }
  65
  66   let settings = SETTINGS.to_owned();
  67
  68   // Run the DB migrations
  69   let db_url = get_database_url(Some(&settings));
  70   run_migrations(&db_url);
  71
  72   // Set up the connection pool
  73   let pool = build_db_pool(&settings).await?;
  74
  75   // Run the Code-required migrations
  76   run_advanced_migrations(&pool, &settings).await?;
  77
  78   // Initialize the secrets
  79   let secret = Secret::init(&pool)
  80     .await
  81     .expect("Couldn't initialize secrets.");
  82
  83   // Make sure the local site is set up.
  84   let site_view = SiteView::read_local(&pool)
  85     .await
  86     .expect("local site not set up");
  87   let local_site = site_view.local_site;
  88   let federation_enabled = local_site.federation_enabled;
  89
  90   if federation_enabled {
  91     println!("federation enabled, host is {}", &settings.hostname);
  92   }
  93
  94   check_private_instance_and_federation_enabled(&local_site)?;
  95
  96   // Set up the rate limiter
  97   let rate_limit_config =
  98     local_site_rate_limit_to_rate_limit_config(&site_view.local_site_rate_limit);
  99   let rate_limit_cell = RateLimitCell::new(rate_limit_config).await;
 100
 101   println!(
 102     "Starting http server at {}:{}",
 103     settings.bind, settings.port
 104   );
 105
 106   let user_agent = build_user_agent(&settings);
 107   let reqwest_client = Client::builder()
 108     .user_agent(user_agent.clone())
 109     .timeout(REQWEST_TIMEOUT)
 110     .build()?;
 111
 112   let retry_policy = ExponentialBackoff {
 113     max_n_retries: 3,
 114     max_retry_interval: REQWEST_TIMEOUT,
 115     min_retry_interval: Duration::from_millis(100),
 116     backoff_exponent: 2,
 117   };
 118
 119   let client = ClientBuilder::new(reqwest_client.clone())
 120     .with(TracingMiddleware::default())
 121     .with(RetryTransientMiddleware::new_with_policy(retry_policy))
 122     .build();
 123
 124   // Pictrs cannot use the retry middleware
 125   let pictrs_client = ClientBuilder::new(reqwest_client.clone())
 126     .with(TracingMiddleware::default())
 127     .build();
 128
 129   // Schedules various cleanup tasks for the DB
 130   thread::spawn(move || {
 131     scheduled_tasks::setup(db_url, user_agent).expect("Couldn't set up scheduled_tasks");
 132   });
 133
 134   let chat_server = Arc::new(ChatServer::startup());
 135
 136   // Create Http server with websocket support
 137   let settings_bind = settings.clone();
 138   HttpServer::new(move || {
 139     let context = LemmyContext::create(
 140       pool.clone(),
 141       chat_server.clone(),
 142       client.clone(),
 143       settings.clone(),
 144       secret.clone(),
 145       rate_limit_cell.clone(),
 146     );
 147     App::new()
 148       .wrap(middleware::Logger::default())
 149       .wrap(TracingLogger::<QuieterRootSpanBuilder>::new())
 150       .app_data(Data::new(context))
 151       .app_data(Data::new(rate_limit_cell.clone()))
 152       // The routes
 153       .configure(|cfg| api_routes_http::config(cfg, rate_limit_cell))
 154       .configure(|cfg| {
 155         if federation_enabled {
 156           lemmy_apub::http::routes::config(cfg);
 157           webfinger::config(cfg);
 158         }
 159       })
 160       .configure(feeds::config)
 161       .configure(|cfg| images::config(cfg, pictrs_client.clone(), rate_limit_cell))
 162       .configure(nodeinfo::config)
 163   })
 164   .bind((settings_bind.bind, settings_bind.port))?
 165   .run()
 166   .await?;
 167
 168   Ok(())
 169 }
 170
 171 pub fn init_logging(opentelemetry_url: &Option<Url>) -> Result<(), LemmyError> {
 172   LogTracer::init()?;
 173
 174   let log_description = std::env::var("RUST_LOG").unwrap_or_else(|_| "info".into());
 175
 176   let targets = log_description
 177     .trim()
 178     .trim_matches('"')
 179     .parse::<Targets>()?;
 180
 181   let format_layer = tracing_subscriber::fmt::layer().with_filter(targets.clone());
 182
 183   let subscriber = Registry::default()
 184     .with(format_layer)
 185     .with(ErrorLayer::default());
 186
 187   if let Some(_url) = opentelemetry_url {
 188     #[cfg(feature = "console")]
 189     telemetry::init_tracing(_url.as_ref(), subscriber, targets)?;
 190     #[cfg(not(feature = "console"))]
 191     tracing::error!("Feature `console` must be enabled for opentelemetry tracing");
 192   } else {
 193     set_global_default(subscriber)?;
 194   }
 195
 196   Ok(())
 197 }