rspack_binding_api 0.101.0-rc.0

use std::{fmt::Display, ops::Deref, ptr};

use napi::{
  Env, JsValue, Property, PropertyAttributes, Status, Unknown, ValueType,
  bindgen_prelude::{External, FromNapiValue, JsObjectValue, Object, ToNapiValue},
  sys::{self, napi_env, napi_value},
};
use napi_derive::napi;
use rspack_core::Compilation;
use rspack_error::{Diagnostic, Error, Result, Severity};
use rspack_napi::napi::check_status;

use crate::{define_symbols, location::DependencyLocation, module::ModuleObject};

pub enum ErrorCode {
  Napi(napi::Status),
  Custom(String),
}

impl From<napi::Status> for ErrorCode {
  fn from(value: napi::Status) -> Self {
    Self::Napi(value)
  }
}

impl AsRef<str> for ErrorCode {
  fn as_ref(&self) -> &str {
    match self {
      ErrorCode::Napi(status) => status.as_ref(),
      ErrorCode::Custom(code) => code.as_str(),
    }
  }
}

#[napi(object, object_to_js = false)]
pub struct JsRspackDiagnostic {
  pub severity: JsRspackSeverity,
  pub error: RspackError,
}

impl From<JsRspackDiagnostic> for Diagnostic {
  fn from(value: JsRspackDiagnostic) -> Self {
    value.error.into_diagnostic(value.severity.into())
  }
}

#[napi(string_enum)]
pub enum JsRspackSeverity {
  Error,
  Warn,
}

impl From<JsRspackSeverity> for Severity {
  fn from(value: JsRspackSeverity) -> Self {
    match value {
      JsRspackSeverity::Error => Severity::Error,
      JsRspackSeverity::Warn => Severity::Warning,
    }
  }
}

define_symbols! {
  RUST_ERROR_SYMBOL => "rspack.error.rust"
}

#[derive(Debug)]
pub struct RspackError {
  pub name: String,
  pub message: String,
  pub details: Option<String>,
  pub stack: Option<String>,
  pub module: Option<ModuleObject>,
  pub loc: Option<DependencyLocation>,
  pub hide_stack: Option<bool>,
  pub file: Option<String>,
  pub error: Option<Box<RspackError>>,
  // Only used for display on the Rust side; this value is set when converting to a Diagnostic struct.
  pub severity: Option<Severity>,
  // Only used for display on the Rust side; the name of the parent error in the error chain, used to determine rendering logic.
  pub parent_error_name: Option<String>,
  pub rust_diagnostic: Option<Diagnostic>,
}

impl napi::bindgen_prelude::TypeName for RspackError {
  fn type_name() -> &'static str {
    "RspackError"
  }
  fn value_type() -> napi::ValueType {
    napi::ValueType::Object
  }
}

impl ToNapiValue for RspackError {
  unsafe fn to_napi_value(
    env: napi::sys::napi_env,
    val: Self,
  ) -> napi::Result<napi::sys::napi_value> {
    unsafe {
      let env_wrapper = Env::from(env);
      let Self {
        name,
        message,
        details,
        stack,
        module,
        loc,
        hide_stack,
        file,
        error,
        rust_diagnostic,
        ..
      } = val;

      let js_string = env_wrapper.create_string(&message)?;
      let mut obj = ptr::null_mut();
      check_status!(sys::napi_create_error(
        env,
        ptr::null_mut(),
        js_string.raw(),
        &mut obj
      ))?;

      let mut obj = Object::from_raw(env, obj);
      obj.set("name", name)?;
      if let Some(details) = details {
        obj.set("details", details)?;
      }
      if let Some(stack) = stack {
        obj.set("stack", stack)?;
      } else {
        obj.set("stack", ())?;
      }
      if let Some(module) = module {
        obj.set("module", module)?;
      }
      if let Some(loc) = loc {
        obj.set("loc", loc)?;
      }
      if let Some(hide_stack) = hide_stack {
        obj.set("hideStack", hide_stack)?;
      }
      if let Some(file) = file {
        obj.set("file", file)?;
      }
      if let Some(error) = error {
        obj.set("error", *error)?;
      }
      if let Some(rust_diagnostic) = rust_diagnostic {
        RUST_ERROR_SYMBOL.with(|symbol| {
          let napi_val = ToNapiValue::to_napi_value(env, External::new(rust_diagnostic))?;
          let unknown = Unknown::from_napi_value(env, napi_val)?;
          obj.define_properties(&[Property::new()
            .with_name(&env_wrapper, symbol.get())?
            .with_value(&unknown)
            .with_property_attributes(PropertyAttributes::Configurable)])
        })?;
      }
      ToNapiValue::to_napi_value(env, obj)
    }
  }
}

impl FromNapiValue for RspackError {
  unsafe fn from_napi_value(env: napi_env, napi_val: napi_value) -> napi::Result<RspackError> {
    unsafe {
      let unknown = Unknown::from_napi_value(env, napi_val)?;
      if unknown.get_type()? != ValueType::Object {
        let message = unknown.coerce_to_string()?.into_utf8()?.into_owned()?;
        return Ok(Self {
          severity: None,
          name: "Error".to_string(),
          message,
          details: None,
          stack: None,
          module: None,
          loc: None,
          hide_stack: None,
          file: None,
          error: None,
          parent_error_name: None,
          rust_diagnostic: None,
        });
      }

      let obj = Object::from_unknown(unknown)?;
      let name: String = obj
        .get("name")
        .map_err(|mut err| {
          err.reason = format!("{} on {}.{}", err.reason, "RspackError", "name");
          err
        })?
        .ok_or_else(|| napi::Error::new(Status::InvalidArg, "Missing field name"))?;
      let message: String = obj
        .get("message")
        .map_err(|mut err| {
          err.reason = format!("{} on {}.{}", err.reason, "RspackError", "message");
          err
        })?
        .ok_or_else(|| napi::Error::new(Status::InvalidArg, "Missing field message"))?;

      let details: Option<String> = obj.get("details").ok().flatten();
      let stack: Option<String> = obj.get("stack").ok().flatten();
      let module: Option<ModuleObject> = obj.get("module").ok().flatten();
      let loc: Option<DependencyLocation> = obj.get("loc").ok().flatten();
      let mut hide_stack: Option<bool> = obj.get("hideStack").ok().flatten();
      if hide_stack.is_none() {
        let literal = obj.get::<String>("hideStack").ok().flatten();
        if literal == Some("true".to_string()) {
          hide_stack = Some(true);
        } else if literal == Some("false".to_string()) {
          hide_stack = Some(false);
        }
      }
      let file: Option<String> = obj.get("file").ok().flatten();
      let error: Option<RspackError> = obj.get("error").ok().flatten();
      let rust_diagnostic = RUST_ERROR_SYMBOL.with(|once_cell| {
        #[allow(clippy::unwrap_used)]
        let napi_val = ToNapiValue::to_napi_value(env, once_cell.get().unwrap())?;
        let symbol = Unknown::from_napi_value(env, napi_val)?;
        if let Ok(unknown) = obj.get_property::<Unknown, Unknown>(symbol) {
          if unknown.get_type()? != napi::ValueType::External {
            return Ok(None);
          }
          let external =
            <&External<Diagnostic> as FromNapiValue>::from_napi_value(env, unknown.raw())?;
          return Ok::<_, napi::Error>(Some(external.as_ref().clone()));
        }
        Ok(None)
      })?;

      let val = Self {
        severity: None,
        name,
        message,
        details,
        stack,
        module,
        loc,
        hide_stack,
        file,
        error: error.map(Box::new),
        parent_error_name: None,
        rust_diagnostic,
      };
      Ok(val)
    }
  }
}

impl napi::bindgen_prelude::ValidateNapiValue for RspackError {}

// The error printing logic here is consistent with Webpack Stats.
impl std::fmt::Display for RspackError {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    if self.parent_error_name.as_deref() == Some("ModuleBuildError") {
      // https://github.com/webpack/webpack/blob/93743d233ab4fa36738065ebf8df5f175323b906/lib/ModuleBuildError.js
      if let Some(stack) = &self.stack
        && !stack.is_empty()
      {
        if self.hide_stack != Some(true) {
          write!(f, "{stack}")
        } else {
          write!(f, "{}", self.message)
        }
      } else {
        write!(f, "{}", self.message)
      }
    } else {
      write!(f, "{}", &self.message)?;
      Ok(())
    }
  }
}

impl std::error::Error for RspackError {}

impl From<RspackError> for rspack_error::Error {
  fn from(value: RspackError) -> Error {
    let mut error = rspack_error::error!(format!("{}", value));
    error.code = Some(value.name);
    error.details = value.details;
    error.stack = value.stack;
    error.hide_stack = value.hide_stack;
    error
  }
}

impl From<&Error> for RspackError {
  fn from(value: &Error) -> Self {
    let mut name = "Error".to_string();
    if let Some(code) = &value.code {
      name = code.clone();
    }

    let mut message = value.to_string();
    // TODO: Delete it after all errors match the message specification
    let prefix = format!("{name}: ");
    if message.starts_with(&prefix) {
      message = message[prefix.len()..].to_string();
    }

    Self {
      severity: None,
      name,
      message,
      details: None,
      stack: None,
      module: None,
      loc: None,
      hide_stack: None,
      file: None,
      error: None,
      parent_error_name: None,
      rust_diagnostic: None,
    }
  }
}

impl RspackError {
  pub fn with_parent_error_name<T: Into<String>>(mut self, parent_error_name: T) -> Self {
    self.parent_error_name = Some(parent_error_name.into());
    self
  }

  pub fn try_from_diagnostic(
    compilation: &Compilation,
    diagnostic: &Diagnostic,
  ) -> napi::Result<Self> {
    let message = diagnostic
      .render_report(false)
      .map_err(|e| napi::Error::from_reason(e.to_string()))?;

    let mut module = None;
    if let Some(module_identifier) = &diagnostic.module_identifier
      && let Some(m) = compilation.module_by_identifier(module_identifier)
    {
      module = Some(ModuleObject::with_ref(
        m.as_ref(),
        compilation.compiler_id(),
      ));
    }

    let rust_diagnostic = Some(diagnostic.clone());
    let name = diagnostic
      .code
      .as_ref()
      .cloned()
      .unwrap_or("Error".to_string());
    let source_error: Option<Box<RspackError>> = diagnostic
      .source_error
      .as_ref()
      .map(|error| Box::new(error.clone().deref().into()));

    Ok(Self {
      severity: None,
      name,
      message,
      details: diagnostic.details.as_ref().cloned(),
      stack: diagnostic.stack.as_ref().cloned(),
      module,
      loc: diagnostic.loc.as_ref().map(Into::into),
      file: diagnostic.file.as_ref().map(|f| f.as_str().to_string()),
      hide_stack: diagnostic.hide_stack,
      error: source_error,
      parent_error_name: None,
      rust_diagnostic,
    })
  }

  pub fn into_diagnostic(mut self, severity: Severity) -> Diagnostic {
    if let Some(rust_diagnostic) = self.rust_diagnostic {
      return rust_diagnostic;
    }

    let mut error = rspack_error::error!(self.message);
    error.severity = severity;
    error.code = Some(self.name);
    error.stack = self.stack;
    error.hide_stack = self.hide_stack;
    let mut diagnostic = Diagnostic::from(error);
    diagnostic.details = self.details;
    diagnostic.file = self.file.map(Into::into);
    diagnostic.loc = self.loc.as_ref().map(Into::into);
    diagnostic.module_identifier = self.module.map(|module| *module.identifier());
    diagnostic
  }
}

pub trait RspackResultToNapiResultExt<T, E, S: AsRef<str> = napi::Status> {
  fn to_napi_result(self) -> napi::Result<T, S>;
  fn to_napi_result_with_message(self, f: impl FnOnce(E) -> String) -> napi::Result<T, S>;
}

impl<T, E: ToString> RspackResultToNapiResultExt<T, E> for Result<T, E> {
  fn to_napi_result(self) -> napi::Result<T> {
    self.map_err(|e| napi::Error::from_reason(e.to_string()))
  }
  fn to_napi_result_with_message(self, f: impl FnOnce(E) -> String) -> napi::Result<T> {
    self.map_err(|e| napi::Error::from_reason(f(e)))
  }
}

impl<T> RspackResultToNapiResultExt<T, Error, ErrorCode> for Result<T, Error> {
  fn to_napi_result(self) -> napi::Result<T, ErrorCode> {
    self.map_err(|e| {
      napi::Error::new(
        e.code.as_ref().map_or_else(
          || ErrorCode::Napi(napi::Status::GenericFailure),
          |code| ErrorCode::Custom(code.clone()),
        ),
        e.to_string(),
      )
    })
  }
  fn to_napi_result_with_message(
    self,
    f: impl FnOnce(Error) -> String,
  ) -> napi::Result<T, ErrorCode> {
    self.map_err(|e| {
      napi::Error::new(
        e.code.as_ref().map_or_else(
          || ErrorCode::Napi(napi::Status::GenericFailure),
          |code| ErrorCode::Custom(code.clone()),
        ),
        f(e),
      )
    })
  }
}