Skip to content

feat: Allow configuration to be read from option_env! #4177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Allow configuration to be read from option_env! #4177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 44 additions & 36 deletions leptos_config/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,31 @@ use std::{
};
use typed_builder::TypedBuilder;

macro_rules! read_env_config {
($key:expr) => {
match ::std::env::var($key) {
Ok(val) => Ok(Some(val)),
Err(::std::env::VarError::NotPresent) => {
Ok(option_env!($key).map(ToString::to_string))
}
Err(e) => Err($crate::errors::LeptosConfigError::EnvVarError(
format!("{}: {e}", $key),
)),
}
};
($key:expr, $default:expr) => {
match std::env::var($key) {
Ok(val) => Ok(val),
Err(::std::env::VarError::NotPresent) => {
Ok(option_env!($key).unwrap_or($default).to_string())
}
Err(e) => Err($crate::errors::LeptosConfigError::EnvVarError(
format!("{}: {e}", $key),
)),
}
};
}

/// A Struct to allow us to parse LeptosOptions from the file. Not really needed, most interactions should
/// occur with LeptosOptions
#[derive(Clone, Debug, serde::Deserialize)]
Expand Down Expand Up @@ -122,10 +147,7 @@ pub struct LeptosOptions {

impl LeptosOptions {
fn try_from_env() -> Result<Self, LeptosConfigError> {
let output_name = env_w_default(
"LEPTOS_OUTPUT_NAME",
std::option_env!("LEPTOS_OUTPUT_NAME",).unwrap_or_default(),
)?;
let output_name = read_env_config!("LEPTOS_OUTPUT_NAME", "")?;
if output_name.is_empty() {
eprintln!(
"It looks like you're trying to compile Leptos without the \
Expand All @@ -139,31 +161,35 @@ impl LeptosOptions {
}
Ok(LeptosOptions {
output_name: output_name.into(),
site_root: env_w_default("LEPTOS_SITE_ROOT", "target/site")?.into(),
site_pkg_dir: env_w_default("LEPTOS_SITE_PKG_DIR", "pkg")?.into(),
env: env_from_str(env_w_default("LEPTOS_ENV", "DEV")?.as_str())?,
site_addr: env_w_default("LEPTOS_SITE_ADDR", "127.0.0.1:3000")?
site_root: read_env_config!("LEPTOS_SITE_ROOT", "target/site")?
.into(),
site_pkg_dir: read_env_config!("LEPTOS_SITE_PKG_DIR", "pkg")?
.into(),
env: env_from_str(read_env_config!("LEPTOS_ENV", "DEV")?.as_str())?,
site_addr: read_env_config!("LEPTOS_SITE_ADDR", "127.0.0.1:3000")?
.parse()?,
reload_port: env_w_default("LEPTOS_RELOAD_PORT", "3001")?
reload_port: read_env_config!("LEPTOS_RELOAD_PORT", "3001")?
.parse()?,
reload_external_port: match env_wo_default(
"LEPTOS_RELOAD_EXTERNAL_PORT",
reload_external_port: match read_env_config!(
"LEPTOS_RELOAD_EXTERNAL_PORT"
)? {
Some(val) => Some(val.parse()?),
None => None,
},
reload_ws_protocol: ws_from_str(
env_w_default("LEPTOS_RELOAD_WS_PROTOCOL", "ws")?.as_str(),
read_env_config!("LEPTOS_RELOAD_WS_PROTOCOL", "ws")?.as_str(),
)?,
not_found_path: env_w_default("LEPTOS_NOT_FOUND_PATH", "/404")?
not_found_path: read_env_config!("LEPTOS_NOT_FOUND_PATH", "/404")?
.into(),
hash_file: env_w_default("LEPTOS_HASH_FILE_NAME", "hash.txt")?
hash_file: read_env_config!("LEPTOS_HASH_FILE_NAME", "hash.txt")?
.into(),
hash_files: env_w_default("LEPTOS_HASH_FILES", "false")?.parse()?,
server_fn_prefix: env_wo_default("SERVER_FN_PREFIX")?,
disable_server_fn_hash: env_wo_default("DISABLE_SERVER_FN_HASH")?
hash_files: read_env_config!("LEPTOS_HASH_FILES", "false")?
.parse()?,
server_fn_prefix: read_env_config!("SERVER_FN_PREFIX")?,
disable_server_fn_hash: read_env_config!("DISABLE_SERVER_FN_HASH")?
.is_some(),
server_fn_mod_path: read_env_config!("SERVER_FN_MOD_PATH")?
.is_some(),
server_fn_mod_path: env_wo_default("SERVER_FN_MOD_PATH")?.is_some(),
})
}
}
Expand Down Expand Up @@ -200,24 +226,6 @@ fn default_hash_files() -> bool {
false
}

fn env_wo_default(key: &str) -> Result<Option<String>, LeptosConfigError> {
match std::env::var(key) {
Ok(val) => Ok(Some(val)),
Err(VarError::NotPresent) => Ok(None),
Err(e) => Err(LeptosConfigError::EnvVarError(format!("{key}: {e}"))),
}
}
fn env_w_default(
key: &str,
default: &str,
) -> Result<String, LeptosConfigError> {
match std::env::var(key) {
Ok(val) => Ok(val),
Err(VarError::NotPresent) => Ok(default.to_string()),
Err(e) => Err(LeptosConfigError::EnvVarError(format!("{key}: {e}"))),
}
}

/// An enum that can be used to define the environment Leptos is running in.
/// Setting this to the `PROD` variant will not include the WebSocket code for `cargo-leptos` watch mode.
/// Defaults to `DEV`.
Expand Down
18 changes: 6 additions & 12 deletions leptos_config/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
use crate::{
env_from_str, env_w_default, env_wo_default, ws_from_str, Env,
LeptosOptions, ReloadWSProtocol,
};
use crate::{env_from_str, ws_from_str, Env, LeptosOptions, ReloadWSProtocol};
use std::{net::SocketAddr, str::FromStr};

#[test]
Expand Down Expand Up @@ -29,33 +26,30 @@ fn ws_from_str_test() {
}

#[test]
fn env_w_default_test() {
fn read_env_config_test() {
temp_env::with_var("LEPTOS_CONFIG_ENV_TEST", Some("custom"), || {
assert_eq!(
env_w_default("LEPTOS_CONFIG_ENV_TEST", "default").unwrap(),
read_env_config!("LEPTOS_CONFIG_ENV_TEST", "default").unwrap(),
String::from("custom")
);
});

temp_env::with_var_unset("LEPTOS_CONFIG_ENV_TEST", || {
assert_eq!(
env_w_default("LEPTOS_CONFIG_ENV_TEST", "default").unwrap(),
read_env_config!("LEPTOS_CONFIG_ENV_TEST", "default").unwrap(),
String::from("default")
);
});
}

#[test]
fn env_wo_default_test() {
temp_env::with_var("LEPTOS_CONFIG_ENV_TEST", Some("custom"), || {
assert_eq!(
env_wo_default("LEPTOS_CONFIG_ENV_TEST").unwrap(),
read_env_config!("LEPTOS_CONFIG_ENV_TEST").unwrap(),
Some(String::from("custom"))
);
});

temp_env::with_var_unset("LEPTOS_CONFIG_ENV_TEST", || {
assert_eq!(env_wo_default("LEPTOS_CONFIG_ENV_TEST").unwrap(), None);
assert_eq!(read_env_config!("LEPTOS_CONFIG_ENV_TEST").unwrap(), None);
});
}

Expand Down
Loading