backhopper-core 0.37.0

// Copyright (C) 2026 Michael S. Klishin and Contributors
// SPDX-License-Identifier: Apache-2.0 OR MIT
// See LICENSE-APACHE and LICENSE-MIT for details.

//! Extractor for `m:f/a` references carried as arguments to a known
//! indirection form: meck expectations, `rpc:call`, `erpc:call`,
//! `rabbit_misc:rpc_call`, and the RabbitMQ CT broker rpc helpers. The
//! atoms naming the referenced function are argument payload to the
//! call-site extractor, so without this pass a test ported from a newer
//! branch can reference a function the target branch never had and the
//! target-tree axis reports nothing. One level of unwrapping covers a
//! meck expectation reached through an rpc helper, the observed
//! incident's shape.
//!
//! The same forms are read in Elixir sources, where the call is written
//! `:module.function(args)` and the argument atoms carry a leading `:`.
//! The referenced module is Erlang whatever the source language, so the
//! form table, the arity readers, and the unwrap are shared; only the
//! call-site matcher, the atom parser, and the comment stripper differ.
//!
//! A non-literal module or function is skipped without counting: it is
//! not a reference this axis claims to read. A literal `m:f` whose arity
//! source is unreadable is counted as withheld, never guessed.

use std::str::FromStr;
use std::sync::OnceLock;

use backhopper_erlang_scan::{
    ScannedArgs, ScannedList, is_bare_atom, scan_list_elements, scan_top_level_args,
};
use regex::Regex;

use crate::compat::call_sites::{
    BodyRun, body_runs_from_context, body_runs_with, call_re, line_context, run_line_at,
};
use crate::model::names::{Arity, FunctionName, Mfa, ModuleName};
use crate::model::symbol::LineClass;
use crate::model::verdict::IndirectCallForm;

/// Which source language a form was written in: selects the atom parser
/// and the fun-arity policy, nothing else.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Syntax {
    Erlang,
    Elixir,
}

impl Syntax {
    fn parse_atom(self, raw: &str) -> Option<String> {
        match self {
            Self::Erlang => parse_atom(raw),
            Self::Elixir => parse_elixir_atom(raw),
        }
    }

    /// Erlang reads a `fun` head or capture; Elixir withholds: no
    /// observed case passes a fun through an Elixir meck expectation,
    /// and the grammar is separate.
    fn fun_arity(self, raw: Option<&&str>) -> Option<Arity> {
        match self {
            Self::Erlang => raw.and_then(|a| fun_arity(a)),
            Self::Elixir => None,
        }
    }
}

/// One statically readable `m:f/a` carried as arguments to a
/// recognized indirection form.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct IndirectCallSite {
    pub mfa: Mfa,
    pub via: IndirectCallForm,
    pub line: u32,
}

/// An occurrence whose module and function were literal atoms but whose
/// arity source was not readable.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WithheldIndirectCall {
    pub module: ModuleName,
    pub function: FunctionName,
    pub line: u32,
}

/// Extraction result: the readable sites plus the occurrences whose arity
/// source was not readable.
#[derive(Debug, Default, PartialEq, Eq)]
pub struct IndirectExtraction {
    pub sites: Vec<IndirectCallSite>,
    pub withheld_dynamic: Vec<WithheldIndirectCall>,
}

impl IndirectExtraction {
    fn withhold(&mut self, module: ModuleName, function: FunctionName, line: u32) {
        self.withheld_dynamic.push(WithheldIndirectCall {
            module,
            function,
            line,
        });
    }
}

/// Where a recognized form carries its module, function, and arity.
/// Positions are argument indexes; the arity source names both the
/// index and how to read it.
struct FormSpec {
    via: IndirectCallForm,
    module_pos: usize,
    function_pos: usize,
    arity: AritySource,
}

enum AritySource {
    IntegerLiteral(usize),
    FunExpression(usize),
    ArgumentList(usize),
}

/// The form table, keyed by the called module, function, and argument
/// count. The CT broker helper is overloaded with the module at
/// different positions per arity, which is why the count is part of
/// the key.
fn form_spec(module: &str, function: &str, argc: usize) -> Option<FormSpec> {
    let spec = |via, module_pos, function_pos, arity| FormSpec {
        via,
        module_pos,
        function_pos,
        arity,
    };
    match (module, function, argc) {
        ("meck", "expect", 3) => Some(spec(
            IndirectCallForm::MeckExpect,
            0,
            1,
            AritySource::FunExpression(2),
        )),
        ("meck", "expect", 4) => Some(spec(
            IndirectCallForm::MeckExpect,
            0,
            1,
            AritySource::IntegerLiteral(2),
        )),
        ("rpc", "call", 4 | 5) => Some(spec(
            IndirectCallForm::RpcCall,
            1,
            2,
            AritySource::ArgumentList(3),
        )),
        ("rabbit_misc", "rpc_call", 4 | 5) => Some(spec(
            IndirectCallForm::RabbitMiscRpcCall,
            1,
            2,
            AritySource::ArgumentList(3),
        )),
        ("erpc", "call", 4 | 5) => Some(spec(
            IndirectCallForm::ErpcCall,
            1,
            2,
            AritySource::ArgumentList(3),
        )),
        ("rabbit_ct_broker_helpers", "rpc", 4) | ("rabbit_ct_broker_helpers", "rpc_all", 4 | 5) => {
            Some(spec(
                IndirectCallForm::CtBrokerHelperRpc,
                1,
                2,
                AritySource::ArgumentList(3),
            ))
        }
        ("rabbit_ct_broker_helpers", "rpc", 5 | 6) => Some(spec(
            IndirectCallForm::CtBrokerHelperRpc,
            2,
            3,
            AritySource::ArgumentList(4),
        )),
        _ => None,
    }
}

/// Every statically readable indirect MFA reference in `src`, scanned
/// over the same joined body runs as the qualified-call extractor so a
/// wrapped form recovers its exact arity. `line_map[i]` is text line
/// `i`'s file line.
pub fn extract_indirect_calls(src: &str, line_map: &[u32]) -> IndirectExtraction {
    extract_indirect_calls_with_context(src, line_map, &line_context(src))
}

/// `extract_indirect_calls` over a precomputed per-line classification
/// rather than one derived from `src` alone, for the same reason
/// `extract_qualified_calls_with_context` exists: a wrapped form whose
/// opener is in a hunk's `Context` line, outside `src`, still
/// classifies against its real attribute region.
pub fn extract_indirect_calls_with_context(
    src: &str,
    line_map: &[u32],
    ctx: &[LineClass],
) -> IndirectExtraction {
    let mut out = IndirectExtraction::default();
    for run in body_runs_from_context(src, line_map, ctx) {
        for caps in call_re().captures_iter(&run.text) {
            let group = caps.get(0).expect("capture");
            let ScannedArgs::Terminated { args, .. } =
                scan_top_level_args(&run.text[group.end()..])
            else {
                continue;
            };
            let Some(spec) = form_spec(&caps[1], &caps[2], args.len()) else {
                continue;
            };
            let line = run_line_at(&run.line_starts, group.start());
            read_reference(&spec, &args, line, Syntax::Erlang, &mut out);
        }
    }
    out
}

/// Every statically readable indirect MFA reference in an Elixir
/// `src`, from `:module.function(args)` calls whose form is in the
/// shared table. The referenced module resolves against the same Erlang
/// target tree as the Erlang sites.
pub fn extract_indirect_calls_elixir(src: &str, line_map: &[u32]) -> IndirectExtraction {
    let mut out = IndirectExtraction::default();
    for run in elixir_body_runs(src, line_map) {
        for caps in elixir_call_re().captures_iter(&run.text) {
            let group = caps.get(0).expect("capture");
            let ScannedArgs::Terminated { args, .. } =
                scan_top_level_args(&run.text[group.end()..])
            else {
                continue;
            };
            let Some(spec) = form_spec(&caps[1], &caps[2], args.len()) else {
                continue;
            };
            let line = run_line_at(&run.line_starts, group.start());
            read_reference(&spec, &args, line, Syntax::Elixir, &mut out);
        }
    }
    out
}

/// Reads one occurrence of a recognized form. A non-atom module or
/// function skips silently; a readable pair with an unreadable arity
/// counts as withheld.
fn read_reference(
    spec: &FormSpec,
    args: &[&str],
    line: u32,
    syntax: Syntax,
    out: &mut IndirectExtraction,
) {
    let (Some(module), Some(function)) = (
        args.get(spec.module_pos).and_then(|a| syntax.parse_atom(a)),
        args.get(spec.function_pos)
            .and_then(|a| syntax.parse_atom(a)),
    ) else {
        return;
    };
    let (Ok(module), Ok(function)) = (
        ModuleName::from_str(&module),
        FunctionName::from_str(&function),
    ) else {
        return;
    };
    let arity = match &spec.arity {
        AritySource::IntegerLiteral(pos) => integer_arity(args.get(*pos)),
        AritySource::FunExpression(pos) => syntax.fun_arity(args.get(*pos)),
        AritySource::ArgumentList(pos) => match list_elements(args.get(*pos)) {
            Some(elements) => {
                // the rpc'd callee is itself a meck expectation: unwrap one level
                if module.as_str() == "meck" && function.as_str() == "expect" {
                    if let Some(inner) = form_spec("meck", "expect", elements.len()) {
                        let elements: Vec<&str> = elements.iter().map(String::as_str).collect();
                        read_reference(&inner, &elements, line, syntax, out);
                    } else {
                        out.withhold(module, function, line);
                    }
                    return;
                }
                Arity::try_from(elements.len()).ok()
            }
            None => None,
        },
    };
    match arity {
        Some(arity) => out.sites.push(IndirectCallSite {
            mfa: Mfa::new(module, function, arity),
            via: spec.via,
            line,
        }),
        None => out.withhold(module, function, line),
    }
}

/// A bare or quoted literal atom, or `None` for anything else.
fn parse_atom(raw: &str) -> Option<String> {
    let raw = raw.trim();
    if let Some(inner) = raw.strip_prefix('\'') {
        let inner = inner.strip_suffix('\'')?;
        if inner.is_empty() || inner.contains('\'') {
            return None;
        }
        return Some(inner.to_owned());
    }
    if is_bare_atom(raw) {
        Some(raw.to_owned())
    } else {
        None
    }
}

/// An Elixir atom naming an Erlang module or function: `:name`,
/// `:"name"`, or `:'name'`. A bare identifier without the leading `:`
/// is a variable or an alias in Elixir, not an atom, so it is `None`
/// and the occurrence skips uncounted.
fn parse_elixir_atom(raw: &str) -> Option<String> {
    let rest = raw.trim().strip_prefix(':')?;
    for quote in ['"', '\''] {
        if let Some(inner) = rest.strip_prefix(quote) {
            let inner = inner.strip_suffix(quote)?;
            if inner.contains(quote) {
                return None;
            }
            return Some(inner.to_owned());
        }
    }
    let mut chars = rest.chars();
    let first = chars.next()?;
    if (first.is_ascii_lowercase() || first == '_')
        && chars.all(|c| c.is_ascii_alphanumeric() || c == '_' || c == '@')
    {
        Some(rest.to_owned())
    } else {
        None
    }
}

/// `:module.function(` for an Erlang module called from Elixir. The
/// module and function are bare lowercase atoms, the same shape the
/// Erlang matcher expects for the argument positions.
fn elixir_call_re() -> &'static Regex {
    static R: OnceLock<Regex> = OnceLock::new();
    R.get_or_init(|| {
        Regex::new(r":([a-z][a-zA-Z0-9_@]*)\.([a-z][a-zA-Z0-9_@]*)\s*\(").expect("regex")
    })
}

/// Elixir run assembly: join file-adjacent added lines after stripping
/// `#` comments, so a form wrapped across lines is scanned whole. No
/// attribute classification, since every Elixir added line is body.
fn elixir_body_runs(src: &str, line_map: &[u32]) -> Vec<BodyRun> {
    body_runs_with(src, line_map, strip_elixir_line_comment, |_| true)
}

/// The prefix of `line` before an Elixir `#` line comment, leaving a
/// `#` inside a string, charlist, or `?#` char literal in place.
fn strip_elixir_line_comment(line: &str) -> &str {
    let bytes = line.as_bytes();
    let mut in_str = false;
    let mut in_charlist = false;
    let mut prev_ident = false;
    let mut i = 0usize;
    while i < bytes.len() {
        let b = bytes[i];
        if in_str || in_charlist {
            match b {
                b'\\' => i += 1,
                b'"' if in_str => in_str = false,
                b'\'' if in_charlist => in_charlist = false,
                _ => {}
            }
            i += 1;
            prev_ident = false;
            continue;
        }
        match b {
            b'"' => in_str = true,
            b'\'' => in_charlist = true,
            // a ?c char literal only at a token boundary, so a foo? suffix is not one
            b'?' if !prev_ident => {
                i += 1;
                if bytes.get(i) == Some(&b'\\') {
                    i += 1;
                }
                i += 1;
                prev_ident = false;
                continue;
            }
            b'#' => return &line[..i],
            _ => {}
        }
        prev_ident = b.is_ascii_alphanumeric() || b == b'_';
        i += 1;
    }
    line
}

/// An integer-literal arity, or `None`.
fn integer_arity(raw: Option<&&str>) -> Option<Arity> {
    let raw = raw?.trim();
    let value: usize = raw.parse().ok()?;
    Arity::try_from(value).ok()
}

/// Arity of a `fun` expression: a `fun(...) ->` head or a `fun [m:]f/N`
/// capture. `None` for anything else, including a variable.
fn fun_arity(raw: &str) -> Option<Arity> {
    let rest = raw.trim().strip_prefix("fun")?;
    // only an open paren or a space follows the fun keyword: funny(...) must not match
    if !rest.starts_with('(') && !rest.starts_with(char::is_whitespace) {
        return None;
    }
    let rest = rest.trim_start();
    if let Some(after_paren) = rest.strip_prefix('(') {
        let ScannedArgs::Terminated { args, .. } = scan_top_level_args(after_paren) else {
            return None;
        };
        return Arity::try_from(args.len()).ok();
    }
    // a capture's arity is the digits after the final slash
    let (_, digits) = rest.rsplit_once('/')?;
    let value: usize = digits.trim().parse().ok()?;
    Arity::try_from(value).ok()
}

/// The elements of a literal list argument, or `None` when the
/// argument is not a plain terminated list.
fn list_elements(raw: Option<&&str>) -> Option<Vec<String>> {
    let raw = raw?.trim();
    let after_bracket = raw.strip_prefix('[')?;
    match scan_list_elements(after_bracket) {
        // trailing text after the close bracket means the argument is not just this list
        ScannedList::Terminated { elements, consumed }
            if after_bracket[consumed..].trim().is_empty() =>
        {
            Some(elements.into_iter().map(str::to_owned).collect())
        }
        ScannedList::Terminated { .. } | ScannedList::ImproperTail | ScannedList::Unterminated => {
            None
        }
    }
}