home-manager: handle profile list in Nix >2.17

Nix 2.17 changed the format of the `nix profile list` output. This
commit adds support for parsing the new JSON profile list format.

Fixes #4298

(cherry picked from commit c3ab5ea047)

home-manager/default.nix

@@ -1,4 +1,4 @@
-{ runCommand, lib, bash, callPackage, coreutils, findutils, gettext, gnused
+{ runCommand, lib, bash, callPackage, coreutils, findutils, gettext, gnused, jq
 , less, ncurses, unixtools
 # used for pkgs.path for nixos-option
 , pkgs
@@ -36,6 +36,7 @@ in runCommand "home-manager" {
         findutils
         gettext
         gnused
+        jq
         less
         ncurses
         nixos-option

home-manager/home-manager

@@ -11,11 +11,21 @@ export TEXTDOMAINDIR=@OUT@/share/locale
 # shellcheck disable=1091
 source @HOME_MANAGER_LIB@
 
-function removeByName() {
+function nixProfileList() {
+    # We attempt to use `--json` first (added in Nix 2.17). Otherwise attempt to
+    # parse the legacy output format.
+    {
+        nix profile list --json 2>/dev/null \
+            | jq -r --arg name "$1" '.elements[].storePaths[] | select(endswith($name))'
+    } || {
         nix profile list \
-      | { grep "$1" || test $? = 1; } \
+            | { grep "$1\$" || test $? = 1; } \
-      | cut -d ' ' -f 4 \
+            | cut -d ' ' -f 4
-      | xargs -t $DRY_RUN_CMD nix profile remove $VERBOSE_ARG
+    }
+}
+
+function removeByName() {
+    nixProfileList "$1" | xargs -t $DRY_RUN_CMD nix profile remove $VERBOSE_ARG
 }
 
 function setNixProfileCommands() {

modules/home-environment.nix

@@ -599,13 +599,27 @@ in
         ''
       else
         ''
+          function nixProfileList() {
+            # We attempt to use `--json` first (added in Nix 2.17). Otherwise attempt to
+            # parse the legacy output format.
+            {
+              nix profile list --json 2>/dev/null \
+                | jq -r --arg name "$1" '.elements[].storePaths[] | select(endswith($name))'
+            } || {
+              nix profile list \
+                | { grep "$1\$" || test $? = 1; } \
+                | cut -d ' ' -f 4
+            }
+          }
+
+          function nixRemoveProfileByName() {
+              nixProfileList "$1" | xargs -t $DRY_RUN_CMD nix profile remove $VERBOSE_ARG
+          }
+
           function nixReplaceProfile() {
             local oldNix="$(command -v nix)"
 
-            nix profile list \
+            nixRemoveProfileByName 'home-manager-path'
-              | { grep 'home-manager-path$' || test $? = 1; } \
-              | cut -d ' ' -f 4 \
-              | xargs -t $DRY_RUN_CMD nix profile remove $VERBOSE_ARG
 
             $DRY_RUN_CMD $oldNix profile install $1
           }
@@ -627,7 +641,7 @@ in
             _iError $'Oops, Nix failed to install your new Home Manager profile!\n\nPerhaps there is a conflict with a package that was installed using\n"%s"? Try running\n\n    %s\n\nand if there is a conflicting package you can remove it with\n\n    %s\n\nThen try activating your Home Manager configuration again.' "$INSTALL_CMD" "$LIST_CMD" "$REMOVE_CMD_SYNTAX"
             exit 1
           fi
-          unset -f nixReplaceProfile
+          unset -f nixProfileList nixRemoveProfileByName nixReplaceProfile
           unset INSTALL_CMD INSTALL_CMD_ACTUAL LIST_CMD REMOVE_CMD_SYNTAX
         ''
     );
@@ -679,6 +693,7 @@ in
             gettext
             gnugrep
             gnused
+            jq
             ncurses             # For `tput`.
           ]
           ++ config.home.extraActivationPath