fix: handle Windows path correctly

[Rustin170506]

fix #550

We need to make truncate_registry_path can handle Windows path as well. Because tokio-console can connect to any server from different platforms, so we use the same path separator to have the same experience.

Some test snapshots:
local package:

crates.io package:

[Rustin170506]

🔢 Self-check (PR reviewed by myself and ready for feedback.)

[hds]

I haven't had a chance to look at the change properly yet (although what I have checked looks good). However I'm not sure what the image in the PR description is showing. Should the "local" one also show a crate path, rather than one from the application code?

[Rustin170506]

Should the "local" one also show a crate path, rather than one from the application code?

Because I ran the example from the console project directly. So I guess we have to show the application code. This path does not match the regex, so we directly show it.

[hds]

I'm not sure this is a good idea, it might cause issues if people have a / or \ in some directory name (although I'm not sure we should worry about that case really).

Also, while "C:/Users/user/projects/tokio-1.0.1/src/lib.rs" looks fine to me, maybe it looks weird to a Windows user?

[Rustin170506]

Also, while "C:/Users/user/projects/tokio-1.0.1/src/lib.rs" looks fine to me, maybe it looks weird to a Windows user?

The reason I want to use the same path style is that users can use tokio-console to connect to servers from different servers. So maybe using the same path style would help us reduce confusion. But I also agree that it might cause some confusion for Windows users.

[Rustin170506]

I'm not sure this is a good idea, it might cause issues if people have a / or \ in some directory name (although I'm not sure we should worry about that case really).

Yes. This is possible. At least, on macOS, I can create a dir that contains it by command: mkdir test\\a.

[Rustin170506]

How about:

1. <cargo>/tokio-1.0.1/src/lib.rs for macOS and Linux path.
2. <cargo>\tokio-1.0.1\src\lib.rs for Windows path.

But I am not sure if there is an easy way to detect if the path string is from the Windows OS.

[Rustin170506]

@hds Do you have any thoughts on this? I am not sure which way we should go.

[hds]

How about:

1. `<cargo>/tokio-1.0.1/src/lib.rs` for macOS and Linux path.

2. `<cargo>\tokio-1.0.1\src\lib.rs` for Windows path.

But I am not sure if there is an easy way to detect if the path string is from the Windows OS.

Let's go with this. I would suggest we just go with what separator we see in the path. If it's / we leave it as /, if it's \ we leave it \. Naively you could probably count the number of each character in the string and only use \ (which I would consider less likely) if it is stricly higher.

[Rustin170506]

I used:

fn is_windows_path(path: &str) -> bool {
    use once_cell::sync::OnceCell;
    use regex::Regex;

    static REGEX: OnceCell<Regex> = OnceCell::new();
    let regex = REGEX.get_or_init(|| Regex::new(r"^[a-zA-Z]:\\").expect("failed to compile regex"));
    let has_drive_letter = regex.is_match(path);
    let slash_count = path.find('/').iter().count();
    let backslash_count = path.find('\\').iter().count();
    has_drive_letter && backslash_count > slash_count
}

It is not perfect, but it seems to work.

[Rustin170506]

I am oncall this week and next week. I will update it when I get out of jail(oncall).

[hds]

Looks good. Thank you!

[Rustin170506]

Tested locally again: