add build info in HTTP header, extract codersdk.BuildVersionHeader

coder · johnstcn · Jan 3, 2024 · Jan 2, 2024 · Jan 2, 2024 · Jan 2, 2024
commit fc13323b4b05a0335e23d483a2b7f3b943efd9e7
diff --git a/cli/login_test.go b/cli/login_test.go
@@ -16,6 +16,7 @@ import (
 	"github.com/coder/coder/v2/cli/clitest"
 	"github.com/coder/coder/v2/cli/cliui"
 	"github.com/coder/coder/v2/coderd/coderdtest"
+	"github.com/coder/coder/v2/codersdk"
 	"github.com/coder/coder/v2/pty/ptytest"
 )
 
@@ -58,7 +59,7 @@ func TestLogin(t *testing.T) {
 		t.Parallel()
 
 		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			w.Header().Set("X-Coder-Build-Version", "something")
+			w.Header().Set(codersdk.BuildVersionHeader, "something")
 			w.WriteHeader(http.StatusNotFound)
 			w.Write([]byte("Not Found"))
 		}))

diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -564,7 +564,7 @@ func New(options *Options) *API {
 		// Build-Version is helpful for debugging.
 		func(next http.Handler) http.Handler {
 			return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-				w.Header().Add("X-Coder-Build-Version", buildinfo.Version())
+				w.Header().Add(codersdk.BuildVersionHeader, buildinfo.Version())
 				next.ServeHTTP(w, r)
 			})
 		},

diff --git a/codersdk/client.go b/codersdk/client.go
@@ -78,6 +78,9 @@ const (
 
 	// ProvisionerDaemonPSK contains the authentication pre-shared key for an external provisioner daemon
 	ProvisionerDaemonPSK = "Coder-Provisioner-Daemon-PSK"
+
+	// BuildVersionHeader contains build information of Coder.
+	BuildVersionHeader = "X-Coder-Build-Version"
 )
 
 // loggableMimeTypes is a list of MIME types that are safe to log

diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -15,6 +15,7 @@ import (
 	"golang.org/x/xerrors"
 	"nhooyr.io/websocket"
 
+	"github.com/coder/coder/v2/buildinfo"
 	"github.com/coder/coder/v2/codersdk/drpc"
 	"github.com/coder/coder/v2/provisionerd/proto"
 	"github.com/coder/coder/v2/provisionerd/runner"
@@ -212,6 +213,7 @@ func (c *Client) ServeProvisionerDaemon(ctx context.Context, req ServeProvisione
 	}
 	headers := http.Header{}
 
+	headers.Set(BuildVersionHeader, buildinfo.Version())
 	if req.PreSharedKey == "" {
 		// use session token if we don't have a PSK.
 		jar, err := cookiejar.New(nil)

diff --git a/codersdk/users.go b/codersdk/users.go
@@ -203,7 +203,7 @@ func (c *Client) HasFirstUser(ctx context.Context) (bool, error) {
 	if res.StatusCode == http.StatusNotFound {
 		// ensure we are talking to coder and not
 		// some other service that returns 404
-		v := res.Header.Get("X-Coder-Build-Version")
+		v := res.Header.Get(BuildVersionHeader)
 		if v == "" {
 			return false, xerrors.Errorf("missing build version header, not a coder instance")
 		}

diff --git a/enterprise/coderd/provisionerdaemons.go b/enterprise/coderd/provisionerdaemons.go
@@ -233,6 +233,8 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request)
 		authCtx = dbauthz.AsSystemRestricted(ctx)
 	}
 
+	versionHdrVal := r.Header.Get(codersdk.BuildVersionHeader)
+
 	// Create the daemon in the database.
 	now := dbtime.Now()
 	daemon, err := api.Database.UpsertProvisionerDaemon(authCtx, database.UpsertProvisionerDaemonParams{
@@ -241,7 +243,7 @@ func (api *API) provisionerDaemonServe(rw http.ResponseWriter, r *http.Request)
 		Tags:         tags,
 		CreatedAt:    now,
 		LastSeenAt:   sql.NullTime{Time: now, Valid: true},
-		Version:      "", // TODO: provisionerd needs to send version
+		Version:      versionHdrVal,
 		APIVersion:   "1.0",
 	})
 	if err != nil {

diff --git a/enterprise/wsproxy/wsproxy.go b/enterprise/wsproxy/wsproxy.go
@@ -323,7 +323,7 @@ func New(ctx context.Context, opts *Options) (*Server, error) {
 		// Build-Version is helpful for debugging.
 		func(next http.Handler) http.Handler {
 			return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-				w.Header().Add("X-Coder-Build-Version", buildinfo.Version())
+				w.Header().Add(codersdk.BuildVersionHeader, buildinfo.Version())
 				next.ServeHTTP(w, r)
 			})
 		},