NixOS/home-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

launchd: fix user domain agents

Browse Source 
User-domain agents need the Background session type to bootstrap into user/501, and activation should fail rather than silently unloading services when launchctl bootstrap fails.
This commit is contained in:
Austin Horstman
2026-06-30 23:39:07 -05:00
parent 2a37d71bbe
commit 2f3da3d45f
30 changed files with 208 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/launchd/default.nix
+137 -24
View File
@@ -14,7 +14,7 @@ let
dstDir = "${config.home.homeDirectory}/Library/LaunchAgents";
launchdConfig =
{ name, ... }:
{ name, config, ... }:
{
options = {
enable = lib.mkEnableOption name;
@@ -55,9 +55,14 @@ let
};
};
config = {
config = lib.mkMerge [
{
config.Label = lib.mkDefault "${labelPrefix}${name}";
};
}
(lib.mkIf (config.domain == "user") {
config.LimitLoadToSessionType = lib.mkDefault "Background";
})
];
};
# mutateConfig calls /bin/sh with /bin/wait4path to wait for /nix/store before
@@ -211,6 +216,13 @@ in
esac
}
agentIsLoaded() {
local domain="$1"
local agentName="$2"
run /bin/launchctl print "$domain/$agentName" >/dev/null 2>&1
}
# Stop an agent if it's running
bootoutAgent() {
local domain="$1"
@@ -218,21 +230,24 @@ in
verboseEcho "Stopping agent '$domain/$agentName'..."
local bootout_output
bootout_output=$(run /bin/launchctl bootout --wait "$domain/$agentName" 2>&1) || {
if bootout_output=$(run /bin/launchctl bootout --wait "$domain/$agentName" 2>&1); then
return 0
else
# Only show warning if it's not the common "No such process" error
if [[ "$bootout_output" != *"No such process"* ]]; then
warnEcho "Failed to stop agent '$domain/$agentName': $bootout_output"
return 1
else
verboseEcho "Agent '$domain/$agentName' was not running"
return 2
fi
fi
}
}
installAndBootstrapAgent() {
installAgentFile() {
local srcPath="$1"
local dstPath="$2"
local domain="$3"
local agentName="$4"
local agentName="$3"
verboseEcho "Installing agent file to $dstPath"
if ! run install -Dm444 -T "$srcPath" "$dstPath"; then
@@ -240,11 +255,17 @@ in
return 1
fi
return 0
}
bootstrapAgent() {
local domain="$1"
local dstPath="$2"
local agentName="$3"
verboseEcho "Starting agent '$domain/$agentName'"
local bootstrap_output
bootstrap_output=$(run /bin/launchctl bootstrap "$domain" "$dstPath" 2>&1) || {
local error_code=$?
if [[ "$bootstrap_output" == *"Bootstrap failed: 5: Input/output error"* ]]; then
errorEcho "Failed to start agent '$domain/$agentName' with I/O error (code 5)"
errorEcho "This typically happens when the agent wasn't unloaded before attempting to bootstrap the new agent."
@@ -259,29 +280,55 @@ in
return 0
}
restoreAgent() {
local oldSrcPath="$1"
local dstPath="$2"
local oldDomain="$3"
local agentName="$4"
if [[ ! -f "$oldSrcPath" ]]; then
warnEcho "Cannot restore previous agent '$oldDomain/$agentName', old file '$oldSrcPath' is missing"
return 1
fi
warnEcho "Restoring previous agent '$oldDomain/$agentName'"
installAgentFile "$oldSrcPath" "$dstPath" "$agentName" \
&& bootstrapAgent "$oldDomain" "$dstPath" "$agentName"
}
processAgent() {
local srcPath="$1"
local dstDir="$2"
local oldDomainsDir="$3"
local newDomainsDir="$4"
local oldDir="$3"
local oldDomainsDir="$4"
local newDomainsDir="$5"
local agentFile="''${srcPath##*/}"
local agentName="''${agentFile%.plist}"
local dstPath="$dstDir/$agentFile"
local oldSrcPath=""
local oldDomainName
local newDomainName
local oldDomain
local newDomain
local oldAgentBootedOut=0
oldDomainName="$(readAgentDomain "$oldDomainsDir" "$agentName")"
newDomainName="$(readAgentDomain "$newDomainsDir" "$agentName")"
oldDomain="$(resolveDomain "$oldDomainName")"
newDomain="$(resolveDomain "$newDomainName")"
if [[ -n "$oldDir" ]]; then
oldSrcPath="$oldDir/$agentFile"
fi
# Skip if unchanged
if cmp -s "$srcPath" "$dstPath" && [[ "$oldDomainName" == "$newDomainName" ]]; then
if agentIsLoaded "$newDomain" "$agentName"; then
verboseEcho "Agent '$newDomain/$agentName' is already up-to-date"
return 0
else
verboseEcho "Agent '$newDomain/$agentName' is up-to-date but not loaded"
fi
fi
verboseEcho "Processing agent '$newDomain/$agentName'"
@@ -289,11 +336,48 @@ in
# Stop/Unload agent if it's already running
if [[ -f "$dstPath" ]]; then
bootoutAgent "$oldDomain" "$agentName"
case "$?" in
0)
oldAgentBootedOut=1
;;
2)
;;
*)
return 1
;;
esac
fi
installAndBootstrapAgent "$srcPath" "$dstPath" "$newDomain" "$agentName"
# Note: We continue processing even if this agent fails
if [[ "$oldDomainName" != "$newDomainName" ]]; then
bootoutAgent "$newDomain" "$agentName"
case "$?" in
0|2)
;;
*)
if [[ "$oldAgentBootedOut" -eq 1 ]]; then
restoreAgent "$oldSrcPath" "$dstPath" "$oldDomain" "$agentName"
fi
return 1
;;
esac
fi
if ! installAgentFile "$srcPath" "$dstPath" "$agentName"; then
if [[ "$oldAgentBootedOut" -eq 1 ]]; then
restoreAgent "$oldSrcPath" "$dstPath" "$oldDomain" "$agentName"
fi
return 1
fi
if bootstrapAgent "$newDomain" "$dstPath" "$agentName"; then
return 0
fi
if [[ "$oldAgentBootedOut" -eq 1 ]]; then
restoreAgent "$oldSrcPath" "$dstPath" "$oldDomain" "$agentName"
fi
return 1
}
removeAgent() {
@@ -328,23 +412,32 @@ in
# Stop and remove the agent
bootoutAgent "$domain" "$agentName"
case "$?" in
0|2)
;;
*)
return 1
;;
esac
verboseEcho "Removing agent file '$dstPath'"
if run rm -f $VERBOSE_ARG "$dstPath"; then
verboseEcho "Successfully removed agent file for '$agentName'"
else
warnEcho "Failed to remove agent file '$dstPath'"
return 1
fi
return 0
}
setupLaunchAgents() {
local oldDir newDir oldDomainsDir newDomainsDir dstDir
local oldDir newDir oldDomainsDir newDomainsDir dstDir launchdStatus
newDir="$(readlink -m "$newGenPath/LaunchAgents")"
newDomainsDir="$(readlink -m "$newGenPath/LaunchAgentDomains")"
dstDir=${lib.escapeShellArg dstDir}
launchdStatus=0
if [[ -n "''${oldGenPath:-}" ]]; then
oldDir="$(readlink -m "$oldGenPath/LaunchAgents")"
@@ -363,29 +456,49 @@ in
fi
verboseEcho "Setting up LaunchAgents in $dstDir"
[[ -d "$dstDir" ]] || run mkdir -p "$dstDir"
if [[ ! -d "$dstDir" ]] && ! run mkdir -p "$dstDir"; then
errorEcho "Failed to create LaunchAgents directory '$dstDir'"
return 1
fi
verboseEcho "Processing new/updated LaunchAgents..."
find -L "$newDir" -maxdepth 1 -name '*.plist' -type f | while read -r srcPath; do
processAgent "$srcPath" "$dstDir" "$oldDomainsDir" "$newDomainsDir"
done
while IFS= read -r srcPath; do
processAgent "$srcPath" "$dstDir" "$oldDir" "$oldDomainsDir" "$newDomainsDir" \
|| launchdStatus=1
done < <(find -L "$newDir" -maxdepth 1 -name '*.plist' -type f)
# Skip cleanup if there's no previous generation
if [[ -z "$oldDir" || ! -d "$oldDir" ]]; then
if [[ "$launchdStatus" -ne 0 ]]; then
errorEcho "Failed to activate one or more LaunchAgents"
fi
verboseEcho "LaunchAgents setup complete"
return
return "$launchdStatus"
fi
verboseEcho "Cleaning up removed LaunchAgents..."
find -L "$oldDir" -maxdepth 1 -name '*.plist' -type f | while read -r srcPath; do
removeAgent "$srcPath" "$dstDir" "$newDir" "$oldDomainsDir"
done
while IFS= read -r srcPath; do
removeAgent "$srcPath" "$dstDir" "$newDir" "$oldDomainsDir" \
|| launchdStatus=1
done < <(find -L "$oldDir" -maxdepth 1 -name '*.plist' -type f)
if [[ "$launchdStatus" -ne 0 ]]; then
errorEcho "Failed to activate one or more LaunchAgents"
fi
return "$launchdStatus"
}
setupLaunchAgents
launchdStatus=0
setupLaunchAgents || launchdStatus=$?
# Restore errexit
set -e
if [[ "$launchdStatus" -ne 0 ]]; then
exit "$launchdStatus"
fi
'';
})
];
tests/modules/launchd/agent-domain.nix
+2
View File
@@ -11,6 +11,8 @@
nmt.script = ''
serviceFile=LaunchAgents/org.nix-community.home.user-service.plist
assertFileExists $serviceFile
assertFileContains $serviceFile '<key>LimitLoadToSessionType</key>'
assertFileContains $serviceFile '<string>Background</string>'
domainFile=LaunchAgentDomains/org.nix-community.home.user-service.domain
assertFileExists $domainFile
tests/modules/launchd/agents.nix
+11
View File
@@ -30,8 +30,19 @@
assertFileExists activate
assertFileContains activate 'readAgentDomain'
assertFileContains activate 'resolveDomain'
assertFileContains activate 'agentIsLoaded'
assertFileContains activate 'if agentIsLoaded "$newDomain" "$agentName"; then'
assertFileContains activate 'is up-to-date but not loaded'
assertFileContains activate "printf 'gui/%s"
assertFileContains activate "printf 'user/%s"
assertFileContains activate 'restoreAgent "$oldSrcPath" "$dstPath" "$oldDomain" "$agentName"'
assertFileContains activate 'bootoutAgent "$newDomain" "$agentName"'
assertFileContains activate 'processAgent "$srcPath" "$dstDir" "$oldDir" "$oldDomainsDir" "$newDomainsDir" \'
assertFileContains activate '|| launchdStatus=1'
assertFileContains activate 'done < <(find -L "$newDir" -maxdepth 1 -name'
assertFileContains activate 'done < <(find -L "$oldDir" -maxdepth 1 -name'
assertFileContains activate 'if [[ "$launchdStatus" -ne 0 ]]; then'
assertFileContains activate 'exit "$launchdStatus"'
'';
};
}
tests/modules/programs/git/expected-agent-daily.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.git-maintenance-daily</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/programs/git/expected-agent-hourly.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.git-maintenance-hourly</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/programs/git/expected-agent-weekly.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.git-maintenance-weekly</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/programs/nh/darwin/launchd.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.nh-clean</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/programs/opencode/web-service-environment-file.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.opencode-web</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/programs/opencode/web-service.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.opencode-web</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/borgmatic/darwin/expected-agent.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.borgmatic</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/colima/darwin/colima-docker-cli-expected.plist
+2
View File
@@ -22,6 +22,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.colima-default</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/services/colima/darwin/expected-agent.plist
+2
View File
@@ -18,6 +18,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.colima-default</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/services/emacs/darwin/expected-agent.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.emacs</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/services/git-sync/darwin/expected-agent.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.git-sync-test</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/glance/default-settings.nix
+2
View File
@@ -18,6 +18,8 @@
serviceFile=$(normalizeStorePaths $serviceFile)
assertFileExists "$serviceFile"
assertFileContent "$serviceFile" ${./glance.plist}
assertFileContains "$serviceFile" '<key>LimitLoadToSessionType</key>'
assertFileContains "$serviceFile" '<string>Background</string>'
domainFile=LaunchAgentDomains/org.nix-community.home.glance.domain
assertFileContent "$domainFile" ${builtins.toFile "expected-domain" "user\n"}
tests/modules/services/glance/glance.plist
+2
View File
@@ -6,6 +6,8 @@
<true/>
<key>Label</key>
<string>org.nix-community.home.glance</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/services/gpg-agent/expected-agent.plist
+2
View File
@@ -16,6 +16,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.gpg-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/home-manager-auto-expire/darwin/expected-agent.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.home-manager-auto-expire</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/imapnotify/darwin/launchd.plist
+2
View File
@@ -13,6 +13,8 @@
<true/>
<key>Label</key>
<string>org.nix-community.home.imapnotify-hm-example.com</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/nix-gc/darwin/expected-agent.plist
+2
View File
@@ -4,6 +4,8 @@
<dict>
<key>Label</key>
<string>org.nix-community.home.nix-gc</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProgramArguments</key>
<array>
<string>/bin/sh</string>
tests/modules/services/ollama/darwin/expected-agent.plist
+2
View File
@@ -20,6 +20,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.ollama</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/podman/darwin/basic-expected-agent.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.podman-machine-podman-machine-default</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/podman/darwin/custom-machines-dev-expected-agent.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.podman-machine-dev-machine</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/proton-pass-agent/basic-service-expected.plist
+2
View File
@@ -6,6 +6,8 @@
<true/>
<key>Label</key>
<string>org.nix-community.home.proton-pass-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/proton-pass-agent/full-service-expected.plist
+2
View File
@@ -6,6 +6,8 @@
<true/>
<key>Label</key>
<string>org.nix-community.home.proton-pass-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/ssh-agent/darwin/basic-service-expected.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.ssh-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/ssh-agent/darwin/pkcs11-service-expected.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.ssh-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/ssh-agent/darwin/timeout-service-expected.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.ssh-agent</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/syncthing/expected-agent.plist
+2
View File
@@ -11,6 +11,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.syncthing</string>
<key>LimitLoadToSessionType</key>
<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>
tests/modules/services/yubikey-agent/darwin/service.nix
+2
View File
@@ -23,6 +23,8 @@
</dict>
<key>Label</key>
<string>org.nix-community.home.yubikey-agent</string>
${"\t"}<key>LimitLoadToSessionType</key>
${"\t"}<string>Background</string>
<key>ProcessType</key>
<string>Background</string>
<key>ProgramArguments</key>