om health: Add supported nix versions health check
#398
Conversation
|
Check passing with: health:
default:
nix-version:
supported:
- ">=2.16.0"...
✅ Flakes Enabled
experimental-features = flakes fetch-tree nix-command
✅ Minimum Nix Version
nix version = 2.24.10
✅ Supported Nix Versions
nix version = 2.24.10
...
✅ All checks passedCheck failing with: health:
default:
nix-version:
supported:
- ">=2.16.0"
- "<2.24.10, >2.24.10"...
✅ Flakes Enabled
experimental-features = flakes fetch-tree nix-command
✅ Minimum Nix Version
nix version = 2.24.10
❌ Supported Nix Versions
nix version = 2.24.10
Problem: Your Nix version (2.24.10) doesn't satisfy the supported bounds: >=2.16.0, <2.24.10, >2.24.10
Fix: Set nix.package in home-manager to the desired Nix version
...
❌ Some required checks failed |
Depends on the behaviour when we run this against old code (which specifies |
It is silently ignored. |
|
An example of failure using the new NixVersion spec:
|
| #[derive(Debug, Serialize, Deserialize, PartialEq, Clone)] | ||
| #[serde(default, rename_all = "kebab-case")] | ||
| pub struct NixVersionCheck { | ||
| pub supported: String, |
There was a problem hiding this comment.
I wish serde supported passing a function as a deserializer. I could just use pub supported: NixVersionReq here, if it did. Maybe it does and I haven’t looked properly?
There was a problem hiding this comment.
I wish serde supported passing a function as a deserializer. I could just use pub supported: NixVersionReq here, if it did. Maybe it does and I haven’t looked properly?
I can also avoid using unwrap() in the check function below.
There was a problem hiding this comment.
Maybe #[serde(deserialize_with = “<function-name>”)]?
| /// Patch version | ||
| pub patch: u32, | ||
| pub patch: Option<u32>, |
There was a problem hiding this comment.
This changes the semantics of this type. If you look at the type documenation, it says
Nix version as parsed from `nix --version`
And nix --version always returns all 3 components - major, minor and patch.
It seems that the type here is being changed to fit something in version_spec.hs - yet version.rs is isolated from that module.
| @@ -0,0 +1,204 @@ | |||
| //! Rust module defining the spec for [NixVersion] | |||
There was a problem hiding this comment.
| //! Rust module defining the spec for [NixVersion] | |
| //! Version requirement spec for [NixVersion] |
| Neq(NixVersion), | ||
| } | ||
|
|
||
| /// A collection of version requirements |
There was a problem hiding this comment.
| /// A collection of version requirements | |
| /// Version requirement for [NixVersion] | |
| /// | |
| /// Example: | |
| /// ``` | |
| /// >=2.8, <2.14, 12.13.4 | |
| /// ``` |
|
|
||
| use crate::version::{BadNixVersion, NixVersion}; | ||
|
|
||
| /// Specifies a version requirement for Nix |
There was a problem hiding this comment.
| /// Specifies a version requirement for Nix | |
| /// An individual component of `NixVersionReq` |
| /// Checks if all version specifications are satisfiable | ||
| /// | ||
| /// Returns Err if the requirements are logically impossible to satisfy | ||
| fn check(specs: &[NixVersionSpec]) -> Result<(), BadNixVersionSpec> { |
There was a problem hiding this comment.
I was confused by this function for a moment.
| fn check(specs: &[NixVersionSpec]) -> Result<(), BadNixVersionSpec> { | |
| fn ensure_logically_sound(specs: &[NixVersionSpec]) -> Result<(), BadNixVersionSpec> { |
There was a problem hiding this comment.
By the way, why do we need this check? Asked differently: what happens if we don't use it?
| NixVersionSpec::Gt(v) => version > v, | ||
| NixVersionSpec::Gteq(v) => version >= v, | ||
| NixVersionSpec::Lt(v) => version < v, | ||
| NixVersionSpec::Lteq(v) => version < v, |
| use NixVersionSpec::{Gt, Gteq, Lt, Lteq, Neq}; | ||
|
|
||
| let s = s.trim(); | ||
| match s.get(..2) { | ||
| Some("!=") => Ok(Neq(NixVersion::from_str(&s[2..])?)), | ||
| Some(">=") => Ok(Gteq(NixVersion::from_str(&s[2..])?)), | ||
| Some("<=") => Ok(Lteq(NixVersion::from_str(&s[2..])?)), | ||
| Some(s2) if s2.starts_with('>') => Ok(Gt(NixVersion::from_str(&s[1..])?)), | ||
| Some(s2) if s2.starts_with('<') => Ok(Lt(NixVersion::from_str(&s[1..])?)), | ||
| _ => Err(BadNixVersionSpec::UnknownOperator(s.to_string())), | ||
| } |
There was a problem hiding this comment.
Hmm, yea, parsing in Rust can be more complicated than Haskell.
I don't understand (in immediate glance; without thinking much) what this 2 index is about. Would using a parsec based parser simplify things? e.g.: https://github.com/Marwes/combine
| let mut specs = self.specs.iter(); | ||
|
|
||
| if let Some(first) = specs.next() { | ||
| write!(f, "{}", first)?; | ||
| for spec in specs { | ||
| write!(f, ", {}", spec)?; | ||
| } | ||
| } |
| pub supported: NixVersionReq, | ||
| } | ||
|
|
||
| fn deserialize_version_req<'de, D>(deserializer: D) -> Result<NixVersionReq, D::Error> |
There was a problem hiding this comment.
| let is_supported = self.supported.specs.iter().all(|spec| spec.matches(val)); | ||
|
|
||
| let supported_version_check = Check { | ||
| title: "Supported Nix Versions".to_string(), |
There was a problem hiding this comment.
| title: "Supported Nix Versions".to_string(), | |
| title: "Nix version is supported".to_string(), |
resolves #386
Changes
NixVersionnix-versions.min-requiredhealth check with more flexiblenix-versions.supportedThe new version specification system provides APIs to parse complex version requirements, enabling fine-grained control over which Nix versions should pass the health check.
Example of a version requirement string for
nix-versions.supported:This requirement specifies that:
Any Nix version meeting all these criteria will pass the health check.
TODO
nix-version.min-required? Even if we are to deprecate it, how to do it?om health: Addsupportednix versions health check #398 (comment)version_spec::NixVersionReq::checkas it doesn’t yet account forGteqandLteqnixand link it as aFixwhenSupported Nix versionsfails? (Use a specific version ofnixnixos-asia/website#47)