Skip to content

feat: respect references.exclude_tests in call-hierarchy #18291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2024
Merged

feat: respect references.exclude_tests in call-hierarchy #18291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 112 additions & 6 deletions crates/ide/src/call_hierarchy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ pub struct CallItem {
pub ranges: Vec<FileRange>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CallHierarchyConfig {
/// Whether to exclude tests from the call hierarchy
pub exclude_tests: bool,
}

pub(crate) fn call_hierarchy(
db: &RootDatabase,
position: FilePosition,
Expand All @@ -28,6 +34,7 @@ pub(crate) fn call_hierarchy(

pub(crate) fn incoming_calls(
db: &RootDatabase,
CallHierarchyConfig { exclude_tests }: CallHierarchyConfig,
FilePosition { file_id, offset }: FilePosition,
) -> Option<Vec<CallItem>> {
let sema = &Semantics::new(db);
Expand Down Expand Up @@ -56,11 +63,18 @@ pub(crate) fn incoming_calls(
references.iter().filter_map(|FileReference { name, .. }| name.as_name_ref());
for name in references {
// This target is the containing function
let nav = sema.ancestors_with_macros(name.syntax().clone()).find_map(|node| {
let def_nav = sema.ancestors_with_macros(name.syntax().clone()).find_map(|node| {
let def = ast::Fn::cast(node).and_then(|fn_| sema.to_def(&fn_))?;
def.try_to_nav(sema.db)
// We should return def before check if it is a test, so that we
// will not continue to search for outer fn in nested fns
def.try_to_nav(sema.db).map(|nav| (def, nav))
});
if let Some(nav) = nav {

if let Some((def, nav)) = def_nav {
if exclude_tests && def.is_test(db) {
continue;
}

let range = sema.original_range(name.syntax());
calls.add(nav.call_site, range.into());
if let Some(other) = nav.def_site {
Expand All @@ -75,6 +89,7 @@ pub(crate) fn incoming_calls(

pub(crate) fn outgoing_calls(
db: &RootDatabase,
CallHierarchyConfig { exclude_tests }: CallHierarchyConfig,
FilePosition { file_id, offset }: FilePosition,
) -> Option<Vec<CallItem>> {
let sema = Semantics::new(db);
Expand Down Expand Up @@ -103,7 +118,12 @@ pub(crate) fn outgoing_calls(
let expr = call.expr()?;
let callable = sema.type_of_expr(&expr)?.original.as_callable(db)?;
match callable.kind() {
hir::CallableKind::Function(it) => it.try_to_nav(db),
hir::CallableKind::Function(it) => {
if exclude_tests && it.is_test(db) {
return None;
}
it.try_to_nav(db)
}
hir::CallableKind::TupleEnumVariant(it) => it.try_to_nav(db),
hir::CallableKind::TupleStruct(it) => it.try_to_nav(db),
_ => None,
Expand All @@ -112,6 +132,9 @@ pub(crate) fn outgoing_calls(
}
ast::CallableExpr::MethodCall(expr) => {
let function = sema.resolve_method_call(&expr)?;
if exclude_tests && function.is_test(db) {
return None;
}
function
.try_to_nav(db)
.zip(Some(sema.original_range(expr.name_ref()?.syntax())))
Expand Down Expand Up @@ -149,6 +172,7 @@ mod tests {
use crate::fixture;

fn check_hierarchy(
exclude_tests: bool,
ra_fixture: &str,
expected_nav: Expect,
expected_incoming: Expect,
Expand All @@ -172,18 +196,21 @@ mod tests {
let nav = navs.pop().unwrap();
expected_nav.assert_eq(&nav.debug_render());

let config = crate::CallHierarchyConfig { exclude_tests };

let item_pos =
FilePosition { file_id: nav.file_id, offset: nav.focus_or_full_range().start() };
let incoming_calls = analysis.incoming_calls(item_pos).unwrap().unwrap();
let incoming_calls = analysis.incoming_calls(config, item_pos).unwrap().unwrap();
expected_incoming.assert_eq(&incoming_calls.into_iter().map(debug_render).join("\n"));

let outgoing_calls = analysis.outgoing_calls(item_pos).unwrap().unwrap();
let outgoing_calls = analysis.outgoing_calls(config, item_pos).unwrap().unwrap();
expected_outgoing.assert_eq(&outgoing_calls.into_iter().map(debug_render).join("\n"));
}

#[test]
fn test_call_hierarchy_on_ref() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn callee() {}
Expand All @@ -200,6 +227,7 @@ fn caller() {
#[test]
fn test_call_hierarchy_on_def() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn call$0ee() {}
Expand All @@ -216,6 +244,7 @@ fn caller() {
#[test]
fn test_call_hierarchy_in_same_fn() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn callee() {}
Expand All @@ -233,6 +262,7 @@ fn caller() {
#[test]
fn test_call_hierarchy_in_different_fn() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn callee() {}
Expand All @@ -255,6 +285,7 @@ fn caller2() {
#[test]
fn test_call_hierarchy_in_tests_mod() {
check_hierarchy(
false,
r#"
//- /lib.rs cfg:test
fn callee() {}
Expand Down Expand Up @@ -283,6 +314,7 @@ mod tests {
#[test]
fn test_call_hierarchy_in_different_files() {
check_hierarchy(
false,
r#"
//- /lib.rs
mod foo;
Expand All @@ -304,6 +336,7 @@ pub fn callee() {}
#[test]
fn test_call_hierarchy_outgoing() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn callee() {}
Expand All @@ -321,6 +354,7 @@ fn call$0er() {
#[test]
fn test_call_hierarchy_outgoing_in_different_files() {
check_hierarchy(
false,
r#"
//- /lib.rs
mod foo;
Expand All @@ -342,6 +376,7 @@ pub fn callee() {}
#[test]
fn test_call_hierarchy_incoming_outgoing() {
check_hierarchy(
false,
r#"
//- /lib.rs
fn caller1() {
Expand All @@ -365,6 +400,7 @@ fn caller3() {
#[test]
fn test_call_hierarchy_issue_5103() {
check_hierarchy(
false,
r#"
fn a() {
b()
Expand All @@ -382,6 +418,7 @@ fn main() {
);

check_hierarchy(
false,
r#"
fn a() {
b$0()
Expand All @@ -402,6 +439,7 @@ fn main() {
#[test]
fn test_call_hierarchy_in_macros_incoming() {
check_hierarchy(
false,
r#"
macro_rules! define {
($ident:ident) => {
Expand All @@ -423,6 +461,7 @@ fn caller() {
expect![[]],
);
check_hierarchy(
false,
r#"
macro_rules! define {
($ident:ident) => {
Expand All @@ -448,6 +487,7 @@ fn caller() {
#[test]
fn test_call_hierarchy_in_macros_outgoing() {
check_hierarchy(
false,
r#"
macro_rules! define {
($ident:ident) => {
Expand All @@ -473,6 +513,7 @@ fn caller$0() {
#[test]
fn test_call_hierarchy_in_macros_incoming_different_files() {
check_hierarchy(
false,
r#"
//- /lib.rs
#[macro_use]
Expand All @@ -498,6 +539,7 @@ macro_rules! call {
expect![[]],
);
check_hierarchy(
false,
r#"
//- /lib.rs
#[macro_use]
Expand All @@ -523,6 +565,7 @@ macro_rules! call {
expect![[]],
);
check_hierarchy(
false,
r#"
//- /lib.rs
#[macro_use]
Expand Down Expand Up @@ -558,6 +601,7 @@ macro_rules! call {
#[test]
fn test_call_hierarchy_in_macros_outgoing_different_files() {
check_hierarchy(
false,
r#"
//- /lib.rs
#[macro_use]
Expand Down Expand Up @@ -585,6 +629,7 @@ macro_rules! call {
expect![[]],
);
check_hierarchy(
false,
r#"
//- /lib.rs
#[macro_use]
Expand Down Expand Up @@ -616,6 +661,7 @@ macro_rules! call {
#[test]
fn test_trait_method_call_hierarchy() {
check_hierarchy(
false,
r#"
trait T1 {
fn call$0ee();
Expand All @@ -636,4 +682,64 @@ fn caller() {
expect![[]],
);
}

#[test]
fn test_call_hierarchy_excluding_tests() {
check_hierarchy(
false,
r#"
fn main() {
f1();
}

fn f1$0() {
f2(); f3();
}

fn f2() {
f1(); f3();
}

#[test]
fn f3() {
f1(); f2();
}
"#,
expect!["f1 Function FileId(0) 25..52 28..30"],
expect![[r#"
main Function FileId(0) 0..23 3..7 : FileId(0):16..18
f2 Function FileId(0) 54..81 57..59 : FileId(0):68..70
f3 Function FileId(0) 83..118 94..96 : FileId(0):105..107"#]],
expect![[r#"
f2 Function FileId(0) 54..81 57..59 : FileId(0):39..41
f3 Function FileId(0) 83..118 94..96 : FileId(0):45..47"#]],
);

check_hierarchy(
true,
r#"
fn main() {
f1();
}

fn f1$0() {
f2(); f3();
}

fn f2() {
f1(); f3();
}

#[test]
fn f3() {
f1(); f2();
}
"#,
expect!["f1 Function FileId(0) 25..52 28..30"],
expect![[r#"
main Function FileId(0) 0..23 3..7 : FileId(0):16..18
f2 Function FileId(0) 54..81 57..59 : FileId(0):68..70"#]],
expect!["f2 Function FileId(0) 54..81 57..59 : FileId(0):39..41"],
);
}
}
18 changes: 13 additions & 5 deletions crates/ide/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ use crate::navigation_target::ToNav;

pub use crate::{
annotations::{Annotation, AnnotationConfig, AnnotationKind, AnnotationLocation},
call_hierarchy::CallItem,
call_hierarchy::{CallHierarchyConfig, CallItem},
expand_macro::ExpandedMacro,
file_structure::{StructureNode, StructureNodeKind},
folding_ranges::{Fold, FoldKind},
Expand Down Expand Up @@ -564,13 +564,21 @@ impl Analysis {
}

/// Computes incoming calls for the given file position.
pub fn incoming_calls(&self, position: FilePosition) -> Cancellable<Option<Vec<CallItem>>> {
self.with_db(|db| call_hierarchy::incoming_calls(db, position))
pub fn incoming_calls(
&self,
config: CallHierarchyConfig,
position: FilePosition,
) -> Cancellable<Option<Vec<CallItem>>> {
self.with_db(|db| call_hierarchy::incoming_calls(db, config, position))
}

/// Computes outgoing calls for the given file position.
pub fn outgoing_calls(&self, position: FilePosition) -> Cancellable<Option<Vec<CallItem>>> {
self.with_db(|db| call_hierarchy::outgoing_calls(db, position))
pub fn outgoing_calls(
&self,
config: CallHierarchyConfig,
position: FilePosition,
) -> Cancellable<Option<Vec<CallItem>>> {
self.with_db(|db| call_hierarchy::outgoing_calls(db, config, position))
}

/// Returns a `mod name;` declaration which created the current module.
Expand Down
15 changes: 10 additions & 5 deletions crates/rust-analyzer/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ use std::{
use cfg::{CfgAtom, CfgDiff};
use hir::Symbol;
use ide::{
AssistConfig, CallableSnippets, CompletionConfig, CompletionFieldsToResolve, DiagnosticsConfig,
ExprFillDefaultMode, GenericParameterHints, HighlightConfig, HighlightRelatedConfig,
HoverConfig, HoverDocFormat, InlayFieldsToResolve, InlayHintsConfig, JoinLinesConfig,
MemoryLayoutHoverConfig, MemoryLayoutHoverRenderKind, Snippet, SnippetScope, SourceRootId,
AssistConfig, CallHierarchyConfig, CallableSnippets, CompletionConfig,
CompletionFieldsToResolve, DiagnosticsConfig, ExprFillDefaultMode, GenericParameterHints,
HighlightConfig, HighlightRelatedConfig, HoverConfig, HoverDocFormat, InlayFieldsToResolve,
InlayHintsConfig, JoinLinesConfig, MemoryLayoutHoverConfig, MemoryLayoutHoverRenderKind,
Snippet, SnippetScope, SourceRootId,
};
use ide_db::{
imports::insert_use::{ImportGranularity, InsertUseConfig, PrefixKind},
Expand Down Expand Up @@ -262,7 +263,7 @@ config_data! {
/// Exclude imports from find-all-references.
references_excludeImports: bool = false,

/// Exclude tests from find-all-references.
/// Exclude tests from find-all-references and call-hierarchy.
references_excludeTests: bool = false,

/// Inject additional highlighting into doc comments.
Expand Down Expand Up @@ -1392,6 +1393,10 @@ impl Config {
}
}

pub fn call_hierarchy(&self) -> CallHierarchyConfig {
CallHierarchyConfig { exclude_tests: self.references_excludeTests().to_owned() }
}

pub fn completion(&self, source_root: Option<SourceRootId>) -> CompletionConfig {
let client_capability_fields = self.completion_resolve_support_properties();
CompletionConfig {
Expand Down
Loading