Send command invocation info in CLI

ammario · ammario · commit 76912df6a8bd · 2023-05-15T22:15:19.000Z
diff --git a/cli/clibase/cmd.go b/cli/clibase/cmd.go
@@ -145,6 +145,16 @@ func (c *Cmd) FullUsage() string {
 	return strings.Join(uses, " ")
 }
 
+// FullOptions returns the options of the command and its parents.
+func (c *Cmd) FullOptions() OptionSet {
+	var opts OptionSet
+	if c.Parent != nil {
+		opts = append(opts, c.Parent.FullOptions()...)
+	}
+	opts = append(opts, c.Options...)
+	return opts
+}
+
 // Invoke creates a new invocation of the command, with
 // stdio discarded.
 //
diff --git a/cli/root.go b/cli/root.go
@@ -2,6 +2,8 @@ package cli
 
 import (
 	"context"
+	"encoding/base64"
+	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
@@ -33,6 +35,7 @@ import (
 	"github.com/coder/coder/cli/config"
 	"github.com/coder/coder/coderd"
 	"github.com/coder/coder/coderd/gitauth"
+	"github.com/coder/coder/coderd/telemetry"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/codersdk/agentsdk"
 )
@@ -425,6 +428,23 @@ type RootCmd struct {
 	noFeatureWarning bool
 }
 
+func telemetryInvocation(i *clibase.Invocation) telemetry.CLIInvocation {
+	var topts []telemetry.CLIOption
+	for _, opt := range i.Command.FullOptions() {
+		if opt.Value.String() == opt.Default {
+			continue
+		}
+		topts = append(topts, telemetry.CLIOption{
+			Name:        opt.Name,
+			ValueSource: string(opt.ValueSource),
+		})
+	}
+	return telemetry.CLIInvocation{
+		Command: i.Command.FullName(),
+		Options: topts,
+	}
+}
+
 // InitClient sets client to a new client.
 // It reads from global configuration files if flags are not set.
 func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc {
@@ -465,7 +485,18 @@ func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc {
 				}
 			}
 
-			err = r.setClient(client, r.clientURL)
+			telemInv := telemetryInvocation(i)
+			byt, err := json.Marshal(telemInv)
+			if err != nil {
+				// Should be impossible
+				panic(err)
+			}
+			err = r.setClient(
+				client, r.clientURL,
+				append(r.header, "Coder-CLI-Invokation="+
+					base64.StdEncoding.EncodeToString(byt),
+				),
+			)
 			if err != nil {
 				return err
 			}
@@ -512,12 +543,12 @@ func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc {
 	}
 }
 
-func (r *RootCmd) setClient(client *codersdk.Client, serverURL *url.URL) error {
+func (*RootCmd) setClient(client *codersdk.Client, serverURL *url.URL, headers []string) error {
 	transport := &headerTransport{
 		transport: http.DefaultTransport,
 		header:    http.Header{},
 	}
-	for _, header := range r.header {
+	for _, header := range headers {
 		parts := strings.SplitN(header, "=", 2)
 		if len(parts) < 2 {
 			return xerrors.Errorf("split header %q had less than two parts", header)
@@ -533,7 +564,7 @@ func (r *RootCmd) setClient(client *codersdk.Client, serverURL *url.URL) error {
 
 func (r *RootCmd) createUnauthenticatedClient(serverURL *url.URL) (*codersdk.Client, error) {
 	var client codersdk.Client
-	err := r.setClient(&client, serverURL)
+	err := r.setClient(&client, serverURL, r.header)
 	return &client, err
 }
 
diff --git a/cli/vscodessh.go b/cli/vscodessh.go
@@ -83,7 +83,7 @@ func (r *RootCmd) vscodeSSH() *clibase.Cmd {
 			client.SetSessionToken(string(sessionToken))
 
 			// This adds custom headers to the request!
-			err = r.setClient(client, serverURL)
+			err = r.setClient(client, serverURL, r.header)
 			if err != nil {
 				return xerrors.Errorf("set client: %w", err)
 			}
diff --git a/coderd/telemetry/telemetry.go b/coderd/telemetry/telemetry.go
@@ -700,6 +700,7 @@ type Snapshot struct {
 	WorkspaceBuilds           []WorkspaceBuild            `json:"workspace_build"`
 	WorkspaceResources        []WorkspaceResource         `json:"workspace_resources"`
 	WorkspaceResourceMetadata []WorkspaceResourceMetadata `json:"workspace_resource_metadata"`
+	CLIInvokations            []CLIInvocation             `json:"cli_invocations"`
 }
 
 // Deployment contains information about the host running Coder.
@@ -874,6 +875,16 @@ type License struct {
 	UUID       uuid.UUID `json:"uuid"`
 }
 
+type CLIOption struct {
+	Name        string `json:"name"`
+	ValueSource string `json:"set_via"`
+}
+
+type CLIInvocation struct {
+	Command string `json:"command"`
+	Options []CLIOption
+}
+
 type noopReporter struct{}
 
 func (*noopReporter) Report(_ *Snapshot) {}
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -179,15 +179,6 @@ func (c *Client) Request(ctx context.Context, method, path string, body interfac
 		return nil, xerrors.Errorf("create request: %w", err)
 	}
 
-	if c.PlainLogger != nil {
-		out, err := httputil.DumpRequest(req, c.LogBodies)
-		if err != nil {
-			return nil, xerrors.Errorf("dump request: %w", err)
-		}
-		out = prefixLines([]byte("http --> "), out)
-		_, _ = c.PlainLogger.Write(out)
-	}
-
 	tokenHeader := c.SessionTokenHeader
 	if tokenHeader == "" {
 		tokenHeader = SessionTokenHeader
@@ -221,6 +212,18 @@ func (c *Client) Request(ctx context.Context, method, path string, body interfac
 	})
 
 	resp, err := c.HTTPClient.Do(req)
+
+	// We log after sending the request because the HTTP Transport may modify
+	// the request within Do, e.g. by adding headers.
+	if resp != nil && c.PlainLogger != nil {
+		out, err := httputil.DumpRequest(resp.Request, c.LogBodies)
+		if err != nil {
+			return nil, xerrors.Errorf("dump request: %w", err)
+		}
+		out = prefixLines([]byte("http --> "), out)
+		_, _ = c.PlainLogger.Write(out)
+	}
+
 	if err != nil {
 		return nil, err
 	}

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ func (r RootCmd) vscodeSSH() clibase.Cmd {`
`83`	`83`	`client.SetSessionToken(string(sessionToken))`
`84`	`84`
`85`	`85`	`// This adds custom headers to the request!`
`86`		`- err = r.setClient(client, serverURL)`
	`86`	`+ err = r.setClient(client, serverURL, r.header)`
`87`	`87`	`if err != nil {`
`88`	`88`	`return xerrors.Errorf("set client: %w", err)`
`89`	`89`	`}`