launchd: enable running after user logs out

Change the launch agent domain from 'gui/<uid>' (tied to login session) to
'user/<uid>' (tied to user, but may run when logged out). To allow the agent
to be loaded with this new domain, explicitly set the
'LimitLoadToSessionType' value in the generated plist to 'Background'
(default value seems to be 'Aqua', corresponding to the logged in session
i.e. 'gui/<uid>' domain).

Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

internal/daemon/launchd.go

@@ -51,14 +51,15 @@ func (p *plist) addKeyValue(key string, value any) {
 	}
 }
 
-const domainFormat string = "gui/%s"
+const domainFormat string = "user/%s"
 
 const LaunchdServiceNotFoundErrorCode int = 113
 
 type launchdConfig struct {
 	DaemonConfig
-	StdOut string
-	StdErr string
+	LimitLoadToSessionType string
+	StdOut                 string
+	StdErr                 string
 }
 
 func (c *launchdConfig) toPlist() *plist {
@@ -68,6 +69,7 @@ func (c *launchdConfig) toPlist() *plist {
 	}
 	p.addKeyValue("Label", c.Label)
 	p.addKeyValue("Program", c.Program)
+	p.addKeyValue("LimitLoadToSessionType", c.LimitLoadToSessionType)
 	p.addKeyValue("StandardOutPath", c.StdOut)
 	p.addKeyValue("StandardErrorPath", c.StdErr)
 
@@ -152,9 +154,10 @@ func (l *launchd) bootoutFile(domain string, filename string) error {
 func (l *launchd) Create(config *DaemonConfig, force bool) error {
 	// Add launchd-specific config
 	lConfig := &launchdConfig{
-		DaemonConfig: *config,
-		StdOut:       "/dev/null",
-		StdErr:       "/dev/null",
+		DaemonConfig:           *config,
+		LimitLoadToSessionType: "Background",
+		StdOut:                 "/dev/null",
+		StdErr:                 "/dev/null",
 	}
 
 	// Generate the configuration

internal/daemon/launchd_test.go

@@ -124,6 +124,9 @@ var launchdCreatePlistTests = []struct {
 			"<key>Program</key>",
 			fmt.Sprintf("<string>%s</string>", basicDaemonConfig.Program),
 
+			"<key>LimitLoadToSessionType</key>",
+			"<string>Background</string>",
+
 			"<key>StandardOutPath</key>",
 			"<string>/dev/null</string>",
 
@@ -161,6 +164,9 @@ var launchdCreatePlistTests = []struct {
 			"<key>Program</key>",
 			"<string>/path/to/the/program with a space</string>",
 
+			"<key>LimitLoadToSessionType</key>",
+			"<string>Background</string>",
+
 			"<key>StandardOutPath</key>",
 			"<string>/dev/null</string>",
 
@@ -195,6 +201,9 @@ var launchdCreatePlistTests = []struct {
 			"<key>Program</key>",
 			"<string>/path/to/the/program</string>",
 
+			"<key>LimitLoadToSessionType</key>",
+			"<string>Background</string>",
+
 			"<key>StandardOutPath</key>",
 			"<string>/dev/null</string>",
 
@@ -359,7 +368,7 @@ func TestLaunchd_Start(t *testing.T) {
 	t.Run("Calls correct launchctl command", func(t *testing.T) {
 		testCommandExecutor.On("Run",
 			"launchctl",
-			[]string{"kickstart", fmt.Sprintf("gui/123/%s", basicDaemonConfig.Label)},
+			[]string{"kickstart", fmt.Sprintf("user/123/%s", basicDaemonConfig.Label)},
 		).Return(0, nil).Once()
 
 		err := launchd.Start(basicDaemonConfig.Label)
@@ -400,7 +409,7 @@ func TestLaunchd_Stop(t *testing.T) {
 	t.Run("Calls correct launchctl command", func(t *testing.T) {
 		testCommandExecutor.On("Run",
 			"launchctl",
-			[]string{"kill", "SIGINT", fmt.Sprintf("gui/123/%s", basicDaemonConfig.Label)},
+			[]string{"kill", "SIGINT", fmt.Sprintf("user/123/%s", basicDaemonConfig.Label)},
 		).Return(0, nil).Once()
 
 		err := launchd.Stop(basicDaemonConfig.Label)