use std::time::Duration; use anyhow::{Context, Result, bail}; use indexmap::map::Entry; use next_core::{ all_assets_from_entries, app_structure::find_app_dir, emit_assets, get_edge_chunking_context, get_edge_chunking_context_with_client_assets, get_edge_compile_time_info, get_edge_resolve_options_context, instrumentation::instrumentation_files, middleware::middleware_files, mode::NextMode, next_client::{ ClientChunkingContextOptions, get_client_chunking_context, get_client_compile_time_info, }, next_config::{JsConfig, ModuleIds as ModuleIdStrategyConfig, NextConfig}, next_edge::context::EdgeChunkingContextOptions, next_server::{ ServerChunkingContextOptions, ServerContextType, get_server_chunking_context, get_server_chunking_context_with_client_assets, get_server_compile_time_info, get_server_module_options_context, get_server_resolve_options_context, }, next_telemetry::NextFeatureTelemetry, util::{NextRuntime, OptionEnvMap, parse_config_from_source}, }; use serde::{Deserialize, Serialize}; use tracing::Instrument; use turbo_rcstr::{RcStr, rcstr}; use turbo_tasks::{ Completion, Completions, FxIndexMap, IntoTraitRef, NonLocalValue, OperationValue, OperationVc, ReadRef, ResolvedVc, State, TaskInput, TransientInstance, TryFlatJoinIterExt, Vc, debug::ValueDebugFormat, fxindexmap, graph::{AdjacencyMap, GraphTraversal}, mark_root, trace::TraceRawVcs, }; use turbo_tasks_env::{EnvMap, ProcessEnv}; use turbo_tasks_fs::{ DiskFileSystem, FileSystem, FileSystemPath, VirtualFileSystem, invalidation, util::{join_path, unix_to_sys}, }; use turbopack::{ ModuleAssetContext, evaluate_context::node_build_environment, global_module_ids::get_global_module_id_strategy, transition::TransitionOptions, }; use turbopack_core::{ PROJECT_FILESYSTEM_NAME, changed::content_changed, chunk::{ ChunkingContext, EvaluatableAssets, SourceMapsType, module_id_strategies::{DevModuleIdStrategy, ModuleIdStrategy}, }, compile_time_info::CompileTimeInfo, context::AssetContext, diagnostics::DiagnosticExt, environment::NodeJsVersion, file_source::FileSource, ident::Layer, issue::{ Issue, IssueDescriptionExt, IssueExt, IssueSeverity, IssueStage, OptionStyledString, StyledString, }, module::Module, module_graph::{ GraphEntries, ModuleGraph, SingleModuleGraph, VisitedModules, chunk_group_info::ChunkGroupEntry, export_usage::{OptionExportUsageInfo, compute_export_usage_info}, }, output::{OutputAsset, OutputAssets}, reference_type::{EntryReferenceSubType, ReferenceType}, resolve::{FindContextFileResult, find_context_file}, source_map::OptionStringifiedSourceMap, version::{ NotFoundVersion, OptionVersionedContent, Update, Version, VersionState, VersionedContent, }, }; use turbopack_node::execution_context::ExecutionContext; use turbopack_nodejs::NodeJsChunkingContext; use crate::{ app::{AppProject, OptionAppProject}, empty::EmptyEndpoint, entrypoints::Entrypoints, instrumentation::InstrumentationEndpoint, middleware::MiddlewareEndpoint, pages::PagesProject, route::{AppPageRoute, Endpoint, Endpoints, Route}, versioned_content_map::VersionedContentMap, }; #[derive( Debug, Serialize, Deserialize, Clone, TaskInput, PartialEq, Eq, Hash, TraceRawVcs, NonLocalValue, OperationValue, )] #[serde(rename_all = "camelCase")] pub struct DraftModeOptions { pub preview_mode_id: RcStr, pub preview_mode_encryption_key: RcStr, pub preview_mode_signing_key: RcStr, } #[derive( Debug, Default, Serialize, Deserialize, Copy, Clone, TaskInput, PartialEq, Eq, Hash, TraceRawVcs, NonLocalValue, OperationValue, )] #[serde(rename_all = "camelCase")] pub struct WatchOptions { /// Whether to watch the filesystem for file changes. pub enable: bool, /// Enable polling at a certain interval if the native file watching doesn't work (e.g. /// docker). pub poll_interval: Option, } #[derive( Debug, Serialize, Deserialize, Clone, TaskInput, PartialEq, Eq, Hash, TraceRawVcs, NonLocalValue, OperationValue, )] #[serde(rename_all = "camelCase")] pub struct ProjectOptions { /// An absolute root path (Unix or Windows path) from which all files must be nested under. /// Trying to access a file outside this root will fail, so think of this as a chroot. /// E.g. `/home/user/projects/my-repo`. pub root_path: RcStr, /// A path which contains the app/pages directories, relative to [`Project::root_path`], always /// Unix path. E.g. `apps/my-app` pub project_path: RcStr, /// The contents of next.config.js, serialized to JSON. pub next_config: RcStr, /// The contents of ts/config read by load-jsconfig, serialized to JSON. pub js_config: RcStr, /// A map of environment variables to use when compiling code. pub env: Vec<(RcStr, RcStr)>, /// A map of environment variables which should get injected at compile /// time. pub define_env: DefineEnv, /// Filesystem watcher options. pub watch: WatchOptions, /// The mode in which Next.js is running. pub dev: bool, /// The server actions encryption key. pub encryption_key: RcStr, /// The build id. pub build_id: RcStr, /// Options for draft mode. pub preview_props: DraftModeOptions, /// The browserslist query to use for targeting browsers. pub browserslist_query: RcStr, /// When the code is minified, this opts out of the default mangling of /// local names for variables, functions etc., which can be useful for /// debugging/profiling purposes. pub no_mangling: bool, /// The version of Node.js that is available/currently running. pub current_node_js_version: RcStr, } #[derive( Debug, Serialize, Deserialize, Clone, TaskInput, PartialEq, Eq, Hash, TraceRawVcs, NonLocalValue, )] #[serde(rename_all = "camelCase")] pub struct PartialProjectOptions { /// A root path from which all files must be nested under. Trying to access /// a file outside this root will fail. Think of this as a chroot. pub root_path: Option, /// A path inside the root_path which contains the app/pages directories. pub project_path: Option, /// The contents of next.config.js, serialized to JSON. pub next_config: Option, /// The contents of ts/config read by load-jsconfig, serialized to JSON. pub js_config: Option, /// A map of environment variables to use when compiling code. pub env: Option>, /// A map of environment variables which should get injected at compile /// time. pub define_env: Option, /// Filesystem watcher options. pub watch: Option, /// The mode in which Next.js is running. pub dev: Option, /// The server actions encryption key. pub encryption_key: Option, /// The build id. pub build_id: Option, /// Options for draft mode. pub preview_props: Option, } #[derive( Debug, Serialize, Deserialize, Clone, TaskInput, PartialEq, Eq, Hash, TraceRawVcs, NonLocalValue, OperationValue, )] #[serde(rename_all = "camelCase")] pub struct DefineEnv { pub client: Vec<(RcStr, Option)>, pub edge: Vec<(RcStr, Option)>, pub nodejs: Vec<(RcStr, Option)>, } #[derive(Serialize, Deserialize, TraceRawVcs, PartialEq, Eq, ValueDebugFormat, NonLocalValue)] pub struct Middleware { pub endpoint: ResolvedVc>, } #[derive(Serialize, Deserialize, TraceRawVcs, PartialEq, Eq, ValueDebugFormat, NonLocalValue)] pub struct Instrumentation { pub node_js: ResolvedVc>, pub edge: ResolvedVc>, } #[turbo_tasks::value] pub struct ProjectContainer { name: RcStr, options_state: State>, versioned_content_map: Option>, } #[turbo_tasks::value_impl] impl ProjectContainer { #[turbo_tasks::function] pub fn new(name: RcStr, dev: bool) -> Result> { Ok(ProjectContainer { name, // we only need to enable versioning in dev mode, since build // is assumed to be operating over a static snapshot versioned_content_map: if dev { Some(VersionedContentMap::new()) } else { None }, options_state: State::new(None), } .cell()) } } #[turbo_tasks::function(operation)] fn project_fs_operation(project: ResolvedVc) -> Vc { project.project_fs() } #[turbo_tasks::function(operation)] fn output_fs_operation(project: ResolvedVc) -> Vc { project.project_fs() } impl ProjectContainer { #[tracing::instrument(level = "info", name = "initialize project", skip_all)] pub async fn initialize(self: ResolvedVc, options: ProjectOptions) -> Result<()> { let watch = options.watch; self.await?.options_state.set(Some(options)); let project = self.project().to_resolved().await?; let project_fs = project_fs_operation(project) .read_strongly_consistent() .await?; if watch.enable { project_fs .start_watching_with_invalidation_reason(watch.poll_interval) .await?; } else { project_fs.invalidate_with_reason(|path| invalidation::Initialize { path: RcStr::from(path), }); } let output_fs = output_fs_operation(project) .read_strongly_consistent() .await?; output_fs.invalidate_with_reason(|path| invalidation::Initialize { path: RcStr::from(path), }); Ok(()) } #[tracing::instrument(level = "info", name = "update project", skip_all)] pub async fn update(self: Vc, options: PartialProjectOptions) -> Result<()> { let PartialProjectOptions { root_path, project_path, next_config, js_config, env, define_env, watch, dev, encryption_key, build_id, preview_props, } = options; let this = self.await?; let mut new_options = this .options_state .get() .clone() .context("ProjectContainer need to be initialized with initialize()")?; if let Some(root_path) = root_path { new_options.root_path = root_path; } if let Some(project_path) = project_path { new_options.project_path = project_path; } if let Some(next_config) = next_config { new_options.next_config = next_config; } if let Some(js_config) = js_config { new_options.js_config = js_config; } if let Some(env) = env { new_options.env = env; } if let Some(define_env) = define_env { new_options.define_env = define_env; } if let Some(watch) = watch { new_options.watch = watch; } if let Some(dev) = dev { new_options.dev = dev; } if let Some(encryption_key) = encryption_key { new_options.encryption_key = encryption_key; } if let Some(build_id) = build_id { new_options.build_id = build_id; } if let Some(preview_props) = preview_props { new_options.preview_props = preview_props; } // TODO: Handle mode switch, should prevent mode being switched. let watch = new_options.watch; let project = self.project().to_resolved().await?; let prev_project_fs = project_fs_operation(project) .read_strongly_consistent() .await?; let prev_output_fs = output_fs_operation(project) .read_strongly_consistent() .await?; this.options_state.set(Some(new_options)); let project = self.project().to_resolved().await?; let project_fs = project_fs_operation(project) .read_strongly_consistent() .await?; let output_fs = output_fs_operation(project) .read_strongly_consistent() .await?; if !ReadRef::ptr_eq(&prev_project_fs, &project_fs) { if watch.enable { // TODO stop watching: prev_project_fs.stop_watching()?; project_fs .start_watching_with_invalidation_reason(watch.poll_interval) .await?; } else { project_fs.invalidate_with_reason(|path| invalidation::Initialize { path: RcStr::from(path), }); } } if !ReadRef::ptr_eq(&prev_output_fs, &output_fs) { prev_output_fs.invalidate_with_reason(|path| invalidation::Initialize { path: RcStr::from(path), }); } Ok(()) } } #[turbo_tasks::value_impl] impl ProjectContainer { #[turbo_tasks::function] pub async fn project(&self) -> Result> { let env_map: Vc; let next_config; let define_env; let js_config; let root_path; let project_path; let watch; let dev; let encryption_key; let build_id; let preview_props; let browserslist_query; let no_mangling; let current_node_js_version; { let options = self.options_state.get(); let options = options .as_ref() .context("ProjectContainer need to be initialized with initialize()")?; env_map = Vc::cell(options.env.iter().cloned().collect()); define_env = ProjectDefineEnv { client: ResolvedVc::cell(options.define_env.client.iter().cloned().collect()), edge: ResolvedVc::cell(options.define_env.edge.iter().cloned().collect()), nodejs: ResolvedVc::cell(options.define_env.nodejs.iter().cloned().collect()), } .cell(); next_config = NextConfig::from_string(Vc::cell(options.next_config.clone())); js_config = JsConfig::from_string(Vc::cell(options.js_config.clone())); root_path = options.root_path.clone(); project_path = options.project_path.clone(); watch = options.watch; dev = options.dev; encryption_key = options.encryption_key.clone(); build_id = options.build_id.clone(); preview_props = options.preview_props.clone(); browserslist_query = options.browserslist_query.clone(); no_mangling = options.no_mangling; current_node_js_version = options.current_node_js_version.clone(); } let dist_dir = next_config .await? .dist_dir .as_ref() .map_or_else(|| rcstr!(".next"), |d| d.clone()); Ok(Project { root_path, project_path, watch, next_config: next_config.to_resolved().await?, js_config: js_config.to_resolved().await?, dist_dir, env: ResolvedVc::upcast(env_map.to_resolved().await?), define_env: define_env.to_resolved().await?, browserslist_query, mode: if dev { NextMode::Development.resolved_cell() } else { NextMode::Build.resolved_cell() }, versioned_content_map: self.versioned_content_map, build_id, encryption_key, preview_props, no_mangling, current_node_js_version, } .cell()) } /// See [Project::entrypoints]. #[turbo_tasks::function] pub fn entrypoints(self: Vc) -> Vc { self.project().entrypoints() } /// See [Project::hmr_identifiers]. #[turbo_tasks::function] pub fn hmr_identifiers(self: Vc) -> Vc> { self.project().hmr_identifiers() } /// Gets a source map for a particular `file_path`. If `dev` mode is disabled, this will always /// return [`OptionStringifiedSourceMap::none`]. #[turbo_tasks::function] pub fn get_source_map( &self, file_path: FileSystemPath, section: Option, ) -> Vc { if let Some(map) = self.versioned_content_map { map.get_source_map(file_path, section) } else { OptionStringifiedSourceMap::none() } } } #[turbo_tasks::value] pub struct Project { /// An absolute root path (Windows or Unix path) from which all files must be nested under. /// Trying to access a file outside this root will fail, so think of this as a chroot. /// E.g. `/home/user/projects/my-repo`. root_path: RcStr, /// A path which contains the app/pages directories, relative to [`Project::root_path`], always /// a Unix path. /// E.g. `apps/my-app` project_path: RcStr, /// A path where to emit the build outputs, relative to [`Project::project_path`], always a /// Unix path. Corresponds to next.config.js's `distDir`. /// E.g. `.next` dist_dir: RcStr, /// Filesystem watcher options. watch: WatchOptions, /// Next config. next_config: ResolvedVc, /// Js/Tsconfig read by load-jsconfig js_config: ResolvedVc, /// A map of environment variables to use when compiling code. env: ResolvedVc>, /// A map of environment variables which should get injected at compile /// time. define_env: ResolvedVc, /// The browserslist query to use for targeting browsers. browserslist_query: RcStr, mode: ResolvedVc, versioned_content_map: Option>, build_id: RcStr, encryption_key: RcStr, preview_props: DraftModeOptions, /// When the code is minified, this opts out of the default mangling of /// local names for variables, functions etc., which can be useful for /// debugging/profiling purposes. no_mangling: bool, current_node_js_version: RcStr, } #[turbo_tasks::value] pub struct ProjectDefineEnv { client: ResolvedVc, edge: ResolvedVc, nodejs: ResolvedVc, } #[turbo_tasks::value_impl] impl ProjectDefineEnv { #[turbo_tasks::function] pub fn client(&self) -> Vc { *self.client } #[turbo_tasks::function] pub fn edge(&self) -> Vc { *self.edge } #[turbo_tasks::function] pub fn nodejs(&self) -> Vc { *self.nodejs } } #[turbo_tasks::value(shared)] struct ConflictIssue { path: FileSystemPath, title: ResolvedVc, description: ResolvedVc, severity: IssueSeverity, } #[turbo_tasks::value_impl] impl Issue for ConflictIssue { #[turbo_tasks::function] fn stage(&self) -> Vc { IssueStage::AppStructure.cell() } fn severity(&self) -> IssueSeverity { self.severity } #[turbo_tasks::function] fn file_path(&self) -> Vc { self.path.clone().cell() } #[turbo_tasks::function] fn title(&self) -> Vc { *self.title } #[turbo_tasks::function] fn description(&self) -> Vc { Vc::cell(Some(self.description)) } } #[turbo_tasks::value_impl] impl Project { #[turbo_tasks::function] pub async fn app_project(self: Vc) -> Result> { let app_dir = find_app_dir(self.project_path().owned().await?).await?; Ok(match &*app_dir { Some(app_dir) => Vc::cell(Some( AppProject::new(self, app_dir.clone()).to_resolved().await?, )), None => Vc::cell(None), }) } #[turbo_tasks::function] pub fn pages_project(self: Vc) -> Vc { PagesProject::new(self) } #[turbo_tasks::function] pub fn project_fs(&self) -> Vc { DiskFileSystem::new( PROJECT_FILESYSTEM_NAME.into(), self.root_path.clone(), vec![], ) } #[turbo_tasks::function] pub fn client_fs(self: Vc) -> Vc> { let virtual_fs = VirtualFileSystem::new_with_name(rcstr!("client-fs")); Vc::upcast(virtual_fs) } #[turbo_tasks::function] pub fn output_fs(&self) -> Vc { DiskFileSystem::new(rcstr!("output"), self.root_path.clone(), vec![]) } #[turbo_tasks::function] pub fn dist_dir_absolute(&self) -> Result> { Ok(Vc::cell( format!( "{}{}{}", self.root_path, std::path::MAIN_SEPARATOR, unix_to_sys( &join_path(&self.project_path, &self.dist_dir) .context("expected project_path to be inside of root_path")? ) ) .into(), )) } #[turbo_tasks::function] pub async fn node_root(self: Vc) -> Result> { let this = self.await?; Ok(self .output_fs() .root() .await? .join(&this.project_path)? .join(&this.dist_dir)? .cell()) } #[turbo_tasks::function] pub fn client_root(self: Vc) -> Vc { self.client_fs().root() } #[turbo_tasks::function] pub fn project_root_path(self: Vc) -> Vc { self.project_fs().root() } #[turbo_tasks::function] pub async fn client_relative_path(self: Vc) -> Result> { let next_config = self.next_config().await?; Ok(self .client_root() .await? .join(&format!( "{}/_next", next_config.base_path.clone().unwrap_or_default(), ))? .cell()) } /// Returns the relative path from the node root to the output root. /// E.g. from `[project]/test/e2e/app-dir/non-root-project-monorepo/apps/web/app/ /// import-meta-url-ssr/page.tsx` to `[project]/`. #[turbo_tasks::function] pub async fn node_root_to_root_path(self: Vc) -> Result> { Ok(Vc::cell( self.node_root() .await? .get_relative_path_to(&*self.output_fs().root().await?) .context("Expected node root to be inside of output fs")?, )) } #[turbo_tasks::function] pub async fn project_path(self: Vc) -> Result> { let this = self.await?; let root = self.project_root_path().await?; Ok(root.join(&this.project_path)?.cell()) } #[turbo_tasks::function] pub(super) fn env(&self) -> Vc> { *self.env } #[turbo_tasks::function] pub(super) fn current_node_js_version(&self) -> Vc { NodeJsVersion::Static(ResolvedVc::cell(self.current_node_js_version.clone())).cell() } #[turbo_tasks::function] pub(super) fn next_config(&self) -> Vc { *self.next_config } #[turbo_tasks::function] pub(super) fn next_mode(&self) -> Vc { *self.mode } #[turbo_tasks::function] pub(super) fn is_watch_enabled(&self) -> Result> { Ok(Vc::cell(self.watch.enable)) } #[turbo_tasks::function] pub(super) async fn per_page_module_graph(&self) -> Result> { Ok(Vc::cell(*self.mode.await? == NextMode::Development)) } #[turbo_tasks::function] pub(super) fn js_config(&self) -> Vc { *self.js_config } #[turbo_tasks::function] pub(super) fn encryption_key(&self) -> Vc { Vc::cell(self.encryption_key.clone()) } #[turbo_tasks::function] pub(super) fn no_mangling(&self) -> Vc { Vc::cell(self.no_mangling) } #[turbo_tasks::function] pub(super) async fn should_create_webpack_stats(&self) -> Result> { Ok(Vc::cell( self.env.read(rcstr!("TURBOPACK_STATS")).await?.is_some(), )) } #[turbo_tasks::function] pub(super) async fn execution_context(self: Vc) -> Result> { let node_root = self.node_root().owned().await?; let next_mode = self.next_mode().await?; let node_execution_chunking_context = Vc::upcast( NodeJsChunkingContext::builder( self.project_root_path().owned().await?, node_root.clone(), self.node_root_to_root_path().owned().await?, node_root.clone(), node_root.join("build/chunks")?, node_root.join("build/assets")?, node_build_environment().to_resolved().await?, next_mode.runtime_type(), ) .source_maps(if *self.next_config().server_source_maps().await? { SourceMapsType::Full } else { SourceMapsType::None }) .build(), ); Ok(ExecutionContext::new( self.project_path().owned().await?, node_execution_chunking_context, self.env(), )) } #[turbo_tasks::function] pub(super) fn client_compile_time_info(&self) -> Vc { get_client_compile_time_info(self.browserslist_query.clone(), self.define_env.client()) } #[turbo_tasks::function] pub async fn get_all_endpoints(self: Vc, app_dir_only: bool) -> Result> { let mut endpoints = Vec::new(); let entrypoints = self.entrypoints().await?; // Always include these basic pages endpoints regardless of `app_dir_only`. The user's // page routes themselves are excluded below. endpoints.push(entrypoints.pages_error_endpoint); endpoints.push(entrypoints.pages_app_endpoint); endpoints.push(entrypoints.pages_document_endpoint); if let Some(middleware) = &entrypoints.middleware { endpoints.push(middleware.endpoint); } if let Some(instrumentation) = &entrypoints.instrumentation { endpoints.push(instrumentation.node_js); endpoints.push(instrumentation.edge); } for (_, route) in entrypoints.routes.iter() { match route { Route::Page { html_endpoint, data_endpoint: _, } => { if !app_dir_only { endpoints.push(*html_endpoint); } } Route::PageApi { endpoint } => { if !app_dir_only { endpoints.push(*endpoint); } } Route::AppPage(page_routes) => { for AppPageRoute { original_name: _, html_endpoint, rsc_endpoint: _, } in page_routes { endpoints.push(*html_endpoint); } } Route::AppRoute { original_name: _, endpoint, } => { endpoints.push(*endpoint); } Route::Conflict => { tracing::info!("WARN: conflict"); } } } Ok(Vc::cell(endpoints)) } #[turbo_tasks::function] pub async fn get_all_entries(self: Vc) -> Result> { let mut modules = self .get_all_endpoints(false) .await? .iter() .map(async |endpoint| Ok(endpoint.entries().owned().await?)) .try_flat_join() .await?; modules.extend(self.client_main_modules().await?.iter().cloned()); Ok(Vc::cell(modules)) } #[turbo_tasks::function] pub async fn get_all_additional_entries( self: Vc, graphs: Vc, ) -> Result> { let modules = self .get_all_endpoints(false) .await? .iter() .map(async |endpoint| Ok(endpoint.additional_entries(graphs).owned().await?)) .try_flat_join() .await?; Ok(Vc::cell(modules)) } #[turbo_tasks::function] pub async fn module_graph( self: Vc, entry: ResolvedVc>, ) -> Result> { Ok(if *self.per_page_module_graph().await? { ModuleGraph::from_entry_module(*entry, self.next_mode().await?.is_production()) } else { *self.whole_app_module_graphs().await?.full }) } #[turbo_tasks::function] pub async fn module_graph_for_modules( self: Vc, evaluatable_assets: Vc, ) -> Result> { Ok(if *self.per_page_module_graph().await? { let entries = evaluatable_assets .await? .iter() .copied() .map(ResolvedVc::upcast) .collect(); ModuleGraph::from_modules( Vc::cell(vec![ChunkGroupEntry::Entry(entries)]), self.next_mode().await?.is_production(), ) } else { *self.whole_app_module_graphs().await?.full }) } #[turbo_tasks::function] pub async fn whole_app_module_graphs( self: ResolvedVc, ) -> Result> { async move { let module_graphs_op = whole_app_module_graph_operation(self); let module_graphs_vc = module_graphs_op.resolve_strongly_consistent().await?; let _ = module_graphs_op.take_issues_with_path().await?; // At this point all modules have been computed and we can get rid of the node.js // process pools if *self.is_watch_enabled().await? { turbopack_node::evaluate::scale_down(); } else { turbopack_node::evaluate::scale_zero(); } Ok(*module_graphs_vc) } .instrument(tracing::info_span!("module graph for app")) .await } #[turbo_tasks::function] pub(super) async fn server_compile_time_info(self: Vc) -> Result> { let this = self.await?; Ok(get_server_compile_time_info( // `/ROOT` corresponds to `[project]/`, so we need exactly the `path` part. format!("/ROOT/{}", self.project_path().await?.path).into(), this.define_env.nodejs(), self.current_node_js_version(), )) } #[turbo_tasks::function] pub(super) async fn edge_compile_time_info(self: Vc) -> Result> { let this = self.await?; Ok(get_edge_compile_time_info( self.project_path().owned().await?, this.define_env.edge(), self.current_node_js_version(), )) } #[turbo_tasks::function] pub(super) fn edge_env(&self) -> Vc { let edge_env = fxindexmap! { rcstr!("__NEXT_BUILD_ID") => self.build_id.clone(), rcstr!("NEXT_SERVER_ACTIONS_ENCRYPTION_KEY") => self.encryption_key.clone(), rcstr!("__NEXT_PREVIEW_MODE_ID") => self.preview_props.preview_mode_id.clone(), rcstr!("__NEXT_PREVIEW_MODE_ENCRYPTION_KEY") => self.preview_props.preview_mode_encryption_key.clone(), rcstr!("__NEXT_PREVIEW_MODE_SIGNING_KEY") => self.preview_props.preview_mode_signing_key.clone(), }; Vc::cell(edge_env) } #[turbo_tasks::function] pub(super) async fn client_chunking_context( self: Vc, ) -> Result>> { Ok(get_client_chunking_context(ClientChunkingContextOptions { mode: self.next_mode(), root_path: self.project_root_path().owned().await?, client_root: self.client_relative_path().owned().await?, client_root_to_root_path: rcstr!("/ROOT"), asset_prefix: self.next_config().computed_asset_prefix(), chunk_suffix_path: self.next_config().chunk_suffix_path(), environment: self.client_compile_time_info().environment(), module_id_strategy: self.module_ids(), export_usage: self.export_usage(), minify: self.next_config().turbo_minify(self.next_mode()), source_maps: self.next_config().client_source_maps(self.next_mode()), no_mangling: self.no_mangling(), scope_hoisting: self.next_config().turbo_scope_hoisting(self.next_mode()), })) } #[turbo_tasks::function] pub(super) async fn server_chunking_context( self: Vc, client_assets: bool, ) -> Result> { let options = ServerChunkingContextOptions { mode: self.next_mode(), root_path: self.project_root_path().owned().await?, node_root: self.node_root().owned().await?, node_root_to_root_path: self.node_root_to_root_path().owned().await?, environment: self.server_compile_time_info().environment(), module_id_strategy: self.module_ids(), export_usage: self.export_usage(), turbo_minify: self.next_config().turbo_minify(self.next_mode()), turbo_source_maps: self.next_config().server_source_maps(), no_mangling: self.no_mangling(), scope_hoisting: self.next_config().turbo_scope_hoisting(self.next_mode()), }; Ok(if client_assets { get_server_chunking_context_with_client_assets( options, self.client_relative_path().owned().await?, self.next_config().computed_asset_prefix().owned().await?, ) } else { get_server_chunking_context(options) }) } #[turbo_tasks::function] pub(super) async fn edge_chunking_context( self: Vc, client_assets: bool, ) -> Result>> { let options = EdgeChunkingContextOptions { mode: self.next_mode(), root_path: self.project_root_path().owned().await?, node_root: self.node_root().owned().await?, output_root_to_root_path: self.node_root_to_root_path(), environment: self.edge_compile_time_info().environment(), module_id_strategy: self.module_ids(), export_usage: self.export_usage(), turbo_minify: self.next_config().turbo_minify(self.next_mode()), turbo_source_maps: self.next_config().server_source_maps(), no_mangling: self.no_mangling(), scope_hoisting: self.next_config().turbo_scope_hoisting(self.next_mode()), }; Ok(if client_assets { get_edge_chunking_context_with_client_assets( options, self.client_relative_path().owned().await?, self.next_config().computed_asset_prefix(), ) } else { get_edge_chunking_context(options) }) } #[turbo_tasks::function] pub(super) fn runtime_chunking_context( self: Vc, client_assets: bool, runtime: NextRuntime, ) -> Vc> { match runtime { NextRuntime::Edge => self.edge_chunking_context(client_assets), NextRuntime::NodeJs => Vc::upcast(self.server_chunking_context(client_assets)), } } /// Emit a telemetry event corresponding to [webpack configuration telemetry](https://github.com/vercel/next.js/blob/9da305fe320b89ee2f8c3cfb7ecbf48856368913/packages/next/src/build/webpack-config.ts#L2516) /// to detect which feature is enabled. #[turbo_tasks::function] async fn collect_project_feature_telemetry(self: Vc) -> Result> { let emit_event = |feature_name: &str, enabled: bool| { NextFeatureTelemetry::new(feature_name.into(), enabled) .resolved_cell() .emit(); }; // First, emit an event for the binary target triple. // This is different to webpack-config; when this is being called, // it is always using SWC so we don't check swc here. emit_event(env!("VERGEN_CARGO_TARGET_TRIPLE"), true); // Go over jsconfig and report enabled features. let compiler_options = self.js_config().compiler_options().await?; let compiler_options = compiler_options.as_object(); let experimental_decorators_enabled = compiler_options .as_ref() .and_then(|compiler_options| compiler_options.get("experimentalDecorators")) .is_some(); let jsx_import_source_enabled = compiler_options .as_ref() .and_then(|compiler_options| compiler_options.get("jsxImportSource")) .is_some(); emit_event("swcExperimentalDecorators", experimental_decorators_enabled); emit_event("swcImportSource", jsx_import_source_enabled); // Go over config and report enabled features. // [TODO]: useSwcLoader is not being reported as it is not directly corresponds (it checks babel config existence) // need to confirm what we'll do with turbopack. let config = self.next_config(); emit_event( "skipMiddlewareUrlNormalize", *config.skip_middleware_url_normalize().await?, ); emit_event( "skipTrailingSlashRedirect", *config.skip_trailing_slash_redirect().await?, ); emit_event( "persistentCaching", *config.persistent_caching_enabled().await?, ); let config = &config.await?; emit_event("modularizeImports", config.modularize_imports.is_some()); emit_event("transpilePackages", config.transpile_packages.is_some()); emit_event("turbotrace", false); // compiler options let compiler_options = config.compiler.as_ref(); let swc_relay_enabled = compiler_options.and_then(|c| c.relay.as_ref()).is_some(); let styled_components_enabled = compiler_options .and_then(|c| c.styled_components.as_ref().map(|sc| sc.is_enabled())) .unwrap_or_default(); let react_remove_properties_enabled = compiler_options .and_then(|c| c.react_remove_properties.as_ref().map(|rc| rc.is_enabled())) .unwrap_or_default(); let remove_console_enabled = compiler_options .and_then(|c| c.remove_console.as_ref().map(|rc| rc.is_enabled())) .unwrap_or_default(); let emotion_enabled = compiler_options .and_then(|c| c.emotion.as_ref().map(|e| e.is_enabled())) .unwrap_or_default(); emit_event("swcRelay", swc_relay_enabled); emit_event("swcStyledComponents", styled_components_enabled); emit_event("swcReactRemoveProperties", react_remove_properties_enabled); emit_event("swcRemoveConsole", remove_console_enabled); emit_event("swcEmotion", emotion_enabled); Ok(Default::default()) } /// Scans the app/pages directories for entry points files (matching the /// provided page_extensions). #[turbo_tasks::function] pub async fn entrypoints(self: Vc) -> Result> { self.collect_project_feature_telemetry().await?; let mut routes = FxIndexMap::default(); let app_project = self.app_project(); let pages_project = self.pages_project(); if let Some(app_project) = &*app_project.await? { let app_routes = app_project.routes(); routes.extend( app_routes .await? .iter() .map(|(k, v)| (k.clone(), v.clone())), ); } for (pathname, page_route) in pages_project.routes().await?.iter() { match routes.entry(pathname.clone()) { Entry::Occupied(mut entry) => { ConflictIssue { path: self.project_path().owned().await?, title: StyledString::Text( format!("App Router and Pages Router both match path: {pathname}") .into(), ) .resolved_cell(), description: StyledString::Text( "Next.js does not support having both App Router and Pages Router \ routes matching the same path. Please remove one of the conflicting \ routes." .into(), ) .resolved_cell(), severity: IssueSeverity::Error, } .resolved_cell() .emit(); *entry.get_mut() = Route::Conflict; } Entry::Vacant(entry) => { entry.insert(page_route.clone()); } } } let pages_document_endpoint = self .pages_project() .document_endpoint() .to_resolved() .await?; let pages_app_endpoint = self.pages_project().app_endpoint().to_resolved().await?; let pages_error_endpoint = self.pages_project().error_endpoint().to_resolved().await?; let middleware = self.find_middleware(); let middleware = if let FindContextFileResult::Found(..) = *middleware.await? { Some(Middleware { endpoint: self.middleware_endpoint().to_resolved().await?, }) } else { None }; let instrumentation = self.find_instrumentation(); let instrumentation = if let FindContextFileResult::Found(..) = *instrumentation.await? { Some(Instrumentation { node_js: self.instrumentation_endpoint(false).to_resolved().await?, edge: self.instrumentation_endpoint(true).to_resolved().await?, }) } else { None }; Ok(Entrypoints { routes, middleware, instrumentation, pages_document_endpoint, pages_app_endpoint, pages_error_endpoint, } .cell()) } #[turbo_tasks::function] async fn edge_middleware_context(self: Vc) -> Result>> { let mut transitions = vec![]; let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let app_project = *self.app_project().await?; let ecmascript_client_reference_transition_name = app_project.map(|_| AppProject::client_transition_name()); if let Some(app_project) = app_project { transitions.push(( AppProject::client_transition_name(), app_project .edge_ecmascript_client_reference_transition() .to_resolved() .await?, )); } Ok(Vc::upcast(ModuleAssetContext::new( TransitionOptions { named_transitions: transitions.clone().into_iter().collect(), ..Default::default() } .cell(), self.edge_compile_time_info(), get_server_module_options_context( self.project_path().owned().await?, self.execution_context(), ServerContextType::Middleware { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name: ecmascript_client_reference_transition_name.clone(), }, self.next_mode(), self.next_config(), NextRuntime::Edge, self.encryption_key(), self.edge_compile_time_info().environment(), ), get_edge_resolve_options_context( self.project_path().owned().await?, ServerContextType::Middleware { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name: ecmascript_client_reference_transition_name.clone(), }, self.next_mode(), self.next_config(), self.execution_context(), ), Layer::new_with_user_friendly_name( rcstr!("middleware-edge"), rcstr!("Edge Middleware"), ), ))) } #[turbo_tasks::function] async fn node_middleware_context(self: Vc) -> Result>> { let mut transitions = vec![]; let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let app_project = *self.app_project().await?; let ecmascript_client_reference_transition_name = app_project.map(|_| AppProject::client_transition_name()); if let Some(app_project) = app_project { transitions.push(( AppProject::client_transition_name(), app_project .edge_ecmascript_client_reference_transition() .to_resolved() .await?, )); } Ok(Vc::upcast(ModuleAssetContext::new( TransitionOptions { named_transitions: transitions.clone().into_iter().collect(), ..Default::default() } .cell(), self.server_compile_time_info(), get_server_module_options_context( self.project_path().owned().await?, self.execution_context(), ServerContextType::Middleware { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name: ecmascript_client_reference_transition_name.clone(), }, self.next_mode(), self.next_config(), NextRuntime::NodeJs, self.encryption_key(), self.server_compile_time_info().environment(), ), get_server_resolve_options_context( self.project_path().owned().await?, ServerContextType::Middleware { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name, }, self.next_mode(), self.next_config(), self.execution_context(), ), Layer::new_with_user_friendly_name(rcstr!("middleware"), rcstr!("Middleware")), ))) } #[turbo_tasks::function] async fn middleware_context(self: Vc) -> Result>> { let edge_module_context = self.edge_middleware_context(); let middleware = self.find_middleware(); let FindContextFileResult::Found(fs_path, _) = &*middleware.await? else { return Ok(Vc::upcast(edge_module_context)); }; let source = Vc::upcast(FileSource::new(fs_path.clone())); let module = edge_module_context .process( source, ReferenceType::Entry(EntryReferenceSubType::Middleware), ) .module(); let config = parse_config_from_source(source, module, NextRuntime::Edge).await?; if matches!(config.runtime, NextRuntime::NodeJs) { Ok(self.node_middleware_context()) } else { Ok(edge_module_context) } } #[turbo_tasks::function] async fn find_middleware(self: Vc) -> Result> { Ok(find_context_file( self.project_path().owned().await?, middleware_files(self.next_config().page_extensions()), )) } #[turbo_tasks::function] async fn middleware_endpoint(self: Vc) -> Result>> { let middleware = self.find_middleware(); let FindContextFileResult::Found(fs_path, _) = &*middleware.await? else { return Ok(Vc::upcast(EmptyEndpoint::new())); }; let source = Vc::upcast(FileSource::new(fs_path.clone())); let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let ecmascript_client_reference_transition_name = (*self.app_project().await?) .as_ref() .map(|_| AppProject::client_transition_name()); let middleware_asset_context = self.middleware_context(); Ok(Vc::upcast(MiddlewareEndpoint::new( self, middleware_asset_context, source, app_dir.clone(), ecmascript_client_reference_transition_name, ))) } #[turbo_tasks::function] async fn node_instrumentation_context(self: Vc) -> Result>> { let mut transitions = vec![]; let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let app_project = &*self.app_project().await?; let ecmascript_client_reference_transition_name = app_project .as_ref() .map(|_| AppProject::client_transition_name()); if let Some(app_project) = app_project { transitions.push(( AppProject::client_transition_name(), app_project .ecmascript_client_reference_transition() .to_resolved() .await?, )); } Ok(Vc::upcast(ModuleAssetContext::new( TransitionOptions { named_transitions: transitions.into_iter().collect(), ..Default::default() } .cell(), self.server_compile_time_info(), get_server_module_options_context( self.project_path().owned().await?, self.execution_context(), ServerContextType::Instrumentation { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name: ecmascript_client_reference_transition_name.clone(), }, self.next_mode(), self.next_config(), NextRuntime::NodeJs, self.encryption_key(), self.server_compile_time_info().environment(), ), get_server_resolve_options_context( self.project_path().owned().await?, ServerContextType::Instrumentation { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name, }, self.next_mode(), self.next_config(), self.execution_context(), ), Layer::new_with_user_friendly_name( rcstr!("instrumentation"), rcstr!("Instrumentation"), ), ))) } #[turbo_tasks::function] async fn edge_instrumentation_context(self: Vc) -> Result>> { let mut transitions = vec![]; let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let app_project = &*self.app_project().await?; let ecmascript_client_reference_transition_name = app_project .as_ref() .map(|_| AppProject::client_transition_name()); if let Some(app_project) = app_project { transitions.push(( AppProject::client_transition_name(), app_project .edge_ecmascript_client_reference_transition() .to_resolved() .await?, )); } Ok(Vc::upcast(ModuleAssetContext::new( TransitionOptions { named_transitions: transitions.into_iter().collect(), ..Default::default() } .cell(), self.edge_compile_time_info(), get_server_module_options_context( self.project_path().owned().await?, self.execution_context(), ServerContextType::Instrumentation { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name: ecmascript_client_reference_transition_name.clone(), }, self.next_mode(), self.next_config(), NextRuntime::Edge, self.encryption_key(), self.edge_compile_time_info().environment(), ), get_edge_resolve_options_context( self.project_path().owned().await?, ServerContextType::Instrumentation { app_dir: app_dir.clone(), ecmascript_client_reference_transition_name, }, self.next_mode(), self.next_config(), self.execution_context(), ), Layer::new_with_user_friendly_name( rcstr!("instrumentation-edge"), rcstr!("Edge Instrumentation"), ), ))) } #[turbo_tasks::function] async fn find_instrumentation(self: Vc) -> Result> { Ok(find_context_file( self.project_path().owned().await?, instrumentation_files(self.next_config().page_extensions()), )) } #[turbo_tasks::function] async fn instrumentation_endpoint( self: Vc, is_edge: bool, ) -> Result>> { let instrumentation = self.find_instrumentation(); let FindContextFileResult::Found(fs_path, _) = &*instrumentation.await? else { return Ok(Vc::upcast(EmptyEndpoint::new())); }; let source = Vc::upcast(FileSource::new(fs_path.clone())); let app_dir = find_app_dir(self.project_path().owned().await?) .owned() .await?; let ecmascript_client_reference_transition_name = (*self.app_project().await?) .as_ref() .map(|_| AppProject::client_transition_name()); let instrumentation_asset_context = if is_edge { self.edge_instrumentation_context() } else { self.node_instrumentation_context() }; Ok(Vc::upcast(InstrumentationEndpoint::new( self, instrumentation_asset_context, source, is_edge, app_dir.clone(), ecmascript_client_reference_transition_name, ))) } #[turbo_tasks::function] pub async fn emit_all_output_assets( self: Vc, output_assets: OperationVc, ) -> Result<()> { let span = tracing::info_span!("emitting"); async move { let all_output_assets = all_assets_from_entries_operation(output_assets); let client_relative_path = self.client_relative_path().owned().await?; let node_root = self.node_root().owned().await?; if let Some(map) = self.await?.versioned_content_map { map.insert_output_assets( all_output_assets, node_root.clone(), client_relative_path.clone(), node_root.clone(), ) .as_side_effect() .await?; Ok(()) } else { emit_assets( all_output_assets.connect(), node_root.clone(), client_relative_path.clone(), node_root.clone(), ) .as_side_effect() .await?; Ok(()) } } .instrument(span) .await } #[turbo_tasks::function] async fn hmr_content(self: Vc, identifier: RcStr) -> Result> { if let Some(map) = self.await?.versioned_content_map { let content = map.get(self.client_relative_path().await?.join(&identifier)?); Ok(content) } else { bail!("must be in dev mode to hmr") } } #[turbo_tasks::function] async fn hmr_version(self: Vc, identifier: RcStr) -> Result>> { let content = self.hmr_content(identifier).await?; if let Some(content) = &*content { Ok(content.version()) } else { Ok(Vc::upcast(NotFoundVersion::new())) } } /// Get the version state for a session. Initialized with the first seen /// version in that session. #[turbo_tasks::function] pub async fn hmr_version_state( self: Vc, identifier: RcStr, session: TransientInstance<()>, ) -> Result> { let version = self.hmr_version(identifier); // The session argument is important to avoid caching this function between // sessions. let _ = session; // INVALIDATION: This is intentionally untracked to avoid invalidating this // function completely. We want to initialize the VersionState with the // first seen version of the session. let state = VersionState::new( version .into_trait_ref() .strongly_consistent() .untracked() .await?, ) .await?; Ok(state) } /// Emits opaque HMR events whenever a change is detected in the chunk group /// internally known as `identifier`. #[turbo_tasks::function] pub async fn hmr_update( self: Vc, identifier: RcStr, from: Vc, ) -> Result> { let from = from.get(); let content = self.hmr_content(identifier).await?; if let Some(content) = *content { Ok(content.update(from)) } else { Ok(Update::Missing.cell()) } } /// Gets a list of all HMR identifiers that can be subscribed to. This is /// only needed for testing purposes and isn't used in real apps. #[turbo_tasks::function] pub async fn hmr_identifiers(self: Vc) -> Result>> { if let Some(map) = self.await?.versioned_content_map { Ok(map.keys_in_path(self.client_relative_path().owned().await?)) } else { bail!("must be in dev mode to hmr") } } /// Completion when server side changes are detected in output assets /// referenced from the roots #[turbo_tasks::function] pub async fn server_changed(self: Vc, roots: Vc) -> Result> { let path = self.node_root().owned().await?; Ok(any_output_changed(roots, path, true)) } /// Completion when client side changes are detected in output assets /// referenced from the roots #[turbo_tasks::function] pub async fn client_changed(self: Vc, roots: Vc) -> Result> { let path = self.client_root().owned().await?; Ok(any_output_changed(roots, path, false)) } #[turbo_tasks::function] pub async fn client_main_modules(self: Vc) -> Result> { let pages_project = self.pages_project(); let mut modules = vec![ChunkGroupEntry::Entry(vec![ pages_project.client_main_module().to_resolved().await?, ])]; if let Some(app_project) = *self.app_project().await? { modules.push(ChunkGroupEntry::Entry(vec![ app_project.client_main_module().to_resolved().await?, ])); } Ok(Vc::cell(modules)) } /// Gets the module id strategy for the project. #[turbo_tasks::function] pub async fn module_ids(self: Vc) -> Result>> { let module_id_strategy = *self.next_config().module_ids(self.next_mode()).await?; match module_id_strategy { ModuleIdStrategyConfig::Named => Ok(Vc::upcast(DevModuleIdStrategy::new())), ModuleIdStrategyConfig::Deterministic => { let module_graphs = self.whole_app_module_graphs().await?; Ok(Vc::upcast(get_global_module_id_strategy( *module_graphs.full, ))) } } } /// Compute the used exports for each module. #[turbo_tasks::function] pub async fn export_usage(self: Vc) -> Result> { if *self .next_config() .turbopack_remove_unused_exports(self.next_mode()) .await? { let module_graphs = self.whole_app_module_graphs().await?; Ok(Vc::cell(Some( compute_export_usage_info(module_graphs.full) // As a performance optimization, we resolve strongly consistently .resolve_strongly_consistent() .await?, ))) } else { Ok(Vc::cell(None)) } } } // This is a performance optimization. This function is a root aggregation function that // aggregates over the whole subgraph. #[turbo_tasks::function(operation)] async fn whole_app_module_graph_operation( project: ResolvedVc, ) -> Result> { mark_root(); let should_trace = project.next_mode().await?.is_production(); let base_single_module_graph = SingleModuleGraph::new_with_entries(project.get_all_entries(), should_trace); let base_visited_modules = VisitedModules::from_graph(base_single_module_graph); let base = ModuleGraph::from_single_graph(base_single_module_graph); let additional_entries = project.get_all_additional_entries(base); let additional_module_graph = SingleModuleGraph::new_with_entries_visited( additional_entries, base_visited_modules, should_trace, ); let full = ModuleGraph::from_graphs(vec![base_single_module_graph, additional_module_graph]); Ok(BaseAndFullModuleGraph { base: base.to_resolved().await?, full: full.to_resolved().await?, } .cell()) } #[turbo_tasks::value(shared)] pub struct BaseAndFullModuleGraph { pub base: ResolvedVc, pub full: ResolvedVc, } #[turbo_tasks::function] async fn any_output_changed( roots: Vc, path: FileSystemPath, server: bool, ) -> Result> { let completions = AdjacencyMap::new() .skip_duplicates() .visit(roots.await?.iter().copied(), get_referenced_output_assets) .await .completed()? .into_inner() .into_postorder_topological() .map(|m| { let path = path.clone(); async move { let asset_path = m.path().await?; if !asset_path.path.ends_with(".map") && (!server || !asset_path.path.ends_with(".css")) && asset_path.is_inside_ref(&path) { anyhow::Ok(Some(content_changed(*ResolvedVc::upcast(m)))) } else { Ok(None) } } }) .map(|v| async move { Ok(match v.await? { Some(v) => Some(v.to_resolved().await?), None => None, }) }) .try_flat_join() .await?; Ok(Vc::::cell(completions).completed()) } async fn get_referenced_output_assets( parent: ResolvedVc>, ) -> Result>> + Send> { Ok(parent.references().owned().await?.into_iter()) } #[turbo_tasks::function(operation)] fn all_assets_from_entries_operation( operation: OperationVc, ) -> Result> { let assets = operation.connect(); Ok(all_assets_from_entries(assets)) } #[turbo_tasks::function] fn stable_endpoint(endpoint: Vc>) -> Vc> { endpoint }