Rust-analyzer inserts & (ampersand) character on the wrong line when auto-completing variable reference

[stevepryde]

When I auto-complete a function parameter that wants a reference, I get a & character randomly inserted on the wrong line in the same file.

It appears to use the line-number relative to the file rather than relative to the current function.

See below for code and steps to reproduce the issue.

rust-analyzer version: (eg. output of "Rust Analyzer: Show RA Version" command)
rust-analyzer version: 0.0.0 (75b2232 2022-07-03)

rustc version: (eg. output of rustc -V)
rustc 1.62.0 (a8314ef7d 2022-06-27)

#[derive(Debug)]
pub struct QueryResultRequest {
    query_id: String,
}

pub async fn query_result(request: QueryResultRequest) -> Result<String, String> {
    Ok(request.query_id)
}

pub fn show_value(value: &str) {
    println!("value: {value}");
}

fn main() {
    println!("Hello, world!");
}

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

    #[tokio::test]
    async fn test() {
        let request = QueryResultRequest {
            query_id: "test".to_string(),
        };

        query_result(request).await.unwrap();
    }
}

Steps to reproduce:

1. Locate the line of code at the bottom (query_result(...))
2. Above that line, type the following, but auto-complete the variable name
   show_value(request.que (then press ENTER to auto-complete query_id)

Upon auto-completion, observe an & character has been inserted on line 6 of the file, making the function signature now look like this:

pub async fn query_result(request: QueryResultRe&quest) -> Result<String, String> {
                                                ^

[stevepryde]

if I change #[tokio::test] to #[test] and remove the async etc. I can't reproduce the issue. May be related to that macro, not sure.

[Veykril]

Ah we don't consider macros for these ye, these are all the problematic locations

rust-analyzer/crates/ide-completion/src/render.rs

Line 138 in 09abd76

item.ref_match(ref_match, receiver.syntax().text_range().start());

rust-analyzer/crates/ide-completion/src/render.rs

Line 317 in 09abd76

item.ref_match(ref_match, path_ctx.path.syntax().text_range().start());

rust-analyzer/crates/ide-completion/src/render/function.rs

Lines 82 to 92 in 09abd76

	if let Some(ref_match) = compute_ref_match(completion, &ret_type) {
	match func_kind {
	FuncKind::Function(path_ctx) => {
	item.ref_match(ref_match, path_ctx.path.syntax().text_range().start());
	}
	FuncKind::Method(DotAccess { receiver: Some(receiver), .. }, _) => {
	item.ref_match(ref_match, receiver.syntax().text_range().start());
	}
	_ => (),
	}
	}

rust-analyzer/crates/ide-completion/src/render/literal.rs

Lines 124 to 126 in 09abd76

	if let Some(ref_match) = compute_ref_match(completion, &ty) {
	item.ref_match(ref_match, path_ctx.path.syntax().text_range().start());
	}

We'll need to use

rust-analyzer/crates/hir/src/semantics.rs

Lines 250 to 254 in 09abd76

	/// Attempts to map the node out of macro expanded files.
	/// This only work for attribute expansions, as other ones do not have nodes as input.
	pub fn original_ast_node<N: AstNode>(&self, node: N) -> Option<N> {
	self.imp.original_ast_node(node)
	}

for this I believe, if we get None back we shouldn't emit this special completion for now.

[abusch]

I can also reproduce this by typing show_value(request.query_id); (without using completion), then executing the "Add reference here" code action, so it doesn't seem to only concern completion.

[Veykril]

thats the same issue in a different part of the project, feel free to create a new issue regarding that

[Rustin170506]

I am working on this.

[Rustin170506]

@rustbot claim

[lnicola]

I think this was fixed in #12800 and #12830.