Import trait help message is incorrect

[disconnect3d]

Code

extern crate rustc_index;

use rustc_index::{vec::Idx};

fn main() { }

Current output

# rustc --version
rustc 1.73.0-nightly (0bdb00d55 2023-08-15)

# rustc main.rs
error[E0603]: module `vec` is private
 --> main.rs:3:19
  |
3 | use rustc_index::{vec::Idx};
  |                   ^^^ private module
  |
note: the module `vec` is defined here
 --> /root/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/compiler/rustc_index/src/lib.rs:24:1
help: consider importing this trait instead
  |
3 | use rustc_index::{rustc_index::Idx};
  |                   ~~~~~~~~~~~~~~~~

error[E0658]: use of unstable library feature 'rustc_private': this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?
 --> main.rs:1:1
  |
1 | extern crate rustc_index;
  | ^^^^^^^^^^^^^^^^^^^^^^^^^
  |
  = note: see issue #27812 <https://github.com/rust-lang/rust/issues/27812> for more information
  = help: add `#![feature(rustc_private)]` to the crate attributes to enable

error: aborting due to 2 previous errors

Some errors have detailed explanations: E0603, E0658.
For more information about an error, try `rustc --explain E0603`.

(The rustc_private error is irrelevant)

Desired output

The suggestion to import rustc_index::{rustc_index::Idx}; is obviously wrong. It should be rustc_index::{Idx}; (or even rustc_index::Idx).

[compiler-errors]

Span of the import suggestion needs to be adjusted.

[gurry]

@rustbot claim

[gurry]

When I try to compile this snippet:

extern crate rustc_index;

use rustc_index::{vec::Idx};

fn main() { }

with my locally built rustc I get the following error:

error[E0463]: can't find crate for `rustc_index`
 --> ../issue-114884.rs:1:1
  |
1 | extern crate rustc_index;
  | ^^^^^^^^^^^^^^^^^^^^^^^^^ can't find crate
  |
  = help: maybe you need to install the missing components with: `rustup component add rust-src rustc-dev llvm-tools-preview`

error: aborting due to previous error

Running rustup component add rust-src rustc-dev llvm-tools-preview didn't help (although it does make it possible to compile with the installed nightly rustc as opposed to the locally built one).

@compiler-errors Can you please help me resolve this problem?

rustc metadata:

rustc 1.73.0-dev
binary: rustc
commit-hash: unknown
commit-date: unknown
host: x86_64-pc-windows-msvc
release: 1.73.0-dev
LLVM version: 17.0.0

[compiler-errors]

@gurry please reproduce this issue using another way that doesn't rely on rustc-internal crates. The only part that matters is the use having braces in the path, I think.

[gurry]

Yes, I first tried with a rustc_index mod in the same file, but it didn't reproduce. So I thought maybe having a crate in the path is relevant. Anyway, I'll try more with the inline mod.

[gurry]

The issue reproduces with the following self contained snippet:

pub mod mod1 {
    pub trait TraitA {}
}

pub mod mod2 {
    mod sub_mod {
        use mod1::TraitA;
    }
}

use mod2::{sub_mod::TraitA};

fn main() { }

resulting in the following diagnostic:

error[E0603]: module `sub_mod` is private
  --> issue-114884-incorrect-import-trait-msg.rs:11:12
   |
11 | use mod2::{sub_mod::TraitA};
   |            ^^^^^^^ private module
   |
note: the module `sub_mod` is defined here
  --> issue-114884-incorrect-import-trait-msg.rs:6:5
   |
6  |     mod sub_mod {
   |     ^^^^^^^^^^^
help: consider importing this trait instead
   |
11 | use mod2::{mod1::TraitA};
   |            ~~~~~~~~~~~~

The immediate cause of the issue is the below argument to show_candidates():

rust/compiler/rustc_resolve/src/diagnostics.rs

Line 1668 in c40cfcf

Some(dedup_span.until(outer_ident.span.shrink_to_hi())),

Specifically, the problem is with dedup_span. It starts at the wrong point which is immediately after the opening brace in the path use mod2::{sub_mod::TraitA} instead of at the beginning of the path.

At first glance the solution is to simply set dedup_span to the correct value i.e. the beginning of the path which will change the suggestion from this:

11 | use mod2::{mod1::TraitA};
   |            ~~~~~~~~~~~~

to this:

11 | use mod1::TraitA;
   |      ~~~~~~~~~~~~

However, it will fail for multi-child paths such as use mod2::{mod1::TraitA, SomeOtherType}. In that case, it will produce a malformed suggestion shown below:

11 | use mod1::TraitA, SomeOtherType};
   |            ~~~~~~~~~~~~~~~~~~

Therefore what we may need is a smarter approach which can:

• Suggest replacing the entire path in the single-child case i.e. use mod2::{mod1::TraitA} -> use mod1::TraitA and
• Suggest the new path on a separate line in the multi-child case i.e. use mod2::{mod1::TraitA, SomeOtherType}) ->

11 | - use mod2::{TraitA, SomeOtherType};
11 | + use mod2::SomeOtherType; 
12 | + use mod1::TraitA; 

It may also be an option to just stick with the simpler approach of correcting dedup_span and not showing any suggestion whatsoever for the bothersome multi-child case.

What are you thoughts @compiler-errors ?

[gurry]

@rustbot claim

[estebank]

Triage: no change

error[E0603]: module `sub_mod` is private
  --> src/main.rs:11:12
   |
11 | use mod2::{sub_mod::TraitA};
   |            ^^^^^^^ private module
   |
note: the module `sub_mod` is defined here
  --> src/main.rs:6:5
   |
6  |     mod sub_mod {
   |     ^^^^^^^^^^^
help: consider importing this trait instead
   |
11 | use mod2::{crate::mod1::TraitA};
   |            ~~~~~~~~~~~~~~~~~~~