hebo 0.3.3

// Copyright (c) 2021 Xu Shaohua <shaohua@biofan.org>. All rights reserved.
// Use of this source is governed by Affero General Public License that can be found
// in the LICENSE file.

use serde::Deserialize;
use std::net::{TcpListener, ToSocketAddrs};

use crate::error::{Error, ErrorKind};

/// Configuration for dashboard app.
#[derive(Debug, Deserialize, Clone)]
pub struct Dashboard {
    /// Enable dashboard or not.
    ///
    /// Default is true.
    #[serde(default = "Dashboard::default_enable")]
    enable: bool,

    /// Binding address.
    ///
    /// Default is `127.0.0.1:18083`.
    #[serde(default = "Dashboard::default_address")]
    address: String,
}

impl Dashboard {
    const fn default_enable() -> bool {
        true
    }

    fn default_address() -> String {
        "127.0.0.1:18083".to_string()
    }

    #[must_use]
    pub const fn enable(&self) -> bool {
        self.enable
    }

    #[must_use]
    pub fn address(&self) -> &str {
        &self.address
    }

    /// Validate dashboard config.
    ///
    /// # Errors
    ///
    /// Returns error if socket address is invalid or in use.
    pub fn validate(&self, bind_address: bool) -> Result<(), Error> {
        if self.enable {
            if bind_address {
                let _socket = TcpListener::bind(&self.address).map_err(|err| {
                    Error::from_string(
                        ErrorKind::ConfigError,
                        format!(
                            "Failed to bind to address {} for dashboard, err: {:?}",
                            &self.address, err
                        ),
                    )
                })?;
            } else {
                let _addr = self.address.to_socket_addrs().map_err(|err| {
                    Error::from_string(
                        ErrorKind::ConfigError,
                        format!(
                            "Invalid socket address in config: {}, err: {:?}",
                            &self.address, err
                        ),
                    )
                })?;
            }
        }
        Ok(())
    }
}

impl Default for Dashboard {
    fn default() -> Self {
        Self {
            enable: Self::default_enable(),
            address: Self::default_address(),
        }
    }
}