Skip to content
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.

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

Improve autoimports on completion speed #6614

Merged
merged 1 commit into from
Nov 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 28 additions & 26 deletions crates/completion/src/completions/unqualified_path.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,32 +79,34 @@ fn fuzzy_completion(acc: &mut Completions, ctx: &CompletionContext) -> Option<()

let potential_import_name = ctx.token.to_string();

let possible_imports =
imports_locator::find_similar_imports(&ctx.sema, ctx.krate?, &potential_import_name, 400)
.filter_map(|import_candidate| match import_candidate {
// when completing outside the use declaration, modules are pretty useless
// and tend to bloat the completion suggestions a lot
Either::Left(ModuleDef::Module(_)) => None,
Either::Left(module_def) => Some((
current_module.find_use_path(ctx.db, module_def)?,
ScopeDef::ModuleDef(module_def),
)),
Either::Right(macro_def) => Some((
current_module.find_use_path(ctx.db, macro_def)?,
ScopeDef::MacroDef(macro_def),
)),
})
.filter(|(mod_path, _)| mod_path.len() > 1)
.filter_map(|(import_path, definition)| {
render_resolution_with_import(
RenderContext::new(ctx),
import_path.clone(),
import_scope.clone(),
ctx.config.merge,
&definition,
)
})
.take(20);
let possible_imports = imports_locator::find_similar_imports(
&ctx.sema,
ctx.krate?,
&potential_import_name,
50,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder what heuristic is used by IntelliJ here to limit the set of auto-import candidates?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll look at it at some point.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the results are not limited there at all.

This is the analogue of our imports_locator: https://github.com/intellij-rust/intellij-rust/blob/48d051f0b040e4cad5fc4dac7f07578e801c808e/src/main/kotlin/org/rust/ide/utils/import/ImportCandidatesCollector.kt

and its usage related to completions seems to be here:
https://github.com/intellij-rust/intellij-rust/blob/48d051f0b040e4cad5fc4dac7f07578e801c808e/src/main/kotlin/org/rust/lang/core/completion/RsCommonCompletionProvider.kt#L198

I think we can safely remove the limit from the imports_locator::find_similar_imports invocation, but still have to have the .take(40) or similar in the unqualified_path::fuzzy_completion function to avoid excessive insert imports calculation.

true,
)
.filter_map(|import_candidate| {
Some(match import_candidate {
Either::Left(module_def) => {
(current_module.find_use_path(ctx.db, module_def)?, ScopeDef::ModuleDef(module_def))
}
Either::Right(macro_def) => {
(current_module.find_use_path(ctx.db, macro_def)?, ScopeDef::MacroDef(macro_def))
}
})
})
.filter(|(mod_path, _)| mod_path.len() > 1)
.take(20)
.filter_map(|(import_path, definition)| {
render_resolution_with_import(
RenderContext::new(ctx),
import_path.clone(),
import_scope.clone(),
ctx.config.merge,
&definition,
)
});

acc.add_all(possible_imports);
Some(())
Expand Down
1 change: 1 addition & 0 deletions crates/completion/src/render.rs
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ impl<'a> Render<'a> {
import_data: Option<(ModPath, ImportScope, Option<MergeBehaviour>)>,
resolution: &ScopeDef,
) -> Option<CompletionItem> {
let _p = profile::span("render_resolution");
use hir::ModuleDef::*;

let completion_kind = match resolution {
Expand Down
82 changes: 77 additions & 5 deletions crates/hir_def/src/import_map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use fst::{self, Streamer};
use hir_expand::name::Name;
use indexmap::{map::Entry, IndexMap};
use itertools::Itertools;
use rustc_hash::{FxHashMap, FxHasher};
use rustc_hash::{FxHashMap, FxHashSet, FxHasher};
use smallvec::SmallVec;
use syntax::SmolStr;

Expand Down Expand Up @@ -225,13 +225,27 @@ fn cmp((_, lhs): &(&ItemInNs, &ImportInfo), (_, rhs): &(&ItemInNs, &ImportInfo))
lhs_str.cmp(&rhs_str)
}

#[derive(Debug, Eq, PartialEq, Hash)]
pub enum ImportKind {
Module,
Function,
Adt,
EnumVariant,
Const,
Static,
Trait,
TypeAlias,
BuiltinType,
}

#[derive(Debug)]
pub struct Query {
query: String,
lowercased: String,
anchor_end: bool,
case_sensitive: bool,
limit: usize,
exclude_import_kinds: FxHashSet<ImportKind>,
}

impl Query {
Expand All @@ -242,6 +256,7 @@ impl Query {
anchor_end: false,
case_sensitive: false,
limit: usize::max_value(),
exclude_import_kinds: FxHashSet::default(),
}
}

Expand All @@ -260,6 +275,12 @@ impl Query {
pub fn case_sensitive(self) -> Self {
Self { case_sensitive: true, ..self }
}

/// Do not include imports of the specified kind in the search results.
pub fn exclude_import_kind(mut self, import_kind: ImportKind) -> Self {
self.exclude_import_kinds.insert(import_kind);
self
}
}

/// Searches dependencies of `krate` for an importable path matching `query`.
Expand Down Expand Up @@ -303,10 +324,17 @@ pub fn search_dependencies<'a>(

// Add the items from this `ModPath` group. Those are all subsequent items in
// `importables` whose paths match `path`.
let iter = importables.iter().copied().take_while(|item| {
let item_path = &import_map.map[item].path;
fst_path(item_path) == fst_path(path)
});
let iter = importables
.iter()
.copied()
.take_while(|item| {
let item_path = &import_map.map[item].path;
fst_path(item_path) == fst_path(path)
})
.filter(|&item| match item_import_kind(item) {
Some(import_kind) => !query.exclude_import_kinds.contains(&import_kind),
None => true,
});

if query.case_sensitive {
// FIXME: This does not do a subsequence match.
Expand Down Expand Up @@ -341,6 +369,20 @@ pub fn search_dependencies<'a>(
res
}

fn item_import_kind(item: ItemInNs) -> Option<ImportKind> {
Some(match item.as_module_def_id()? {
ModuleDefId::ModuleId(_) => ImportKind::Module,
ModuleDefId::FunctionId(_) => ImportKind::Function,
ModuleDefId::AdtId(_) => ImportKind::Adt,
ModuleDefId::EnumVariantId(_) => ImportKind::EnumVariant,
ModuleDefId::ConstId(_) => ImportKind::Const,
ModuleDefId::StaticId(_) => ImportKind::Static,
ModuleDefId::TraitId(_) => ImportKind::Trait,
ModuleDefId::TypeAliasId(_) => ImportKind::TypeAlias,
ModuleDefId::BuiltinType(_) => ImportKind::BuiltinType,
})
}

#[cfg(test)]
mod tests {
use base_db::{fixture::WithFixture, SourceDatabase, Upcast};
Expand Down Expand Up @@ -758,4 +800,34 @@ mod tests {
"#]],
);
}

#[test]
fn search_exclusions() {
let ra_fixture = r#"
//- /main.rs crate:main deps:dep
//- /dep.rs crate:dep

pub struct fmt;
pub struct FMT;
"#;

check_search(
ra_fixture,
"main",
Query::new("FMT"),
expect![[r#"
dep::fmt (t)
dep::fmt (v)
dep::FMT (t)
dep::FMT (v)
"#]],
);

check_search(
ra_fixture,
"main",
Query::new("FMT").exclude_import_kind(ImportKind::Adt),
expect![[r#""#]],
);
}
}
9 changes: 8 additions & 1 deletion crates/ide_db/src/imports_locator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,15 @@ pub fn find_similar_imports<'a>(
krate: Crate,
name_to_import: &str,
limit: usize,
ignore_modules: bool,
) -> impl Iterator<Item = Either<ModuleDef, MacroDef>> {
let _p = profile::span("find_similar_imports");

let mut external_query = import_map::Query::new(name_to_import).limit(limit);
if ignore_modules {
external_query = external_query.exclude_import_kind(import_map::ImportKind::Module);
}

find_imports(
sema,
krate,
Expand All @@ -46,7 +53,7 @@ pub fn find_similar_imports<'a>(
local_query.limit(limit);
local_query
},
import_map::Query::new(name_to_import).limit(limit),
external_query,
)
}

Expand Down