Turbopack: allow gzip compression on trace files, write to diagnostics folder

Author: sokra

Cargo.lock

@@ -367,6 +367,7 @@ dhat = { version = "0.3.2" }
 dunce = "1.0.3"
 either = "1.9.0"
 erased-serde = "0.4.5"
+flate2 = "1.0.28"
 futures = "0.3.31"
 futures-util = "0.3.31"
 futures-retry = "0.6.0"

Cargo.toml

@@ -55,10 +55,11 @@ ignored = [
 ]
 
 [dependencies]
-anyhow = "1.0.66"
+anyhow = { workspace = true }
 console-subscriber = { workspace = true, optional = true }
 dhat = { workspace = true, optional = true }
 either = { workspace = true }
+flate2 = { workspace = true }
 futures-util = { workspace = true }
 owo-colors = { workspace = true }
 napi = { workspace = true }

crates/napi/Cargo.toml

@@ -30,6 +30,7 @@ DEALINGS IN THE SOFTWARE.
 //#![deny(clippy::all)]
 #![feature(arbitrary_self_types)]
 #![feature(arbitrary_self_types_pointers)]
+#![feature(iter_intersperse)]
 
 #[macro_use]
 extern crate napi_derive;

crates/napi/src/lib.rs

@@ -1,6 +1,7 @@
 use std::{borrow::Cow, io::Write, path::PathBuf, sync::Arc, thread, time::Duration};
 
 use anyhow::{Context, Result, anyhow, bail};
+use flate2::write::GzEncoder;
 use futures_util::TryFutureExt;
 use napi::{
     Env, JsFunction, JsObject, Status,
@@ -363,21 +364,33 @@ pub fn project_new(
     }
 
     if let Some(mut trace) = trace {
-        // Trace presets
-        match trace.as_str() {
-            "overview" | "1" => {
-                trace = TRACING_NEXT_OVERVIEW_TARGETS.join(",");
-            }
-            "next" => {
-                trace = TRACING_NEXT_TARGETS.join(",");
-            }
-            "turbopack" => {
-                trace = TRACING_NEXT_TURBOPACK_TARGETS.join(",");
-            }
-            "turbo-tasks" => {
-                trace = TRACING_NEXT_TURBO_TASKS_TARGETS.join(",");
-            }
-            _ => {}
+        trace = trace
+            .split(",")
+            .map(|item| {
+                // Trace presets
+                match item {
+                    "overview" | "1" => Cow::Owned(TRACING_NEXT_OVERVIEW_TARGETS.join(",")),
+                    "next" => Cow::Owned(TRACING_NEXT_TARGETS.join(",")),
+                    "turbopack" => Cow::Owned(TRACING_NEXT_TURBOPACK_TARGETS.join(",")),
+                    "turbo-tasks" => Cow::Owned(TRACING_NEXT_TURBO_TASKS_TARGETS.join(",")),
+                    _ => Cow::Borrowed(item),
+                }
+            })
+            .intersperse_with(|| Cow::Borrowed(","))
+            .collect::<String>();
+
+        enum Compression {
+            None,
+            GzipFast,
+            GzipBest,
+        }
+        let mut compress = Compression::None;
+        if trace.ends_with(",gz") {
+            trace.drain(trace.len() - 3..);
+            compress = Compression::GzipFast;
+        } else if trace.ends_with(",gz-best") {
+            trace.drain(trace.len() - 8..);
+            compress = Compression::GzipBest;
         }
 
         let subscriber = Registry::default();
@@ -396,9 +409,25 @@ pub fn project_new(
         std::fs::create_dir_all(&internal_dir)
             .context("Unable to create .next directory")
             .unwrap();
-        let trace_file = internal_dir.join("trace-turbopack");
-        let trace_writer = std::fs::File::create(trace_file.clone()).unwrap();
-        let (trace_writer, trace_writer_guard) = TraceWriter::new(trace_writer);
+        let (trace_writer, trace_writer_guard) = match compress {
+            Compression::None => {
+                let trace_file = internal_dir.join("diagnostics/trace-turbopack");
+                let trace_writer = std::fs::File::create(trace_file.clone()).unwrap();
+                TraceWriter::new(trace_writer)
+            }
+            Compression::GzipFast => {
+                let trace_file = internal_dir.join("diagnostics/trace-turbopack.gz");
+                let trace_writer = std::fs::File::create(trace_file.clone()).unwrap();
+                let trace_writer = GzEncoder::new(trace_writer, flate2::Compression::fast());
+                TraceWriter::new(trace_writer)
+            }
+            Compression::GzipBest => {
+                let trace_file = internal_dir.join("diagnostics/trace-turbopack.gz");
+                let trace_writer = std::fs::File::create(trace_file.clone()).unwrap();
+                let trace_writer = GzEncoder::new(trace_writer, flate2::Compression::best());
+                TraceWriter::new(trace_writer)
+            }
+        };
         let subscriber = subscriber.with(RawTraceLayer::new(trace_writer));
 
         exit.on_exit(async move {

crates/napi/src/next_api/project.rs

@@ -14,7 +14,7 @@ bench = false
 [dependencies]
 anyhow = { workspace = true, features = ["backtrace"] }
 either = { workspace = true }
-flate2 = { version = "1.0.28" }
+flate2 = { workspace = true }
 hashbrown = { workspace = true, features = ["raw"] }
 indexmap = { workspace = true, features = ["serde"] }
 itertools = { workspace = true }