turbopack_resolve/

node_native_binding.rs

use std::sync::LazyLock;

use anyhow::{Result, bail};
use regex::Regex;
use serde::Deserialize;
use turbo_rcstr::{RcStr, rcstr};
use turbo_tasks::{FxIndexMap, ResolvedVc, TryFlatJoinIterExt, TryJoinIterExt, ValueToString, Vc};
use turbo_tasks_fs::{
    DirectoryContent, DirectoryEntry, FileContent, FileSystemEntryType, FileSystemPath,
    json::parse_json_rope_with_source_context,
};
use turbopack_core::{
    asset::{Asset, AssetContent},
    chunk::{ChunkingType, TracedMode},
    file_source::FileSource,
    raw_module::RawModule,
    reference::ModuleReference,
    resolve::{ModuleResolveResult, RequestKey, ResolveResultItem, pattern::Pattern, resolve_raw},
    source::Source,
    target::{CompileTarget, Platform},
};

#[derive(Deserialize, Debug)]
struct NodePreGypConfigJson {
    binary: NodePreGypConfig,
}

#[derive(Deserialize, Debug)]
struct NodePreGypConfig {
    module_name: String,
    module_path: String,
    napi_versions: Vec<u32>,
}

#[turbo_tasks::value]
#[derive(Hash, Clone, Debug, ValueToString)]
#[value_to_string("node-gyp in {context_dir} with {config_file_pattern} for {compile_target}")]
pub struct NodePreGypConfigReference {
    pub context_dir: FileSystemPath,
    pub config_file_pattern: ResolvedVc<Pattern>,
    pub compile_target: ResolvedVc<CompileTarget>,
    pub collect_affecting_sources: bool,
}

#[turbo_tasks::value_impl]
impl NodePreGypConfigReference {
    #[turbo_tasks::function]
    pub fn new(
        context_dir: FileSystemPath,
        config_file_pattern: ResolvedVc<Pattern>,
        compile_target: ResolvedVc<CompileTarget>,
        collect_affecting_sources: bool,
    ) -> Vc<Self> {
        Self::cell(NodePreGypConfigReference {
            context_dir,
            config_file_pattern,
            compile_target,
            collect_affecting_sources,
        })
    }
}

#[turbo_tasks::value_impl]
impl ModuleReference for NodePreGypConfigReference {
    #[turbo_tasks::function]
    async fn resolve_reference(&self) -> Result<Vc<ModuleResolveResult>> {
        resolve_node_pre_gyp_files(
            self.context_dir.clone(),
            *self.config_file_pattern,
            *self.compile_target,
            self.collect_affecting_sources,
        )
        .await
    }

    fn chunking_type(&self) -> Option<ChunkingType> {
        Some(ChunkingType::Traced {
            mode: TracedMode::Transitive,
        })
    }
}

async fn resolve_node_pre_gyp_files(
    context_dir: FileSystemPath,
    config_file_pattern: Vc<Pattern>,
    compile_target: Vc<CompileTarget>,
    collect_affecting_sources: bool,
) -> Result<Vc<ModuleResolveResult>> {
    static NAPI_VERSION_TEMPLATE: LazyLock<Regex> = LazyLock::new(|| {
        Regex::new(r"\{(napi_build_version|node_napi_label)\}")
            .expect("create napi_build_version regex failed")
    });
    static PLATFORM_TEMPLATE: LazyLock<Regex> =
        LazyLock::new(|| Regex::new(r"\{platform\}").expect("create node_platform regex failed"));
    static ARCH_TEMPLATE: LazyLock<Regex> =
        LazyLock::new(|| Regex::new(r"\{arch\}").expect("create node_arch regex failed"));
    static LIBC_TEMPLATE: LazyLock<Regex> =
        LazyLock::new(|| Regex::new(r"\{libc\}").expect("create node_libc regex failed"));
    let config = resolve_raw(
        context_dir,
        config_file_pattern,
        collect_affecting_sources,
        true,
    )
    .await?;
    let compile_target = compile_target.await?;
    if let Some(config_asset) = config.first_source()
        && let AssetContent::File(file) = &*config_asset.content().await?
        && let FileContent::Content(config_file) = &*file.await?
    {
        let config_asset_ident = config_asset.ident().await?;
        let config_file_path = &config_asset_ident.path;
        let mut affecting_paths = vec![config_file_path.clone()];
        let config_file_dir = config_file_path.parent();
        let node_pre_gyp_config: NodePreGypConfigJson =
            parse_json_rope_with_source_context(config_file.content())?;
        let mut sources: FxIndexMap<RcStr, Vc<Box<dyn Source>>> = FxIndexMap::default();
        for version in node_pre_gyp_config.binary.napi_versions.iter() {
            let native_binding_path = NAPI_VERSION_TEMPLATE.replace(
                node_pre_gyp_config.binary.module_path.as_str(),
                version.to_string(),
            );
            let platform = compile_target.platform;
            let native_binding_path =
                PLATFORM_TEMPLATE.replace(&native_binding_path, platform.as_str());
            let native_binding_path =
                ARCH_TEMPLATE.replace(&native_binding_path, compile_target.arch.as_str());
            let native_binding_path: RcStr = LIBC_TEMPLATE
                .replace(
                    &native_binding_path,
                    // node-pre-gyp only cares about libc on linux
                    if platform == Platform::Linux {
                        compile_target.libc.as_str()
                    } else {
                        "unknown"
                    },
                )
                .into();

            // Find all dynamic libraries in the given directory.
            if let DirectoryContent::Entries(entries) = &*config_file_dir
                .join(&native_binding_path)?
                .read_dir()
                .await?
            {
                let extension = compile_target.dylib_ext();
                for (key, entry) in entries.iter().filter(|(k, _)| k.ends_with(extension)) {
                    if let DirectoryEntry::File(dylib) | DirectoryEntry::Symlink(dylib) = entry {
                        sources.insert(
                            format!("{native_binding_path}/{key}").into(),
                            Vc::upcast(FileSource::new(dylib.clone())),
                        );
                    }
                }
            }

            let node_file_path: RcStr = format!(
                "{}/{}.node",
                native_binding_path, node_pre_gyp_config.binary.module_name
            )
            .into();
            let resolved_file_vc = config_file_dir.join(&node_file_path)?;
            if *resolved_file_vc.get_type().await? == FileSystemEntryType::File {
                sources.insert(
                    node_file_path,
                    Vc::upcast(FileSource::new(resolved_file_vc)),
                );
            }
        }
        if let DirectoryContent::Entries(entries) = &*config_file_dir
            // TODO
            // read the dependencies path from `bindings.gyp`
            .join("deps/lib")?
            .read_dir()
            .await?
        {
            for (key, entry) in entries.iter() {
                match entry {
                    DirectoryEntry::File(dylib) => {
                        sources.insert(
                            format!("deps/lib/{key}").into(),
                            Vc::upcast(FileSource::new(dylib.clone())),
                        );
                    }
                    DirectoryEntry::Symlink(dylib) => {
                        let realpath_with_links = dylib.realpath_with_links().await?;
                        for symlink in realpath_with_links.symlinks.iter() {
                            affecting_paths.push(symlink.clone());
                        }
                        sources.insert(
                            format!("deps/lib/{key}").into(),
                            Vc::upcast(FileSource::new(match &realpath_with_links.path_result {
                                Ok(path) => path.clone(),
                                Err(e) => {
                                    bail!(e.as_error_message(dylib, &realpath_with_links).await?)
                                }
                            })),
                        );
                    }
                    _ => {}
                }
            }
        }
        return Ok(*ModuleResolveResult::modules_with_affecting_sources(
            sources
                .into_iter()
                .map(|(key, source)| async move {
                    Ok((
                        RequestKey::new(key),
                        ResolvedVc::upcast(RawModule::new(source).to_resolved().await?),
                    ))
                })
                .try_join()
                .await?,
            affecting_paths
                .into_iter()
                .map(|p| async move {
                    anyhow::Ok(ResolvedVc::upcast(FileSource::new(p).to_resolved().await?))
                })
                .try_join()
                .await?,
        ));
    };
    Ok(*ModuleResolveResult::unresolvable())
}

#[turbo_tasks::value]
#[derive(Hash, Clone, Debug, ValueToString)]
#[value_to_string("node-gyp in {context_dir} for {compile_target}")]
pub struct NodeGypBuildReference {
    pub context_dir: FileSystemPath,
    collect_affecting_sources: bool,
    pub compile_target: ResolvedVc<CompileTarget>,
}

#[turbo_tasks::value_impl]
impl NodeGypBuildReference {
    #[turbo_tasks::function]
    pub fn new(
        context_dir: FileSystemPath,
        collect_affecting_sources: bool,
        compile_target: ResolvedVc<CompileTarget>,
    ) -> Vc<Self> {
        Self::cell(NodeGypBuildReference {
            context_dir,
            collect_affecting_sources,
            compile_target,
        })
    }
}

#[turbo_tasks::value_impl]
impl ModuleReference for NodeGypBuildReference {
    #[turbo_tasks::function]
    async fn resolve_reference(&self) -> Result<Vc<ModuleResolveResult>> {
        resolve_node_gyp_build_files(
            self.context_dir.clone(),
            self.collect_affecting_sources,
            self.compile_target,
        )
        .await
    }

    fn chunking_type(&self) -> Option<ChunkingType> {
        Some(ChunkingType::Traced {
            mode: TracedMode::Transitive,
        })
    }
}

async fn resolve_node_gyp_build_files(
    context_dir: FileSystemPath,
    collect_affecting_sources: bool,
    compile_target: ResolvedVc<CompileTarget>,
) -> Result<Vc<ModuleResolveResult>> {
    // TODO Proper parser
    static GYP_BUILD_TARGET_NAME: LazyLock<Regex> = LazyLock::new(|| {
        Regex::new(r#"['"]target_name['"]\s*:\s*(?:"(.*?)"|'(.*?)')"#)
            .expect("create napi_build_version regex failed")
    });
    let binding_gyp_pat = Pattern::new(Pattern::Constant(rcstr!("binding.gyp")));
    let gyp_file = resolve_raw(
        context_dir.clone(),
        binding_gyp_pat,
        collect_affecting_sources,
        true,
    );
    let gyp_file = gyp_file.await?;
    let mut primary_sources = gyp_file.primary_sources();
    if let (Some(binding_gyp), None) = (primary_sources.next(), primary_sources.next()) {
        let mut merged_affecting_sources = if collect_affecting_sources {
            gyp_file.get_affecting_sources().collect::<Vec<_>>()
        } else {
            Vec::new()
        };
        if let AssetContent::File(file) = &*binding_gyp.content().await?
            && let FileContent::Content(config_file) = &*file.await?
            && let Some(captured) = GYP_BUILD_TARGET_NAME.captures(&config_file.content().to_str()?)
        {
            let mut resolved: FxIndexMap<RcStr, ResolvedVc<Box<dyn Source>>> =
                FxIndexMap::with_capacity_and_hasher(captured.len(), Default::default());
            for found in captured.iter().skip(1).flatten() {
                let name = found.as_str();
                let target_path = context_dir.join("build/Release")?;
                let resolved_prebuilt_file = resolve_raw(
                    target_path,
                    Pattern::new(Pattern::Constant(format!("{name}.node").into())),
                    collect_affecting_sources,
                    true,
                )
                .await?;
                if let Some((_, ResolveResultItem::Source(source))) =
                    resolved_prebuilt_file.primary.first()
                {
                    resolved.insert(format!("build/Release/{name}.node").into(), *source);
                    if collect_affecting_sources {
                        merged_affecting_sources
                            .extend(resolved_prebuilt_file.affecting_sources.iter().copied());
                    }
                }
            }
            if !resolved.is_empty() {
                return Ok(*ModuleResolveResult::modules_with_affecting_sources(
                    resolved
                        .into_iter()
                        .map(|(key, source)| async move {
                            Ok((
                                RequestKey::new(key),
                                ResolvedVc::upcast(RawModule::new(*source).to_resolved().await?),
                            ))
                        })
                        .try_join()
                        .await?,
                    merged_affecting_sources,
                ));
            }
        }
    }
    let compile_target = compile_target.await?;
    let arch = compile_target.arch;
    let platform = compile_target.platform;
    let prebuilt_dir = format!("{platform}-{arch}");
    Ok(resolve_raw(
        context_dir,
        Pattern::new(Pattern::Concatenation(vec![
            Pattern::Constant(format!("prebuilds/{prebuilt_dir}/").into()),
            Pattern::Dynamic,
            Pattern::Constant(rcstr!(".node")),
        ])),
        collect_affecting_sources,
        true,
    )
    .as_raw_module_result())
}

#[turbo_tasks::value]
#[derive(Hash, Clone, Debug, ValueToString)]
#[value_to_string("bindings in {context_dir}")]
pub struct NodeBindingsReference {
    pub context_dir: FileSystemPath,
    pub file_name: RcStr,
    pub collect_affecting_sources: bool,
}

#[turbo_tasks::value_impl]
impl NodeBindingsReference {
    #[turbo_tasks::function]
    pub fn new(
        context_dir: FileSystemPath,
        file_name: RcStr,
        collect_affecting_sources: bool,
    ) -> Vc<Self> {
        Self::cell(NodeBindingsReference {
            context_dir,
            file_name,
            collect_affecting_sources,
        })
    }
}

#[turbo_tasks::value_impl]
impl ModuleReference for NodeBindingsReference {
    #[turbo_tasks::function]
    async fn resolve_reference(&self) -> Result<Vc<ModuleResolveResult>> {
        resolve_node_bindings_files(
            self.context_dir.clone(),
            self.file_name.clone(),
            self.collect_affecting_sources,
        )
        .await
    }

    fn chunking_type(&self) -> Option<ChunkingType> {
        Some(ChunkingType::Traced {
            mode: TracedMode::Transitive,
        })
    }
}

async fn resolve_node_bindings_files(
    context_dir: FileSystemPath,
    file_name: RcStr,
    collect_affecting_sources: bool,
) -> Result<Vc<ModuleResolveResult>> {
    static BINDINGS_TRY: LazyLock<[&'static str; 5]> = LazyLock::new(|| {
        [
            "build/bindings",
            "build/Release",
            "build/Release/bindings",
            "out/Release/bindings",
            "Release/bindings",
        ]
    });
    let mut root_context_dir = context_dir;
    loop {
        let resolved = resolve_raw(
            root_context_dir.clone(),
            Pattern::new(Pattern::Constant(rcstr!("package.json"))),
            collect_affecting_sources,
            true,
        )
        .await?;
        if let Some(asset) = resolved.first_source()
            && let AssetContent::File(file) = &*asset.content().await?
            && let FileContent::Content(_) = &*file.await?
        {
            break;
        };
        let current_context = root_context_dir.clone();
        let parent = root_context_dir.parent();
        if parent.path == current_context.path {
            break;
        }
        root_context_dir = parent;
    }

    let try_path = |sub_path: RcStr| async move {
        let path = root_context_dir.join(&sub_path)?;
        Ok(
            if matches!(*path.get_type().await?, FileSystemEntryType::File) {
                Some((
                    RequestKey::new(sub_path),
                    ResolvedVc::upcast(
                        RawModule::new(Vc::upcast(FileSource::new(path.clone())))
                            .to_resolved()
                            .await?,
                    ),
                ))
            } else {
                None
            },
        )
    };

    let modules = BINDINGS_TRY
        .iter()
        .map(|try_dir| try_path.clone()(format!("{}/{}", try_dir, file_name).into()))
        .try_flat_join()
        .await?;
    Ok(*ModuleResolveResult::modules(modules))
}