fixup! nixos/{assertions,warnings}: use structured attrs

NixOS · Oct 3, 2024 · 8a86a2b · 8a86a2b
1 parent b01fa5a
commit 8a86a2b
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 6 deletions.
diff --git a/nixos/modules/misc/assertions.nix b/nixos/modules/misc/assertions.nix
@@ -3,7 +3,7 @@
   options = {
     assertions = lib.mkOption {
       type = let
-        assertionItemType = lib.types.submodule {
+        assertionItemType = lib.types.submodule ({ config, ... }: {
           options = {
             enable = lib.mkOption {
               description = ''
@@ -25,11 +25,28 @@
 
             message = lib.mkOption {
               description = "The contents of the error message that should be shown upon triggering a false assertion";
-              type = lib.types.nonEmptyStr;
+              type = if config.lazy then lib.types.unspecified else lib.types.nonEmptyStr;
               example = "This is an example error message";
             };
+
+            lazy = lib.mkOption {
+              description = ''
+                Whether to avoid evaluating the message contents until the assertion condition occurs.
+
+                This will also disable typechecking.
+
+                ::: {.note}
+                We do not recommend you enable this. It is mostly intended for backwards compatibility.
+                If you do need to enable it, make sure to double check that your `message` always will
+                evaluate successfully whenever the assertion would trigger.
+                :::
+              '';
+              type = lib.types.bool;
+              default = false;
+              example = true;
+            };
           };
-        };
+        });
 
         # This might be replaced when tagged submodules or similar are available,
         # see https://github.com/NixOS/nixpkgs/pull/254790
@@ -50,7 +67,7 @@
         # The attribute name will be set to the sha256 sum of the assertion message, e.g. `assertions.legacy."<sha256>" = { ... }`
         coercedAssertionAttrs = let
           coerce = xs: {
-            legacy = lib.listToAttrs (map (assertion: lib.nameValuePair (builtins.hashString "sha256" assertion.message) assertion) xs);
+            legacy = lib.listToAttrs (lib.imap0 (i: assertion: lib.nameValuePair "anon-${toString i}" (assertion // { lazy = true; })) xs);
           };
         in with lib.types; coercedTo (listOf (attrsOf unspecified)) coerce (submodule { freeformType = nestedAssertionAttrsType; });
       in coercedAssertionAttrs;

diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix
@@ -61,12 +61,31 @@ let
 
   # Handle assertions and warnings
 
+  collectUntil = let
+    collectUntil' =
+      path:
+      pred:
+      dontProceedPred:
+      value:
+      if pred value then
+        [ { inherit path value; } ]
+      else if dontProceedPred value then
+        [ ]
+      else if isAttrs value then
+        concatMap ({ name, value }: collectUntil' (path ++ [ name ]) pred dontProceedPred value) (attrsToList value)
+      else
+        [];
+  in collectUntil' [];
+
   failedAssertions = let
-    assertions = lib.collect' (x: builtins.isAttrs x && x ? message && !(x.assertion or true) && (x.enable or false)) config.assertions;
+    assertions = collectUntil
+      (x: builtins.isAttrs x && !(x.assertion or true) && (x.enable or false) && x ? message)
+      (x: builtins.isAttrs x && (x.lazy or false))
+      config.assertions;
   in map (x: "assertions." + (lib.concatStringsSep "." x.path) + ":\n" + x.value.message) assertions;
 
   failedWarnings = let
-    warnings = lib.collect' (x: builtins.isAttrs x && x ? message && (x.condition or false) && (x.enable or false)) config.warnings;
+    warnings = lib.collect' (x: builtins.isAttrs x && (x.condition or false) && (x.enable or false) && x ? message) config.warnings;
   in map (x: "warnings." (lib.concatStringsSep "." x.path) + ":\n" + x.value.message) warnings;
 
   baseSystemAssertWarn = if failedAssertions != []