turbopack_ecmascript/async_chunk/
module.rs

1use anyhow::Result;
2use turbo_rcstr::rcstr;
3use turbo_tasks::{ResolvedVc, Vc};
4use turbopack_core::{
5    asset::{Asset, AssetContent},
6    chunk::{ChunkableModule, ChunkingContext, availability_info::AvailabilityInfo},
7    ident::AssetIdent,
8    module::{Module, ModuleSideEffects},
9    module_graph::ModuleGraph,
10    reference::{ModuleReferences, SingleModuleReference},
11};
12
13use crate::async_chunk::chunk_item::AsyncLoaderChunkItem;
14
15/// The AsyncLoaderModule is a module that loads another module async, by
16/// putting it into a separate chunk group.
17#[turbo_tasks::value]
18pub struct AsyncLoaderModule {
19    pub inner: ResolvedVc<Box<dyn ChunkableModule>>,
20    pub chunking_context: ResolvedVc<Box<dyn ChunkingContext>>,
21    pub availability_info: AvailabilityInfo,
22}
23
24#[turbo_tasks::value_impl]
25impl AsyncLoaderModule {
26    #[turbo_tasks::function]
27    pub fn new(
28        module: ResolvedVc<Box<dyn ChunkableModule>>,
29        chunking_context: ResolvedVc<Box<dyn ChunkingContext>>,
30        availability_info: AvailabilityInfo,
31    ) -> Vc<Self> {
32        Self::cell(AsyncLoaderModule {
33            inner: module,
34            chunking_context,
35            availability_info,
36        })
37    }
38
39    #[turbo_tasks::function]
40    pub fn asset_ident_for(module: Vc<Box<dyn ChunkableModule>>) -> Vc<AssetIdent> {
41        module.ident().with_modifier(rcstr!("async loader"))
42    }
43}
44
45#[turbo_tasks::value_impl]
46impl Module for AsyncLoaderModule {
47    #[turbo_tasks::function]
48    fn ident(&self) -> Vc<AssetIdent> {
49        Self::asset_ident_for(*self.inner)
50    }
51
52    #[turbo_tasks::function]
53    fn source(&self) -> Vc<turbopack_core::source::OptionSource> {
54        Vc::cell(None)
55    }
56
57    #[turbo_tasks::function]
58    async fn references(self: Vc<Self>) -> Result<Vc<ModuleReferences>> {
59        Ok(Vc::cell(vec![ResolvedVc::upcast(
60            SingleModuleReference::new(
61                *ResolvedVc::upcast(self.await?.inner),
62                rcstr!("async module"),
63            )
64            .to_resolved()
65            .await?,
66        )]))
67    }
68
69    #[turbo_tasks::function]
70    fn side_effects(self: Vc<Self>) -> Vc<ModuleSideEffects> {
71        ModuleSideEffects::SideEffectFree.cell()
72    }
73}
74
75#[turbo_tasks::value_impl]
76impl Asset for AsyncLoaderModule {
77    #[turbo_tasks::function]
78    fn content(&self) -> Vc<AssetContent> {
79        panic!("content() should not be called");
80    }
81}
82
83#[turbo_tasks::value_impl]
84impl ChunkableModule for AsyncLoaderModule {
85    #[turbo_tasks::function]
86    fn as_chunk_item(
87        self: ResolvedVc<Self>,
88        module_graph: ResolvedVc<ModuleGraph>,
89        chunking_context: ResolvedVc<Box<dyn ChunkingContext>>,
90    ) -> Vc<Box<dyn turbopack_core::chunk::ChunkItem>> {
91        Vc::upcast(
92            AsyncLoaderChunkItem {
93                chunking_context,
94                module_graph,
95                module: self,
96            }
97            .cell(),
98        )
99    }
100}