Migrate systray to an fx.App (#14985)

Deprecate single-dash args and add double-dash args

Move code from cmd/systray to comp/systray

Update UAC manifest to requireAdministrator

Fix log file and add `system_tray.log_file` configuration option.

.github/CODEOWNERS

@@ -177,6 +177,7 @@
 /comp @DataDog/agent-shared-components
 /comp/core @DataDog/agent-shared-components
 /comp/process @DataDog/processes
+/comp/systray @DataDog/windows-agent
 # END COMPONENTS
 
 # pkg

cmd/systray/command/command.go

@@ -0,0 +1,103 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2016-present Datadog, Inc.
+//go:build windows
+// +build windows
+
+// Package command implements the top-level `systray` binary, including its subcommands.
+package command
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+
+	"github.com/spf13/cobra"
+
+	"github.com/DataDog/datadog-agent/cmd/agent/common"
+	"github.com/DataDog/datadog-agent/comp/core"
+	"github.com/DataDog/datadog-agent/comp/core/config"
+	"github.com/DataDog/datadog-agent/comp/core/log"
+	"github.com/DataDog/datadog-agent/comp/systray/systray"
+	"github.com/DataDog/datadog-agent/pkg/util/fxutil"
+	"github.com/DataDog/datadog-agent/pkg/util/winutil"
+	"go.uber.org/fx"
+)
+
+const (
+	defaultLogFile = "c:\\programdata\\datadog\\logs\\ddtray.log"
+)
+
+var (
+	// set by the build task and used to configure the logger to output to console when debugging.
+	// This value should correspond to the subsystem in the PE header.
+	//
+	// In normal circumstances, we don't want the systray to launch a console window when it runs
+	// so the default subsystem is "windows". However, console output can be useful for debugging.
+	// Console output can be viewd by setting the PE subsystem to "console".
+	subsystem = "windows"
+)
+
+func init() {
+	// disable cobra mouse trap so cobra doesn't immediately kill our GUI app
+	cobra.MousetrapHelpText = ""
+}
+
+// MakeCommand makes the top-level Cobra command for this app.
+func MakeCommand() *cobra.Command {
+	systrayParams := systray.Params{}
+
+	// log file path
+	var logFilePath string
+	confPath, err := winutil.GetProgramDataDir()
+	if err == nil {
+		logFilePath = filepath.Join(confPath, "logs", "ddtray.log")
+	} else {
+		logFilePath = defaultLogFile
+	}
+
+	// log params
+	var logParams log.Params
+	if subsystem == "windows" {
+		logParams = log.LogForDaemon("TRAY", "system_tray.log_file", logFilePath)
+	} else if subsystem == "console" {
+		logParams = log.LogForOneShot("TRAY", "info", true)
+	}
+
+	// root command
+	cmd := &cobra.Command{
+		Use:          fmt.Sprintf("%s", os.Args[0]),
+		SilenceUsage: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return fxutil.Run(
+				// core
+				fx.Supply(core.BundleParams{
+					ConfigParams: config.NewParams(common.DefaultConfPath),
+					LogParams:    logParams,
+				}),
+				core.Bundle,
+				// systray
+				fx.Supply(systrayParams),
+				systray.Module,
+				// require the systray component, causing it to start
+				fx.Invoke(func(_ systray.Component) {}),
+			)
+		},
+	}
+
+	//
+	// NOTE: The command line help/usage will not be visible in the release binary because the PE subsystem is "windows"
+	//
+
+	cmd.PersistentFlags().BoolVar(&systrayParams.LaunchGuiFlag, "launch-gui", false, "Launch browser configuration and exit")
+
+	// launch-elev=true only means the process should have been elevated so that it will not elevate again. If the
+	// parameter is specified but the process is not elevated, some operation will fail due to access denied.
+	cmd.PersistentFlags().BoolVar(&systrayParams.LaunchElevatedFlag, "launch-elev", false, "Launch program as elevated, internal use only")
+
+	// If this parameter is specified, the process will try to carry out the command before the message loop.
+	cmd.PersistentFlags().StringVar(&systrayParams.LaunchCommand, "launch-cmd", "", "Carry out a specific command after launch")
+
+	return cmd
+}

cmd/systray/ddtray.exe.manifest

@@ -10,7 +10,7 @@
     <security>
       <requestedPrivileges>
         <requestedExecutionLevel
-          level="asInvoker"
+          level="requireAdministrator"
           uiAccess="false"/>
         </requestedPrivileges>
        </security>

cmd/systray/main_windows.go

@@ -0,0 +1,23 @@
+// Unless explicitly stated otherwise all files in this repository are licensed
+// under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2016-present Datadog, Inc.
+
+package main
+
+import (
+	"os"
+
+	"github.com/DataDog/datadog-agent/cmd/internal/runcmd"
+	"github.com/DataDog/datadog-agent/cmd/systray/command"
+	"github.com/DataDog/datadog-agent/pkg/util/log"
+)
+
+func main() {
+	exitcode := 0
+	defer func() {
+		log.Flush()
+		os.Exit(exitcode)
+	}()
+	exitcode = runcmd.Run(command.MakeCommand())
+}