Replace log with tracing (#573)

neuronull · web-flow · commit d05b2aee6b08 · 2025-11-24T07:45:14.000-07:00
## 🎟️ Tracking https://bitwarden.atlassian.net/browse/PM-27519 ## 📔 Objective Cascading the standardization of `tracing` crate from clients repo into the SDK, that was started per bitwarden/clients#16321 , this change updates the remaining crates in the SDK to use `tracing`. ## 🚨 Breaking Changes  ## ⏰ Reminders before review - Contributor guidelines followed - All formatters and local linters executed and passed - Written new unit and / or integration tests where applicable - Protected functional changes with optionality (feature flags) - Used internationalization (i18n) for all UI strings - CI builds passed - Communicated to DevOps any deployment requirements - Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team ## 🦮 Reviewer guidelines  - 👍 (`:+1:`) or similar for great changes - 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info - ❓ (`:question:`) for questions - 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion - 🎨 (`:art:`) for suggestions / improvements - ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or concerns needing attention - 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or indications of technical debt - ⛏ (`:pick:`) for minor or nitpick changes
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -58,7 +58,6 @@ data-encoding = ">=2.0, <3"
 ed25519-dalek = { version = ">=2.1.1, <=2.2.0" }
 futures = ">=0.3.31, <0.4"
 js-sys = { version = ">=0.3.72, <0.4" }
-log = ">=0.4.18, <0.5"
 proc-macro2 = ">=1.0.89, <2"
 quote = ">=1.0.37, <2"
 reqwest = { version = ">=0.12.5, <0.13", features = [
diff --git a/bitwarden_license/bitwarden-sm/Cargo.toml b/bitwarden_license/bitwarden-sm/Cargo.toml
@@ -18,11 +18,11 @@ bitwarden-api-api = { workspace = true }
 bitwarden-core = { workspace = true, features = ["secrets"] }
 bitwarden-crypto = { workspace = true }
 chrono = { workspace = true }
-log = { workspace = true }
 schemars = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }
+tracing = { workspace = true }
 uuid = { workspace = true }
 validator = { workspace = true }
 
diff --git a/bitwarden_license/bitwarden-sm/src/error.rs b/bitwarden_license/bitwarden-sm/src/error.rs
@@ -1,6 +1,6 @@
 use bitwarden_api_api::apis::Error as ApiApisError;
-use log::debug;
 use thiserror::Error;
+use tracing::debug;
 use validator::ValidationErrors;
 
 #[derive(Debug, thiserror::Error)]
@@ -45,7 +45,7 @@ pub fn validate_only_whitespaces(value: &str) -> Result<(), validator::Validatio
 
 impl From<ValidationErrors> for ValidationError {
     fn from(e: ValidationErrors) -> Self {
-        debug!("Validation errors: {e:#?}");
+        debug!(?e, "Validation errors");
         for (field_name, errors) in e.field_errors() {
             for error in errors {
                 match error.code.as_ref() {
diff --git a/crates/bitwarden-core/Cargo.toml b/crates/bitwarden-core/Cargo.toml
@@ -49,7 +49,6 @@ bitwarden-uuid = { workspace = true }
 chrono = { workspace = true, features = ["std"] }
 # We don't use this directly (it's used by rand), but we need it here to enable WASM support
 getrandom = { version = ">=0.2.9, <0.3", features = ["js"] }
-log = { workspace = true }
 rand = ">=0.8.5, <0.9"
 reqwest = { workspace = true }
 schemars = { workspace = true }
@@ -59,6 +58,7 @@ serde_json = { workspace = true }
 serde_qs = { workspace = true }
 serde_repr = { workspace = true }
 thiserror = { workspace = true }
+tracing = { workspace = true }
 tsify = { workspace = true, optional = true }
 uniffi = { workspace = true, optional = true, features = ["tokio"] }
 uuid = { workspace = true }
diff --git a/crates/bitwarden-core/src/auth/api/request/access_token_request.rs b/crates/bitwarden-core/src/auth/api/request/access_token_request.rs
@@ -1,5 +1,5 @@
-use log::debug;
 use serde::{Deserialize, Serialize};
+use tracing::debug;
 use uuid::Uuid;
 
 use crate::{
@@ -23,7 +23,7 @@ impl AccessTokenRequest {
             client_secret: client_secret.to_string(),
             grant_type: "client_credentials".to_string(),
         };
-        debug!("initializing {obj:?}");
+        debug!(?obj, "initializing");
         obj
     }
 
diff --git a/crates/bitwarden-core/src/auth/api/request/api_token_request.rs b/crates/bitwarden-core/src/auth/api/request/api_token_request.rs
@@ -1,5 +1,5 @@
-use log::debug;
 use serde::{Deserialize, Serialize};
+use tracing::debug;
 
 use crate::{
     auth::{api::response::IdentityTokenResponse, login::LoginError},
@@ -31,7 +31,7 @@ impl ApiTokenRequest {
             device_name: "firefox".to_string(),
             grant_type: "client_credentials".to_string(),
         };
-        debug!("initializing {obj:?}");
+        debug!(?obj, "initializing");
         obj
     }
 
diff --git a/crates/bitwarden-core/src/auth/api/request/auth_request_token_request.rs b/crates/bitwarden-core/src/auth/api/request/auth_request_token_request.rs
@@ -1,5 +1,5 @@
-use log::debug;
 use serde::{Deserialize, Serialize};
+use tracing::debug;
 use uuid::Uuid;
 
 use crate::{
@@ -47,7 +47,7 @@ impl AuthRequestTokenRequest {
             auth_request_id: *auth_request_id,
             access_code: access_code.to_string(),
         };
-        debug!("initializing {obj:?}");
+        debug!(?obj, "initializing");
         obj
     }
 
diff --git a/crates/bitwarden-core/src/auth/api/request/password_token_request.rs b/crates/bitwarden-core/src/auth/api/request/password_token_request.rs
@@ -1,5 +1,5 @@
-use log::debug;
 use serde::{Deserialize, Serialize};
+use tracing::debug;
 
 use crate::{
     DeviceType,
@@ -56,7 +56,7 @@ impl PasswordTokenRequest {
             two_factor_provider: tf.map(|t| t.provider.clone()),
             two_factor_remember: tf.map(|t| t.remember),
         };
-        debug!("initializing {obj:?}");
+        debug!(?obj, "initializing");
         obj
     }
 
diff --git a/crates/bitwarden-core/src/auth/login/password.rs b/crates/bitwarden-core/src/auth/login/password.rs
@@ -1,7 +1,7 @@
-#[cfg(feature = "internal")]
-use log::info;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
+#[cfg(feature = "internal")]
+use tracing::info;
 
 use crate::auth::{
     api::response::IdentityTokenResponse, login::response::two_factor::TwoFactorProviders,
diff --git a/crates/bitwarden-core/src/client/encryption_settings.rs b/crates/bitwarden-core/src/client/encryption_settings.rs
@@ -9,9 +9,9 @@ use bitwarden_crypto::{
 #[cfg(any(feature = "internal", feature = "secrets"))]
 use bitwarden_crypto::{KeyStore, SymmetricCryptoKey};
 use bitwarden_error::bitwarden_error;
-#[cfg(feature = "internal")]
-use log::warn;
 use thiserror::Error;
+#[cfg(feature = "internal")]
+use tracing::warn;
 
 #[cfg(any(feature = "secrets", feature = "internal"))]
 use crate::OrganizationId;
diff --git a/crates/bitwarden-core/src/client/internal.rs b/crates/bitwarden-core/src/client/internal.rs
@@ -194,9 +194,9 @@ impl InternalClient {
 
     #[cfg(any(feature = "internal", feature = "secrets"))]
     pub(crate) fn set_login_method(&self, login_method: LoginMethod) {
-        use log::debug;
+        use tracing::debug;
 
-        debug! {"setting login method: {login_method:#?}"}
+        debug!(?login_method, "setting login method.");
         *self.login_method.write().expect("RwLock is not poisoned") = Some(Arc::new(login_method));
     }
 
diff --git a/crates/bitwarden-core/src/key_management/crypto.rs b/crates/bitwarden-core/src/key_management/crypto.rs
@@ -672,11 +672,11 @@ pub(super) fn verify_asymmetric_keys(
             private_key_decryptable: true,
             valid_private_key: true,
         },
-        Err(e) => {
-            log::debug!("User asymmetric keys verification: {e}");
+        Err(error) => {
+            tracing::debug!(%error, "User asymmetric keys verification");
 
             VerifyAsymmetricKeysResponse {
-                private_key_decryptable: !matches!(e, VerifyError::DecryptFailed(_)),
+                private_key_decryptable: !matches!(error, VerifyError::DecryptFailed(_)),
                 valid_private_key: false,
             }
         }
diff --git a/crates/bitwarden-core/src/platform/get_user_api_key.rs b/crates/bitwarden-core/src/platform/get_user_api_key.rs
@@ -16,9 +16,9 @@ use std::sync::Arc;
 
 use bitwarden_api_api::models::{ApiKeyResponseModel, SecretVerificationRequestModel};
 use bitwarden_crypto::{CryptoError, HashPurpose, MasterKey};
-use log::{debug, info};
 use serde::{Deserialize, Serialize};
 use thiserror::Error;
+use tracing::{debug, info};
 
 use super::SecretVerificationRequest;
 use crate::{
@@ -48,7 +48,7 @@ pub(crate) async fn get_user_api_key(
     input: &SecretVerificationRequest,
 ) -> Result<UserApiKeyResponse, UserApiKeyError> {
     info!("Getting Api Key");
-    debug!("{input:?}");
+    debug!(?input);
 
     let auth_settings = get_login_method(client)?;
     let config = client.internal.get_api_configurations().await;
diff --git a/crates/bitwarden-fido/Cargo.toml b/crates/bitwarden-fido/Cargo.toml
@@ -26,7 +26,6 @@ bitwarden-vault = { workspace = true }
 chrono = { workspace = true }
 coset = ">=0.3.7, <0.4"
 itertools = ">=0.13.0, <0.15"
-log = { workspace = true }
 p256 = ">=0.13.2, <0.14"
 passkey = { git = "https://github.com/bitwarden/passkey-rs", rev = "3b764633ebc6576c07bdd12ee14d8e5c87b494ed" }
 passkey-client = { git = "https://github.com/bitwarden/passkey-rs", rev = "3b764633ebc6576c07bdd12ee14d8e5c87b494ed", features = [
@@ -36,6 +35,7 @@ reqwest = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }
+tracing = { workspace = true }
 uniffi = { workspace = true, optional = true }
 uuid = { workspace = true }
 
diff --git a/crates/bitwarden-fido/src/authenticator.rs b/crates/bitwarden-fido/src/authenticator.rs
@@ -4,7 +4,6 @@ use bitwarden_core::Client;
 use bitwarden_crypto::CryptoError;
 use bitwarden_vault::{CipherError, CipherView, EncryptionContext};
 use itertools::Itertools;
-use log::error;
 use passkey::{
     authenticator::{Authenticator, DiscoverabilitySupport, StoreInfo, UIHint, UserCheck},
     types::{
@@ -13,6 +12,7 @@ use passkey::{
     },
 };
 use thiserror::Error;
+use tracing::error;
 
 use super::{
     AAGUID, CheckUserOptions, CipherViewContainer, Fido2CredentialStore, Fido2UserInterface,
@@ -419,8 +419,8 @@ impl passkey::authenticator::CredentialStore for CredentialStoreImpl<'_> {
             }
         }
 
-        inner(self, ids, rp_id).await.map_err(|e| {
-            error!("Error finding credentials: {e:?}");
+        inner(self, ids, rp_id).await.map_err(|error| {
+            error!(%error, "Error finding credentials.");
             VendorError::try_from(0xF0)
                 .expect("Valid vendor error code")
                 .into()
@@ -501,8 +501,8 @@ impl passkey::authenticator::CredentialStore for CredentialStoreImpl<'_> {
             Ok(())
         }
 
-        inner(self, cred, user, rp, options).await.map_err(|e| {
-            error!("Error saving credential: {e:?}");
+        inner(self, cred, user, rp, options).await.map_err(|error| {
+            error!(%error, "Error saving credential.");
             VendorError::try_from(0xF1)
                 .expect("Valid vendor error code")
                 .into()
@@ -579,8 +579,8 @@ impl passkey::authenticator::CredentialStore for CredentialStoreImpl<'_> {
             Ok(())
         }
 
-        inner(self, cred).await.map_err(|e| {
-            error!("Error updating credential: {e:?}");
+        inner(self, cred).await.map_err(|error| {
+            error!(%error, "Error updating credential.");
             VendorError::try_from(0xF2)
                 .expect("Valid vendor error code")
                 .into()
@@ -644,8 +644,8 @@ impl passkey::authenticator::UserValidationMethod for UserValidationMethodImpl<'
             }
         };
 
-        let result = result.map_err(|e| {
-            error!("Error checking user: {e:?}");
+        let result = result.map_err(|error| {
+            error!(%error, "Error checking user.");
             Ctap2Error::UserVerificationInvalid
         })?;
 
diff --git a/crates/bitwarden-fido/src/crypto.rs b/crates/bitwarden-fido/src/crypto.rs
@@ -17,14 +17,14 @@ pub enum CoseKeyToPkcs8Error {
 pub(crate) fn cose_key_to_pkcs8(cose_key: &CoseKey) -> Result<Vec<u8>, CoseKeyToPkcs8Error> {
     // cose_key.
     let secret_key = private_key_from_cose_key(cose_key).map_err(|error| {
-        log::error!("Failed to extract private key from cose_key: {error:?}");
+        tracing::error!(?error, "Failed to extract private key from cose_key.");
         CoseKeyToPkcs8Error::FailedToExtractPrivateKeyFromCoseKey
     })?;
 
     let vec = secret_key
         .to_pkcs8_der()
         .map_err(|error| {
-            log::error!("Failed to convert P256 private key to PKC8: {error:?}");
+            tracing::error!(%error, "Failed to convert P256 private key to PKC8.");
             CoseKeyToPkcs8Error::FailedToConvertP256PrivateKeyToPkcs8
         })?
         .as_bytes()
@@ -39,7 +39,7 @@ pub struct PrivateKeyFromSecretKeyError;
 
 pub fn pkcs8_to_cose_key(secret_key: &[u8]) -> Result<CoseKey, PrivateKeyFromSecretKeyError> {
     let secret_key = SecretKey::from_pkcs8_der(secret_key).map_err(|error| {
-        log::error!("Failed to extract private key from secret_key: {error:?}");
+        tracing::error!(%error, "Failed to extract private key from secret_key.");
         PrivateKeyFromSecretKeyError
     })?;
 
diff --git a/crates/bitwarden-ipc/Cargo.toml b/crates/bitwarden-ipc/Cargo.toml
@@ -25,11 +25,11 @@ bitwarden-error = { workspace = true }
 bitwarden-threading = { workspace = true }
 erased-serde = ">=0.4.6, <0.5"
 js-sys = { workspace = true, optional = true }
-log = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
 thiserror = { workspace = true }
 tokio = { features = ["sync", "time", "rt"], workspace = true }
+tracing = { workspace = true }
 tsify = { workspace = true, optional = true }
 uuid = { workspace = true }
 wasm-bindgen = { workspace = true, optional = true }
diff --git a/crates/bitwarden-ipc/src/ipc_client.rs b/crates/bitwarden-ipc/src/ipc_client.rs
diff --git a/crates/bitwarden-threading/Cargo.toml b/crates/bitwarden-threading/Cargo.toml
diff --git a/crates/bitwarden-threading/src/thread_bound_runner.rs b/crates/bitwarden-threading/src/thread_bound_runner.rs
diff --git a/crates/bw/Cargo.toml b/crates/bw/Cargo.toml
diff --git a/crates/bw/src/auth/login.rs b/crates/bw/src/auth/login.rs
diff --git a/crates/bw/src/main.rs b/crates/bw/src/main.rs
