wip: coder: agent: register version on agent

johnstcn · johnstcn · commit 927921444afb · 2022-08-29T08:51:22.000Z
diff --git a/cli/agent.go b/cli/agent.go
@@ -20,6 +20,7 @@ import (
 	"cdr.dev/slog/sloggers/sloghuman"
 	"github.com/coder/coder/agent"
 	"github.com/coder/coder/agent/reaper"
+	"github.com/coder/coder/buildinfo"
 	"github.com/coder/coder/cli/cliflag"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/retry"
@@ -53,6 +54,7 @@ func workspaceAgent() *cobra.Command {
 			}
 			defer logWriter.Close()
 			logger := slog.Make(sloghuman.Sink(cmd.ErrOrStderr()), sloghuman.Sink(logWriter)).Leveled(slog.LevelDebug)
+			logger.Info(cmd.Context(), "coder agent version: "+buildinfo.Version())
 
 			isLinux := runtime.GOOS == "linux"
 
diff --git a/coderd/coderd.go b/coderd/coderd.go
@@ -333,6 +333,7 @@ func New(options *Options) *API {
 			r.Route("/me", func(r chi.Router) {
 				r.Use(httpmw.ExtractWorkspaceAgent(options.Database))
 				r.Get("/metadata", api.workspaceAgentMetadata)
+				r.Post("/version", api.postWorkspaceAgentVersion)
 				r.Get("/listen", api.workspaceAgentListen)
 				r.Get("/gitsshkey", api.agentGitSSHKey)
 				r.Get("/turn", api.workspaceAgentTurn)
diff --git a/coderd/coderdtest/authtest.go b/coderd/coderdtest/authtest.go
@@ -201,6 +201,7 @@ func AGPLRoutes(a *AuthTester) (map[string]string, map[string]RouteCheck) {
 		"GET:/api/v2/workspaceagents/me/metadata":                 {NoAuthorize: true},
 		"GET:/api/v2/workspaceagents/me/turn":                     {NoAuthorize: true},
 		"GET:/api/v2/workspaceagents/me/derp":                     {NoAuthorize: true},
+		"POST:/api/v2/workspaceagents/me/version":                 {NoAuthorize: true},
 		"GET:/api/v2/workspaceagents/me/wireguardlisten":          {NoAuthorize: true},
 		"POST:/api/v2/workspaceagents/me/keys":                    {NoAuthorize: true},
 		"GET:/api/v2/workspaceagents/{workspaceagent}/iceservers": {NoAuthorize: true},
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -2040,6 +2040,22 @@ func (q *fakeQuerier) UpdateWorkspaceAgentKeysByID(_ context.Context, arg databa
 	return sql.ErrNoRows
 }
 
+func (q *fakeQuerier) UpdateWorkspaceAgentVersionByID(_ context.Context, arg database.UpdateWorkspaceAgentVersionByIDParams) error {
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for index, agent := range q.provisionerJobAgents {
+		if agent.ID != arg.ID {
+			continue
+		}
+
+		agent.Version = arg.Version
+		q.provisionerJobAgents[index] = agent
+		return nil
+	}
+	return sql.ErrNoRows
+}
+
 func (q *fakeQuerier) UpdateProvisionerJobByID(_ context.Context, arg database.UpdateProvisionerJobByIDParams) error {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000039_add_workspace_agent_version.down.sql b/coderd/database/migrations/000039_add_workspace_agent_version.down.sql
@@ -0,0 +1 @@
+ALTER TABLE ONLY workspace_agents DROP COLUMN version;
diff --git a/coderd/database/migrations/000039_add_workspace_agent_version.up.sql b/coderd/database/migrations/000039_add_workspace_agent_version.up.sql
@@ -0,0 +1,2 @@
+ALTER TABLE ONLY workspace_agents ADD COLUMN version text DEFAULT ''::text NOT NULL;
+COMMENT ON COLUMN workspace_agents.version IS 'version tracks the version of the currently running workspace agent. Workspace agents register their version upon start.';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceagents.sql b/coderd/database/queries/workspaceagents.sql
@@ -81,3 +81,11 @@ SET
 	updated_at = $4
 WHERE
 	id = $1;
+
+-- name: UpdateWorkspaceAgentVersionByID :exec
+UPDATE
+	workspace_agents
+SET
+	version = $2
+WHERE
+	id = $1;
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -14,6 +14,7 @@ import (
 	"github.com/google/uuid"
 	"github.com/hashicorp/yamux"
 	"github.com/tabbed/pqtype"
+	"golang.org/x/mod/semver"
 	"golang.org/x/xerrors"
 	"inet.af/netaddr"
 	"nhooyr.io/websocket"
@@ -152,6 +153,49 @@ func (api *API) workspaceAgentMetadata(rw http.ResponseWriter, r *http.Request)
 	})
 }
 
+func (api *API) postWorkspaceAgentVersion(rw http.ResponseWriter, r *http.Request) {
+	workspaceAgent := httpmw.WorkspaceAgent(r)
+	apiAgent, err := convertWorkspaceAgent(workspaceAgent, nil, api.AgentInactiveDisconnectTimeout)
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Internal error reading workspace agent.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	var req codersdk.PostWorkspaceAgentVersionRequest
+	if err := json.NewDecoder(r.Body).Decode(req); err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Invalid request to set workspace agent version.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	if !semver.IsValid(req.Version) {
+		httpapi.Write(rw, http.StatusBadRequest, codersdk.Response{
+			Message: "Invalid workspace agent version provided.",
+			Detail:  fmt.Sprintf("invalid semver version: %q", req.Version),
+		})
+		return
+	}
+
+	if err := api.Database.UpdateWorkspaceAgentVersionByID(r.Context(), database.UpdateWorkspaceAgentVersionByIDParams{
+		ID:      apiAgent.ID,
+		Version: req.Version,
+	}); err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, codersdk.Response{
+			Message: "Error setting agent version",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	httpapi.Write(rw, http.StatusOK, nil)
+	return
+}
+
 func (api *API) workspaceAgentListen(rw http.ResponseWriter, r *http.Request) {
 	api.websocketWaitMutex.Lock()
 	api.websocketWaitGroup.Add(1)
@@ -707,6 +751,7 @@ func convertWorkspaceAgent(dbAgent database.WorkspaceAgent, apps []codersdk.Work
 		IPv6:                 inetToNetaddr(dbAgent.WireguardNodeIPv6),
 		WireguardPublicKey:   key.NodePublic(dbAgent.WireguardNodePublicKey),
 		DiscoPublicKey:       key.DiscoPublic(dbAgent.WireguardDiscoPublicKey),
+		Version:              dbAgent.Version,
 	}
 
 	if dbAgent.FirstConnectedAt.Valid {
diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -1,6 +1,7 @@
 package codersdk
 
 import (
+	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
@@ -20,6 +21,7 @@ import (
 	"cdr.dev/slog"
 
 	"github.com/coder/coder/agent"
+	"github.com/coder/coder/buildinfo"
 	"github.com/coder/coder/coderd/turnconn"
 	"github.com/coder/coder/peer"
 	"github.com/coder/coder/peer/peerwg"
@@ -48,6 +50,10 @@ type WorkspaceAgentAuthenticateResponse struct {
 	SessionToken string `json:"session_token"`
 }
 
+type PostWorkspaceAgentVersionRequest struct {
+	Version string `json:"version"`
+}
+
 // AuthWorkspaceGoogleInstanceIdentity uses the Google Compute Engine Metadata API to
 // fetch a signed JWT, and exchange it for a session token for a workspace agent.
 //
@@ -240,6 +246,23 @@ func (c *Client) ListenWorkspaceAgent(ctx context.Context, logger slog.Logger) (
 	if err != nil {
 		return agent.Metadata{}, nil, xerrors.Errorf("listen peerbroker: %w", err)
 	}
+
+	// Phone home and tell the mothership what version we're on.
+	var agentVersionPayload bytes.Buffer
+	if err := json.NewEncoder(&agentVersionPayload).Encode(&PostWorkspaceAgentVersionRequest{Version: buildinfo.Version()}); err != nil {
+		// This should not be a fatal error, but also should not pass unnoticed.
+		logger.Error(ctx, "unable to encode agent version", slog.Error(err))
+	} else {
+		res, err = c.Request(ctx, http.MethodPost, "/api/v2/workspaceagents/me/metadata", agentVersionPayload)
+		if err != nil {
+			// Again, don't crash and burn if we can't phone home, but don't keep stumm either.
+			logger.Error(ctx, "unable to inform coderd of agent version", slog.Error(err))
+		}
+		// Discord the response
+		_, _ = io.Copy(io.Discard, res.Body)
+		_ = res.Body.Close()
+	}
+	// Fetch updated agent metadata
 	res, err = c.Request(ctx, http.MethodGet, "/api/v2/workspaceagents/me/metadata", nil)
 	if err != nil {
 		return agent.Metadata{}, nil, err
diff --git a/codersdk/workspaceresources.go b/codersdk/workspaceresources.go
@@ -57,6 +57,7 @@ type WorkspaceAgent struct {
 	WireguardPublicKey   key.NodePublic       `json:"wireguard_public_key"`
 	DiscoPublicKey       key.DiscoPublic      `json:"disco_public_key"`
 	IPv6                 netaddr.IPPrefix     `json:"ipv6"`
+	Version              string               `json:"version"`
 }
 
 type WorkspaceAgentResourceMetadata struct {
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -249,6 +249,11 @@ export interface ParameterSchema {
   readonly validation_contains?: string[]
 }
 
+// From codersdk/workspaceagents.go
+export interface PostWorkspaceAgentVersionRequest {
+  readonly version: string
+}
+
 // From codersdk/provisionerdaemons.go
 export interface ProvisionerDaemon {
   readonly id: string
@@ -479,6 +484,7 @@ export interface WorkspaceAgent {
   // Named type "inet.af/netaddr.IPPrefix" unknown, using "any"
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   readonly ipv6: any
+  readonly version: string
 }
 
 // From codersdk/workspaceagents.go
diff --git a/site/src/components/Resources/Resources.tsx b/site/src/components/Resources/Resources.tsx
@@ -105,6 +105,7 @@ export const Resources: FC<React.PropsWithChildren<ResourcesProps>> = ({
                       <TableCell className={styles.agentColumn}>
                         {agent.name}
                         <div className={styles.agentInfo}>
+                          <span className={styles.agentVersion}>{agent.version}</span>
                           <span className={styles.operatingSystem}>{agent.operating_system}</span>
                           {WorkspaceStateEnum[workspaceStatus] !==
                             WorkspaceStateEnum["stopped"] && (
@@ -194,6 +195,10 @@ const useStyles = makeStyles((theme) => ({
     textTransform: "capitalize",
   },
 
+  agentVersion: {
+    display: "block",
+  },
+
   accessLinks: {
     display: "flex",
     gap: theme.spacing(0.5),
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -305,6 +305,7 @@ export const MockWorkspaceAgent: TypesGen.WorkspaceAgent = {
   wireguard_public_key: "",
   disco_public_key: "",
   ipv6: "",
+  version: "v0.0.0-devel",
 }
 
 export const MockWorkspaceAgentDisconnected: TypesGen.WorkspaceAgent = {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE ONLY workspace_agents DROP COLUMN version;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE ONLY workspace_agents ADD COLUMN version text DEFAULT ''::text NOT NULL;`
	`2`	`+COMMENT ON COLUMN workspace_agents.version IS 'version tracks the version of the currently running workspace agent. Workspace agents register their version upon start.';`