Unverified Commit 826da1f7 authored by Joshua Hannaford's avatar Joshua Hannaford Committed by GitHub

update(turbopack): Update the messaging UX for timing writing files to disk (#79469)

## Refactor Turbopack Compilation Events and Timing Reporting

### What?
This PR refactors how compilation events are created, displayed, and
formatted in Turbopack. It introduces a dedicated `TimingEvent` type for
timing-related messages and improves the formatting of duration
displays.

Additionally we now display all compilation events now that it has been
shown to be stable with no breakages.

### Why?
To provide more consistent and user-friendly output for compilation
events, especially for timing information. The new approach makes
duration formatting more readable by automatically selecting appropriate
units (ms, s, min) based on the duration length.

### How?
- Added a new `TimingEvent` struct that properly formats durations based
on their duration
- Updated the `DiagnosticEvent` constructor to take severity first, then
message
- Improved event handling in the build process to properly categorize
and display different severity levels
- Enhanced file I/O benchmarking to use the new timing event format
- Fixed the formatting of compilation events in the UI

---------
Co-authored-by: 's avatarNiklas Mischkulnig <4586894+mischnic@users.noreply.github.com>
parent fc05711d
...@@ -31,7 +31,7 @@ use turbo_rcstr::RcStr; ...@@ -31,7 +31,7 @@ use turbo_rcstr::RcStr;
use turbo_tasks::{ use turbo_tasks::{
Completion, Effects, FxIndexSet, OperationVc, ReadRef, ResolvedVc, TransientInstance, Completion, Effects, FxIndexSet, OperationVc, ReadRef, ResolvedVc, TransientInstance,
TryJoinIterExt, UpdateInfo, Vc, get_effects, TryJoinIterExt, UpdateInfo, Vc, get_effects,
message_queue::{CompilationEvent, DiagnosticEvent, Severity}, message_queue::{CompilationEvent, DiagnosticEvent, Severity, TimingEvent},
}; };
use turbo_tasks_fs::{ use turbo_tasks_fs::{
DiskFileSystem, FileContent, FileSystem, FileSystemPath, get_relative_path_to, DiskFileSystem, FileContent, FileSystem, FileSystemPath, get_relative_path_to,
...@@ -405,8 +405,8 @@ pub async fn project_new( ...@@ -405,8 +405,8 @@ pub async fn project_new(
)?; )?;
turbo_tasks.send_compilation_event(Arc::new(DiagnosticEvent::new( turbo_tasks.send_compilation_event(Arc::new(DiagnosticEvent::new(
"Starting the compilation events server...".to_owned(), Severity::Info,
Severity::Trace, "Starting the compilation events server ...".to_owned(),
))); )));
let stats_path = std::env::var_os("NEXT_TURBOPACK_TASK_STATISTICS"); let stats_path = std::env::var_os("NEXT_TURBOPACK_TASK_STATISTICS");
...@@ -850,21 +850,14 @@ pub async fn project_write_all_entrypoints_to_disk( ...@@ -850,21 +850,14 @@ pub async fn project_write_all_entrypoints_to_disk(
// Start timing writing the files to disk // Start timing writing the files to disk
let now = Instant::now(); let now = Instant::now();
compilation_event_sender.send_compilation_event(Arc::new(DiagnosticEvent::new(
"Starting to write all entrypoints to disk...".to_owned(),
Severity::Event,
)));
// Write the files to disk // Write the files to disk
effects.apply().await?; effects.apply().await?;
// Send a compilation event to indicate that the files have been written to disk // Send a compilation event to indicate that the files have been written to disk
compilation_event_sender.send_compilation_event(Arc::new(DiagnosticEvent::new( compilation_event_sender.send_compilation_event(Arc::new(TimingEvent::new(
format!( "Finished writing all entrypoints to disk".to_owned(),
"Finished writing all entrypoints to disk in {:?}", now.elapsed(),
now.elapsed()
),
Severity::Event,
))); )));
Ok((entrypoints.clone(), issues.clone(), diagnostics.clone())) Ok((entrypoints.clone(), issues.clone(), diagnostics.clone()))
......
...@@ -91,8 +91,27 @@ export async function turbopackBuild(): Promise<{ ...@@ -91,8 +91,27 @@ export async function turbopackBuild(): Promise<{
try { try {
;(async function logCompilationEvents() { ;(async function logCompilationEvents() {
for await (const event of project.compilationEventsSubscribe()) { for await (const event of project.compilationEventsSubscribe()) {
if (event.severity === 'EVENT') { switch (event.severity) {
Log.event(event.message) case 'EVENT':
Log.event(event.message)
break
case 'TRACE':
Log.trace(event.message)
break
case 'INFO':
Log.info(event.message)
break
case 'WARNING':
Log.warn(event.message)
break
case 'ERROR':
Log.error(event.message)
break
case 'FATAL':
Log.error(event.message)
break
default:
break
} }
} }
})() })()
......
use std::{any::Any, collections::VecDeque, fmt::Display, sync::Arc}; use std::{any::Any, collections::VecDeque, fmt::Display, sync::Arc, time::Duration};
use dashmap::DashMap; use dashmap::DashMap;
use tokio::sync::{Mutex, mpsc}; use tokio::sync::{Mutex, mpsc};
...@@ -155,6 +155,56 @@ impl Display for Severity { ...@@ -155,6 +155,56 @@ impl Display for Severity {
} }
} }
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
/// Compilation event that is used to log the duration of a task
pub struct TimingEvent {
/// Message of the event without the timing information
///
/// Example:
/// ```rust
/// let event = TimingEvent::new("Compiled successfully".to_string(), Duration::from_millis(100));
/// let message = event.message();
/// assert_eq!(message, "Compiled successfully in 100ms");
/// ```
pub message: String,
/// Duration in milliseconds
pub duration: Duration,
}
impl TimingEvent {
pub fn new(message: String, duration: Duration) -> Self {
Self { message, duration }
}
}
impl CompilationEvent for TimingEvent {
fn type_name(&self) -> &'static str {
"TimingEvent"
}
fn severity(&self) -> Severity {
Severity::Event
}
fn message(&self) -> String {
let duration_secs = self.duration.as_secs_f64();
let duration_string = if duration_secs > 120.0 {
format!("{:.1}min", duration_secs / 60.0)
} else if duration_secs > 40.0 {
format!("{duration_secs:.0}s")
} else if duration_secs > 2.0 {
format!("{duration_secs:.1}s")
} else {
format!("{:.0}ms", duration_secs * 1000.0)
};
format!("{} in {}", self.message, duration_string)
}
fn to_json(&self) -> String {
serde_json::to_string(self).unwrap()
}
}
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)] #[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct DiagnosticEvent { pub struct DiagnosticEvent {
pub message: String, pub message: String,
...@@ -162,7 +212,7 @@ pub struct DiagnosticEvent { ...@@ -162,7 +212,7 @@ pub struct DiagnosticEvent {
} }
impl DiagnosticEvent { impl DiagnosticEvent {
pub fn new(message: String, severity: Severity) -> Self { pub fn new(severity: Severity, message: String) -> Self {
Self { message, severity } Self { message, severity }
} }
} }
...@@ -184,3 +234,31 @@ impl CompilationEvent for DiagnosticEvent { ...@@ -184,3 +234,31 @@ impl CompilationEvent for DiagnosticEvent {
serde_json::to_string(self).unwrap() serde_json::to_string(self).unwrap()
} }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_timing_event_string_formatting() {
let tests = vec![
(Duration::from_nanos(1588), "0ms"),
(Duration::from_nanos(1022616), "1ms"),
(Duration::from_millis(100), "100ms"),
(Duration::from_millis(1000), "1000ms"),
(Duration::from_millis(10000), "10.0s"),
(Duration::from_millis(20381), "20.4s"),
(Duration::from_secs(60), "60s"),
(Duration::from_secs(100), "100s"),
(Duration::from_secs(125), "2.1min"),
];
for (duration, expected) in tests {
let event = TimingEvent::new("Compiled successfully".to_string(), duration);
assert_eq!(
event.message(),
format!("Compiled successfully in {expected}")
);
}
}
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment