// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license. //! The collection of APIs to be able to take `deno_graph` module graphs and //! populate a cache, emit files, and transform a graph into the structures for //! loading into an isolate. use crate::cache::CacheType; use crate::cache::Cacher; use crate::colors; use crate::config_file; use crate::config_file::ConfigFile; use crate::config_file::IgnoredCompilerOptions; use crate::config_file::TsConfig; use crate::diagnostics::Diagnostics; use crate::flags; use crate::graph_util::GraphData; use crate::graph_util::ModuleEntry; use crate::tsc; use crate::version; use deno_ast::swc::bundler::Hook; use deno_ast::swc::bundler::ModuleRecord; use deno_ast::swc::common::Span; use deno_core::error::AnyError; use deno_core::parking_lot::RwLock; use deno_core::serde::Deserialize; use deno_core::serde::Deserializer; use deno_core::serde::Serialize; use deno_core::serde::Serializer; use deno_core::serde_json; use deno_core::serde_json::json; use deno_core::serde_json::Value; use deno_core::ModuleSpecifier; use deno_graph::MediaType; use deno_graph::ModuleGraph; use deno_graph::ModuleGraphError; use deno_graph::ModuleKind; use deno_graph::ResolutionError; use std::collections::HashMap; use std::collections::HashSet; use std::fmt; use std::result; use std::sync::Arc; use std::time::Instant; /// Emit cache for a single file. #[derive(Debug, Clone, PartialEq)] pub struct SpecifierEmitCacheData { pub source_hash: String, pub text: String, pub map: Option, } pub trait EmitCache { /// Gets the emit data from the cache. fn get_emit_data( &self, specifier: &ModuleSpecifier, ) -> Option; /// Gets the stored hash of the source of the provider specifier /// to tell if the emit is out of sync with the source. /// TODO(13302): this is actually not reliable and should be removed /// once switching to an sqlite db fn get_source_hash(&self, specifier: &ModuleSpecifier) -> Option; /// Gets the emitted JavaScript of the TypeScript source. /// TODO(13302): remove this once switching to an sqlite db fn get_emit_text(&self, specifier: &ModuleSpecifier) -> Option; /// Sets the emit data in the cache. fn set_emit_data( &self, specifier: ModuleSpecifier, data: SpecifierEmitCacheData, ) -> Result<(), AnyError>; /// Gets the .tsbuildinfo file from the cache. fn get_tsbuildinfo(&self, specifier: &ModuleSpecifier) -> Option; /// Sets the .tsbuildinfo file in the cache. fn set_tsbuildinfo( &self, specifier: ModuleSpecifier, text: String, ) -> Result<(), AnyError>; } impl EmitCache for T { fn get_emit_data( &self, specifier: &ModuleSpecifier, ) -> Option { Some(SpecifierEmitCacheData { source_hash: self.get_source_hash(specifier)?, text: self.get_emit_text(specifier)?, map: self.get(CacheType::SourceMap, specifier), }) } fn get_source_hash(&self, specifier: &ModuleSpecifier) -> Option { self.get(CacheType::Version, specifier) } fn get_emit_text(&self, specifier: &ModuleSpecifier) -> Option { self.get(CacheType::Emit, specifier) } fn set_emit_data( &self, specifier: ModuleSpecifier, data: SpecifierEmitCacheData, ) -> Result<(), AnyError> { self.set(CacheType::Version, &specifier, data.source_hash)?; self.set(CacheType::Emit, &specifier, data.text)?; if let Some(map) = data.map { self.set(CacheType::SourceMap, &specifier, map)?; } Ok(()) } fn get_tsbuildinfo(&self, specifier: &ModuleSpecifier) -> Option { self.get(CacheType::TypeScriptBuildInfo, specifier) } fn set_tsbuildinfo( &self, specifier: ModuleSpecifier, text: String, ) -> Result<(), AnyError> { self.set(CacheType::TypeScriptBuildInfo, &specifier, text) } } /// Represents the "default" type library that should be used when type /// checking the code in the module graph. Note that a user provided config /// of `"lib"` would override this value. #[derive(Debug, Clone, Eq, Hash, PartialEq)] pub enum TypeLib { DenoWindow, DenoWorker, UnstableDenoWindow, UnstableDenoWorker, } impl Default for TypeLib { fn default() -> Self { Self::DenoWindow } } impl Serialize for TypeLib { fn serialize(&self, serializer: S) -> Result where S: Serializer, { let value = match self { Self::DenoWindow => vec!["deno.window".to_string()], Self::DenoWorker => vec!["deno.worker".to_string()], Self::UnstableDenoWindow => { vec!["deno.window".to_string(), "deno.unstable".to_string()] } Self::UnstableDenoWorker => { vec!["deno.worker".to_string(), "deno.unstable".to_string()] } }; Serialize::serialize(&value, serializer) } } /// A structure representing stats from an emit operation for a graph. #[derive(Clone, Debug, Default, Eq, PartialEq)] pub struct Stats(pub Vec<(String, u32)>); impl<'de> Deserialize<'de> for Stats { fn deserialize(deserializer: D) -> result::Result where D: Deserializer<'de>, { let items: Vec<(String, u32)> = Deserialize::deserialize(deserializer)?; Ok(Stats(items)) } } impl Serialize for Stats { fn serialize(&self, serializer: S) -> Result where S: Serializer, { Serialize::serialize(&self.0, serializer) } } impl fmt::Display for Stats { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { writeln!(f, "Compilation statistics:")?; for (key, value) in self.0.clone() { writeln!(f, " {}: {}", key, value)?; } Ok(()) } } /// An enum that represents the base tsc configuration to return. pub enum ConfigType { /// Return a configuration for bundling, using swc to emit the bundle. This is /// independent of type checking. Bundle, /// Return a configuration to use tsc to type check and optionally emit. This /// is independent of either bundling or just emitting via swc Check { lib: TypeLib, tsc_emit: bool }, /// Return a configuration to use swc to emit single module files. Emit, } /// For a given configuration type and optionally a configuration file, return a /// tuple of the resulting `TsConfig` struct and optionally any user /// configuration options that were ignored. pub fn get_ts_config( config_type: ConfigType, maybe_config_file: Option<&ConfigFile>, maybe_user_config: Option<&HashMap>, ) -> Result<(TsConfig, Option), AnyError> { let mut ts_config = match config_type { ConfigType::Bundle => TsConfig::new(json!({ "checkJs": false, "emitDecoratorMetadata": false, "importsNotUsedAsValues": "remove", "inlineSourceMap": false, "inlineSources": false, "sourceMap": false, "jsx": "react", "jsxFactory": "React.createElement", "jsxFragmentFactory": "React.Fragment", })), ConfigType::Check { tsc_emit, lib } => { let mut ts_config = TsConfig::new(json!({ "allowJs": true, "allowSyntheticDefaultImports": true, "experimentalDecorators": true, "incremental": true, "jsx": "react", "isolatedModules": true, "lib": lib, "module": "esnext", "resolveJsonModule": true, "strict": true, "target": "esnext", "tsBuildInfoFile": "deno:///.tsbuildinfo", "useDefineForClassFields": true, // TODO(@kitsonk) remove for Deno 2.0 "useUnknownInCatchVariables": false, })); if tsc_emit { ts_config.merge(&json!({ "emitDecoratorMetadata": false, "importsNotUsedAsValues": "remove", "inlineSourceMap": true, "inlineSources": true, "outDir": "deno://", "removeComments": true, })); } else { ts_config.merge(&json!({ "noEmit": true, })); } ts_config } ConfigType::Emit => TsConfig::new(json!({ "checkJs": false, "emitDecoratorMetadata": false, "importsNotUsedAsValues": "remove", "inlineSourceMap": true, "inlineSources": true, "sourceMap": false, "jsx": "react", "jsxFactory": "React.createElement", "jsxFragmentFactory": "React.Fragment", "resolveJsonModule": true, })), }; let maybe_ignored_options = if let Some(user_options) = maybe_user_config { ts_config.merge_user_config(user_options)? } else { ts_config.merge_tsconfig_from_config_file(maybe_config_file)? }; ts_config.merge(&json!({ "moduleDetection": "force", })); Ok((ts_config, maybe_ignored_options)) } /// Transform the graph into root specifiers that we can feed `tsc`. We have to /// provide the media type for root modules because `tsc` does not "resolve" the /// media type like other modules, as well as a root specifier needs any /// redirects resolved. If we aren't checking JavaScript, we need to include all /// the emittable files in the roots, so they get type checked and optionally /// emitted, otherwise they would be ignored if only imported into JavaScript. fn get_tsc_roots( roots: &[(ModuleSpecifier, ModuleKind)], graph_data: &GraphData, check_js: bool, ) -> Vec<(ModuleSpecifier, MediaType)> { if !check_js { graph_data .entries() .into_iter() .filter_map(|(specifier, module_entry)| match module_entry { ModuleEntry::Module { media_type, ts_check, .. } => match &media_type { MediaType::TypeScript | MediaType::Tsx | MediaType::Mts | MediaType::Cts | MediaType::Jsx => Some((specifier.clone(), *media_type)), MediaType::JavaScript | MediaType::Mjs | MediaType::Cjs if check_js || *ts_check => { Some((specifier.clone(), *media_type)) } _ => None, }, _ => None, }) .collect() } else { roots .iter() .filter_map(|(specifier, _)| match graph_data.get(specifier) { Some(ModuleEntry::Module { media_type, .. }) => { Some((specifier.clone(), *media_type)) } _ => None, }) .collect() } } /// A hashing function that takes the source code, version and optionally a /// user provided config and generates a string hash which can be stored to /// determine if the cached emit is valid or not. fn get_version(source_bytes: &[u8], config_bytes: &[u8]) -> String { crate::checksum::gen(&[ source_bytes, version::deno().as_bytes(), config_bytes, ]) } /// Determine if a given module kind and media type is emittable or not. pub fn is_emittable( kind: &ModuleKind, media_type: &MediaType, include_js: bool, ) -> bool { if matches!(kind, ModuleKind::Synthetic) { return false; } match &media_type { MediaType::TypeScript | MediaType::Mts | MediaType::Cts | MediaType::Tsx | MediaType::Jsx => true, MediaType::JavaScript | MediaType::Mjs | MediaType::Cjs => include_js, _ => false, } } /// Options for performing a check of a module graph. Note that the decision to /// emit or not is determined by the `ts_config` settings. pub struct CheckOptions { /// The check flag from the option which can effect the filtering of /// diagnostics in the emit result. pub type_check_mode: flags::TypeCheckMode, /// Set the debug flag on the TypeScript type checker. pub debug: bool, /// If true, any files emitted will be cached, even if there are diagnostics /// produced. If false, if there are diagnostics, caching emitted files will /// be skipped. pub emit_with_diagnostics: bool, /// The module specifier to the configuration file, passed to tsc so that /// configuration related diagnostics are properly formed. pub maybe_config_specifier: Option, /// The derived tsconfig that should be used when checking. pub ts_config: TsConfig, /// If true, `Check ` will be written to stdout for each root. pub log_checks: bool, /// If true, valid existing emits and `.tsbuildinfo` files will be ignored. pub reload: bool, pub reload_exclusions: HashSet, } /// The result of a check or emit of a module graph. Note that the actual /// emitted sources are stored in the cache and are not returned in the result. #[derive(Debug, Default)] pub struct CheckEmitResult { pub diagnostics: Diagnostics, pub stats: Stats, } /// Given a set of roots and graph data, type check the module graph and /// optionally emit modules, updating the cache as appropriate. Emitting is /// determined by the `ts_config` supplied in the options, and if emitting, the /// files are stored in the cache. /// /// It is expected that it is determined if a check and/or emit is validated /// before the function is called. pub fn check_and_maybe_emit( roots: &[(ModuleSpecifier, ModuleKind)], graph_data: Arc>, cache: &dyn EmitCache, options: CheckOptions, ) -> Result { let check_js = options.ts_config.get_check_js(); let segment_graph_data = { let graph_data = graph_data.read(); graph_data.graph_segment(roots).unwrap() }; if valid_emit( &segment_graph_data, cache, &options.ts_config, options.reload, &options.reload_exclusions, ) { return Ok(Default::default()); } let root_names = get_tsc_roots(roots, &segment_graph_data, check_js); if options.log_checks { for (root, _) in roots { let root_str = root.to_string(); // `$deno` specifiers are internal, don't print them. if !root_str.contains("$deno") { log::info!("{} {}", colors::green("Check"), root); } } } // while there might be multiple roots, we can't "merge" the build info, so we // try to retrieve the build info for first root, which is the most common use // case. let maybe_tsbuildinfo = if options.reload { None } else { cache.get_tsbuildinfo(&roots[0].0) }; // to make tsc build info work, we need to consistently hash modules, so that // tsc can better determine if an emit is still valid or not, so we provide // that data here. let hash_data = vec![ options.ts_config.as_bytes(), version::deno().as_bytes().to_owned(), ]; let config_bytes = options.ts_config.as_bytes(); let response = tsc::exec(tsc::Request { config: options.ts_config, debug: options.debug, graph_data: graph_data.clone(), hash_data, maybe_config_specifier: options.maybe_config_specifier, maybe_tsbuildinfo, root_names, })?; let diagnostics = if options.type_check_mode == flags::TypeCheckMode::Local { response.diagnostics.filter(|d| { if let Some(file_name) = &d.file_name { !file_name.starts_with("http") } else { true } }) } else { response.diagnostics }; // sometimes we want to emit when there are diagnostics, and sometimes we // don't. tsc will always return an emit if there are diagnostics if (diagnostics.is_empty() || options.emit_with_diagnostics) && !response.emitted_files.is_empty() { if let Some(info) = &response.maybe_tsbuildinfo { // while we retrieve the build info for just the first module, it can be // used for all the roots in the graph, so we will cache it for all roots for (root, _) in roots { cache.set_tsbuildinfo(root.clone(), info.to_string())?; } } struct SpecifierEmitData { pub version_hash: String, pub text: Option, pub map: Option, } impl SpecifierEmitData { fn into_cache_data(self) -> Option { self.text.map(|text| SpecifierEmitCacheData { source_hash: self.version_hash, text, map: self.map, }) } } // combine the emitted files into groups based on their specifier and media type let mut emit_data_items: HashMap = HashMap::with_capacity(response.emitted_files.len()); for emit in response.emitted_files.into_iter() { if let Some(specifiers) = emit.maybe_specifiers { assert!(specifiers.len() == 1); // The emitted specifier might not be the file specifier we want, so we // resolve it via the graph. let graph_data = graph_data.read(); let specifier = graph_data.follow_redirect(&specifiers[0]); let (source_bytes, media_type, ts_check) = match graph_data.get(&specifier) { Some(ModuleEntry::Module { code, media_type, ts_check, .. }) => (code.as_bytes(), *media_type, *ts_check), _ => { log::debug!("skipping emit for {}", specifier); continue; } }; // Sometimes if `tsc` sees a CommonJS file or a JSON module, it will // _helpfully_ output it, which we don't really want to do unless // someone has enabled check_js. if matches!(media_type, MediaType::Json) || (!check_js && !ts_check && matches!( media_type, MediaType::JavaScript | MediaType::Cjs | MediaType::Mjs )) { log::debug!("skipping emit for {}", specifier); continue; } let mut emit_data_item = emit_data_items .entry(specifier.clone()) .or_insert_with(|| SpecifierEmitData { version_hash: get_version(source_bytes, &config_bytes), text: None, map: None, }); match emit.media_type { MediaType::JavaScript | MediaType::Mjs | MediaType::Cjs => { emit_data_item.text = Some(emit.data); } MediaType::SourceMap => { emit_data_item.map = Some(emit.data); } _ => unreachable!( "unexpected media_type {} {}", emit.media_type, specifier ), } } } // now insert these items into the cache for (specifier, data) in emit_data_items.into_iter() { if let Some(cache_data) = data.into_cache_data() { cache.set_emit_data(specifier, cache_data)?; } } } Ok(CheckEmitResult { diagnostics, stats: response.stats, }) } pub struct EmitOptions { pub ts_config: TsConfig, pub reload: bool, pub reload_exclusions: HashSet, } /// Given a module graph, emit any appropriate modules and cache them. // TODO(nayeemrmn): This would ideally take `GraphData` like // `check_and_maybe_emit()`, but the AST isn't stored in that. Cleanup. pub fn emit( graph: &ModuleGraph, cache: &dyn EmitCache, options: EmitOptions, ) -> Result { let start = Instant::now(); let config_bytes = options.ts_config.as_bytes(); let include_js = options.ts_config.get_check_js(); let emit_options = options.ts_config.into(); let mut emit_count = 0_u32; let mut file_count = 0_u32; for module in graph.modules() { file_count += 1; if !is_emittable(&module.kind, &module.media_type, include_js) { continue; } let needs_reload = options.reload && !options.reload_exclusions.contains(&module.specifier); let version = get_version( module.maybe_source.as_ref().map(|s| s.as_bytes()).unwrap(), &config_bytes, ); let is_valid = cache .get_source_hash(&module.specifier) .map_or(false, |v| v == version); if is_valid && !needs_reload { continue; } let transpiled_source = module .maybe_parsed_source .as_ref() .map(|ps| ps.transpile(&emit_options)) .unwrap()?; emit_count += 1; cache.set_emit_data( module.specifier.clone(), SpecifierEmitCacheData { source_hash: version, text: transpiled_source.text, map: transpiled_source.source_map, }, )?; } let stats = Stats(vec![ ("Files".to_string(), file_count), ("Emitted".to_string(), emit_count), ("Total time".to_string(), start.elapsed().as_millis() as u32), ]); Ok(CheckEmitResult { diagnostics: Diagnostics::default(), stats, }) } /// Check a module graph to determine if the graph contains anything that /// is required to be emitted to be valid. It determines what modules in the /// graph are emittable and for those that are emittable, if there is currently /// a valid emit in the cache. fn valid_emit( graph_data: &GraphData, cache: &dyn EmitCache, ts_config: &TsConfig, reload: bool, reload_exclusions: &HashSet, ) -> bool { let config_bytes = ts_config.as_bytes(); let check_js = ts_config.get_check_js(); for (specifier, module_entry) in graph_data.entries() { if let ModuleEntry::Module { code, media_type, ts_check, .. } = module_entry { match media_type { MediaType::TypeScript | MediaType::Mts | MediaType::Cts | MediaType::Tsx | MediaType::Jsx => {} MediaType::JavaScript | MediaType::Mjs | MediaType::Cjs => { if !check_js && !ts_check { continue; } } MediaType::Json | MediaType::TsBuildInfo | MediaType::SourceMap | MediaType::Dts | MediaType::Dmts | MediaType::Dcts | MediaType::Wasm | MediaType::Unknown => continue, } if reload && !reload_exclusions.contains(specifier) { return false; } if let Some(source_hash) = cache.get_source_hash(specifier) { if source_hash != get_version(code.as_bytes(), &config_bytes) { return false; } } else { return false; } } } true } /// An adapter struct to make a deno_graph::ModuleGraphError display as expected /// in the Deno CLI. #[derive(Debug)] pub struct GraphError(pub ModuleGraphError); impl std::error::Error for GraphError {} impl From for GraphError { fn from(err: ModuleGraphError) -> Self { Self(err) } } impl fmt::Display for GraphError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match &self.0 { ModuleGraphError::ResolutionError(err) => { if matches!( err, ResolutionError::InvalidDowngrade { .. } | ResolutionError::InvalidLocalImport { .. } ) { write!(f, "{}", err.to_string_with_range()) } else { self.0.fmt(f) } } _ => self.0.fmt(f), } } } /// This contains the logic for Deno to rewrite the `import.meta` when bundling. pub struct BundleHook; impl Hook for BundleHook { fn get_import_meta_props( &self, span: Span, module_record: &ModuleRecord, ) -> Result, AnyError> { use deno_ast::swc::ast; Ok(vec![ ast::KeyValueProp { key: ast::PropName::Ident(ast::Ident::new("url".into(), span)), value: Box::new(ast::Expr::Lit(ast::Lit::Str(ast::Str { span, value: module_record.file_name.to_string().into(), raw: None, }))), }, ast::KeyValueProp { key: ast::PropName::Ident(ast::Ident::new("main".into(), span)), value: Box::new(if module_record.is_entry { ast::Expr::Member(ast::MemberExpr { span, obj: Box::new(ast::Expr::MetaProp(ast::MetaPropExpr { span, kind: ast::MetaPropKind::ImportMeta, })), prop: ast::MemberProp::Ident(ast::Ident::new("main".into(), span)), }) } else { ast::Expr::Lit(ast::Lit::Bool(ast::Bool { span, value: false })) }), }, ]) } } impl From for deno_ast::EmitOptions { fn from(config: config_file::TsConfig) -> Self { let options: config_file::EmitConfigOptions = serde_json::from_value(config.0).unwrap(); let imports_not_used_as_values = match options.imports_not_used_as_values.as_str() { "preserve" => deno_ast::ImportsNotUsedAsValues::Preserve, "error" => deno_ast::ImportsNotUsedAsValues::Error, _ => deno_ast::ImportsNotUsedAsValues::Remove, }; let (transform_jsx, jsx_automatic, jsx_development) = match options.jsx.as_str() { "react" => (true, false, false), "react-jsx" => (true, true, false), "react-jsxdev" => (true, true, true), _ => (false, false, false), }; deno_ast::EmitOptions { emit_metadata: options.emit_decorator_metadata, imports_not_used_as_values, inline_source_map: options.inline_source_map, inline_sources: options.inline_sources, source_map: options.source_map, jsx_automatic, jsx_development, jsx_factory: options.jsx_factory, jsx_fragment_factory: options.jsx_fragment_factory, jsx_import_source: options.jsx_import_source, transform_jsx, var_decl_imports: false, } } } #[cfg(test)] mod tests { use super::*; #[test] fn test_is_emittable() { assert!(is_emittable( &ModuleKind::Esm, &MediaType::TypeScript, false )); assert!(!is_emittable( &ModuleKind::Synthetic, &MediaType::TypeScript, false )); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Dts, false)); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Dcts, false)); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Dmts, false)); assert!(is_emittable(&ModuleKind::Esm, &MediaType::Tsx, false)); assert!(!is_emittable( &ModuleKind::Esm, &MediaType::JavaScript, false )); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Cjs, false)); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Mjs, false)); assert!(is_emittable(&ModuleKind::Esm, &MediaType::JavaScript, true)); assert!(is_emittable(&ModuleKind::Esm, &MediaType::Jsx, false)); assert!(!is_emittable(&ModuleKind::Esm, &MediaType::Json, false)); } }