packages/ak-common/mode: init (#21259)

rissson · rissson · commit b16bb997502c · 2026-04-07T14:22:59.000+02:00
Squashed commit of the following: commit 6ce8e12 Merge: 0edc38e 0079984 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Wed Apr 1 17:09:25 2026 +0200 Merge branch 'rust-lib-rename' into rust-lib-mode Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit 0079984 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Wed Apr 1 17:08:07 2026 +0200 packages/ak-common: rename from ak-lib Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit 0edc38e Merge: 775a971 a3fea5d Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Wed Apr 1 16:52:25 2026 +0200 Merge branch 'fix-rustfmt-config' into rust-lib-mode commit a3fea5d Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Wed Apr 1 16:32:16 2026 +0200 root: fix rustfmt config Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit 775a971 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Wed Apr 1 15:44:16 2026 +0200 add docs Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit 52d6fc1 Merge: e4ca5d9 55e555c Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Tue Mar 31 13:54:07 2026 +0200 Merge branch 'main' into rust-lib-mode Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit e4ca5d9 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Mon Mar 30 20:16:24 2026 +0200 packages/ak-lib/mode: init Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit 524b788 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Mon Mar 30 19:57:51 2026 +0200 fixup Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space> commit dc65ab1 Author: Marc 'risson' Schmitt <marc.schmitt@risson.space> Date: Mon Mar 30 16:33:49 2026 +0200 packages/ak-lib: init Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
diff --git a/Cargo.toml b/Cargo.toml
@@ -64,7 +64,7 @@ tracing = "= 0.1.44"
 url = "= 2.5.8"
 uuid = { version = "= 1.23.0", features = ["serde", "v4"] }
 
-ak-common = { package = "authentik-common", version = "2026.5.0-rc1", path = "./packages/ak-common" }
+ak-common = { package = "authentik-common", version = "2026.5.0-rc1", path = "./packages/ak-common", default-features = false }
 
 [profile.dev.package.backtrace]
 opt-level = 3
diff --git a/packages/ak-common/Cargo.toml b/packages/ak-common/Cargo.toml
@@ -9,6 +9,11 @@ repository.workspace = true
 license-file.workspace = true
 publish.workspace = true
 
+[features]
+default = ["core", "proxy"]
+core = []
+proxy = []
+
 [dependencies]
 arc-swap.workspace = true
 axum-server.workspace = true
diff --git a/packages/ak-common/src/lib.rs b/packages/ak-common/src/lib.rs
@@ -3,6 +3,8 @@
 pub mod arbiter;
 pub use arbiter::{Arbiter, Event, Tasks};
 pub mod config;
+pub mod mode;
+pub use mode::Mode;
 pub mod tokio;
 
 pub const VERSION: &str = env!("CARGO_PKG_VERSION");
diff --git a/packages/ak-common/src/mode.rs b/packages/ak-common/src/mode.rs
@@ -0,0 +1,193 @@
+//! Utilities to manage the current execution mode.
+
+use std::{
+    env,
+    path::PathBuf,
+    sync::atomic::{AtomicU8, Ordering},
+};
+
+use eyre::{Result, eyre};
+use tracing::debug;
+
+/// Stores the current mode.
+static MODE: AtomicU8 = AtomicU8::new(0);
+
+fn mode_path() -> PathBuf {
+    env::temp_dir().join("authentik-mode")
+}
+
+/// authentik execution mode.
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[repr(u8)]
+pub enum Mode {
+    /// Running both the server and the worker.
+    #[cfg(feature = "core")]
+    AllInOne = 0,
+    /// Running the server.
+    #[cfg(feature = "core")]
+    Server = 1,
+    /// Running the worker.
+    #[cfg(feature = "core")]
+    Worker = 2,
+    /// Running the proxy outpost.
+    #[cfg(feature = "proxy")]
+    Proxy = 128,
+}
+
+impl std::fmt::Display for Mode {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            #[cfg(feature = "core")]
+            Self::AllInOne => write!(f, "allinone"),
+            #[cfg(feature = "core")]
+            Self::Server => write!(f, "server"),
+            #[cfg(feature = "core")]
+            Self::Worker => write!(f, "worker"),
+            #[cfg(feature = "proxy")]
+            Self::Proxy => write!(f, "proxy"),
+        }
+    }
+}
+
+impl From<Mode> for u8 {
+    #[expect(clippy::as_conversions, reason = "repr of enum is u8")]
+    fn from(value: Mode) -> Self {
+        value as Self
+    }
+}
+
+impl Mode {
+    /// Get the current mode.
+    pub fn get() -> Self {
+        match MODE.load(Ordering::Relaxed) {
+            #[cfg(feature = "core")]
+            0 => Self::AllInOne,
+            #[cfg(feature = "core")]
+            1 => Self::Server,
+            #[cfg(feature = "core")]
+            2 => Self::Worker,
+            #[cfg(feature = "proxy")]
+            128 => Self::Proxy,
+            _ => unreachable!(),
+        }
+    }
+
+    /// Set the current mode.
+    pub fn set(mode: Self) -> Result<()> {
+        std::fs::write(mode_path(), mode.to_string())?;
+        MODE.store(mode.into(), Ordering::SeqCst);
+        Ok(())
+    }
+
+    /// Load the current mode from the filesystem.
+    pub fn load() -> Result<()> {
+        let mode = std::fs::read_to_string(mode_path())?;
+        let mode = match mode.trim() {
+            #[cfg(feature = "core")]
+            "allinone" => Self::AllInOne,
+            #[cfg(feature = "core")]
+            "server" => Self::Server,
+            #[cfg(feature = "core")]
+            "worker" => Self::Worker,
+            #[cfg(feature = "proxy")]
+            "proxy" => Self::Proxy,
+            _ => return Err(eyre!("Mode {mode} not supported")),
+        };
+        MODE.store(mode.into(), Ordering::SeqCst);
+        Ok(())
+    }
+
+    /// Cleanup the mode stored on the filesystem.
+    pub fn cleanup() {
+        let mode_path = mode_path();
+        if let Err(err) = std::fs::remove_file(&mode_path) {
+            debug!(%err, mode_path = %&mode_path.display(), "failed to remove mode file");
+        }
+    }
+
+    /// Check if the mode is one of the "core" modes, namely [`Mode::AllInOne`], [`Mode::Server`]
+    /// or [`Mode::Worker`].
+    #[must_use]
+    pub fn is_core() -> bool {
+        match Self::get() {
+            #[cfg(feature = "core")]
+            Self::AllInOne | Self::Server | Self::Worker => true,
+            _ => false,
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use tempfile::{TempDir, tempdir};
+
+    use super::Mode;
+
+    fn prepare_temp_dir() -> TempDir {
+        let tempdir = tempdir().expect("failed to create tempdir");
+        #[expect(unsafe_code, reason = "testing")]
+        // SAFETY: testing
+        unsafe {
+            std::env::set_var("TMPDIR", tempdir.path());
+        }
+        tempdir
+    }
+
+    #[test]
+    fn get_and_set() {
+        let temp_dir = prepare_temp_dir();
+        let mode_path = temp_dir.path().join("authentik-mode");
+        for mode in [
+            (Mode::AllInOne, "allinone"),
+            (Mode::Server, "server"),
+            (Mode::Worker, "worker"),
+            (Mode::Proxy, "proxy"),
+        ] {
+            Mode::set(mode.0).expect("failed to set mode");
+            assert_eq!(Mode::get(), mode.0);
+            assert_eq!(
+                std::fs::read_to_string(&mode_path).expect("failed to read mode"),
+                mode.1
+            );
+        }
+    }
+
+    #[test]
+    fn load() {
+        let temp_dir = prepare_temp_dir();
+        let mode_path = temp_dir.path().join("authentik-mode");
+        for mode in [
+            ("allinone", Mode::AllInOne),
+            ("server", Mode::Server),
+            ("worker", Mode::Worker),
+            ("proxy", Mode::Proxy),
+        ] {
+            std::fs::write(&mode_path, mode.0).expect("failed to write mode");
+            Mode::load().expect("failed to load mode");
+            assert_eq!(Mode::get(), mode.1);
+        }
+    }
+
+    #[test]
+    fn cleanup() {
+        let temp_dir = prepare_temp_dir();
+        let mode_path = temp_dir.path().join("authentik-mode");
+        Mode::set(Mode::AllInOne).expect("failed to set mode");
+        Mode::cleanup();
+        mode_path.metadata().expect_err("mode file still exists");
+    }
+
+    #[test]
+    fn is_core() {
+        let _temp_dir = prepare_temp_dir();
+        for mode in [
+            (Mode::AllInOne, true),
+            (Mode::Server, true),
+            (Mode::Worker, true),
+            (Mode::Proxy, false),
+        ] {
+            Mode::set(mode.0).expect("failed to set mode");
+            assert_eq!(Mode::is_core(), mode.1);
+        }
+    }
+}
