chore(cli): correctly report telemetry even when transport replaced

ammario · ammario · commit 5c4e24b4fc57 · 2023-05-24T19:23:04.000Z
By introducing the "ExtraHeaders" map, we can apply headers even when
handlers replace the transport, as in the case of our scaletests.
diff --git a/cli/root.go b/cli/root.go
@@ -27,6 +27,7 @@ import (
 	"cdr.dev/slog"
 
 	"github.com/charmbracelet/lipgloss"
+	"github.com/gobwas/httphead"
 	"github.com/mattn/go-isatty"
 
 	"github.com/coder/coder/buildinfo"
@@ -494,14 +495,15 @@ func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc {
 			}
 			err = r.setClient(
 				client, r.clientURL,
-				append(r.header, codersdk.CLITelemetryHeader+"="+
-					base64.StdEncoding.EncodeToString(byt),
-				),
 			)
 			if err != nil {
 				return err
 			}
 
+			client.ExtraHeaders.Set(codersdk.CLITelemetryHeader,
+				base64.StdEncoding.EncodeToString(byt),
+			)
+
 			client.SetSessionToken(r.token)
 
 			if r.debugHTTP {
@@ -544,28 +546,29 @@ func (r *RootCmd) InitClient(client *codersdk.Client) clibase.MiddlewareFunc {
 	}
 }
 
-func (*RootCmd) setClient(client *codersdk.Client, serverURL *url.URL, headers []string) error {
+func (r *RootCmd) setClient(client *codersdk.Client, serverURL *url.URL) error {
 	transport := &headerTransport{
 		transport: http.DefaultTransport,
 		header:    http.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)
-		}
-		transport.header.Add(parts[0], parts[1])
-	}
 	client.URL = serverURL
 	client.HTTPClient = &http.Client{
 		Transport: transport,
 	}
+	client.ExtraHeaders = make(http.Header)
+	for _, hd := range r.header {
+		k, v, ok := httphead.ParseHeaderLine([]byte(hd))
+		if !ok {
+			return xerrors.Errorf("invalid header: %s", hd)
+		}
+		client.ExtraHeaders.Add(string(k), string(v))
+	}
 	return nil
 }
 
 func (r *RootCmd) createUnauthenticatedClient(serverURL *url.URL) (*codersdk.Client, error) {
 	var client codersdk.Client
-	err := r.setClient(&client, serverURL, r.header)
+	err := r.setClient(&client, serverURL)
 	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, r.header)
+			err = r.setClient(client, serverURL)
 			if err != nil {
 				return xerrors.Errorf("set client: %w", err)
 			}
diff --git a/codersdk/client.go b/codersdk/client.go
@@ -85,8 +85,9 @@ var loggableMimeTypes = map[string]struct{}{
 // New creates a Coder client for the provided URL.
 func New(serverURL *url.URL) *Client {
 	return &Client{
-		URL:        serverURL,
-		HTTPClient: &http.Client{},
+		URL:          serverURL,
+		HTTPClient:   &http.Client{},
+		ExtraHeaders: make(http.Header),
 	}
 }
 
@@ -96,6 +97,9 @@ type Client struct {
 	mu           sync.RWMutex // Protects following.
 	sessionToken string
 
+	// ExtraHeaders are headers to add to every request.
+	ExtraHeaders http.Header
+
 	HTTPClient *http.Client
 	URL        *url.URL
 
@@ -189,6 +193,8 @@ func (c *Client) Request(ctx context.Context, method, path string, body interfac
 		return nil, xerrors.Errorf("create request: %w", err)
 	}
 
+	req.Header = c.ExtraHeaders.Clone()
+
 	tokenHeader := c.SessionTokenHeader
 	if tokenHeader == "" {
 		tokenHeader = SessionTokenHeader
diff --git a/go.mod b/go.mod
@@ -352,3 +352,5 @@ require (
 	howett.net/plist v1.0.0 // indirect
 	inet.af/peercred v0.0.0-20210906144145-0893ea02156a // indirect
 )
+
+require github.com/gobwas/httphead v0.1.0

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, r.header)`
	`86`	`+ err = r.setClient(client, serverURL)`
`87`	`87`	`if err != nil {`
`88`	`88`	`return xerrors.Errorf("set client: %w", err)`
`89`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -352,3 +352,5 @@ require (`
`352`	`352`	`howett.net/plist v1.0.0 // indirect`
`353`	`353`	`inet.af/peercred v0.0.0-20210906144145-0893ea02156a // indirect`
`354`	`354`	`)`
	`355`	`+`
	`356`	`+require github.com/gobwas/httphead v0.1.0`