Merge pull request 'inventory/interface: reduce apply arguments chain by adding options' (#4092) from clan-unify into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4092

docs/nix/options/flake-module.nix

@@ -121,9 +121,10 @@
                   roleName: roleSettingsModule:
                   mkOption {
                     type = types.submodule {
+                      _file = "docs flake-module";
                       imports = [
+                        { _module.args = { inherit clanLib; }; }
                         (import ../../../lib/inventory/build-inventory/roles-interface.nix {
-                          inherit clanLib;
                           nestedSettingsOption = mkOption {
                             type = types.raw;
                             description = ''
@@ -148,10 +149,12 @@
       mkScope = name: modules: {
         inherit name;
         modules = [
-          (import ../../../lib/inventory/build-inventory/interface.nix {
+          {
-            inherit clanLib;
+            _module.args = { inherit clanLib; };
-            noInstanceOptions = true;
+            _file = "docs mkScope";
-          })
+          }
+          { noInstanceOptions = true; }
+          ../../../lib/inventory/build-inventory/interface.nix
         ] ++ mapAttrsToList fakeInstanceOptions modules;
         urlPrefix = "https://github.com/nix-community/dream2nix/blob/main/";
       };

lib/inventory/build-inventory/builder/default.nix

@@ -170,6 +170,7 @@ in
               getRoleFile = role: builtins.seq role inventory.modules.${serviceName} + "/roles/${role}.nix";
             in
             {
+              _file = "inventory/builder.nix";
               _module.args = {
                 inherit
                   resolveTags

lib/inventory/build-inventory/interface.nix

@@ -1,10 +1,6 @@
-{
-  clanLib,
-  # workaround for docs rendering to include fake instance options
-  noInstanceOptions ? false,
-}:
 {
   lib,
+  clanLib,
   config,
   options,
   ...
@@ -101,6 +97,7 @@ in
     ./assertions.nix
   ];
   options = {
+    # Internal things
     _inventoryFile = lib.mkOption {
       type = types.path;
       readOnly = true;
@@ -112,6 +109,12 @@ in
       visible = false;
       default = { };
     };
+    noInstanceOptions = lib.mkOption {
+      type = types.bool;
+      internal = true;
+      visible = false;
+      default = false;
+    };
 
     options = lib.mkOption {
       internal = true;
@@ -119,6 +122,8 @@ in
       type = types.raw;
       default = options;
     };
+    # ---------------------------
+
     modules = lib.mkOption {
       # Don't define the type yet
       # We manually transform the value with types.deferredModule.merge later to keep them serializable
@@ -375,7 +380,7 @@ in
     };
 
     instances =
-      if noInstanceOptions then
+      if config.noInstanceOptions then
         { }
       else
         lib.mkOption {
@@ -414,7 +419,15 @@ in
                         default = { };
                         type = types.attrsOf (
                           types.submodule {
-                            imports = [ (import ./roles-interface.nix { inherit clanLib; }) ];
+                            imports = [
+                              {
+                                _file = "inventory/interface";
+                                _module.args = {
+                                  inherit clanLib;
+                                };
+                              }
+                              (import ./roles-interface.nix { })
+                            ];
                           }
                         );
                       };

lib/inventory/build-inventory/roles-interface.nix

@@ -1,9 +1,8 @@
 {
-  clanLib,
   settingsOption ? null,
   nestedSettingsOption ? null,
 }:
-{ lib, ... }:
+{ lib, clanLib, ... }:
 let
   inherit (lib)
     types

lib/inventory/default.nix

@@ -6,12 +6,11 @@ in
   inherit (services) evalClanService mapInstances resolveModule;
   inherit (import ./build-inventory { inherit lib clanLib; }) buildInventory;
   interface = {
+    _file = "inventory/default.nix";
     imports = [
-      (import ./build-inventory/interface.nix { inherit clanLib; })
+      ./build-inventory/interface.nix
     ];
-    _module.args = {
+    _module.args = { inherit clanLib; };
-      inherit clanLib;
-    };
   };
   # Returns the list of machine names
   # { ... } -> [ string ]

lib/inventory/distributed-service/tests/default.nix

@@ -15,6 +15,7 @@ let
       modules = [
         clanLib.inventory.interface
         {
+          _file = "test file";
           tags.all = [ ];
           tags.nixos = [ ];
           tags.darwin = [ ];

lib/inventory/frontmatter/default.nix

@@ -56,7 +56,9 @@ let
         {
           constraints.imports = [
             (lib.modules.importApply ../constraints {
+              resolvedRoles = { };
               moduleName = "{moduleName}";
+              instanceName = "{instanceName}";
               allRoles = [ "{roleName}" ];
             })
           ];

lib/inventory/schemas/default.nix

@@ -18,9 +18,10 @@ let
 
   frontMatterSchema = jsonLib.parseOptions self.clanLib.modules.frontmatterOptions { };
 
-  inventorySchema = jsonLib.parseModule (
+  inventorySchema = jsonLib.parseModule ({
-    import ../build-inventory/interface.nix { inherit (self) clanLib; }
+    imports = [ ../build-inventory/interface.nix ];
-  );
+    _module.args = { inherit (self) clanLib; };
+  });
 
   clanSchema = jsonLib.parseOptions (flakeOptions.clan.type.getSubOptions [ "clan" ]) { };
 

lib/modules/clan/interface.nix

@@ -100,7 +100,11 @@ in
     inventory = lib.mkOption {
       type = types.submodule {
         imports = [
-          (lib.modules.importApply ../../inventory/build-inventory/interface.nix { inherit clanLib; })
+          {
+            _module.args = { inherit clanLib; };
+            _file = "clan interface";
+          }
+          ../../inventory/build-inventory/interface.nix
         ];
       };
       description = ''