Skip to content

Commit

Permalink
nixos/modules: Add declarationsWithLocations
Browse files Browse the repository at this point in the history
What it does: line and column level *declaration* position information:

$ nix repl .
nix-repl> :p nixosConfigurations.micro.options.environment.systemPackages.declarationsWithLocations
[ { column = 7; file = "/nix/store/24aj3k7fgqv3ly7qkbf98qvphasrw9nb-source/nixos/modules/config/system-path.nix"; line = 63; } ]

Use cases:
- ctags over NixOS options, as will be presented at NixCon 2023 ;)
- improving the documentation pages to go to the exact line of the
  declarations.

Related work:
- NixOS#65024

  This one does it for all *definitions* rather than declarations, and
  it was not followed through with due to performance worries.
- NixOS#208173

  The basis for this change. This change is just a rebase of that one.
  I split it out to add the capability before adding users of it, in
  order to simplify review. However, the ctags script in there is a
  sample user of this feature.

Benchmarks: conducted by evaluating my own reasonably complex NixOS
configuration with the command:
`hyperfine -S none -w 1 -- "nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath"`

```
Benchmark 1: nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath
  Time (mean ± σ):      8.971 s ±  0.254 s    [User: 5.872 s, System: 1.388 s]
  Range (min … max):    8.574 s …  9.327 s    10 runs

Benchmark 1: nix eval .#nixosConfigurations.snowflake.config.system.build.toplevel.outPath
  Time (mean ± σ):      8.766 s ±  0.160 s    [User: 5.873 s, System: 1.346 s]
  Range (min … max):    8.496 s …  9.033 s    10 runs
```

Summary of results: it seems to be in the noise, this does not cause any
visible regression in times.
  • Loading branch information
lf- committed Aug 15, 2023
1 parent 450d643 commit 997f76f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
13 changes: 7 additions & 6 deletions lib/modules.nix
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ let
else config;
in
if m ? config || m ? options then
let badAttrs = removeAttrs m ["_class" "_file" "key" "disabledModules" "imports" "options" "config" "meta" "freeformType"]; in
let badAttrs = removeAttrs m ["_class" "_file" "_loc" "key" "disabledModules" "imports" "options" "config" "meta" "freeformType"]; in
if badAttrs != {} then
throw "Module `${key}' has an unsupported attribute `${head (attrNames badAttrs)}'. This is caused by introducing a top-level `config' or `options' attribute. Add configuration attributes immediately on the top level instead, or move all of them (namely: ${toString (attrNames badAttrs)}) into the explicit `config' attribute."
else
Expand All @@ -480,7 +480,7 @@ let
disabledModules = m.disabledModules or [];
imports = m.require or [] ++ m.imports or [];
options = {};
config = addFreeformType (removeAttrs m ["_class" "_file" "key" "disabledModules" "require" "imports" "freeformType"]);
config = addFreeformType (removeAttrs m ["_class" "_file" "_loc" "key" "disabledModules" "require" "imports" "freeformType"]);
};

applyModuleArgsIfFunction = key: f: args@{ config, options, lib, ... }:
Expand Down Expand Up @@ -537,7 +537,7 @@ let
mergeModules' prefix modules
(concatMap (m: map (config: { file = m._file; inherit config; }) (pushDownProperties m.config)) modules);

mergeModules' = prefix: options: configs:
mergeModules' = prefix: modules: configs:
let
# an attrset 'name' => list of submodules that declare ‘name’.
declsByName =
Expand All @@ -554,11 +554,11 @@ let
else
mapAttrs
(n: option:
[{ inherit (module) _file; options = option; }]
[{ inherit (module) _file; _loc = builtins.unsafeGetAttrPos n subtree; options = option; }]
)
subtree
)
options);
modules);

# The root of any module definition must be an attrset.
checkedConfigs =
Expand Down Expand Up @@ -730,9 +730,10 @@ let
else res.options;
in opt.options // res //
{ declarations = res.declarations ++ [opt._file];
declarationsWithLocations = res.declarationsWithLocations ++ optional (opt._loc != null) opt._loc;
options = submodules;
} // typeSet
) { inherit loc; declarations = []; options = []; } opts;
) { inherit loc; declarations = []; declarationsWithLocations = []; options = []; } opts;

/* Merge all the definitions of an option to produce the final
config value. */
Expand Down
1 change: 1 addition & 0 deletions lib/tests/modules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ checkConfigError 'The option .* is used but not defined' config.foo ./freeform-l
checkConfigOutput '^"24"$' config.foo ./freeform-lazyAttrsOf.nix ./freeform-unstr-dep-str.nix ./define-value-string.nix
# submodules in freeformTypes should have their locations annotated
checkConfigOutput '/freeform-submodules.nix"$' config.fooDeclarations.0 ./freeform-submodules.nix
checkConfigOutput '/freeform-submodules.nix"$' config.fooDeclarationsLoc.0.file ./freeform-submodules.nix
# freeformTypes can get merged using `types.type`, including submodules
checkConfigOutput '^10$' config.free.xxx.foo ./freeform-submodules.nix
checkConfigOutput '^10$' config.free.yyy.bar ./freeform-submodules.nix
Expand Down
3 changes: 3 additions & 0 deletions lib/tests/modules/freeform-submodules.nix
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
options.fooDeclarations = lib.mkOption {
default = (options.free.type.getSubOptions [])._freeformOptions.foo.declarations;
};
options.fooDeclarationsLoc = lib.mkOption {
default = (options.free.type.getSubOptions [])._freeformOptions.foo.declarationsWithLocations;
};

options.free = lib.mkOption {
type = submodule {
Expand Down

0 comments on commit 997f76f

Please sign in to comment.