nixos/modules/programs/dconf: redesign profiles #189099

kekrby · 2022-08-31T11:12:17Z

Description of changes

This PR is a redesign of the NixOS dconf module and provides a way to solve the issues noted in #54150.

If merged, it presents an alternative to extraGSettingsOverrides that is more reliable as the user can disable overriding options with enableUserDb = false;. Users can store their configurations both as dconf keyfiles or as Nix expressions.

This is how the module can be used:

{
  # With keyfiles
  programs.dconf.profiles.user.databases = lib.singleton (pkgs.dconf-utils.mkDconfDb ./files/dconf);

  # With a Nix expression
  programs.dconf.profiles.user.databases = with lib.dconf; lib.singleton {
    org.gnome.shell = {
      disable-user-extensions = true;
      favorite-apps = [ "firefox.desktop" "thunderbird.desktop" ];
      welcome-dialog-last-shown-version = "999";
    };

    org.gnome.desktop.input-sources = {
      sources = [
        (mkTuple [ "xkb" "en" ])
      ];
      xkb-options = [ "terminate:ctrl_alt_bksp" ];
    };
  };
}

Things done

bjornfor · 2022-11-07T12:01:28Z

@kekrby: Can you rebase please?

lib/dconf.nix

pkgs/development/libraries/dconf/utils.nix

nixos/modules/programs/dconf.nix

bjornfor · 2022-11-08T17:45:25Z

nixos/modules/i18n/input-method/ibus.nix (and possibly more?) refer to the option programs.dconf.packages, which this PR removes. Migrate them in this PR please?

kekrby · 2022-11-08T19:02:14Z

It looks like I missed that. It should now correctly create an ibus profile.

This redesign allows proper creation and management of dconf profiles using NixOS and provides a way to solve the problems noted in issue 54150.

nixos-discourse · 2023-04-05T12:51:08Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/prs-already-reviewed/2617/891

SuperSandro2000 · 2023-04-06T20:23:07Z

pkgs/top-level/all-packages.nix

@@ -3703,6 +3703,8 @@ with pkgs;

  dconf = callPackage ../development/libraries/dconf { };

+  dconf-utils = callPackage ../development/libraries/dconf/utils.nix { };


This is very tiny, please move it into dconf itself.

It is only tiny because it is very incomplete. We will eventually want something like https://github.com/nix-community/home-manager/blob/ec06f419af79207b33d797064dfb3fc9dbe1df4a/modules/lib/gvariant.nix Never mind, was looking at a wrong file.

SuperSandro2000 · 2023-04-06T20:23:24Z

nixos/modules/services/x11/display-managers/gdm.nix

-            sleep-inactive-battery-timeout=0
-          ''}
-        '';
+    programs.dconf.profiles.gdm.databases = [ "${gdm}/share/gdm/greeter-dconf-defaults" ] ++ lib.lists.optional cfg.gdm.autoSuspend {


Suggested change

programs.dconf.profiles.gdm.databases = [ "${gdm}/share/gdm/greeter-dconf-defaults" ] ++ lib.lists.optional cfg.gdm.autoSuspend {

programs.dconf.profiles.gdm.databases = [ "${gdm}/share/gdm/greeter-dconf-defaults" ]

++ lib.lists.optional cfg.gdm.autoSuspend {

SuperSandro2000 · 2023-04-06T20:23:48Z

nixos/modules/programs/dconf.nix

+    environment.sessionVariables = {
+      # Needed for unwrapped applications
+      GIO_EXTRA_MODULES = [ "${pkgs.dconf.lib}/lib/gio/modules" ];
+    } // (if cfg.defaultProfile != null then { DCONF_PROFILE = cfg.defaultProfile; } else {});


Suggested change

} // (if cfg.defaultProfile != null then { DCONF_PROFILE = cfg.defaultProfile; } else {});

} // lib.optionalAttrs (cfg.defaultProfile != null) { DCONF_PROFILE = cfg.defaultProfile; };

SuperSandro2000 · 2023-04-06T20:24:18Z

nixos/modules/programs/dconf.nix

-    # Needed for unwrapped applications
-    environment.sessionVariables.GIO_EXTRA_MODULES = mkIf cfg.enable [ "${pkgs.dconf.lib}/lib/gio/modules" ];
+    environment.sessionVariables = {
+      # Needed for unwrapped applications


Shouldn't we rather fix those or is the overhead so big, that we rather not wrap this at all?

SuperSandro2000 · 2023-04-06T20:24:52Z

nixos/modules/programs/dconf.nix

 in
 {
-  ###### interface
+  imports = [
+    (lib.mkRemovedOptionModule [ "programs" "dconf" "packages" ] "This option is not supported anymore, you should use `programs.dconf.profiles.<profile>.databases` instead.")


We canno use mkRenamedOption here?

SuperSandro2000 · 2023-04-06T20:25:14Z

nixos/doc/manual/release-notes/rl-2211.section.md

@@ -212,6 +217,8 @@ Available as [services.patroni](options.html#opt-services.patroni.enable).
 - Emacs now uses the Lucid toolkit by default instead of GTK because of stability and compatibility issues.
  Users who still wish to remain using GTK can do so by using `emacs-gtk`.

+- The option `programs.dconf.packages` has been removed, use `programs.dconf.profiles.user.databases` instead.


This can definitely be a mkRenamedOption

SuperSandro2000 · 2023-04-06T20:25:47Z

nixos/doc/manual/from_md/release-notes/rl-2211.section.xml

@@ -125,6 +125,18 @@
          would in NixOS 22.05 and earlier.
        </para>
      </listitem>
+      <listitem>


We no longer do xml files in nixos/* . Also please carry over the other changelog to 23.05

SuperSandro2000 · 2023-04-06T20:26:18Z

lib/dconf.nix

+rec {
+  types = {
+    tuple = "_tuple";
+  };
+
+  mkTuple = _elements: {
+    inherit _elements;
+
+    _type = types.tuple;
+  };
+}


Do we even need this here? Why not put it into the module.

This incomplete implementation of GVariant type system. Ideally, we would have a full implementation like home-manager has and having it separately is nicer for using it in different context, including tests.

If that is the full one, we should keep it separate. Maybe add a comment, that it isn't complete and maybe with a ref to hm.

jtojnar · 2023-04-06T22:10:16Z

nixos/modules/services/x11/display-managers/gdm.nix

+      org.gnome.settings-daemon.plugins.power = {
+        sleep-inactive-ac-type = "nothing";
+        sleep-inactive-battery-type = "nothing";
+        sleep-inactive-ac-timeout = 0;


I wonder if we should require an explicit integer type (eg. lib.gvariant.mkInt). For example, org.gnome.desktop.session’s idle-delay requires uint32 and people regularly trip on it, passing it a Nix number in home-manager, which implicitly gets turned into an int.

Alternative would be making the dconf module internal and creating a separate GSettings module that would also perform validation against schema.

jtojnar · 2023-04-06T22:12:36Z

nixos/modules/programs/dconf.nix

+            databases = lib.mkOption {
+              type = with lib.types; listOf (oneOf [ attrs str path package ]);
+              default = [];
+              description = lib.mdDoc "List of data sources for the profile. An element can be an attrset, or the path of an already compiled database.";


Missing explanation of string argument.

I wrote this before realizing that there's a good implementation of this in `home-manager`: - https://github.com/nix-community/home-manager/blob/master/modules/lib/gvariant.nix - https://github.com/nix-community/home-manager/blob/master/tests/lib/types/gvariant-merge.nix - https://github.com/nix-community/home-manager/blob/master/modules/misc/dconf.nix And that there's an INI based adapter for `dconf` in this nixpkgs PR (which will hopefully be merged soon): - NixOS/nixpkgs#189099 Even so, I'm going to keep this for now so that I can set gnome settings in NixOS configs without needing to wait for that PR or resort to embedding gschema files.

linsui · 2023-08-29T02:26:18Z

Suppressed by #234615.

kekrby requested review from edolstra, nbp, Profpatsch and infinisil as code owners August 31, 2022 11:12

github-actions bot added 6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) labels Aug 31, 2022

kekrby force-pushed the enhance-dconf-module branch from 6226f18 to 090a42e Compare August 31, 2022 11:16

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Aug 31, 2022

kekrby force-pushed the enhance-dconf-module branch 7 times, most recently from 376408a to df82365 Compare September 1, 2022 06:11

kekrby force-pushed the enhance-dconf-module branch from 64c4a6d to fd906fb Compare September 7, 2022 17:24

ofborg bot added 2.status: merge conflict and removed 2.status: merge conflict labels Sep 7, 2022

bjornfor requested a review from jtojnar November 5, 2022 15:39

kekrby force-pushed the enhance-dconf-module branch from f7cf907 to 05927ee Compare November 7, 2022 14:38

jtojnar reviewed Nov 7, 2022

View reviewed changes

lib/dconf.nix Outdated Show resolved Hide resolved

jtojnar reviewed Nov 7, 2022

View reviewed changes

pkgs/development/libraries/dconf/utils.nix Outdated Show resolved Hide resolved

jtojnar reviewed Nov 7, 2022

View reviewed changes

nixos/modules/programs/dconf.nix Outdated Show resolved Hide resolved

kekrby force-pushed the enhance-dconf-module branch from 05927ee to ced2d66 Compare November 8, 2022 17:07

kekrby removed request for edolstra and nbp November 8, 2022 17:08

kekrby requested review from jtojnar and removed request for Profpatsch and infinisil November 8, 2022 17:08

kekrby force-pushed the enhance-dconf-module branch 2 times, most recently from 5e0698b to ab3bcd3 Compare November 8, 2022 19:00

nixos/modules/programs/dconf: redesign profiles

0967cce

This redesign allows proper creation and management of dconf profiles using NixOS and provides a way to solve the problems noted in issue 54150.

kekrby force-pushed the enhance-dconf-module branch from ab3bcd3 to 0967cce Compare November 8, 2022 19:04

SuperSandro2000 reviewed Apr 6, 2023

View reviewed changes

jtojnar reviewed Apr 6, 2023

View reviewed changes

linsui mentioned this pull request May 28, 2023

nixos/dconf: support generating from attrs #234615

Merged

12 tasks

linsui closed this Aug 29, 2023

kekrby deleted the enhance-dconf-module branch August 29, 2023 12:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nixos/modules/programs/dconf: redesign profiles #189099

nixos/modules/programs/dconf: redesign profiles #189099

kekrby commented Aug 31, 2022 •

edited

bjornfor commented Nov 7, 2022

bjornfor commented Nov 8, 2022

kekrby commented Nov 8, 2022

nixos-discourse commented Apr 5, 2023

SuperSandro2000 Apr 6, 2023

jtojnar Apr 6, 2023 •

edited

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

SuperSandro2000 Apr 6, 2023

jtojnar Apr 6, 2023 •

edited

SuperSandro2000 Apr 8, 2023

jtojnar Apr 6, 2023

jtojnar Apr 6, 2023

linsui commented Aug 29, 2023

		@@ -3703,6 +3703,8 @@ with pkgs;

		dconf = callPackage ../development/libraries/dconf { };

		dconf-utils = callPackage ../development/libraries/dconf/utils.nix { };

	programs.dconf.profiles.gdm.databases = [ "${gdm}/share/gdm/greeter-dconf-defaults" ] ++ lib.lists.optional cfg.gdm.autoSuspend {
	programs.dconf.profiles.gdm.databases = [ "${gdm}/share/gdm/greeter-dconf-defaults" ]
	++ lib.lists.optional cfg.gdm.autoSuspend {

	} // (if cfg.defaultProfile != null then { DCONF_PROFILE = cfg.defaultProfile; } else {});
	} // lib.optionalAttrs (cfg.defaultProfile != null) { DCONF_PROFILE = cfg.defaultProfile; };

nixos/modules/programs/dconf: redesign profiles #189099

nixos/modules/programs/dconf: redesign profiles #189099

Conversation

kekrby commented Aug 31, 2022 • edited

Description of changes

Things done

bjornfor commented Nov 7, 2022

bjornfor commented Nov 8, 2022

kekrby commented Nov 8, 2022

nixos-discourse commented Apr 5, 2023

Choose a reason for hiding this comment

jtojnar Apr 6, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtojnar Apr 6, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linsui commented Aug 29, 2023

kekrby commented Aug 31, 2022 •

edited

jtojnar Apr 6, 2023 •

edited

jtojnar Apr 6, 2023 •

edited