use std::sync::Arc; use anyhow::{Result, anyhow}; use turbo_rcstr::RcStr; use turbo_tasks::{ IntoTraitRef, NonLocalValue, OperationValue, ReadRef, ResolvedVc, State, TraitRef, Vc, debug::ValueDebugFormat, trace::TraceRawVcs, }; use turbo_tasks_fs::{FileContent, LinkType}; use turbo_tasks_hash::{encode_hex, hash_xxh3_hash64}; use crate::asset::AssetContent; #[turbo_tasks::value(transparent)] pub struct OptionVersionedContent(Option>>); /// The content of an [Asset] alongside its version. #[turbo_tasks::value_trait] pub trait VersionedContent { /// The content of the [Asset]. #[turbo_tasks::function] fn content(self: Vc) -> Vc; /// Get a [`Version`] implementor that contains enough information to /// identify and diff a future [`VersionedContent`] against it. #[turbo_tasks::function] fn version(self: Vc) -> Vc>; /// Describes how to update the content from an earlier version to the /// latest available one. #[turbo_tasks::function] async fn update(self: Vc, from: Vc>) -> Result> { // By default, since we can't make any assumptions about the versioning // scheme of the content, we ask for a full invalidation, except in the // case where versions are the same. let to = self.version(); let from_ref = from.into_trait_ref().await?; let to_ref = to.into_trait_ref().await?; // Fast path: versions are the same. if TraitRef::ptr_eq(&from_ref, &to_ref) { return Ok(Update::None.into()); } // The fast path might not always work since `self` might have been converted // from a `ReadRef` or a `ReadRef`, in which case `self.version()` would // return a new `Vc>`. In this case, we need to compare // version ids. let from_id = from.id(); let to_id = to.id(); let from_id = from_id.await?; let to_id = to_id.await?; Ok(if *from_id == *to_id { Update::None.into() } else { Update::Total(TotalUpdate { to: to_ref }).into() }) } } /// A versioned file content. #[turbo_tasks::value] pub struct VersionedAssetContent { // We can't store a `Vc` directly because we don't want // `Vc` to invalidate when the content changes. // Otherwise, reading `content` and `version` at two different instants in // time might return inconsistent values. asset_content: ReadRef, } #[turbo_tasks::value] #[derive(Clone)] enum AssetContentSnapshot { File(ReadRef), Redirect { target: String, link_type: LinkType }, } #[turbo_tasks::value_impl] impl VersionedContent for VersionedAssetContent { #[turbo_tasks::function] fn content(&self) -> Vc { (*self.asset_content).clone().cell() } #[turbo_tasks::function] async fn version(&self) -> Result>> { Ok(Vc::upcast( FileHashVersion::compute(&self.asset_content).await?, )) } } #[turbo_tasks::value_impl] impl VersionedAssetContent { #[turbo_tasks::function] /// Creates a new [Vc] from a [Vc]. pub async fn new(asset_content: Vc) -> Result> { let asset_content = asset_content.await?; Ok(Self::cell(VersionedAssetContent { asset_content })) } } impl From for Vc { fn from(asset_content: AssetContent) -> Self { VersionedAssetContent::new(asset_content.cell()) } } impl From for Vc> { fn from(asset_content: AssetContent) -> Self { Vc::upcast(VersionedAssetContent::new(asset_content.cell())) } } pub trait VersionedContentExt: Send { fn versioned(self: Vc) -> Vc>; } impl VersionedContentExt for AssetContent { fn versioned(self: Vc) -> Vc> { Vc::upcast(VersionedAssetContent::new(self)) } } /// Describes the current version of an object, and how to update them from an earlier version. /// /// **Important:** Implementations must not contain instances of [`Vc`]! This should describe a /// specific version, and the value of a [`Vc`] can change due to invalidations or cache eviction. #[turbo_tasks::value_trait] pub trait Version { /// Get a unique identifier of the version as a string. There is no way /// to convert an id back to its original `Version`, so the original object /// needs to be stored somewhere. #[turbo_tasks::function] fn id(self: Vc) -> Vc; } /// This trait allows multiple `VersionedContent` to declare which /// [`VersionedContentMerger`] implementation should be used for merging. /// /// [`MergeableVersionedContent`] which return the same merger will be merged /// together. #[turbo_tasks::value_trait] pub trait MergeableVersionedContent: VersionedContent { #[turbo_tasks::function] fn get_merger(self: Vc) -> Vc>; } /// A [`VersionedContentMerger`] merges multiple [`VersionedContent`] into a /// single one. #[turbo_tasks::value_trait] pub trait VersionedContentMerger { #[turbo_tasks::function] fn merge(self: Vc, contents: Vc) -> Vc>; } #[turbo_tasks::value(transparent)] pub struct VersionedContents(Vec>>); #[turbo_tasks::value(operation)] pub struct NotFoundVersion; #[turbo_tasks::value_impl] impl NotFoundVersion { #[turbo_tasks::function] pub fn new() -> Vc { NotFoundVersion.cell() } } #[turbo_tasks::value_impl] impl Version for NotFoundVersion { #[turbo_tasks::function] fn id(&self) -> Vc { Vc::cell(Default::default()) } } /// Describes an update to a versioned object. #[turbo_tasks::value(serialization = "none", shared)] #[derive(Debug)] pub enum Update { /// The asset can't be meaningfully updated while the app is running, so the /// whole thing needs to be replaced. Total(TotalUpdate), /// The asset can (potentially) be updated to a new version by applying a /// specific set of instructions. Partial(PartialUpdate), // The asset is now missing, so it can't be updated. A full reload is required. Missing, /// No update required. None, } /// A total update to a versioned object. #[derive(PartialEq, Eq, Debug, Clone, TraceRawVcs, ValueDebugFormat, NonLocalValue)] pub struct TotalUpdate { /// The version this update will bring the object to. // // TODO: This trace_ignore is wrong, and could cause problems if/when we add a GC. While // `Version` assumes the implementation does not contain `Vc`, `EcmascriptDevChunkListVersion` // is broken and violates this assumption. #[turbo_tasks(trace_ignore)] pub to: TraitRef>, } /// A partial update to a versioned object. #[derive(PartialEq, Eq, Debug, Clone, TraceRawVcs, ValueDebugFormat, NonLocalValue)] pub struct PartialUpdate { /// The version this update will bring the object to. // TODO: This trace_ignore is *very* wrong, and could cause problems if/when we add a GC #[turbo_tasks(trace_ignore)] pub to: TraitRef>, /// The instructions to be passed to a remote system in order to update the /// versioned object. #[turbo_tasks(trace_ignore)] pub instruction: Arc, } /// [`Version`] implementation that hashes a file at a given path and returns /// the hex encoded hash as a version identifier. #[turbo_tasks::value(operation)] #[derive(Clone)] pub struct FileHashVersion { hash: RcStr, } impl FileHashVersion { /// Computes a new [`Vc`] from a path. pub async fn compute(asset_content: &AssetContent) -> Result> { match asset_content { AssetContent::File(file_vc) => match &*file_vc.await? { FileContent::Content(file) => { let hash = hash_xxh3_hash64(file.content()); let hex_hash = encode_hex(hash); Ok(Self::cell(FileHashVersion { hash: hex_hash.into(), })) } FileContent::NotFound => Err(anyhow!("file not found")), }, AssetContent::Redirect { .. } => Err(anyhow!("not a file")), } } } #[turbo_tasks::value_impl] impl Version for FileHashVersion { #[turbo_tasks::function] fn id(&self) -> Vc { Vc::cell(self.hash.clone()) } } /// This is a dummy wrapper type to (incorrectly) implement [`OperationValue`] (required by /// [`State`]), because the [`Version`] trait is not (yet?) a subtype of [`OperationValue`]. #[derive(Debug, Eq, PartialEq, TraceRawVcs, NonLocalValue, OperationValue)] struct VersionRef( // TODO: This trace_ignore is *very* wrong, and could cause problems if/when we add a GC. // It also allows to `Version`s that don't implement `OperationValue`, which could lead to // incorrect results when attempting to strongly resolve Vcs. #[turbo_tasks(trace_ignore)] TraitRef>, ); #[turbo_tasks::value(serialization = "none")] pub struct VersionState { version: State, } #[turbo_tasks::value_impl] impl VersionState { #[turbo_tasks::function] pub fn get(&self) -> Vc> { TraitRef::cell(self.version.get().0.clone()) } } impl VersionState { pub async fn new(version: TraitRef>) -> Result> { Ok(Self::cell(VersionState { version: State::new(VersionRef(version)), })) } pub async fn set(self: Vc, new_version: TraitRef>) -> Result<()> { let this = self.await?; this.version.set(VersionRef(new_version)); Ok(()) } }