provenant/parsers/

yarn_lock.rs

// SPDX-FileCopyrightText: nexB Inc. and others
// ScanCode is a trademark of nexB Inc.
// SPDX-FileCopyrightText: Provenant contributors
// SPDX-License-Identifier: Apache-2.0
// Derived from ScanCode Toolkit (Apache-2.0); modified. See NOTICE.

//! Parser for Yarn yarn.lock lockfiles.
//!
//! Extracts resolved dependency information from Yarn lockfiles supporting both
//! Yarn Classic (v1) and Yarn Berry (v2+) formats with different syntax and structures.
//!
//! # Supported Formats
//! - yarn.lock (Classic v1 format - key-value style)
//! - yarn.lock (Berry v2+ format - YAML-like structure with different key format)
//!
//! # Key Features
//! - Multi-format support for Yarn Classic and Berry versions
//! - Direct vs transitive dependency tracking (`is_direct`)
//! - Integrity hash extraction (sha1, sha512, sha256)
//! - Package URL (purl) generation for scoped and unscoped packages
//! - Workspace and monorepo dependency resolution
//!
//! # Implementation Notes
//! - v1 format: `"@scope/name@version"` keys with nested `version` and `integrity` fields
//! - v2+ format: Similar structure but different key generation with workspace awareness
//! - All lockfile versions are pinned (`is_pinned: Some(true)`)
//! - Graceful error handling with `warn!()` logs

use crate::models::{
    DatasourceId, Dependency, PackageData, PackageType, ResolvedPackage, Sha512Digest,
};
use crate::parser_warn as warn;
use crate::parsers::utils::{capped_iteration_limit, npm_purl, parse_sri, truncate_field};
use serde_json::Value as JsonValue;
use std::collections::{HashMap, HashSet};
use std::path::Path;
use yaml_serde::Value;

use super::PackageParser;

/// Yarn lockfile parser supporting both Yarn Classic (v1) and Berry (v2+) formats.
///
/// Extracts pinned dependency versions with integrity hashes from yarn.lock files.
pub struct YarnLockParser;

#[derive(Clone, Debug, PartialEq, Eq)]
struct ManifestDependencyInfo {
    scope: &'static str,
    is_runtime: bool,
    is_optional: bool,
}

impl PackageParser for YarnLockParser {
    const PACKAGE_TYPE: PackageType = PackageType::Npm;

    fn is_match(path: &Path) -> bool {
        path.file_name()
            .and_then(|name| name.to_str())
            .map(|name| name == "yarn.lock")
            .unwrap_or(false)
    }

    fn extract_packages(path: &Path) -> Vec<PackageData> {
        let content = match crate::parsers::utils::read_file_to_string(path, None) {
            Ok(content) => content,
            Err(e) => {
                warn!("Failed to read yarn.lock at {:?}: {}", path, e);
                return vec![default_package_data(Some(DatasourceId::YarnLock))];
            }
        };

        let is_v2 = detect_yarn_version(&content);
        let manifest_dependencies = load_manifest_dependency_info(path);

        vec![if is_v2 {
            parse_yarn_v2(&content, &manifest_dependencies)
        } else {
            parse_yarn_v1(&content, &manifest_dependencies)
        }]
    }

    fn metadata() -> Vec<super::metadata::ParserMetadata> {
        vec![super::metadata::ParserMetadata {
            description: "yarn.lock lockfile (v1 and v2+)",
            file_patterns: &["**/yarn.lock"],
            package_type: "npm",
            primary_language: "JavaScript",
            documentation_url: Some("https://classic.yarnpkg.com/lang/en/docs/yarn-lock/"),
        }]
    }
}

/// Detect if yarn.lock is v2 (has __metadata) or v1 (has "yarn lockfile v1")
pub fn detect_yarn_version(content: &str) -> bool {
    content
        .lines()
        .take(10)
        .any(|line| line.contains("__metadata:"))
}

/// Parse yarn.lock v2 format (standard YAML)
fn parse_yarn_v2(
    content: &str,
    manifest_dependencies: &HashMap<String, ManifestDependencyInfo>,
) -> PackageData {
    let yaml_value: Value = match yaml_serde::from_str(content) {
        Ok(val) => val,
        Err(e) => {
            warn!("Failed to parse yarn.lock v2 YAML: {}", e);
            return default_package_data(Some(DatasourceId::YarnLockV2));
        }
    };

    let yaml_map = match yaml_value.as_mapping() {
        Some(map) => map,
        None => return default_package_data(Some(DatasourceId::YarnLockV2)),
    };

    let mut dependencies = Vec::new();
    let package_extra_data = extract_yarn_v2_package_extra_data(yaml_map);

    let limit = capped_iteration_limit(yaml_map.len(), "yarn.lock v2 entries");
    for (spec, details) in yaml_map.iter().take(limit) {
        if spec.as_str().map(|s| s == "__metadata").unwrap_or(false) {
            continue;
        }

        let _spec_str = match spec.as_str() {
            Some(s) => s,
            None => continue,
        };

        let details_map = match details.as_mapping() {
            Some(map) => map,
            None => continue,
        };

        let resolution = extract_yaml_string(details_map, "resolution").unwrap_or_default();

        let (namespace_opt, name, resolved_version) = parse_yarn_v2_resolution(&resolution);
        let namespace = namespace_opt.map(truncate_field).unwrap_or_default();
        let name = truncate_field(name);
        let resolved_version = truncate_field(resolved_version);
        let full_name = full_package_name(&namespace, &name);
        let manifest_info = manifest_dependencies.get(&full_name);
        let purl = create_purl(&namespace, &name, &resolved_version).map(truncate_field);
        let checksum = extract_yaml_string(details_map, "checksum").map(truncate_field);

        let deps_yaml = details_map.get("dependencies");
        let peer_deps_yaml = details_map.get("peerDependencies");
        let resolved_extra_data = extract_yarn_v2_resolved_extra_data(details_map, &resolution);

        let nested_deps = parse_yaml_dependencies(deps_yaml);
        let peer_deps = parse_yaml_dependencies(peer_deps_yaml);

        let all_deps = if peer_deps.is_empty() {
            nested_deps
        } else {
            let mut combined = nested_deps;
            for mut dep in peer_deps {
                dep.scope = Some("peerDependencies".to_string());
                dep.is_optional = Some(true);
                dep.is_runtime = Some(false);
                combined.push(dep);
            }
            combined
        };

        let resolved_package = ResolvedPackage {
            primary_language: Some("JavaScript".to_string()),
            download_url: None,
            sha1: None,
            sha256: None,
            sha512: checksum.and_then(|h| Sha512Digest::from_hex(&h).ok()),
            md5: None,
            is_virtual: true,
            extra_data: resolved_extra_data,
            dependencies: all_deps,
            repository_homepage_url: None,
            repository_download_url: None,
            api_data_url: None,
            datasource_id: Some(DatasourceId::YarnLockV2),
            purl: None,
            ..ResolvedPackage::new(
                YarnLockParser::PACKAGE_TYPE,
                namespace.clone(),
                name.clone(),
                resolved_version.clone(),
            )
        };

        let (scope, is_runtime, is_optional, is_direct) = manifest_info
            .map(|info| {
                (
                    Some(info.scope.to_string()),
                    Some(info.is_runtime),
                    Some(info.is_optional),
                    Some(true),
                )
            })
            .unwrap_or((None, None, None, None));

        let dependency = Dependency {
            purl,
            extracted_requirement: Some(truncate_field(resolved_version.clone())),
            scope,
            is_runtime,
            is_optional,
            is_pinned: Some(true),
            is_direct,
            resolved_package: Some(Box::new(resolved_package)),
            extra_data: Some(HashMap::from([(
                "resolution".to_string(),
                JsonValue::String(truncate_field(resolution)),
            )])),
        };

        dependencies.push(dependency);
    }

    PackageData {
        package_type: Some(YarnLockParser::PACKAGE_TYPE),
        namespace: None,
        name: None,
        version: None,
        qualifiers: None,
        subpath: None,
        primary_language: None,
        description: None,
        release_date: None,
        parties: Vec::new(),
        keywords: Vec::new(),
        homepage_url: None,
        download_url: None,
        size: None,
        sha1: None,
        md5: None,
        sha256: None,
        sha512: None,
        bug_tracking_url: None,
        code_view_url: None,
        vcs_url: None,
        copyright: None,
        holder: None,
        declared_license_expression: None,
        declared_license_expression_spdx: None,
        license_detections: Vec::new(),
        other_license_expression: None,
        other_license_expression_spdx: None,
        other_license_detections: Vec::new(),
        extracted_license_statement: None,
        notice_text: None,
        source_packages: Vec::new(),
        file_references: Vec::new(),
        is_private: false,
        is_virtual: false,
        extra_data: package_extra_data,
        dependencies,
        repository_homepage_url: None,
        repository_download_url: None,
        api_data_url: None,
        datasource_id: Some(DatasourceId::YarnLockV2),
        purl: None,
    }
}

/// Parse yarn.lock v1 format (custom YAML-like)
fn parse_yarn_v1(
    content: &str,
    manifest_dependencies: &HashMap<String, ManifestDependencyInfo>,
) -> PackageData {
    let mut dependencies = Vec::new();
    let mut seen_purls = HashSet::new();

    let block_count = content.split("\n\n").count();
    let limit = capped_iteration_limit(block_count, "yarn.lock v1 blocks");
    for block in content.split("\n\n").take(limit) {
        if is_empty_or_comment_block(block) {
            continue;
        }

        if let Some(dep) = parse_yarn_v1_block(block, manifest_dependencies) {
            if let Some(ref purl) = dep.purl {
                if seen_purls.insert(purl.clone()) {
                    dependencies.push(dep);
                }
            } else {
                dependencies.push(dep);
            }
        }
    }

    PackageData {
        package_type: Some(YarnLockParser::PACKAGE_TYPE),
        namespace: None,
        name: None,
        version: None,
        qualifiers: None,
        subpath: None,
        primary_language: None,
        description: None,
        release_date: None,
        parties: Vec::new(),
        keywords: Vec::new(),
        homepage_url: None,
        download_url: None,
        size: None,
        sha1: None,
        md5: None,
        sha256: None,
        sha512: None,
        bug_tracking_url: None,
        code_view_url: None,
        vcs_url: None,
        copyright: None,
        holder: None,
        declared_license_expression: None,
        declared_license_expression_spdx: None,
        license_detections: Vec::new(),
        other_license_expression: None,
        other_license_expression_spdx: None,
        other_license_detections: Vec::new(),
        extracted_license_statement: None,
        notice_text: None,
        source_packages: Vec::new(),
        file_references: Vec::new(),
        is_private: false,
        is_virtual: false,
        extra_data: None,
        dependencies,
        repository_homepage_url: None,
        repository_download_url: None,
        api_data_url: None,
        datasource_id: Some(DatasourceId::YarnLockV1),
        purl: None,
    }
}

fn is_empty_or_comment_block(block: &str) -> bool {
    block
        .lines()
        .all(|line| line.trim().is_empty() || line.trim().starts_with('#'))
}

/// Parse integrity field (format: "sha512-base64string==")
fn parse_integrity_field(integrity: &str) -> Option<String> {
    parse_sri(integrity).and_then(|(algo, hex_digest)| {
        if algo == "sha512" {
            Some(hex_digest)
        } else {
            None
        }
    })
}

/// Extract namespace and name from package name ("@types/node" -> ("@types", "node"))
pub fn extract_namespace_and_name(package_name: &str) -> (String, String) {
    if package_name.starts_with('@') {
        let parts: Vec<&str> = package_name.splitn(2, '/').collect();
        if parts.len() == 2 {
            (parts[0].to_string(), parts[1].to_string())
        } else {
            (String::new(), package_name.to_string())
        }
    } else {
        (String::new(), package_name.to_string())
    }
}

fn create_purl(namespace: &str, name: &str, version: &str) -> Option<String> {
    let full_name = if namespace.is_empty() {
        name.to_string()
    } else {
        format!("{}/{}", namespace, name)
    };
    let version_opt = if version.is_empty() {
        None
    } else {
        Some(version)
    };
    npm_purl(&full_name, version_opt)
}

fn default_package_data(datasource_id: Option<DatasourceId>) -> PackageData {
    PackageData {
        package_type: Some(YarnLockParser::PACKAGE_TYPE),
        datasource_id,
        ..Default::default()
    }
}

/// Parse a single yarn v1 dependency block
fn parse_yarn_v1_block(
    block: &str,
    manifest_dependencies: &HashMap<String, ManifestDependencyInfo>,
) -> Option<Dependency> {
    let lines: Vec<&str> = block.lines().collect();
    if lines.is_empty() {
        return None;
    }

    let requirement_index = lines.iter().position(|line| {
        let trimmed = line.trim();
        !trimmed.is_empty() && !trimmed.starts_with('#')
    })?;

    let requirement_line = lines[requirement_index]
        .trim()
        .strip_suffix(':')
        .unwrap_or_else(|| lines[requirement_index].trim())
        .trim_matches('"');
    if requirement_line.is_empty() {
        return None;
    }

    let (namespace, name, constraint) = parse_yarn_v1_requirement(requirement_line);
    let namespace = truncate_field(namespace);
    let name = truncate_field(name);
    let constraint = truncate_field(constraint);

    if name.is_empty() {
        return None;
    }

    let mut version = String::new();
    let mut resolved_url = String::new();
    let mut integrity = String::new();
    let mut nested_deps = Vec::new();

    for line in &lines[requirement_index + 1..] {
        let trimmed = line.trim();
        if trimmed.is_empty() {
            continue;
        }

        if trimmed.starts_with("version") {
            version = truncate_field(extract_quoted_value(trimmed).unwrap_or_default());
        } else if trimmed.starts_with("resolved") {
            resolved_url = truncate_field(extract_quoted_value(trimmed).unwrap_or_default());
        } else if trimmed.starts_with("integrity") {
            integrity = truncate_field(
                trimmed
                    .strip_prefix("integrity")
                    .map(|s| s.trim().to_string())
                    .unwrap_or_default(),
            );
        } else if trimmed.starts_with("dependencies") {
            // Dependencies block - parse indented lines
            continue;
        } else if trimmed.starts_with("  ") && !trimmed.starts_with("    ") {
            // Dependency line (2-space indent)
            let dep_line = trimmed.trim();
            if let Some(dep) = parse_yarn_v1_dependency_line(dep_line, &namespace, &name, &version)
            {
                nested_deps.push(dep);
            }
        }
    }

    let sha512 = if integrity.is_empty() {
        None
    } else {
        parse_integrity_field(&integrity)
    };

    let full_name = full_package_name(&namespace, &name);
    let manifest_info = manifest_dependencies.get(&full_name);
    let purl = create_purl(&namespace, &name, &version).map(truncate_field);
    let (scope, is_runtime, is_optional, is_direct) = manifest_info
        .map(|info| {
            (
                Some(info.scope.to_string()),
                Some(info.is_runtime),
                Some(info.is_optional),
                Some(true),
            )
        })
        .unwrap_or((None, None, None, None));

    let resolved_package = ResolvedPackage {
        primary_language: Some("JavaScript".to_string()),
        download_url: if resolved_url.is_empty() {
            None
        } else {
            Some(resolved_url)
        },
        sha1: None,
        sha256: None,
        sha512: sha512.and_then(|h| Sha512Digest::from_hex(&h).ok()),
        md5: None,
        is_virtual: true,
        extra_data: None,
        dependencies: nested_deps,
        repository_homepage_url: None,
        repository_download_url: None,
        api_data_url: None,
        datasource_id: Some(DatasourceId::YarnLockV1),
        purl: None,
        ..ResolvedPackage::new(
            YarnLockParser::PACKAGE_TYPE,
            namespace.clone(),
            name.clone(),
            version.clone(),
        )
    };

    Some(Dependency {
        purl,
        extracted_requirement: Some(constraint),
        scope,
        is_runtime,
        is_optional,
        is_pinned: Some(true),
        is_direct,
        resolved_package: Some(Box::new(resolved_package)),
        extra_data: None,
    })
}

fn full_package_name(namespace: &str, name: &str) -> String {
    if namespace.is_empty() {
        name.to_string()
    } else {
        format!("{namespace}/{name}")
    }
}

fn load_manifest_dependency_info(path: &Path) -> HashMap<String, ManifestDependencyInfo> {
    let Some(parent) = path.parent() else {
        return HashMap::new();
    };

    let manifest_path = parent.join("package.json");
    let Ok(content) = crate::parsers::utils::read_file_to_string(&manifest_path, None) else {
        return HashMap::new();
    };

    let Ok(json) = serde_json::from_str::<JsonValue>(&content) else {
        return HashMap::new();
    };

    let peer_optional = json
        .get("peerDependenciesMeta")
        .and_then(|value| value.as_object())
        .map(|meta| {
            meta.iter()
                .filter_map(|(name, value)| {
                    value
                        .as_object()
                        .and_then(|entry| entry.get("optional"))
                        .and_then(|value| value.as_bool())
                        .map(|optional| (name.clone(), optional))
                })
                .collect::<HashMap<_, _>>()
        })
        .unwrap_or_default();

    let mut dependencies = HashMap::new();
    insert_manifest_dependency_info(
        &mut dependencies,
        &json,
        "dependencies",
        ManifestDependencyInfo {
            scope: "dependencies",
            is_runtime: true,
            is_optional: false,
        },
    );
    insert_manifest_dependency_info(
        &mut dependencies,
        &json,
        "devDependencies",
        ManifestDependencyInfo {
            scope: "devDependencies",
            is_runtime: false,
            is_optional: true,
        },
    );
    insert_manifest_dependency_info(
        &mut dependencies,
        &json,
        "optionalDependencies",
        ManifestDependencyInfo {
            scope: "optionalDependencies",
            is_runtime: true,
            is_optional: true,
        },
    );

    if let Some(peer_dependencies) = json
        .get("peerDependencies")
        .and_then(|value| value.as_object())
    {
        let limit =
            capped_iteration_limit(peer_dependencies.len(), "yarn manifest peerDependencies");
        for name in peer_dependencies.keys().take(limit) {
            dependencies.insert(
                name.clone(),
                ManifestDependencyInfo {
                    scope: "peerDependencies",
                    is_runtime: false,
                    is_optional: peer_optional.get(name).copied().unwrap_or(false),
                },
            );
        }
    }

    dependencies
}

fn insert_manifest_dependency_info(
    dependencies: &mut HashMap<String, ManifestDependencyInfo>,
    json: &JsonValue,
    field: &str,
    info: ManifestDependencyInfo,
) {
    if let Some(entries) = json.get(field).and_then(|value| value.as_object()) {
        let context = format!("yarn manifest {field}");
        let limit = capped_iteration_limit(entries.len(), &context);
        for name in entries.keys().take(limit) {
            dependencies.insert(name.clone(), info.clone());
        }
    }
}

/// Parse yarn v1 requirement line: "express@^4.0.0" or "@babel/core@^7.1.0"
pub fn parse_yarn_v1_requirement(line: &str) -> (String, String, String) {
    // Handle multiple aliases: "rimraf@2, rimraf@~2.5.1"
    if line.contains(", ") {
        // Use the first part for parsing
        let first_part = line.split(", ").next().unwrap_or(line);
        return parse_single_yarn_v1_requirement(first_part);
    }
    parse_single_yarn_v1_requirement(line)
}

/// Parse a single yarn v1 requirement
fn parse_single_yarn_v1_requirement(line: &str) -> (String, String, String) {
    if let Some(at_pos) = line.rfind('@') {
        let name_part = &line[..at_pos];
        let constraint = &line[at_pos + 1..];

        // Yarn classic "npm:" alias keys map an alias name to a different
        // resolved package, e.g. `react-loadable@npm:@docusaurus/react-loadable@6.0.0`
        // resolves to `@docusaurus/react-loadable@6.0.0`. Report the aliased
        // target so the emitted purl matches the package actually installed.
        let (namespace, name) = resolve_npm_alias_name(name_part);

        if !name.is_empty() {
            return (namespace, name, constraint.to_string());
        }
    }

    (String::new(), String::new(), String::new())
}

/// Resolve the namespace/name from the pre-version portion of a yarn v1
/// requirement key, unwrapping a `@npm:` alias when present.
///
/// For a plain key part such as `@types/node` this behaves exactly like
/// [`extract_namespace_and_name`]. For an alias key part such as
/// `react-loadable@npm:@docusaurus/react-loadable` it returns the aliased
/// target (`@docusaurus`, `react-loadable`).
fn resolve_npm_alias_name(name_part: &str) -> (String, String) {
    if let Some(npm_idx) = name_part.find("@npm:") {
        let aliased_target = &name_part[npm_idx + "@npm:".len()..];
        if !aliased_target.is_empty() {
            return extract_namespace_and_name(aliased_target);
        }
    }

    extract_namespace_and_name(name_part)
}

/// Parse a dependency line from yarn v1 block: "\"dep@^1.0.0\""
fn parse_yarn_v1_dependency_line(
    line: &str,
    _parent_namespace: &str,
    _parent_name: &str,
    parent_version: &str,
) -> Option<Dependency> {
    let trimmed = line.trim_matches('"');
    if !trimmed.contains('@') {
        return None;
    }

    let (namespace, name, constraint) = parse_yarn_v1_requirement(trimmed);
    let namespace = truncate_field(namespace);
    let name = truncate_field(name);
    let constraint = truncate_field(constraint);

    let purl = create_purl(&namespace, &name, parent_version).map(truncate_field);

    Some(Dependency {
        purl,
        extracted_requirement: Some(constraint),
        scope: Some("dependencies".to_string()),
        is_runtime: Some(true),
        is_optional: Some(false),
        is_pinned: Some(false),
        is_direct: Some(false),
        resolved_package: None,
        extra_data: None,
    })
}

/// Extract value from quoted line: 'version "1.0.0"' -> "1.0.0"
fn extract_quoted_value(line: &str) -> Option<String> {
    line.find('"').and_then(|start| {
        let rest = &line[start + 1..];
        rest.find('"').map(|end| rest[..end].to_string())
    })
}

/// Parse yarn v2 resolution: "@actions/core@npm:1.2.6" -> ("@actions", "core", "1.2.6")
pub fn parse_yarn_v2_resolution(resolution: &str) -> (Option<String>, String, String) {
    if resolution.contains("@npm:") {
        let parts: Vec<&str> = resolution.split("@npm:").collect();
        if parts.len() == 2 {
            let package_name = parts[0];
            let version = parts[1];
            let (namespace, name) = extract_namespace_and_name(package_name);
            let namespace_opt = if namespace.is_empty() {
                None
            } else {
                Some(namespace)
            };
            return (namespace_opt, name, version.to_string());
        }
    }

    if let Some((ident, reference)) = split_yarn_locator(resolution) {
        let (namespace, name) = extract_namespace_and_name(ident);
        let namespace_opt = if namespace.is_empty() {
            None
        } else {
            Some(namespace)
        };
        return (namespace_opt, name, reference.to_string());
    }

    let (namespace, name) = extract_namespace_and_name(resolution);
    let namespace_opt = if namespace.is_empty() {
        None
    } else {
        Some(namespace)
    };
    (namespace_opt, name, "*".to_string())
}

fn split_yarn_locator(resolution: &str) -> Option<(&str, &str)> {
    if resolution.is_empty() {
        return None;
    }

    let separator_index = if resolution.starts_with('@') {
        let slash_index = resolution.find('/')?;
        let rest = &resolution[slash_index + 1..];
        let at_index = rest.find('@')?;
        slash_index + 1 + at_index
    } else {
        resolution.find('@')?
    };

    let ident = &resolution[..separator_index];
    let reference = &resolution[separator_index + 1..];

    if ident.is_empty() || reference.is_empty() {
        None
    } else {
        Some((ident, reference))
    }
}

fn extract_yarn_v2_package_extra_data(
    yaml_map: &yaml_serde::Mapping,
) -> Option<HashMap<String, JsonValue>> {
    let metadata = yaml_map.get("__metadata")?.as_mapping()?;
    let mut extra_data = HashMap::new();

    for field in ["version", "cacheKey"] {
        if let Some(value) = metadata.get(field).and_then(yaml_value_to_json) {
            extra_data.insert(field.to_string(), value);
        }
    }

    (!extra_data.is_empty()).then_some(extra_data)
}

fn extract_yarn_v2_resolved_extra_data(
    details_map: &yaml_serde::Mapping,
    resolution: &str,
) -> Option<HashMap<String, JsonValue>> {
    let mut extra_data = HashMap::new();
    extra_data.insert(
        "resolution".to_string(),
        JsonValue::String(truncate_field(resolution.to_string())),
    );

    for field in ["languageName", "linkType", "bin", "dependenciesMeta"] {
        if let Some(value) = details_map.get(field).and_then(yaml_value_to_json) {
            extra_data.insert(field.to_string(), value);
        }
    }

    Some(extra_data)
}

fn yaml_value_to_json(value: &Value) -> Option<JsonValue> {
    serde_json::to_value(value).ok()
}

/// Extract string value from YAML mapping
fn extract_yaml_string(map: &yaml_serde::Mapping, key: &str) -> Option<String> {
    map.get(key).and_then(|v| v.as_str()).map(|s| s.to_string())
}

/// Parse dependencies from YAML Value
fn parse_yaml_dependencies(yaml_value: Option<&Value>) -> Vec<Dependency> {
    let mut dependencies = Vec::new();

    if let Some(deps_value) = yaml_value
        && let Some(mapping) = deps_value.as_mapping()
    {
        let limit = capped_iteration_limit(mapping.len(), "yarn.lock v2 nested dependencies");
        for (key, value) in mapping.iter().take(limit) {
            let name = match key.as_str() {
                Some(s) => s.to_string(),
                None => continue,
            };

            let constraint = match value.as_str() {
                Some(s) => s.to_string(),
                None => "*".to_string(),
            };

            let (namespace, dep_name) = extract_namespace_and_name(&name);
            let namespace = truncate_field(namespace);
            let dep_name = truncate_field(dep_name);
            let constraint = truncate_field(constraint);
            let purl = create_purl(&namespace, &dep_name, &constraint).map(truncate_field);

            dependencies.push(Dependency {
                purl,
                extracted_requirement: Some(constraint),
                scope: Some("dependencies".to_string()),
                is_runtime: Some(true),
                is_optional: Some(false),
                is_pinned: Some(false),
                is_direct: Some(false),
                resolved_package: None,
                extra_data: None,
            });
        }
    }
    dependencies
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::PathBuf;

    #[test]
    fn test_is_match_yarn_lock() {
        let valid_path = PathBuf::from("/some/path/yarn.lock");
        assert!(YarnLockParser::is_match(&valid_path));
    }

    #[test]
    fn test_is_not_match_package_json() {
        let invalid_path = PathBuf::from("/some/path/package.json");
        assert!(!YarnLockParser::is_match(&invalid_path));
    }

    #[test]
    fn test_detect_yarn_v2() {
        let content = r#"# This file is generated by running "yarn install"
__metadata:
  version: 6
"#;
        assert!(detect_yarn_version(content));
    }

    #[test]
    fn test_detect_yarn_v1() {
        let content = r#"# THIS IS AN AUTOGENERATED FILE
# yarn lockfile v1

abbrev@1:
  version "1.0.9"
"#;
        assert!(!detect_yarn_version(content));
    }

    #[test]
    fn test_parse_yarn_v2_uses_yarn_lock_v2_datasource_ids() {
        let content = r#"# This file is generated by running \"yarn install\"
__metadata:
  version: 6

lodash@npm:^4.17.21:
  version: 4.17.21
  resolution: "lodash@npm:4.17.21"
"#;

        let package_data = parse_yarn_v2(content, &HashMap::new());

        assert_eq!(package_data.datasource_id, Some(DatasourceId::YarnLockV2));
        assert_eq!(
            package_data.dependencies[0]
                .resolved_package
                .as_ref()
                .and_then(|pkg| pkg.datasource_id),
            Some(DatasourceId::YarnLockV2)
        );
    }

    #[test]
    fn test_parse_yarn_v1_uses_yarn_lock_v1_datasource_ids() {
        let content = r#"# THIS IS AN AUTOGENERATED FILE
# yarn lockfile v1

left-pad@^1.3.0:
  version \"1.3.0\"
"#;

        let package_data = parse_yarn_v1(content, &HashMap::new());

        assert_eq!(package_data.datasource_id, Some(DatasourceId::YarnLockV1));
        assert_eq!(
            package_data.dependencies[0]
                .resolved_package
                .as_ref()
                .and_then(|pkg| pkg.datasource_id),
            Some(DatasourceId::YarnLockV1)
        );
    }

    #[test]
    fn test_extract_namespace_and_name_scoped() {
        let (namespace, name) = extract_namespace_and_name("@types/node");
        assert_eq!(namespace, "@types");
        assert_eq!(name, "node");
    }

    #[test]
    fn test_extract_namespace_and_name_regular() {
        let (namespace, name) = extract_namespace_and_name("express");
        assert_eq!(namespace, "");
        assert_eq!(name, "express");
    }

    #[test]
    fn test_parse_yarn_v1_requirement() {
        let (namespace, name, constraint) = parse_yarn_v1_requirement("express@^4.0.0");
        assert_eq!(namespace, "");
        assert_eq!(name, "express");
        assert_eq!(constraint, "^4.0.0");
    }

    #[test]
    fn test_parse_yarn_v1_requirement_scoped() {
        let (namespace, name, constraint) = parse_yarn_v1_requirement("@types/node@^18.0.0");
        assert_eq!(namespace, "@types");
        assert_eq!(name, "node");
        assert_eq!(constraint, "^18.0.0");
    }

    #[test]
    fn test_parse_yarn_v2_resolution() {
        let (namespace, name, version) = parse_yarn_v2_resolution("@actions/core@npm:1.2.6");
        assert_eq!(namespace, Some("@actions".to_string()));
        assert_eq!(name, "core");
        assert_eq!(version, "1.2.6");
    }

    #[test]
    fn test_parse_yarn_v1_requirement_npm_alias_scoped_target() {
        // `react-loadable@npm:@docusaurus/react-loadable@6.0.0` resolves to the
        // aliased target `@docusaurus/react-loadable@6.0.0`.
        let (namespace, name, constraint) =
            parse_yarn_v1_requirement("react-loadable@npm:@docusaurus/react-loadable@6.0.0");
        assert_eq!(namespace, "@docusaurus");
        assert_eq!(name, "react-loadable");
        assert_eq!(constraint, "6.0.0");
    }

    #[test]
    fn test_parse_yarn_v1_requirement_npm_alias_renames_scope() {
        let (namespace, name, constraint) =
            parse_yarn_v1_requirement("ajv@npm:@redocly/ajv@8.18.0");
        assert_eq!(namespace, "@redocly");
        assert_eq!(name, "ajv");
        assert_eq!(constraint, "8.18.0");
    }

    #[test]
    fn test_parse_yarn_v1_requirement_npm_alias_unscoped_target() {
        // `cliui@npm:@isaacs/cliui@8.0.2` aliases an unscoped name onto a
        // scoped target; the unscoped alias form must still unwrap cleanly.
        let (namespace, name, constraint) =
            parse_yarn_v1_requirement("string-width@npm:string-width-cjs@4.2.3");
        assert_eq!(namespace, "");
        assert_eq!(name, "string-width-cjs");
        assert_eq!(constraint, "4.2.3");
    }

    #[test]
    fn test_parse_yarn_v1_block_npm_alias_emits_aliased_purl() {
        let content = r#"# THIS IS AN AUTOGENERATED FILE
# yarn lockfile v1

"react-loadable@npm:@docusaurus/react-loadable@6.0.0":
  version "6.0.0"
  resolved "https://registry.npmjs.org/@docusaurus/react-loadable/-/react-loadable-6.0.0.tgz"
  integrity sha512-YMMxTUQV/QFSnbgrP3tjDzLHRg7vsbMn8e9HAa8o/1iXoiomo48b7sk/kkmWEuWNDPJVlKSJRB6Y2fHqdJk+SQ==
"#;

        let package_data = parse_yarn_v1(content, &HashMap::new());

        assert_eq!(package_data.dependencies.len(), 1);
        let dep = &package_data.dependencies[0];
        assert_eq!(
            dep.purl.as_deref(),
            Some("pkg:npm/%40docusaurus/react-loadable@6.0.0")
        );
        let resolved = dep
            .resolved_package
            .as_ref()
            .expect("aliased dependency should carry a resolved package");
        assert_eq!(resolved.namespace, "@docusaurus");
        assert_eq!(resolved.name, "react-loadable");
        assert_eq!(resolved.version, "6.0.0");
    }
}