From 1caa47a3835b3333d9ded61ec3ac2636c26596a7 Mon Sep 17 00:00:00 2001
From: LukeMathWalker <contact@palmieri.com>
Date: Sat, 1 May 2021 15:51:06 +0100
Subject: [PATCH] Use once_cell instead of lazy_static for tracing. Use custom
 sinks instead of filters to disable logging.

---
 Cargo.lock           |  6 +++---
 Cargo.toml           |  2 +-
 src/main.rs          |  2 +-
 src/telemetry.rs     |  9 +++++++--
 tests/api/helpers.rs | 19 +++++++++++++------
 5 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 20c9e07..84f77c1 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1282,9 +1282,9 @@ dependencies = [
 
 [[package]]
 name = "once_cell"
-version = "1.5.2"
+version = "1.7.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "13bd41f508810a131401606d54ac32a467c97172d74ba7662562ebba5ad07fa0"
+checksum = "af8b08b04175473088b46763e51ee54da5f9a164bc162f615b91bc179dbf15a3"
 
 [[package]]
 name = "opaque-debug"
@@ -2619,7 +2619,7 @@ dependencies = [
  "claim",
  "config",
  "fake",
- "lazy_static",
+ "once_cell",
  "quickcheck",
  "quickcheck_macros",
  "reqwest",
diff --git a/Cargo.toml b/Cargo.toml
index c3fcd90..a8e9672 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -31,7 +31,7 @@ unicode-segmentation = "1.7.1"
 validator = "0.12.0"
 
 [dev-dependencies]
-lazy_static = "1.4.0"
+once_cell = "1.7.2"
 claim = "0.4.0"
 quickcheck = "0.9.2"
 quickcheck_macros = "0.9.1"
diff --git a/src/main.rs b/src/main.rs
index 265e746..a185acb 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -4,7 +4,7 @@ use zero2prod::telemetry::{get_subscriber, init_subscriber};
 
 #[actix_web::main]
 async fn main() -> std::io::Result<()> {
-    let subscriber = get_subscriber("zero2prod".into(), "info".into());
+    let subscriber = get_subscriber("zero2prod".into(), "info".into(), std::io::stdout);
     init_subscriber(subscriber);
 
     let configuration = get_configuration().expect("Failed to read configuration.");
diff --git a/src/telemetry.rs b/src/telemetry.rs
index 27168fb..f8646a4 100644
--- a/src/telemetry.rs
+++ b/src/telemetry.rs
@@ -2,6 +2,7 @@ use tracing::subscriber::set_global_default;
 use tracing::Subscriber;
 use tracing_bunyan_formatter::{BunyanFormattingLayer, JsonStorageLayer};
 use tracing_log::LogTracer;
+use tracing_subscriber::fmt::MakeWriter;
 use tracing_subscriber::{layer::SubscriberExt, EnvFilter, Registry};
 
 /// Compose multiple layers into a `tracing`'s subscriber.
@@ -10,10 +11,14 @@ use tracing_subscriber::{layer::SubscriberExt, EnvFilter, Registry};
 ///
 /// We are using `impl Subscriber` as return type to avoid having to spell out the actual
 /// type of the returned subscriber, which is indeed quite complex.
-pub fn get_subscriber(name: String, env_filter: String) -> impl Subscriber + Sync + Send {
+pub fn get_subscriber(
+    name: String,
+    env_filter: String,
+    sink: impl MakeWriter + Send + Sync + 'static,
+) -> impl Subscriber + Sync + Send {
     let env_filter =
         EnvFilter::try_from_default_env().unwrap_or_else(|_| EnvFilter::new(env_filter));
-    let formatting_layer = BunyanFormattingLayer::new(name, std::io::stdout);
+    let formatting_layer = BunyanFormattingLayer::new(name, sink);
     Registry::default()
         .with(env_filter)
         .with(JsonStorageLayer)
diff --git a/tests/api/helpers.rs b/tests/api/helpers.rs
index 29cc2f9..31e43f9 100644
--- a/tests/api/helpers.rs
+++ b/tests/api/helpers.rs
@@ -1,17 +1,22 @@
+use once_cell::sync::Lazy;
 use sqlx::{Connection, Executor, PgConnection, PgPool};
 use uuid::Uuid;
 use zero2prod::configuration::{get_configuration, DatabaseSettings};
 use zero2prod::startup::{get_connection_pool, Application};
 use zero2prod::telemetry::{get_subscriber, init_subscriber};
 
-// Ensure that the `tracing` stack is only initialised once using `lazy_static`
-lazy_static::lazy_static! {
-    static ref TRACING: () = {
-        let filter = if std::env::var("TEST_LOG").is_ok() { "debug" } else { "" };
-        let subscriber = get_subscriber("test".into(), filter.into());
+// Ensure that the `tracing` stack is only initialised once using `once_cell`
+static TRACING: Lazy<()> = Lazy::new(|| {
+    let default_filter_level = "info".to_string();
+    let subscriber_name = "test".to_string();
+    if std::env::var("TEST_LOG").is_ok() {
+        let subscriber = get_subscriber(subscriber_name, default_filter_level, std::io::stdout);
+        init_subscriber(subscriber);
+    } else {
+        let subscriber = get_subscriber(subscriber_name, default_filter_level, std::io::sink);
         init_subscriber(subscriber);
     };
-}
+});
 
 pub struct TestApp {
     pub address: String,
@@ -31,6 +36,8 @@ impl TestApp {
 }
 
 pub async fn spawn_app() -> TestApp {
+    Lazy::force(&TRACING);
+
     // Randomise configuration to ensure test isolation
     let configuration = {
         let mut c = get_configuration().expect("Failed to read configuration.");