use std::{future::Future, ops::Deref, sync::Arc}; use anyhow::{Context, Result, anyhow}; use futures_util::TryFutureExt; use napi::{ JsFunction, JsObject, JsUnknown, NapiRaw, NapiValue, Status, bindgen_prelude::{External, ToNapiValue}, threadsafe_function::{ThreadSafeCallContext, ThreadsafeFunction, ThreadsafeFunctionCallMode}, }; use rustc_hash::FxHashMap; use serde::Serialize; use turbo_tasks::{ Effects, OperationVc, ReadRef, TaskId, TryJoinIterExt, Vc, VcValueType, get_effects, }; use turbo_tasks_fs::FileContent; use turbopack_core::{ diagnostics::{Diagnostic, DiagnosticContextExt, PlainDiagnostic}, issue::{ IssueDescriptionExt, IssueSeverity, PlainIssue, PlainIssueSource, PlainSource, StyledString, }, source_pos::SourcePos, }; use crate::next_api::turbopack_ctx::NextTurbopackContext; /// An [`OperationVc`] that can be passed back and forth to JS across the [`napi`][mod@napi] /// boundary via [`External`]. /// /// It is a helper type to hold both a [`OperationVc`] and the [`NextTurbopackContext`]. Without /// this, we'd need to pass both individually all over the place. /// /// This napi-specific abstraction does not implement [`turbo_tasks::NonLocalValue`] or /// [`turbo_tasks::OperationValue`] and should be dereferenced to an [`OperationVc`] before being /// passed to a [`turbo_tasks::function`]. // // TODO: If we add a tracing garbage collector to turbo-tasks, this should be tracked as a GC root. #[derive(Clone)] pub struct DetachedVc { turbopack_ctx: NextTurbopackContext, /// The Vc. Must be unresolved, otherwise you are referencing an inactive operation. vc: OperationVc, } impl DetachedVc { pub fn new(turbopack_ctx: NextTurbopackContext, vc: OperationVc) -> Self { Self { turbopack_ctx, vc } } pub fn turbopack_ctx(&self) -> &NextTurbopackContext { &self.turbopack_ctx } } impl Deref for DetachedVc { type Target = OperationVc; fn deref(&self) -> &Self::Target { &self.vc } } pub fn serde_enum_to_string(value: &T) -> Result { Ok(serde_json::to_value(value)? .as_str() .context("value must serialize to a string")? .to_string()) } /// An opaque handle to the root of a turbo-tasks computation created by /// [`turbo_tasks::TurboTasks::spawn_root_task`] that can be passed back and forth to JS across the /// [`napi`][mod@napi] boundary via [`External`]. /// /// JavaScript code receiving this value **must** call [`root_task_dispose`] in a `try...finally` /// block to avoid leaking root tasks. /// /// This is used by [`subscribe`] to create a computation that re-executes when dependencies change. // // TODO: If we add a tracing garbage collector to turbo-tasks, this should be tracked as a GC root. pub struct RootTask { turbopack_ctx: NextTurbopackContext, task_id: Option, } impl Drop for RootTask { fn drop(&mut self) { // TODO stop the root task } } #[napi] pub fn root_task_dispose( #[napi(ts_arg_type = "{ __napiType: \"RootTask\" }")] mut root_task: External, ) -> napi::Result<()> { if let Some(task) = root_task.task_id.take() { root_task .turbopack_ctx .turbo_tasks() .dispose_root_task(task); } Ok(()) } pub async fn get_issues(source: OperationVc) -> Result>>> { let issues = source.peek_issues_with_path().await?; Ok(Arc::new(issues.get_plain_issues().await?)) } /// Reads the [turbopack_core::diagnostics::Diagnostic] held /// by the given source and returns it as a /// [turbopack_core::diagnostics::PlainDiagnostic]. It does /// not consume any Diagnostics held by the source. pub async fn get_diagnostics( source: OperationVc, ) -> Result>>> { let captured_diags = source.peek_diagnostics().await?; let mut diags = captured_diags .diagnostics .iter() .map(|d| d.into_plain()) .try_join() .await?; diags.sort(); Ok(Arc::new(diags)) } #[napi(object)] pub struct NapiIssue { pub severity: String, pub stage: String, pub file_path: String, pub title: serde_json::Value, pub description: Option, pub detail: Option, pub source: Option, pub documentation_link: String, pub import_traces: serde_json::Value, } impl From<&PlainIssue> for NapiIssue { fn from(issue: &PlainIssue) -> Self { Self { description: issue .description .as_ref() .map(|styled| serde_json::to_value(StyledStringSerialize::from(styled)).unwrap()), stage: issue.stage.to_string(), file_path: issue.file_path.to_string(), detail: issue .detail .as_ref() .map(|styled| serde_json::to_value(StyledStringSerialize::from(styled)).unwrap()), documentation_link: issue.documentation_link.to_string(), severity: issue.severity.as_str().to_string(), source: issue.source.as_ref().map(|source| source.into()), title: serde_json::to_value(StyledStringSerialize::from(&issue.title)).unwrap(), import_traces: serde_json::to_value(&issue.import_traces).unwrap(), } } } #[derive(Serialize)] #[serde(tag = "type", rename_all = "camelCase")] pub enum StyledStringSerialize<'a> { Line { value: Vec>, }, Stack { value: Vec>, }, Text { value: &'a str, }, Code { value: &'a str, }, Strong { value: &'a str, }, } impl<'a> From<&'a StyledString> for StyledStringSerialize<'a> { fn from(value: &'a StyledString) -> Self { match value { StyledString::Line(parts) => StyledStringSerialize::Line { value: parts.iter().map(|p| p.into()).collect(), }, StyledString::Stack(parts) => StyledStringSerialize::Stack { value: parts.iter().map(|p| p.into()).collect(), }, StyledString::Text(string) => StyledStringSerialize::Text { value: string }, StyledString::Code(string) => StyledStringSerialize::Code { value: string }, StyledString::Strong(string) => StyledStringSerialize::Strong { value: string }, } } } #[napi(object)] pub struct NapiIssueSource { pub source: NapiSource, pub range: Option, } impl From<&PlainIssueSource> for NapiIssueSource { fn from( PlainIssueSource { asset: source, range, }: &PlainIssueSource, ) -> Self { Self { source: (&**source).into(), range: range.as_ref().map(|range| range.into()), } } } #[napi(object)] pub struct NapiIssueSourceRange { pub start: NapiSourcePos, pub end: NapiSourcePos, } impl From<&(SourcePos, SourcePos)> for NapiIssueSourceRange { fn from((start, end): &(SourcePos, SourcePos)) -> Self { Self { start: (*start).into(), end: (*end).into(), } } } #[napi(object)] pub struct NapiSource { pub ident: String, pub content: Option, } impl From<&PlainSource> for NapiSource { fn from(source: &PlainSource) -> Self { Self { ident: source.ident.to_string(), content: match &*source.content { FileContent::Content(content) => match content.content().to_str() { Ok(str) => Some(str.into_owned()), Err(_) => None, }, FileContent::NotFound => None, }, } } } #[napi(object)] pub struct NapiSourcePos { pub line: u32, pub column: u32, } impl From for NapiSourcePos { fn from(pos: SourcePos) -> Self { Self { line: pos.line, column: pos.column, } } } #[napi(object)] pub struct NapiDiagnostic { pub category: String, pub name: String, #[napi(ts_type = "Record")] pub payload: FxHashMap, } impl NapiDiagnostic { pub fn from(diagnostic: &PlainDiagnostic) -> Self { Self { category: diagnostic.category.to_string(), name: diagnostic.name.to_string(), payload: diagnostic .payload .iter() .map(|(k, v)| (k.to_string(), v.to_string())) .collect(), } } } pub struct TurbopackResult { pub result: T, pub issues: Vec, pub diagnostics: Vec, } impl ToNapiValue for TurbopackResult { unsafe fn to_napi_value( env: napi::sys::napi_env, val: Self, ) -> napi::Result { let mut obj = unsafe { napi::Env::from_raw(env).create_object()? }; let result = unsafe { let result = T::to_napi_value(env, val.result)?; JsUnknown::from_raw(env, result)? }; if matches!(result.get_type()?, napi::ValueType::Object) { // SAFETY: We know that result is an object, so we can cast it to a JsObject let result = unsafe { result.cast::() }; for key in JsObject::keys(&result)? { let value: JsUnknown = result.get_named_property(&key)?; obj.set_named_property(&key, value)?; } } obj.set_named_property("issues", val.issues)?; obj.set_named_property("diagnostics", val.diagnostics)?; Ok(unsafe { obj.raw() }) } } pub fn subscribe> + Send, V: ToNapiValue>( ctx: NextTurbopackContext, func: JsFunction, handler: impl 'static + Sync + Send + Clone + Fn() -> F, mapper: impl 'static + Sync + Send + FnMut(ThreadSafeCallContext) -> napi::Result>, ) -> napi::Result> { let func: ThreadsafeFunction = func.create_threadsafe_function(0, mapper)?; let task_id = ctx.turbo_tasks().spawn_root_task({ let ctx = ctx.clone(); move || { let ctx = ctx.clone(); let handler = handler.clone(); let func = func.clone(); async move { let result = handler() .or_else(|e| ctx.throw_turbopack_internal_result(&e)) .await; let status = func.call(result, ThreadsafeFunctionCallMode::NonBlocking); if !matches!(status, Status::Ok) { let error = anyhow!("Error calling JS function: {}", status); eprintln!("{error}"); return Err::, _>(error); } Ok(Default::default()) } } }); Ok(External::new(RootTask { turbopack_ctx: ctx, task_id: Some(task_id), })) } // Await the source and return fatal issues if there are any, otherwise // propagate any actual error results. pub async fn strongly_consistent_catch_collectables( source_op: OperationVc, ) -> Result<( Option>, Arc>>, Arc>>, Arc, )> { let result = source_op.read_strongly_consistent().await; let issues = get_issues(source_op).await?; let diagnostics = get_diagnostics(source_op).await?; let effects = Arc::new(get_effects(source_op).await?); let result = if result.is_err() && issues.iter().any(|i| i.severity <= IssueSeverity::Error) { None } else { Some(result?) }; Ok((result, issues, diagnostics, effects)) }