mirror of
https://github.com/dani-garcia/vaultwarden.git
synced 2024-11-25 20:33:14 +01:00
1b64b9e164
This PR adds query logging support as an optional feature. It is only allowed during development/debug builds, and will abort when used during a `--release` build. For this feature to be fully activated you also need to se an environment variable `QUERY_LOGGER=1` to activate the debug log-level for this crate, else there will be no output. The reason for this PR is that sometimes it is useful to be able to see the generated queries, like when debugging an issue, or trying to optimize a query. Currently i always added this code when needed, but having this a part of the code could benifit other developers too who maybe need this.
81 lines
3.1 KiB
Rust
81 lines
3.1 KiB
Rust
use std::env;
|
|
use std::process::Command;
|
|
|
|
fn main() {
|
|
// This allow using #[cfg(sqlite)] instead of #[cfg(feature = "sqlite")], which helps when trying to add them through macros
|
|
#[cfg(feature = "sqlite")]
|
|
println!("cargo:rustc-cfg=sqlite");
|
|
#[cfg(feature = "mysql")]
|
|
println!("cargo:rustc-cfg=mysql");
|
|
#[cfg(feature = "postgresql")]
|
|
println!("cargo:rustc-cfg=postgresql");
|
|
#[cfg(feature = "query_logger")]
|
|
println!("cargo:rustc-cfg=query_logger");
|
|
|
|
#[cfg(not(any(feature = "sqlite", feature = "mysql", feature = "postgresql")))]
|
|
compile_error!(
|
|
"You need to enable one DB backend. To build with previous defaults do: cargo build --features sqlite"
|
|
);
|
|
|
|
#[cfg(all(not(debug_assertions), feature = "query_logger"))]
|
|
compile_error!("Query Logging is only allowed during development, it is not intented for production usage!");
|
|
|
|
// Support $BWRS_VERSION for legacy compatibility, but default to $VW_VERSION.
|
|
// If neither exist, read from git.
|
|
let maybe_vaultwarden_version =
|
|
env::var("VW_VERSION").or_else(|_| env::var("BWRS_VERSION")).or_else(|_| version_from_git_info());
|
|
|
|
if let Ok(version) = maybe_vaultwarden_version {
|
|
println!("cargo:rustc-env=VW_VERSION={version}");
|
|
println!("cargo:rustc-env=CARGO_PKG_VERSION={version}");
|
|
}
|
|
}
|
|
|
|
fn run(args: &[&str]) -> Result<String, std::io::Error> {
|
|
let out = Command::new(args[0]).args(&args[1..]).output()?;
|
|
if !out.status.success() {
|
|
use std::io::{Error, ErrorKind};
|
|
return Err(Error::new(ErrorKind::Other, "Command not successful"));
|
|
}
|
|
Ok(String::from_utf8(out.stdout).unwrap().trim().to_string())
|
|
}
|
|
|
|
/// This method reads info from Git, namely tags, branch, and revision
|
|
/// To access these values, use:
|
|
/// - env!("GIT_EXACT_TAG")
|
|
/// - env!("GIT_LAST_TAG")
|
|
/// - env!("GIT_BRANCH")
|
|
/// - env!("GIT_REV")
|
|
/// - env!("VW_VERSION")
|
|
fn version_from_git_info() -> Result<String, std::io::Error> {
|
|
// The exact tag for the current commit, can be empty when
|
|
// the current commit doesn't have an associated tag
|
|
let exact_tag = run(&["git", "describe", "--abbrev=0", "--tags", "--exact-match"]).ok();
|
|
if let Some(ref exact) = exact_tag {
|
|
println!("cargo:rustc-env=GIT_EXACT_TAG={exact}");
|
|
}
|
|
|
|
// The last available tag, equal to exact_tag when
|
|
// the current commit is tagged
|
|
let last_tag = run(&["git", "describe", "--abbrev=0", "--tags"])?;
|
|
println!("cargo:rustc-env=GIT_LAST_TAG={last_tag}");
|
|
|
|
// The current branch name
|
|
let branch = run(&["git", "rev-parse", "--abbrev-ref", "HEAD"])?;
|
|
println!("cargo:rustc-env=GIT_BRANCH={branch}");
|
|
|
|
// The current git commit hash
|
|
let rev = run(&["git", "rev-parse", "HEAD"])?;
|
|
let rev_short = rev.get(..8).unwrap_or_default();
|
|
println!("cargo:rustc-env=GIT_REV={rev_short}");
|
|
|
|
// Combined version
|
|
if let Some(exact) = exact_tag {
|
|
Ok(exact)
|
|
} else if &branch != "main" && &branch != "master" {
|
|
Ok(format!("{last_tag}-{rev_short} ({branch})"))
|
|
} else {
|
|
Ok(format!("{last_tag}-{rev_short}"))
|
|
}
|
|
}
|