dioxus-cli 0.7.6

//! Report progress about the build to the user. We use channels to report progress back to the CLI.

use super::BuildMode;
use crate::{BuildArtifacts, BuildStage, Error, TraceSrc};
use cargo_metadata::diagnostic::Diagnostic;
use futures_channel::mpsc::{UnboundedReceiver, UnboundedSender};
use serde::{Deserialize, Serialize};
use std::{path::PathBuf, process::ExitStatus, time::SystemTime};

/// The context of the build process. While the BuildRequest is a "plan" for the build, the BuildContext
/// provides some dynamic configuration that is only known at runtime. For example, the Progress channel
/// and the BuildMode can change while serving.
///
/// The structure of this is roughly taken from cargo itself which uses a similar pattern.
#[derive(Debug, Clone)]
pub struct BuildContext {
    pub tx: ProgressTx,
    pub mode: BuildMode,
    pub build_id: BuildId,
}

pub type ProgressTx = UnboundedSender<BuilderUpdate>;
pub type ProgressRx = UnboundedReceiver<BuilderUpdate>;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
pub struct BuildId(pub(crate) usize);
impl BuildId {
    pub const PRIMARY: Self = Self(0);
    pub const SECONDARY: Self = Self(1);
}

#[allow(clippy::large_enum_variant)]
pub enum BuilderUpdate {
    Progress {
        stage: BuildStage,
    },

    ProfilePhase {
        profile: BuildPhaseProfile,
    },

    CompilerMessage {
        message: Diagnostic,
    },

    /// The build completed successfully and the artifacts are ready. The artifacts are dependent on
    /// the build mode (fat vs thin vs base).
    BuildReady {
        bundle: BuildArtifacts,
    },

    /// The build failed. This might be because of a compilation error, or an error internal to DX.
    BuildFailed {
        err: Error,
    },

    /// A running process has received a stdout.
    /// May or may not be a complete line - do not treat it as a line. It will include a line if it is a complete line.
    ///
    /// We will poll lines and any content in a 50ms interval
    StdoutReceived {
        msg: String,
    },

    /// A running process has received a stderr.
    /// May or may not be a complete line - do not treat it as a line. It will include a line if it is a complete line.
    ///
    /// We will poll lines and any content in a 50ms interval
    StderrReceived {
        msg: String,
    },

    /// The running app (DUT) has exited and is no longer running.
    ProcessExited {
        status: ExitStatus,
    },

    /// Waiting for the process failed. This might be because it's hung or being debugged.
    /// This is not the same as the process exiting, so it should just be logged but not treated as an error.
    ProcessWaitFailed {
        err: std::io::Error,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BuildPhaseProfile {
    pub label: &'static str,
    pub start: SystemTime,
}

impl BuildContext {
    pub(crate) fn new(tx: ProgressTx, mode: BuildMode, build_id: BuildId) -> Self {
        Self { tx, mode, build_id }
    }

    /// Returns true if this is a client build - basically, is this the primary build?
    /// We try not to duplicate work between client and server builds, like asset copying.
    pub(crate) fn is_primary_build(&self) -> bool {
        self.build_id == BuildId::PRIMARY
    }

    pub(crate) fn profile_phase(&self, label: &'static str) {
        _ = self.tx.unbounded_send(BuilderUpdate::ProfilePhase {
            profile: BuildPhaseProfile {
                label,
                start: SystemTime::now(),
            },
        });
    }

    pub(crate) fn status_wasm_bindgen_start(&self) {
        self.profile_phase("Wasm Bindgen");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::RunningBindgen,
        });
    }

    pub(crate) fn status_splitting_bundle(&self) {
        self.profile_phase("Wasm Split");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::SplittingBundle,
        });
    }

    pub(crate) fn status_start_bundle(&self) {
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::Bundling,
        });
    }

    pub(crate) fn status_running_gradle(&self) {
        self.profile_phase("Gradle");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::RunningGradle,
        })
    }

    pub(crate) fn status_compiling_native_plugins(&self, detail: impl Into<String>) {
        self.profile_phase("Compiling Native Plugins");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::CompilingNativePlugins {
                detail: detail.into(),
            },
        });
    }

    pub(crate) fn status_codesigning(&self) {
        self.profile_phase("Code Signing");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::CodeSigning,
        });
    }

    pub(crate) fn status_build_diagnostic(&self, message: Diagnostic) {
        _ = self
            .tx
            .unbounded_send(BuilderUpdate::CompilerMessage { message });
    }

    pub(crate) fn status_build_error(&self, line: String) {
        tracing::warn!(dx_src = ?TraceSrc::Cargo, "{line}");
    }

    pub(crate) fn status_build_message(&self, line: String) {
        tracing::trace!(dx_src = ?TraceSrc::Cargo, "{line}");
    }

    pub(crate) fn status_build_progress(
        &self,
        count: usize,
        total: usize,
        name: String,
        fresh: bool,
    ) {
        self.profile_phase("Compiling");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::Compiling {
                current: count,
                total,
                krate: name,
                fresh,
            },
        });
    }

    pub(crate) fn status_starting_build(&self, crate_count: usize) {
        self.profile_phase("Compiling");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::Starting {
                patch: matches!(self.mode, BuildMode::Thin { .. }),
                crate_count,
            },
        });
    }

    pub(crate) fn status_starting_fat_link(&self) {
        self.profile_phase("Fat Linking");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::Linking,
        });
    }

    pub(crate) fn status_copied_asset(&self, current: usize, total: usize, path: PathBuf) {
        self.profile_phase("Copying Assets");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::CopyingAssets {
                current,
                total,
                path,
            },
        });
    }

    pub(crate) fn status_optimizing_wasm(&self) {
        self.profile_phase("Optimizing Wasm");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::OptimizingWasm,
        });
    }

    pub(crate) fn status_writing_patch(&self) {
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::Hotpatching,
        });
    }

    pub(crate) fn status_installing_tooling(&self) {
        self.profile_phase("Installing Tooling");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::InstallingTooling,
        });
    }

    pub(crate) fn status_compressing_assets(&self) {
        self.profile_phase("Compressing Assets");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::CompressingAssets,
        });
    }

    pub(crate) fn status_extracting_assets(&self) {
        self.profile_phase("Extracting assets");
        _ = self.tx.unbounded_send(BuilderUpdate::Progress {
            stage: BuildStage::ExtractingAssets,
        });
    }
}