unify cargo check and clippy commands #631
Conversation
|
OmarTawfik
force-pushed
the
clippy-fix
branch
from
f85c2b4
to
4f9c5a0
Compare
| pub fn get_check_command(subcommand: impl AsRef<str>) -> Result<Command> { | ||
| let mut command = Command::new("cargo") | ||
| .arg(subcommand.as_ref()) | ||
| .flag("--offline") |
There was a problem hiding this comment.
IMO this should be --frozen, if I understand your initial intention of making sure the lockfile is preserved and enforced.
This bit me twice already, when we added some dependencies but my local infra check/test failed because we specify --offline and I actually needed to download new dependencies.
There was a problem hiding this comment.
I think these are two separate concerns:
On one hand, infra setup cargo is responsible for doing that .. locally, it will cargo fetch to download any new deps .. but in CI, it uses uses cargo fetch --locked to make sure Cargo.lock is up to date. We don't use cargo fetch --frozen, because the cache is rarely up to date, and we don't want to fail for that.
On the other hand, infra check cargo or infra test cargo ] use --offline (both locally and CI) for different reasons; Cargo will periodically try to update its manifest/local cache from internet, blocking any local builds/tests. This periodically means 1min+ interruptions for local development, and even blocking development completely if you don't have internet (working offline). --offline prevents that, and makes sure it is always reusing the dependencies already downloaded by infra setup ..
In reality, I never really ran into the problem of missing dependencies, because if I added things in my VS Code, Rust Analyzer will automatically run cargo check on file save (without --locked), which will attempt to download them regardless. I wonder if it is different in your case? isn't it not installed as soon as you save the new Cargo.toml file?
In any case, I added these comments to the source code for clarity!
There was a problem hiding this comment.
I wasn't so focused so much on using --frozen specifically but rather not using --offline unconditionally for check/test locally (we could also use --locked - I understood that enforcing same Cargo.lock is the key here).
The CI case is clear cut - we always expect to run these 4 commands sequentially, so we always run setup first, which fetches the dependencies. One could argue that --offline is too much and just --locked would suffice to make sure the committed Cargo.lock is up to date, but let's leave that.
However, in the local case, I would expect that the subcommands are independent of each other, with the notable exception of having to run setup first.
After running it once, I shouldn't be expected to always run setup before running check/test/lint because it adds overhead and somewhat defeats the purpose of having an ergonomic build system facade.
In reality, I never really ran into the problem of missing dependencies (...)
I just mentioned that this happened to me twice already.
I'm not always running a background check and/or VS Code, so relying on the accidental dependency fetch done by Rust Analyzer is not really reliable, and also goes against the another argument of being blocked by accidental Cargo build, as each build (this includes RA check build) locks the target directory and slows both editor analysis and the infra call.
Cargo will periodically try to update its manifest/local cache from internet
Could you elaborate on that? I don't think Cargo attempts to hit the network again and/or download the registry once it already resolves the lockfile and downloads the relevant packages, unless asked to (e.g. update).
If the index download performance is a concern, maybe we should be using Cargo's sparse-registry feature? See the link for more details, but long story short, this allows to download the index over a HTTP over resolving it via git, which speeds up the initial crates.io index fetch tremendously.
If we want to add an explicit support for --offline, I think this is better done as an extra flag to the infra rather than doing this unconditionally, as explained per above.
There was a problem hiding this comment.
Could you elaborate on that? I don't think Cargo attempts to hit the network again and/or download the registry once it already resolves the lockfile and downloads the relevant packages, unless asked to (e.g. update).
Even cargo check or cargo test can routinely update its offline copy of crates.io index (IIRC, fetching from this repo), which can take up to a minute to complete. I'm not sure which exact conditions that trigger it.
this happened to me twice already.
I'm not always running a background check and/or VS Code
I see. In that case, I will remove -offline for now, as it defeats the purpose if it actually blocks local development. I'll look into implementing a better solution when/if that comes up again. Will also look up sparse-registry! thanks for the link.
OmarTawfik
force-pushed
the
clippy-fix
branch
from
4f9c5a0
to
20597c2
Compare
OmarTawfik
force-pushed
the
clippy-fix
branch
from
20597c2
to
d63a048
Compare
OmarTawfik
force-pushed
the
clippy-fix
branch
from
d63a048
to
42c39cd
Compare
So that all targets/features/packages are checked in the same way.
Additionally, I'm removing
rust-analyzer.checkOnSavefrom settings, as I suggest leaving this up to individual user preferences. Running checks for a large workspace is expensive.