rspack_core 0.100.0-rc.2

// This crate introduces a smart pointer called BindingCell.
//
// When the "napi" feature is disabled, BindingCell uses the sys_binding module as a simple alias for Box.
//
// When the "napi" feature is enabled, BindingCell uses the napi_binding module.
// 1. BindingCell establishes a 1:1 relationship between a Rust instance and a JS Object.
// 2. BindingCell creates a JS Object only when converting a Rust instance to a JS object.
// 3. The JS Object is hold a weak reference to the Rust instance. If the Rust instance is dropped,
//    any attempt to access the JS Object will throw an exception indicating that the Rust instance has been dropped.

#[cfg(feature = "napi")]
mod napi_binding {
  use std::{
    any::{Any, TypeId},
    hash::{Hash, Hasher},
    ops::{Deref, DerefMut},
    sync::{Arc, Weak},
  };

  use derive_more::Debug;
  use napi::{
    Env,
    bindgen_prelude::{Object, ToNapiValue},
  };
  use once_cell::sync::OnceCell;
  use rspack_napi::{ThreadsafeOneShotRef, object_assign};
  use rspack_sources::BoxSource;
  use rustc_hash::FxHashMap;

  use crate::{
    AssetInfo, CodeGenerationResult, CodeGenerationResults, CompilationAsset, SourceType,
    with_thread_local_allocator,
  };

  pub struct WeakBindingCell<T: ?Sized> {
    ptr: *mut T,
    heap: Weak<Heap>,
  }

  impl<T: ?Sized> WeakBindingCell<T> {
    pub fn upgrade(&self) -> Option<BindingCell<T>> {
      self.heap.upgrade().map(|heap| BindingCell {
        ptr: self.ptr,
        heap,
      })
    }
  }

  #[derive(Default, Debug, Clone)]
  pub struct Reflector {
    heap: Weak<Heap>,
  }

  impl Reflector {
    pub fn set_jsobject(&self, env: &Env, object: Object) -> napi::Result<()> {
      let heap = self.heap.upgrade().ok_or_else(|| {
        napi::Error::new(
          napi::Status::GenericFailure,
          "Failed to upgrade weak reference to heap",
        )
      })?;

      heap.jsobject.get_or_try_init(|| match &heap.variant {
        HeapVariant::AssetInfo(_asset_info) => ThreadsafeOneShotRef::new(env.raw(), object),
        _ => unreachable!(),
      })?;
      Ok(())
    }
  }

  impl ToNapiValue for Reflector {
    unsafe fn to_napi_value(
      raw_env: napi::sys::napi_env,
      val: Self,
    ) -> napi::Result<napi::sys::napi_value> {
      with_thread_local_allocator(|allocator| {
        let heap = val.heap.upgrade().ok_or_else(|| {
          napi::Error::new(
            napi::Status::GenericFailure,
            "Failed to upgrade weak reference to heap",
          )
        })?;

        let raw_ref = heap.jsobject.get_or_try_init(|| match &heap.variant {
          HeapVariant::AssetInfo(asset_info) => {
            let binding_cell = BindingCell {
              ptr: asset_info.as_ref() as *const AssetInfo as *mut AssetInfo,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_asset_info(raw_env, &binding_cell)?;
            let target = Object::from_raw(raw_env, napi_val);
            ThreadsafeOneShotRef::new(raw_env, target)
          }
          HeapVariant::CodeGenerationResult(code_generation_result) => {
            let binding_cell = BindingCell {
              ptr: code_generation_result.as_ref() as *const CodeGenerationResult
                as *mut CodeGenerationResult,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_code_generation_result(raw_env, &binding_cell)?;
            let target = Object::from_raw(raw_env, napi_val);
            ThreadsafeOneShotRef::new(raw_env, target)
          }
          HeapVariant::Sources(sources) => {
            let binding_cell = BindingCell {
              ptr: sources.as_ref() as *const FxHashMap<SourceType, BoxSource>
                as *mut FxHashMap<SourceType, BoxSource>,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_sources(raw_env, &binding_cell)?;
            let target = Object::from_raw(raw_env, napi_val);
            ThreadsafeOneShotRef::new(raw_env, target)
          }
          HeapVariant::CodeGenerationResults(code_generation_results) => {
            let binding_cell = BindingCell {
              ptr: code_generation_results.as_ref() as *const CodeGenerationResults
                as *mut CodeGenerationResults,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_code_generation_results(raw_env, &binding_cell)?;
            let target = Object::from_raw(raw_env, napi_val);
            ThreadsafeOneShotRef::new(raw_env, target)
          }
          HeapVariant::Assets(assets) => {
            let binding_cell = BindingCell {
              ptr: assets.as_ref() as *const FxHashMap<String, CompilationAsset>
                as *mut FxHashMap<String, CompilationAsset>,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_assets(raw_env, &binding_cell)?;
            let target = Object::from_raw(raw_env, napi_val);
            ThreadsafeOneShotRef::new(raw_env, target)
          }
        })?;

        let result = unsafe { ToNapiValue::to_napi_value(raw_env, raw_ref)? };

        match &heap.variant {
          HeapVariant::AssetInfo(asset_info) => {
            let binding_cell = BindingCell {
              ptr: asset_info.as_ref() as *const AssetInfo as *mut AssetInfo,
              heap: heap.clone(),
            };
            let napi_val = allocator.allocate_asset_info(raw_env, &binding_cell)?;
            let new_object = Object::from_raw(raw_env, napi_val);
            let mut original_object = Object::from_raw(raw_env, result);
            object_assign(&mut original_object, &new_object)?;
            Ok(result)
          }
          _ => Ok(result),
        }
      })
    }
  }

  pub trait Reflectable {
    fn reflector(&self) -> Reflector;
  }

  // The reason HeapVariant does not use the generic type T is that for types requiring the implementation of the Reflectable trait,
  // the implementation of Reflectable needs to use the concrete type T, which prevents the trait from inheriting the Reflectable trait.
  #[derive(Debug)]
  enum HeapVariant {
    AssetInfo(Box<AssetInfo>),
    CodeGenerationResults(Box<CodeGenerationResults>),
    CodeGenerationResult(Box<CodeGenerationResult>),
    Sources(Box<FxHashMap<SourceType, BoxSource>>),
    Assets(Box<FxHashMap<String, CompilationAsset>>),
  }

  #[derive(Debug)]
  struct Heap {
    variant: HeapVariant,
    #[debug(skip)]
    jsobject: OnceCell<ThreadsafeOneShotRef>,
  }

  unsafe impl Send for Heap {}
  unsafe impl Sync for Heap {}

  #[derive(Debug)]
  pub struct BindingCell<T: ?Sized> {
    ptr: *mut T,
    heap: Arc<Heap>,
  }

  impl<T: ?Sized> BindingCell<T> {
    pub fn reflector(&self) -> Reflector {
      Reflector {
        heap: Arc::downgrade(&self.heap),
      }
    }
  }

  impl<T: ?Sized> Reflectable for BindingCell<T> {
    fn reflector(&self) -> Reflector {
      Reflector {
        heap: Arc::downgrade(&self.heap),
      }
    }
  }

  unsafe impl<T: ?Sized + Send> Send for BindingCell<T> {}
  unsafe impl<T: ?Sized + Sync> Sync for BindingCell<T> {}

  impl BindingCell<AssetInfo> {
    pub fn new(asset_info: AssetInfo) -> Self {
      let boxed = Box::new(asset_info);
      let ptr = boxed.as_ref() as *const AssetInfo as *mut AssetInfo;
      let heap = Arc::new(Heap {
        variant: HeapVariant::AssetInfo(boxed),
        jsobject: Default::default(),
      });
      Self { ptr, heap }
    }
  }

  impl From<AssetInfo> for BindingCell<AssetInfo> {
    fn from(asset_info: AssetInfo) -> Self {
      Self::new(asset_info)
    }
  }

  impl BindingCell<CodeGenerationResults> {
    pub fn new(code_generation_results: CodeGenerationResults) -> Self {
      let boxed = Box::new(code_generation_results);
      let ptr = boxed.as_ref() as *const CodeGenerationResults as *mut CodeGenerationResults;
      let heap = Arc::new(Heap {
        variant: HeapVariant::CodeGenerationResults(boxed),
        jsobject: Default::default(),
      });
      Self { ptr, heap }
    }
  }

  impl From<CodeGenerationResults> for BindingCell<CodeGenerationResults> {
    fn from(code_generation_results: CodeGenerationResults) -> Self {
      Self::new(code_generation_results)
    }
  }

  impl BindingCell<CodeGenerationResult> {
    pub fn new(code_generation_result: CodeGenerationResult) -> Self {
      let boxed = Box::new(code_generation_result);
      let ptr = boxed.as_ref() as *const CodeGenerationResult as *mut CodeGenerationResult;
      let heap = Arc::new(Heap {
        variant: HeapVariant::CodeGenerationResult(boxed),
        jsobject: Default::default(),
      });
      Self { ptr, heap }
    }
  }

  impl From<CodeGenerationResult> for BindingCell<CodeGenerationResult> {
    fn from(code_generation_result: CodeGenerationResult) -> Self {
      Self::new(code_generation_result)
    }
  }

  impl BindingCell<FxHashMap<SourceType, BoxSource>> {
    pub fn new(sources: FxHashMap<SourceType, BoxSource>) -> Self {
      let boxed = Box::new(sources);
      let ptr = boxed.as_ref() as *const FxHashMap<SourceType, BoxSource>
        as *mut FxHashMap<SourceType, BoxSource>;
      let heap = Arc::new(Heap {
        variant: HeapVariant::Sources(boxed),
        jsobject: Default::default(),
      });
      Self { ptr, heap }
    }
  }

  impl From<FxHashMap<SourceType, BoxSource>> for BindingCell<FxHashMap<SourceType, BoxSource>> {
    fn from(sources: FxHashMap<SourceType, BoxSource>) -> Self {
      Self::new(sources)
    }
  }

  impl BindingCell<FxHashMap<String, CompilationAsset>> {
    pub fn new(assets: FxHashMap<String, CompilationAsset>) -> Self {
      let boxed = Box::new(assets);
      let ptr = boxed.as_ref() as *const FxHashMap<String, CompilationAsset>
        as *mut FxHashMap<String, CompilationAsset>;
      let heap = Arc::new(Heap {
        variant: HeapVariant::Assets(boxed),
        jsobject: Default::default(),
      });
      Self { ptr, heap }
    }
  }

  impl From<FxHashMap<String, CompilationAsset>>
    for BindingCell<FxHashMap<String, CompilationAsset>>
  {
    fn from(assets: FxHashMap<String, CompilationAsset>) -> Self {
      Self::new(assets)
    }
  }

  impl<T: ?Sized> BindingCell<T> {
    pub fn downgrade(&self) -> WeakBindingCell<T> {
      WeakBindingCell {
        ptr: self.ptr,
        heap: Arc::downgrade(&self.heap),
      }
    }
  }

  impl<T: ?Sized> AsRef<T> for BindingCell<T> {
    fn as_ref(&self) -> &T {
      unsafe { &*self.ptr }
    }
  }

  impl<T: ?Sized> AsMut<T> for BindingCell<T> {
    fn as_mut(&mut self) -> &mut T {
      unsafe { &mut *self.ptr }
    }
  }

  impl<T: ?Sized> Deref for BindingCell<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
      unsafe { &*self.ptr }
    }
  }

  impl<T: ?Sized> DerefMut for BindingCell<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
      unsafe { &mut *self.ptr }
    }
  }

  impl<T: Clone + Into<BindingCell<T>>> Clone for BindingCell<T> {
    fn clone(&self) -> Self {
      let val = self.as_ref().clone();
      val.into()
    }
  }

  impl<T: ?Sized + Hash> Hash for BindingCell<T> {
    fn hash<H: Hasher>(&self, state: &mut H) {
      self.as_ref().hash(state);
    }
  }

  impl<T: ?Sized + PartialEq> PartialEq for BindingCell<T> {
    fn eq(&self, other: &Self) -> bool {
      self.as_ref() == other.as_ref()
    }
  }

  impl<T: ?Sized + Eq> Eq for BindingCell<T> {}

  impl<T: Default + Into<BindingCell<T>>> Default for BindingCell<T> {
    fn default() -> Self {
      let value: T = Default::default();
      value.into()
    }
  }

  // Implement rkyv traits for BindingCell<T>

  impl<T: rkyv::ArchiveUnsized + ?Sized> rkyv::Archive for BindingCell<T> {
    type Archived = rkyv::boxed::ArchivedBox<T::Archived>;
    type Resolver = rkyv::boxed::BoxResolver;

    fn resolve(&self, resolver: Self::Resolver, out: rkyv::Place<Self::Archived>) {
      rkyv::boxed::ArchivedBox::resolve_from_ref(self.as_ref(), resolver, out);
    }
  }

  impl<T, S> rkyv::Serialize<S> for BindingCell<T>
  where
    T: rkyv::SerializeUnsized<S> + ?Sized,
    S: rkyv::rancor::Fallible + ?Sized,
  {
    fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error> {
      rkyv::boxed::ArchivedBox::serialize_from_ref(self.as_ref(), serializer)
    }
  }

  impl<T, D> rkyv::Deserialize<BindingCell<T>, D> for rkyv::boxed::ArchivedBox<T::Archived>
  where
    T: rkyv::ArchiveUnsized + rkyv::traits::LayoutRaw + ?Sized + 'static,
    T::Archived: rkyv::DeserializeUnsized<T, D>,
    D: rkyv::rancor::Fallible + ?Sized,
    D::Error: rkyv::rancor::Source,
  {
    fn deserialize(&self, deserializer: &mut D) -> Result<BindingCell<T>, D::Error> {
      let boxed: Box<T> = self.deserialize(deserializer)?;
      let type_id = boxed.type_id();

      macro_rules! deserialize_variant {
        ($type_id:expr, $boxed:expr, $variant:path, $target:ty) => {
          if $type_id == TypeId::of::<Box<$target>>() {
            let ptr = Box::into_raw($boxed);
            let boxed = unsafe { Box::from_raw(ptr as *mut $target) };
            return Ok(BindingCell {
              ptr,
              heap: Arc::new(Heap {
                variant: $variant(boxed),
                jsobject: OnceCell::default(),
              }),
            });
          }
        };
      }

      deserialize_variant!(type_id, boxed, HeapVariant::AssetInfo, AssetInfo);
      deserialize_variant!(
        type_id,
        boxed,
        HeapVariant::CodeGenerationResults,
        CodeGenerationResults
      );
      deserialize_variant!(
        type_id,
        boxed,
        HeapVariant::CodeGenerationResult,
        CodeGenerationResult
      );
      deserialize_variant!(type_id, boxed, HeapVariant::Sources, FxHashMap<SourceType, BoxSource>);
      deserialize_variant!(type_id, boxed, HeapVariant::Assets, FxHashMap<String, CompilationAsset>);

      unreachable!()
    }
  }
}

#[cfg(not(feature = "napi"))]
mod sys_binding {
  pub type BindingCell<T> = Box<T>;
}

#[cfg(feature = "napi")]
pub use napi_binding::*;
#[cfg(not(feature = "napi"))]
pub use sys_binding::*;