Deal cleanly with malformed default-host #1578

kinnison · 2018-12-14T22:28:46Z

It is better to report errors cleanly rather than panic. If the
default-host is set badly then we can end up panicking because
we're unable to parse it. Since default-host is user input, it's
better we don't panic.

This PR will, when complete, add in some appropriate checks for default-host
and hopefully lead the user to resolution of the problem resulting in fixing #745

So far, all I've done is to change the .expect() into .ok_or() and propagate the Result<...>
properly. This removes the panic but means that we get some very odd reports from things
like rustup show, hence the plan to add some proper earlier checks which can report errors more usefully.

If this approach seems sane, I'd appreciate any pointers possible on where to add appropriate checks, and in addition, where to add appropriate tests.

kinnison · 2018-12-16T15:42:50Z

At this point, I've added a debug!() macro, fixed a minor typo in one of the sanity check warnings, and added an explicit sanity check on the host and toolchain inputs to the installer. This combo should handle the situation mentioned in #874 by @alexcrichton too.

My next steps will be to try and improve the situation by suggesting the build triple and the 'stable' channel if these errors come up.

kinnison · 2018-12-19T17:43:04Z

This PR will need further work as #1583 has been merged and #1585 may get merged soon. Also there'll be a PR about clippy lint fixes which might happen before this too. I'll get back to it, I promise.

kinnison · 2019-01-14T22:00:39Z

I've un-WIPped this because I finally added a commit which addresses the direct bad action in #745

I also rebased, so hopefully this'll be good.

nrc

Thanks for the PR, there are some comments inline

nrc · 2019-01-16T08:20:33Z

src/rustup-cli/self_update.rs

+ e,
+ dist::TargetTriple::from_host_or_build().as_ref()
+ )
+ })?;


I think we should move this checking to its own function - do_pre_install_sanity_checks is about checking the user's system, rather than the installation options

Okay, I've created a function called do_pre_install_options_sanity_checks() and moved the content into there, though for now I'm calling it from the same spot as do_pre_install_sanity_checks() unless I find something better.

nrc · 2019-01-16T08:21:25Z

src/rustup-dist/src/dist.rs

@@ -210,6 210,12 @@ impl TargetTriple {
 }
 }

+impl AsRef<str> for TargetTriple {


I don't think we should use AsRef for this as it is doing a type conversion, not just a ref/deref

Fair. Also there's already a Display so I've dropped this particular commit from the PR

nrc · 2019-01-16T08:22:13Z

src/rustup-cli/self_update.rs

+ "stable"
+ } else {
+ &opts.default_toolchain
+ };


This seems like it is duplicating behaviour defined elsewhere.

To my knowledge it's not per-se. This is simply because using PartialToolchainDesc::resolve needs a valid toolchain name or it won't work (and none isn't valid IIRC).

It looks similar to other checks, but this time we're resolving from options and don't have a Cfg struct so I can't just call set_default_host et al, and deal with things that way. Also the debug!() is meant to be useful to tell us that it's behaving right and picking the correct fully qualified toolchain name.

If I've missed something you know of, please do let me know, but I've had a fairly good grep around I think.

nrc · 2019-01-16T08:22:54Z

src/rustup/config.rs

+ // Run some basic checks against the constructed configuration
+ // For now, that means simply checking that 'stable' can resolve
+ // for the current configuration.
+ cfg.resolve_toolchain("stable")


I don't understand why we need this check. Could you explain please?

Sure. By doing this check here we verify that later attempts to resolve the toolchain are more likely to succeed. It means we report the error about bad host types etc earlier in the sequence of operations. This leads to, in my opinion, a slightly better user experience.

Thanks for the explanation. I wonder if this will ever give a false negatve? If we have some toolchain which is nightly-only perhaps?

nrc · 2019-01-16T08:23:35Z

src/rustup/config.rs

@@ -470,7 478,20 @@ impl Cfg {
 }

 pub fn set_default_host_triple(&self, host_triple: &str) -> Result<()> {
- if dist::PartialTargetTriple::from_str(host_triple).is_none() {
+ if let Some(host) = dist::PartialTargetTriple::from_str(host_triple) {


Seems like these checks are duplicating the checks done in resolve?

Yeah, for some reason I was entirely blind to how to reuse PartialToolchainDesc::resolve() when I wrote this check. I've reworked it now.

It is better to report errors cleanly rather than panic. If the default-host is set badly then we can end up panicking because we're unable to parse it. Since default-host is user input, it's better we don't panic.

In order to have useful early error messages when the configuration is unusably broken, allow the Cfg struct to smoke-test itself during `Cfg::from_env()`

It can be useful to debug rustup's operation. This comit adds a debug macro using BRIGHT_BLUE which only displays if RUSTUP_DEBUG is in the environment

When rustup-init is running, we need to verify that the provided host triple and toolchain channel can be used together to determine a full toolchain triple (quadruple?). If we can't do this during the sanity checks, error out early.

In order for the user to install rustup and no toolchain, we must support the 'none' toolchain which isn't actually a valid name. As such whitelist it in the santiy checks.

kinnison

Thanks for your review @nrc - I've responded to everything I think, and I'll push a new set of commits momentarily

kinnison · 2019-01-16T21:48:20Z

src/rustup-dist/src/dist.rs

@@ -210,6 210,12 @@ impl TargetTriple {
 }
 }

+impl AsRef<str> for TargetTriple {


Fair. Also there's already a Display so I've dropped this particular commit from the PR

kinnison · 2019-01-16T21:52:20Z

src/rustup/config.rs

+ // Run some basic checks against the constructed configuration
+ // For now, that means simply checking that 'stable' can resolve
+ // for the current configuration.
+ cfg.resolve_toolchain("stable")


Sure. By doing this check here we verify that later attempts to resolve the toolchain are more likely to succeed. It means we report the error about bad host types etc earlier in the sequence of operations. This leads to, in my opinion, a slightly better user experience.

kinnison · 2019-01-16T21:58:07Z

src/rustup/config.rs

@@ -470,7 478,20 @@ impl Cfg {
 }

 pub fn set_default_host_triple(&self, host_triple: &str) -> Result<()> {
- if dist::PartialTargetTriple::from_str(host_triple).is_none() {
+ if let Some(host) = dist::PartialTargetTriple::from_str(host_triple) {


Yeah, for some reason I was entirely blind to how to reuse PartialToolchainDesc::resolve() when I wrote this check. I've reworked it now.

kinnison · 2019-01-16T22:02:12Z

src/rustup-cli/self_update.rs

+ e,
+ dist::TargetTriple::from_host_or_build().as_ref()
+ )
+ })?;


Okay, I've created a function called do_pre_install_options_sanity_checks() and moved the content into there, though for now I'm calling it from the same spot as do_pre_install_sanity_checks() unless I find something better.

kinnison · 2019-01-16T22:04:48Z

src/rustup-cli/self_update.rs

+ "stable"
+ } else {
+ &opts.default_toolchain
+ };


To my knowledge it's not per-se. This is simply because using PartialToolchainDesc::resolve needs a valid toolchain name or it won't work (and none isn't valid IIRC).

It looks similar to other checks, but this time we're resolving from options and don't have a Cfg struct so I can't just call set_default_host et al, and deal with things that way. Also the debug!() is meant to be useful to tell us that it's behaving right and picking the correct fully qualified toolchain name.

If I've missed something you know of, please do let me know, but I've had a fairly good grep around I think.

Perform similar checks to when resolving toolchains in order to reduce the possibility that the configuration will end up with an unusable default-host value. This finally addresses the initial point in rust-lang#745 and thus fixes it. Signed-off-by: Daniel Silverstone <[email protected]>

nrc · 2019-01-22T08:22:45Z

Looks good, thanks!

kinnison mentioned this pull request Dec 14, 2018

Wrong default-host leads to panic #745

Closed

kinnison force-pushed the kinnison/fix-745 branch from f7f4695 to c50d1b0 Compare December 16, 2018 15:37

kinnison force-pushed the kinnison/fix-745 branch from c50d1b0 to b9f786a Compare December 16, 2018 15:57

kinnison force-pushed the kinnison/fix-745 branch 3 times, most recently from 6e26bae to 4af0bd8 Compare January 13, 2019 09:14

kinnison changed the title ~~WIP: Deal cleanly with malformed default-host~~ Deal cleanly with malformed default-host Jan 14, 2019

kinnison force-pushed the kinnison/fix-745 branch from 082440b to 49a9cec Compare January 14, 2019 21:59

kinnison force-pushed the kinnison/fix-745 branch 2 times, most recently from 01e8877 to a71cf31 Compare January 15, 2019 20:56

nrc reviewed Jan 16, 2019

View reviewed changes

kinnison added 6 commits January 16, 2019 21:42

Remove panic on malformed default host

26972a5

It is better to report errors cleanly rather than panic. If the default-host is set badly then we can end up panicking because we're unable to parse it. Since default-host is user input, it's better we don't panic.

Allow configuration to smoke-test itself

87c36da

In order to have useful early error messages when the configuration is unusably broken, allow the Cfg struct to smoke-test itself during `Cfg::from_env()`

Fix minor typo in warning

5481115

Add a log macro at debug level

983b5a6

It can be useful to debug rustup's operation. This comit adds a debug macro using BRIGHT_BLUE which only displays if RUSTUP_DEBUG is in the environment

Permit 'none' as a toolchain

239b34a

In order for the user to install rustup and no toolchain, we must support the 'none' toolchain which isn't actually a valid name. As such whitelist it in the santiy checks.

kinnison commented Jan 16, 2019

View reviewed changes

kinnison force-pushed the kinnison/fix-745 branch from a71cf31 to 36ec58f Compare January 16, 2019 22:14

nrc merged commit b697df1 into rust-lang:master Jan 22, 2019

kinnison deleted the kinnison/fix-745 branch January 22, 2019 10:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deal cleanly with malformed default-host #1578

Deal cleanly with malformed default-host #1578

kinnison commented Dec 14, 2018

kinnison commented Dec 16, 2018

kinnison commented Dec 19, 2018

kinnison commented Jan 14, 2019

nrc left a comment

nrc Jan 16, 2019

kinnison Jan 16, 2019

nrc Jan 16, 2019

kinnison Jan 16, 2019

nrc Jan 16, 2019

kinnison Jan 16, 2019

nrc Jan 16, 2019

kinnison Jan 16, 2019

nrc Jan 17, 2019

nrc Jan 16, 2019

kinnison Jan 16, 2019

kinnison left a comment

kinnison Jan 16, 2019

kinnison Jan 16, 2019

kinnison Jan 16, 2019

kinnison Jan 16, 2019

kinnison Jan 16, 2019

nrc commented Jan 22, 2019

Deal cleanly with malformed default-host #1578

Deal cleanly with malformed default-host #1578

Conversation

kinnison commented Dec 14, 2018

kinnison commented Dec 16, 2018

kinnison commented Dec 19, 2018

kinnison commented Jan 14, 2019

nrc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kinnison left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nrc commented Jan 22, 2019