Jonathan A. Sternberg
3e0e9333c2
Add metrics associated with the debugger that are reported through the metrics writer. This adds a few attributes that are only added when a debugger is used with either the `debug` command or `dap` command. At the moment, these metrics show up the exact same as a build and we can't identify if something is using `dap` or `debug` since they use the same code path. This also adds a new available metric that can be utilized by plugins to report additional information. The metrics will check if an environment variable `BUILDX_DAP_USER_AGENT` is sent and that will get included in the metrics if they are enabled. Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com>
137 lines
3.0 KiB
Go
137 lines
3.0 KiB
Go
package commands
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
"net"
|
|
"os"
|
|
|
|
"github.com/containerd/console"
|
|
"github.com/docker/buildx/dap"
|
|
"github.com/docker/buildx/dap/common"
|
|
"github.com/docker/buildx/util/cobrautil"
|
|
"github.com/docker/buildx/util/ioset"
|
|
"github.com/docker/buildx/util/progress"
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
const (
|
|
dapEnvUserAgent = "BUILDX_DAP_USER_AGENT"
|
|
)
|
|
|
|
func dapCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
|
|
var options dapOptions
|
|
cmd := &cobra.Command{
|
|
Use: "dap",
|
|
Short: "Start debug adapter protocol compatible debugger",
|
|
|
|
DisableFlagsInUseLine: true,
|
|
}
|
|
cobrautil.MarkCommandExperimental(cmd)
|
|
|
|
dapBuildCmd := buildCmd(dockerCli, rootOpts, &options)
|
|
dapBuildCmd.Args = cobra.RangeArgs(0, 1)
|
|
|
|
// Remove aliases for documentation.
|
|
dapBuildCmd.Aliases = nil
|
|
delete(dapBuildCmd.Annotations, "aliases")
|
|
|
|
cmd.AddCommand(dapBuildCmd)
|
|
|
|
cmd.AddCommand(dapAttachCmd())
|
|
return cmd
|
|
}
|
|
|
|
type dapOptions struct{}
|
|
|
|
func (d *dapOptions) New(in ioset.In) (debuggerInstance, error) {
|
|
conn := dap.NewConn(in.Stdin, in.Stdout)
|
|
return &adapterProtocolDebugger{
|
|
Adapter: dap.New[LaunchConfig](),
|
|
conn: conn,
|
|
}, nil
|
|
}
|
|
|
|
func (d *dapOptions) Info() debuggerInfo {
|
|
return debuggerInfo{
|
|
Name: "dap",
|
|
UserAgent: os.Getenv(dapEnvUserAgent),
|
|
}
|
|
}
|
|
|
|
type LaunchConfig struct {
|
|
Dockerfile string `json:"dockerfile,omitempty"`
|
|
ContextPath string `json:"contextPath,omitempty"`
|
|
Target string `json:"target,omitempty"`
|
|
common.Config
|
|
}
|
|
|
|
type adapterProtocolDebugger struct {
|
|
*dap.Adapter[LaunchConfig]
|
|
conn dap.Conn
|
|
}
|
|
|
|
func (d *adapterProtocolDebugger) Start(printer *progress.Printer, opts *BuildOptions) error {
|
|
cfg, err := d.Adapter.Start(context.Background(), d.conn)
|
|
if err != nil {
|
|
return errors.Wrap(err, "debug adapter did not start")
|
|
}
|
|
|
|
if cfg.Dockerfile != "" {
|
|
opts.DockerfileName = cfg.Dockerfile
|
|
}
|
|
if cfg.ContextPath != "" {
|
|
opts.ContextPath = cfg.ContextPath
|
|
}
|
|
if cfg.Target != "" {
|
|
opts.Target = cfg.Target
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (d *adapterProtocolDebugger) Stop() error {
|
|
defer d.conn.Close()
|
|
return d.Adapter.Stop()
|
|
}
|
|
|
|
func dapAttachCmd() *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "attach PATH",
|
|
Short: "Attach to a container created by the dap evaluate request",
|
|
Args: cli.ExactArgs(1),
|
|
Hidden: true,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
c, err := console.ConsoleFromFile(os.Stdout)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := c.SetRaw(); err != nil {
|
|
return err
|
|
}
|
|
|
|
dialer := net.Dialer{}
|
|
conn, err := dialer.DialContext(cmd.Context(), "unix", args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
fwd := ioset.NewSingleForwarder()
|
|
fwd.SetReader(os.Stdin)
|
|
fwd.SetWriter(conn, func() io.WriteCloser {
|
|
return conn
|
|
})
|
|
|
|
if _, err := io.Copy(os.Stdout, conn); err != nil && !errors.Is(err, io.EOF) {
|
|
return err
|
|
}
|
|
return nil
|
|
},
|
|
DisableFlagsInUseLine: true,
|
|
}
|
|
return cmd
|
|
}
|