aoc_leaderbot_lib 3.0.0

Support library for aoc_leaderbot, an Advent of Code leaderboard-watching bot
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

//! Bot config loading values from the environment.

use std::fmt::Debug;

use aoc_leaderboard::aoc::LeaderboardCredentials;

use crate::detail::{env_var, int_env_var};
use crate::error::EnvVarError;
use crate::leaderbot::Config;
use crate::leaderbot::config::mem::MemoryConfig;

/// Environment variable name suffix for `year`. See [`get_env_config`].
pub const ENV_CONFIG_YEAR_SUFFIX: &str = "YEAR";

/// Environment variable name suffix for `leaderboard_id`. See [`get_env_config`].
pub const ENV_CONFIG_LEADERBOARD_ID_SUFFIX: &str = "LEADERBOARD_ID";

/// Environment variable name suffix for `view_key`. See [`get_env_config`].
pub const ENV_CONFIG_VIEW_KEY_SUFFIX: &str = "VIEW_KEY";

/// Environment variable name suffix for `session_cookie`. See [`get_env_config`].
pub const ENV_CONFIG_SESSION_COOKIE_SUFFIX: &str = "SESSION_COOKIE";

/// Loads bot config values from the environment.
///
/// The following environment variables are used:
///
/// | Env var name             | Config field                        | Default value |
/// |--------------------------|-------------------------------------|---------------|
/// | `{prefix}YEAR`           | `year`                              | Current year  |
/// | `{prefix}LEADERBOARD_ID` | `leaderboard_id`                    | -             |
/// | `{prefix}VIEW_KEY`       | `credentials` (as [view key])       | -             |
/// | `{prefix}SESSION_COOKIE` | `credentials` (as [session cookie]) | -             |
///
/// [view key]: LeaderboardCredentials::ViewKey
/// [session cookie]: LeaderboardCredentials::SessionCookie
#[cfg_attr(not(coverage), tracing::instrument(level = "trace", err))]
pub fn get_env_config<S>(env_var_prefix: S) -> crate::Result<impl Config + Send + Debug>
where
    S: AsRef<str> + Debug,
{
    let env_var_prefix = env_var_prefix.as_ref();
    let var_name = |name| format!("{env_var_prefix}{name}");

    let year = match int_env_var(var_name(ENV_CONFIG_YEAR_SUFFIX)) {
        Ok(year) => Some(year),
        Err(crate::Error::Env { source: EnvVarError::NotPresent, .. }) => None,
        Err(err) => return Err(err),
    };

    let credentials = match env_var(var_name(ENV_CONFIG_VIEW_KEY_SUFFIX)) {
        Ok(view_key) => LeaderboardCredentials::ViewKey(view_key),
        Err(crate::Error::Env { source: EnvVarError::NotPresent, .. }) => {
            LeaderboardCredentials::SessionCookie(env_var(var_name(
                ENV_CONFIG_SESSION_COOKIE_SUFFIX,
            ))?)
        },
        Err(err) => return Err(err),
    };

    let mut builder = MemoryConfig::builder();
    if let Some(year) = year {
        builder.year(year);
    }
    builder
        .leaderboard_id(int_env_var(var_name(ENV_CONFIG_LEADERBOARD_ID_SUFFIX))?)
        .credentials(credentials)
        .build()
}