lux_lib/operations/

run.rs

use std::{ops::Deref, path::PathBuf};

use bon::Builder;
use itertools::Itertools;
use miette::Diagnostic;
use serde::Deserialize;
use thiserror::Error;
use tokio::process::Command;

use crate::{
    config::Config,
    lua_installation::{LuaBinary, LuaInstallationError},
    lua_rockspec::LuaVersionError,
    operations::run_lua::{self, RunLua},
    package::PackageName,
    path::{Paths, PathsError},
    project::project_toml::LocalProjectTomlValidationError,
    tree::InstallTree,
    workspace::{Workspace, WorkspaceError, WorkspaceTreeError},
};

use super::RunLuaError;

#[derive(Debug, Error, Diagnostic)]
#[error("'{0}' should not be used as a `command` as it is not cross-platform.
You should only change the default `command` if it is a different Lua interpreter that behaves identically on all platforms.
Consider removing the `command` field and letting Lux choose the default Lua interpreter instead.")]
pub struct RunCommandError(String);

#[derive(Debug, Clone)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
#[cfg_attr(feature = "schema", serde(transparent))]
pub struct RunCommand(String);

impl RunCommand {
    pub fn from(command: String) -> Result<Self, RunCommandError> {
        match command.as_str() {
            // Common Lua interpreters that could lead to cross-platform issues
            // Luajit is also included because it may or may not have lua52 syntax support compiled in.
            "lua" | "lua5.1" | "lua5.2" | "lua5.3" | "lua5.4" | "luajit" => {
                Err(RunCommandError(command))
            }
            _ => Ok(Self(command)),
        }
    }
}

impl<'de> Deserialize<'de> for RunCommand {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let command = String::deserialize(deserializer)?;

        RunCommand::from(command).map_err(serde::de::Error::custom)
    }
}

impl Deref for RunCommand {
    type Target = String;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

#[derive(Debug, Error, Diagnostic)]
#[error(transparent)]
#[non_exhaustive]
pub enum RunError {
    #[diagnostic(transparent)]
    Toml(#[from] LocalProjectTomlValidationError),
    #[diagnostic(transparent)]
    RunCommand(#[from] RunCommandError),
    #[diagnostic(transparent)]
    LuaVersion(#[from] LuaVersionError),
    #[diagnostic(transparent)]
    RunLua(#[from] RunLuaError),
    #[error("failed to detect or install a luau runtime")]
    #[diagnostic(forward(0))]
    LuaInstallation(#[from] LuaInstallationError),
    #[diagnostic(transparent)]
    WorkspaceError(#[from] WorkspaceError),
    #[diagnostic(transparent)]
    WorkspaceTree(#[from] WorkspaceTreeError),
    Io(#[from] std::io::Error),
    #[diagnostic(transparent)]
    Paths(#[from] PathsError),
    #[error("No `run` field found in `lux.toml`")]
    NoRunField,
}

#[derive(Builder)]
#[builder(start_fn = new, finish_fn(name = _build, vis = ""))]
pub struct Run<'a> {
    workspace: &'a Workspace,
    package: Option<PackageName>,
    dir: Option<PathBuf>,
    args: &'a [String],
    config: &'a Config,
    disable_loader: Option<bool>,
}

impl<State> RunBuilder<'_, State>
where
    State: run_builder::State + run_builder::IsComplete,
{
    pub async fn run(self) -> Result<(), RunError> {
        let run = self._build();
        let workspace = run.workspace;
        let config = run.config;
        let extra_args = run.args;
        let project = workspace.single_member_or_select(&run.package)?;
        let toml = project.toml().into_local()?;

        let run_spec = toml
            .run()
            .ok_or(RunError::NoRunField)?
            .current_platform()
            .clone();

        let mut args: Vec<String> = run_spec.args.map(|args| args.into()).unwrap_or_default();

        if !extra_args.is_empty() {
            args.extend(extra_args.iter().cloned());
        }
        let disable_loader = run.disable_loader.unwrap_or(false);
        match &run_spec.command {
            Some(command) => {
                run_with_command(workspace, command, run.dir, disable_loader, &args, config).await
            }
            None => run_with_local_lua(workspace, run.dir, disable_loader, &args, config).await,
        }
    }
}

async fn run_with_local_lua(
    workspace: &Workspace,
    root_dir: Option<PathBuf>,
    disable_loader: bool,
    args: &Vec<String>,
    config: &Config,
) -> Result<(), RunError> {
    let version = workspace.lua_version(config)?;

    let tree = workspace.tree(config)?;

    let lua_cmd = LuaBinary::from(run_lua::resolve_lua_runtime(&version, config).await?);

    RunLua::new()
        .root(&root_dir.unwrap_or(workspace.root().to_path_buf()))
        .tree(&tree)
        .config(config)
        .lua_cmd(lua_cmd)
        .disable_loader(disable_loader)
        .args(args)
        .run_lua()
        .await?;

    Ok(())
}

async fn run_with_command(
    workspace: &Workspace,
    command: &RunCommand,
    root_dir: Option<PathBuf>,
    disable_loader: bool,
    args: &[String],
    config: &Config,
) -> Result<(), RunError> {
    let tree = workspace.tree(config)?;
    let paths = Paths::new(&tree)?;

    let lua_init = if tree.version().is_luau() || disable_loader {
        None
    } else if tree.version().lux_lib_dir().is_none() {
        tracing::warn!("lux-lua library not found.\n    Cannot use the `lux.loader`.\n    To suppress this warning, set the `--no-loader` option.");
        None
    } else {
        Some(paths.init())
    };

    let mut cmd = Command::new(command.deref());
    if let Some(dir) = root_dir {
        cmd.current_dir(dir);
    } else {
        cmd.current_dir(workspace.root());
    }
    match cmd
        .args(args.iter().cloned().collect_vec())
        .env("PATH", paths.path_prepended().joined())
        .env("LUA_INIT", lua_init.unwrap_or_default())
        .env("LUA_PATH", paths.package_path().joined())
        .env("LUA_CPATH", paths.package_cpath().joined())
        .status()
        .await?
        .code()
    {
        Some(0) => Ok(()),
        code => Err(RunLuaError::LuaCommandNonZeroExitCode {
            lua_cmd: command.to_string(),
            exit_code: code,
        }
        .into()),
    }
}