turbopack_resolve/

typescript.rs

use std::mem::take;

use anyhow::Result;
use async_trait::async_trait;
use serde_json::Value as JsonValue;
use turbo_rcstr::{RcStr, rcstr};
use turbo_tasks::{FxIndexMap, ResolvedVc, ValueDefault, Vc, fxindexset};
use turbo_tasks_fs::{FileContent, FileJsonContent, FileSystemPath, FileSystemPathOption};
use turbopack_core::{
    asset::Asset,
    context::AssetContext,
    file_source::FileSource,
    issue::{Issue, IssueExt, IssueSeverity, IssueSource, IssueStage, StyledString},
    reference_type::{ReferenceType, TypeScriptReferenceSubType},
    resolve::{
        AliasPattern, ModuleResolveResult, RequestKey, ResolveErrorMode,
        error::handle_resolve_error,
        node::node_cjs_resolve_options,
        options::{
            ConditionValue, ImportMap, ImportMapping, ResolveIntoPackage, ResolveModules,
            ResolveOptions,
        },
        origin::ResolveOrigin,
        parse::Request,
        pattern::Pattern,
        resolve,
    },
    source::Source,
};

use crate::ecmascript::get_condition_maps;

#[turbo_tasks::value(shared)]
struct TsConfigIssue {
    severity: IssueSeverity,
    source: IssueSource,
    message: RcStr,
}

#[turbo_tasks::function]
async fn json_only(resolve_options: Vc<ResolveOptions>) -> Result<Vc<ResolveOptions>> {
    let mut opts = resolve_options.owned().await?;
    opts.extensions = vec![rcstr!(".json")];
    Ok(opts.cell())
}

type TsConfig = (Vc<FileJsonContent>, ResolvedVc<Box<dyn Source>>);

#[tracing::instrument(skip_all)]
pub async fn read_tsconfigs(
    mut data: Vc<FileContent>,
    mut tsconfig: ResolvedVc<Box<dyn Source>>,
    resolve_options: Vc<ResolveOptions>,
) -> Result<Vec<TsConfig>> {
    let mut configs = Vec::new();
    let resolve_options = json_only(resolve_options);
    loop {
        // tsc ignores empty config files.
        if let FileContent::Content(file) = &*data.await?
            && file.content().is_empty()
        {
            break;
        }

        let parsed_data = data.parse_json_with_comments();
        match &*parsed_data.await? {
            FileJsonContent::Unparsable(e) => {
                let message = format!("tsconfig is not parseable: invalid JSON: {}", e.message);
                let source = IssueSource::from_unparsable_json(tsconfig, e);
                TsConfigIssue {
                    severity: IssueSeverity::Error,
                    source,
                    message: message.into(),
                }
                .resolved_cell()
                .emit();
            }
            FileJsonContent::NotFound => {
                TsConfigIssue {
                    severity: IssueSeverity::Error,
                    source: IssueSource::from_source_only(tsconfig),
                    message: rcstr!("tsconfig not found"),
                }
                .resolved_cell()
                .emit();
            }
            FileJsonContent::Content(json) => {
                configs.push((parsed_data, tsconfig));
                if let Some(extends) = json["extends"].as_str() {
                    let resolved = resolve_extends(*tsconfig, extends, resolve_options).await?;
                    if let Some(source) = resolved {
                        data = source.content().file_content();
                        tsconfig = source;
                        continue;
                    } else {
                        TsConfigIssue {
                            severity: IssueSeverity::Error,
                            // TODO: this should point at the `extends` property
                            source: IssueSource::from_source_only(tsconfig),
                            message: format!("extends: \"{extends}\" doesn't resolve correctly")
                                .into(),
                        }
                        .resolved_cell()
                        .emit();
                    }
                }
            }
        }
        break;
    }
    Ok(configs)
}

/// Resolves tsconfig files according to TS's implementation:
/// https://github.com/microsoft/TypeScript/blob/611a912d/src/compiler/commandLineParser.ts#L3294-L3326
#[tracing::instrument(skip_all)]
async fn resolve_extends(
    tsconfig: Vc<Box<dyn Source>>,
    extends: &str,
    resolve_options: Vc<ResolveOptions>,
) -> Result<Option<ResolvedVc<Box<dyn Source>>>> {
    let parent_dir = tsconfig.ident().await?.path.parent();
    let request = Request::parse_string(extends.into());

    // TS's resolution is weird, and has special behavior for different import
    // types. There might be multiple alternatives like
    // "some/path/node_modules/xyz/abc.json" and "some/node_modules/xyz/abc.json".
    // We only want to use the first one.
    match &*request.await? {
        // TS has special behavior for "rooted" paths (absolute paths):
        // https://github.com/microsoft/TypeScript/blob/611a912d/src/compiler/commandLineParser.ts#L3303-L3313
        Request::Windows { path: Pattern::Constant(path), .. } |
        // Server relative is treated as absolute
        Request::ServerRelative { path: Pattern::Constant(path), .. } => {
            resolve_extends_rooted_or_relative(parent_dir, request, resolve_options, path).await
        }

        // TS has special behavior for (explicitly) './' and '../', but not '.' nor '..':
        // https://github.com/microsoft/TypeScript/blob/611a912d/src/compiler/commandLineParser.ts#L3303-L3313
        Request::Relative {
            path: Pattern::Constant(path),
            ..
        } if path.starts_with("./") || path.starts_with("../") => {
            resolve_extends_rooted_or_relative(parent_dir, request, resolve_options, path).await
        }

        // An empty extends is treated as "./tsconfig"
        Request::Empty => {
            let request = Request::parse_string(rcstr!("./tsconfig"));
            Ok(resolve(parent_dir,
                ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined), request, resolve_options).await?.first_source())
        }

        // All other types are treated as module imports, and potentially joined with
        // "tsconfig.json". This includes "relative" imports like '.' and '..'.
        _ => {
            let result = resolve(parent_dir.clone(), ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined), request, resolve_options).await?;
            if let Some(source) = result.first_source() {
                return Ok(Some(source));
            }
            let request = Request::parse_string(format!("{extends}/tsconfig").into());
            Ok(resolve(parent_dir, ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined), request, resolve_options).await?.first_source())
        }
    }
}

async fn resolve_extends_rooted_or_relative(
    lookup_path: FileSystemPath,
    request: Vc<Request>,
    resolve_options: Vc<ResolveOptions>,
    path: &str,
) -> Result<Option<ResolvedVc<Box<dyn Source>>>> {
    let result = resolve(
        lookup_path.clone(),
        ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined),
        request,
        resolve_options,
    )
    .await?;

    let mut result = result.first_source();

    // If the file doesn't end with ".json" and we can't find the file, then we have
    // to try again with it.
    // https://github.com/microsoft/TypeScript/blob/611a912d/src/compiler/commandLineParser.ts#L3305
    if !path.ends_with(".json") && result.is_none() {
        let request = Request::parse_string(format!("{path}.json").into());
        result = resolve(
            lookup_path.clone(),
            ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined),
            request,
            resolve_options,
        )
        .await?
        .first_source();
    }
    Ok(result)
}

pub async fn read_from_tsconfigs<T>(
    configs: &[TsConfig],
    accessor: impl Fn(&JsonValue, ResolvedVc<Box<dyn Source>>) -> Option<T>,
) -> Result<Option<T>> {
    for (config, source) in configs.iter() {
        if let FileJsonContent::Content(json) = &*config.await?
            && let Some(result) = accessor(json, *source)
        {
            return Ok(Some(result));
        }
    }
    Ok(None)
}

/// Resolve options specific to tsconfig.json.
#[turbo_tasks::value]
#[derive(Default)]
pub struct TsConfigResolveOptions {
    base_url: Option<FileSystemPath>,
    import_map: Option<ResolvedVc<ImportMap>>,
    is_module_resolution_nodenext: bool,
}

#[turbo_tasks::value_impl]
impl ValueDefault for TsConfigResolveOptions {
    #[turbo_tasks::function]
    fn value_default() -> Vc<Self> {
        Self::default().cell()
    }
}

#[turbo_tasks::function]
async fn try_join_base_url(
    source: ResolvedVc<Box<dyn Source>>,
    base_url: RcStr,
) -> Result<Vc<FileSystemPathOption>> {
    Ok(Vc::cell(
        source.ident().await?.path.parent().try_join(&base_url),
    ))
}

/// Returns the resolve options
#[turbo_tasks::function]
pub async fn tsconfig_resolve_options(
    tsconfig: FileSystemPath,
) -> Result<Vc<TsConfigResolveOptions>> {
    let configs = read_tsconfigs(
        tsconfig.read(),
        ResolvedVc::upcast(FileSource::new(tsconfig.clone()).to_resolved().await?),
        node_cjs_resolve_options(tsconfig.root().owned().await?),
    )
    .await?;

    if configs.is_empty() {
        return Ok(Default::default());
    }

    let base_url = if let Some(base_url) = read_from_tsconfigs(&configs, |json, source| {
        json["compilerOptions"]["baseUrl"]
            .as_str()
            .map(|base_url| try_join_base_url(*source, base_url.into()))
    })
    .await?
    {
        base_url.owned().await?
    } else {
        None
    };

    let mut all_paths = FxIndexMap::default();
    for (content, source) in configs.iter().rev() {
        if let FileJsonContent::Content(json) = &*content.await?
            && let JsonValue::Object(paths) = &json["compilerOptions"]["paths"]
        {
            let mut context_dir = source.ident().await?.path.parent();
            if let Some(base_url) = json["compilerOptions"]["baseUrl"].as_str()
                && let Some(new_context) = context_dir.try_join(base_url)
            {
                context_dir = new_context;
            };
            for (key, value) in paths.iter() {
                if let JsonValue::Array(vec) = value {
                    let entries = vec
                        .iter()
                        .filter_map(|entry| {
                            let entry = entry.as_str();

                            if entry.map(|e| e.ends_with(".d.ts")).unwrap_or_default() {
                                return None;
                            }

                            entry.map(|s| {
                                // tsconfig paths are always relative requests
                                if s.starts_with("./") || s.starts_with("../") {
                                    s.into()
                                } else {
                                    format!("./{s}").into()
                                }
                            })
                        })
                        .collect();
                    all_paths.insert(
                        RcStr::from(key.as_str()),
                        ImportMapping::primary_alternatives(entries, Some(context_dir.clone())),
                    );
                } else {
                    TsConfigIssue {
                        severity: IssueSeverity::Warning,
                        // TODO: this should point at the invalid key
                        source: IssueSource::from_source_only(*source),
                        message: format!(
                            "compilerOptions.paths[{key}] doesn't contains an array as \
                             expected\n{key}: {value:#}",
                            key = serde_json::to_string(key)?,
                            value = value
                        )
                        .into(),
                    }
                    .resolved_cell()
                    .emit()
                }
            }
        }
    }

    let import_map = if !all_paths.is_empty() {
        let mut import_map = ImportMap::empty();
        for (key, value) in all_paths {
            import_map.insert_alias(AliasPattern::parse(key), value.resolved_cell());
        }
        Some(import_map.resolved_cell())
    } else {
        None
    };

    let is_module_resolution_nodenext = read_from_tsconfigs(&configs, |json, _| {
        json["compilerOptions"]["moduleResolution"]
            .as_str()
            .map(|module_resolution| module_resolution.eq_ignore_ascii_case("nodenext"))
    })
    .await?
    .unwrap_or_default();

    Ok(TsConfigResolveOptions {
        base_url,
        import_map,
        is_module_resolution_nodenext,
    }
    .cell())
}

#[turbo_tasks::function]
pub fn tsconfig() -> Vc<Vec<RcStr>> {
    Vc::cell(vec![rcstr!("tsconfig.json"), rcstr!("jsconfig.json")])
}

#[turbo_tasks::function]
pub async fn apply_tsconfig_resolve_options(
    resolve_options: Vc<ResolveOptions>,
    tsconfig_resolve_options: Vc<TsConfigResolveOptions>,
) -> Result<Vc<ResolveOptions>> {
    let tsconfig_resolve_options = tsconfig_resolve_options.await?;
    let mut resolve_options = resolve_options.owned().await?;
    if let Some(base_url) = &tsconfig_resolve_options.base_url {
        // We want to resolve in `compilerOptions.baseUrl` first, then in other
        // locations as a fallback.
        resolve_options.modules.insert(
            0,
            ResolveModules::Path {
                dir: base_url.clone(),
                // tsconfig basepath doesn't apply to json requests
                excluded_extensions: ResolvedVc::cell(fxindexset![rcstr!(".json")]),
            },
        );
    }
    if let Some(tsconfig_import_map) = tsconfig_resolve_options.import_map {
        resolve_options.import_map = Some(
            resolve_options
                .import_map
                .map(|import_map| import_map.extend(*tsconfig_import_map))
                .unwrap_or(*tsconfig_import_map)
                .to_resolved()
                .await?,
        );
    }
    resolve_options.enable_typescript_with_output_extension =
        tsconfig_resolve_options.is_module_resolution_nodenext;

    Ok(resolve_options.cell())
}

#[turbo_tasks::function]
pub async fn type_resolve(
    origin: Vc<Box<dyn ResolveOrigin>>,
    request: Vc<Request>,
) -> Result<Vc<ModuleResolveResult>> {
    let ty = ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined);
    let context_path = origin.origin_path().await?.parent();
    let options = origin.resolve_options();
    let options = apply_typescript_types_options(options);
    let types_request = if let Request::Module {
        module: m,
        path: p,
        query: _,
        fragment: _,
    } = &*request.await?
    {
        let mut m = if let Some(mut stripped) = m.strip_prefix("@")? {
            stripped.replace_constants(&|c| Some(Pattern::Constant(c.replace("/", "__").into())));
            stripped
        } else {
            m.clone()
        };
        m.push_front(rcstr!("@types/").into());
        Some(Request::module(
            m,
            p.clone(),
            RcStr::default(),
            RcStr::default(),
        ))
    } else {
        None
    };
    let result = if let Some(types_request) = types_request {
        let result1 = resolve(
            context_path.clone(),
            ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined),
            request,
            options,
        );
        if !result1.await?.is_unresolvable() {
            result1
        } else {
            resolve(
                context_path,
                ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined),
                types_request,
                options,
            )
        }
    } else {
        resolve(
            context_path,
            ReferenceType::TypeScript(TypeScriptReferenceSubType::Undefined),
            request,
            options,
        )
    };
    let result = as_typings_result(
        origin
            .asset_context()
            .process_resolve_result(result, ty.clone()),
    );
    handle_resolve_error(
        result,
        ty,
        origin,
        request,
        options,
        ResolveErrorMode::Error,
        None,
    )
    .await
}

#[turbo_tasks::function]
pub async fn as_typings_result(result: Vc<ModuleResolveResult>) -> Result<Vc<ModuleResolveResult>> {
    let mut result = result.owned().await?;
    result.primary = IntoIterator::into_iter(take(&mut result.primary))
        .map(|(k, v)| {
            (
                RequestKey {
                    request: k.request.clone(),
                    conditions: k.conditions.extend([(rcstr!("types"), true)]),
                },
                v,
            )
        })
        .collect();
    Ok(result.cell())
}

#[turbo_tasks::function]
async fn apply_typescript_types_options(
    resolve_options: Vc<ResolveOptions>,
) -> Result<Vc<ResolveOptions>> {
    let mut resolve_options = resolve_options.owned().await?;
    resolve_options.extensions = vec![rcstr!(".tsx"), rcstr!(".ts"), rcstr!(".d.ts")];
    resolve_options.into_package = resolve_options
        .into_package
        .drain(..)
        .filter_map(|into| {
            if let ResolveIntoPackage::ExportsField {
                mut conditions,
                unspecified_conditions,
            } = into
            {
                conditions.insert(rcstr!("types"), ConditionValue::Set);
                Some(ResolveIntoPackage::ExportsField {
                    conditions,
                    unspecified_conditions,
                })
            } else {
                None
            }
        })
        .collect();
    resolve_options
        .into_package
        .push(ResolveIntoPackage::MainField {
            field: rcstr!("types"),
        });
    for conditions in get_condition_maps(&mut resolve_options) {
        conditions.insert(rcstr!("types"), ConditionValue::Set);
    }
    Ok(resolve_options.cell())
}

#[async_trait]
#[turbo_tasks::value_impl]
impl Issue for TsConfigIssue {
    fn severity(&self) -> IssueSeverity {
        self.severity
    }

    async fn title(&self) -> anyhow::Result<StyledString> {
        Ok(StyledString::Text(rcstr!(
            "An issue occurred while parsing a tsconfig.json file."
        )))
    }

    async fn file_path(&self) -> anyhow::Result<FileSystemPath> {
        self.source.file_path().await
    }

    async fn description(&self) -> anyhow::Result<Option<StyledString>> {
        Ok(Some(StyledString::Text(self.message.clone())))
    }

    fn stage(&self) -> IssueStage {
        IssueStage::Analysis
    }

    fn source(&self) -> Option<IssueSource> {
        Some(self.source)
    }
}