chore: Add ability to update workspace proxy fields

coder · Emyrk · May 9, 2023 · May 4, 2023 · May 4, 2023 · May 5, 2023
commit 94e38e8e1824fbf6d0c937d4fd9f9cf3e3180395
diff --git a/coderd/database/dbauthz/querier.go b/coderd/database/dbauthz/querier.go
@@ -1705,6 +1705,13 @@ func (q *querier) InsertWorkspaceProxy(ctx context.Context, arg database.InsertW
 	return insert(q.log, q.auth, rbac.ResourceWorkspaceProxy, q.db.InsertWorkspaceProxy)(ctx, arg)
 }
 
+func (q *querier) UpdateWorkspaceProxy(ctx context.Context, arg database.UpdateWorkspaceProxyParams) (database.WorkspaceProxy, error) {
+	fetch := func(ctx context.Context, arg database.UpdateWorkspaceProxyParams) (database.WorkspaceProxy, error) {
+		return q.db.GetWorkspaceProxyByID(ctx, arg.ID)
+	}
+	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateWorkspaceProxy)(ctx, arg)
+}
+
 func (q *querier) RegisterWorkspaceProxy(ctx context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 	fetch := func(ctx context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 		return q.db.GetWorkspaceProxyByID(ctx, arg.ID)

diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -5231,6 +5231,31 @@ func (q *fakeQuerier) RegisterWorkspaceProxy(_ context.Context, arg database.Reg
 	return database.WorkspaceProxy{}, sql.ErrNoRows
 }
 
+func (q *fakeQuerier) UpdateWorkspaceProxy(_ context.Context, arg database.UpdateWorkspaceProxyParams) (database.WorkspaceProxy, error) {
+	q.mutex.Lock()
+	defer q.mutex.Unlock()
+
+	for _, p := range q.workspaceProxies {
+		if p.Name == arg.Name && p.ID != arg.ID {
+			return database.WorkspaceProxy{}, errDuplicateKey
+		}
+	}
+
+	for i, p := range q.workspaceProxies {
+		if p.ID == arg.ID {
+			p.Name = arg.Name
+			p.DisplayName = arg.DisplayName
+			p.Icon = arg.Icon
+			if len(p.TokenHashedSecret) > 0 {
+				p.TokenHashedSecret = arg.TokenHashedSecret
+			}
+			q.workspaceProxies[i] = p
+			return p, nil
+		}
+	}
+	return database.WorkspaceProxy{}, sql.ErrNoRows
+}
+
 func (q *fakeQuerier) UpdateWorkspaceProxyDeleted(_ context.Context, arg database.UpdateWorkspaceProxyDeletedParams) error {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()

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/proxies.sql b/coderd/database/queries/proxies.sql
@@ -36,6 +36,28 @@ SET
 WHERE
 	id = @id;
 
+-- name: UpdateWorkspaceProxy :one
+-- This allows editing the properties of a workspace proxy.
+UPDATE
+	workspace_proxies
+SET
+	-- These values should always be provided.
+	name = @name,
+	display_name = @display_name,
+	icon = @icon,
+	-- Only update the token if a new one is provided.
+	-- So this is an optional field.
+	token_hashed_secret = CASE
+		WHEN length(@token_hashed_secret :: bytea) > 0  THEN @token_hashed_secret :: bytea
+		ELSE  workspace_proxies.token_hashed_secret
+	END,
+    -- Always update this timestamp.
+	updated_at = Now()
+WHERE
+	id = @id
+RETURNING *
+;
+
 -- name: GetWorkspaceProxyByID :one
 SELECT
 	*
@@ -57,6 +79,14 @@ WHERE
 LIMIT
 	1;
 
+-- name: GetWorkspaceProxies :many
+SELECT
+	*
+FROM
+	workspace_proxies
+WHERE
+		deleted = false;
+
 -- Finds a workspace proxy that has an access URL or app hostname that matches
 -- the provided hostname. This is to check if a hostname matches any workspace
 -- proxy.
@@ -94,11 +124,3 @@ WHERE
 	)
 LIMIT
 	1;
-
--- name: GetWorkspaceProxies :many
-SELECT
-	*
-FROM
-	workspace_proxies
-WHERE
-	deleted = false;
diff --git a/codersdk/workspaceproxy.go b/codersdk/workspaceproxy.go
@@ -110,6 +110,37 @@ func (c *Client) WorkspaceProxies(ctx context.Context) ([]WorkspaceProxy, error)
 	return proxies, json.NewDecoder(res.Body).Decode(&proxies)
 }
 
+type PatchWorkspaceProxy struct {
+	ID              uuid.UUID `json:"id" format:"uuid" validate:"required"`
+	Name            string    `json:"name" validate:"required"`
+	DisplayName     string    `json:"display_name" validate:"required"`
+	Icon            string    `json:"icon" validate:"required"`
+	RegenerateToken bool      `json:"regenerate_token"`
+}
+
+type PatchWorkspaceProxyResponse struct {
+	Proxy WorkspaceProxy `json:"proxy" table:"proxy,recursive"`
+	// ProxyToken is only returned if 'RegenerateToken' is set.
+	ProxyToken string `json:"proxy_token" table:"proxy token,default_sort"`
+}
+
+func (c *Client) PatchWorkspaceProxy(ctx context.Context, req PatchWorkspaceProxy) (WorkspaceProxy, error) {
+	res, err := c.Request(ctx, http.MethodPatch,
+		fmt.Sprintf("/api/v2/workspaceproxies/%s", req.ID.String()),
+		nil,
+	)
+	if err != nil {
+		return WorkspaceProxy{}, xerrors.Errorf("make request: %w", err)
+	}
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusCreated {
+		return WorkspaceProxy{}, ReadBodyAsError(res)
+	}
+	var resp WorkspaceProxy
+	return resp, json.NewDecoder(res.Body).Decode(&resp)
+}
+
 func (c *Client) DeleteWorkspaceProxyByName(ctx context.Context, name string) error {
 	res, err := c.Request(ctx, http.MethodDelete,
 		fmt.Sprintf("/api/v2/workspaceproxies/%s", name),
@@ -131,6 +162,28 @@ func (c *Client) DeleteWorkspaceProxyByID(ctx context.Context, id uuid.UUID) err
 	return c.DeleteWorkspaceProxyByName(ctx, id.String())
 }
 
+func (c *Client) WorkspaceProxyByName(ctx context.Context, name string) (WorkspaceProxy, error) {
+	res, err := c.Request(ctx, http.MethodGet,
+		fmt.Sprintf("/api/v2/workspaceproxies/%s", name),
+		nil,
+	)
+	if err != nil {
+		return WorkspaceProxy{}, xerrors.Errorf("make request: %w", err)
+	}
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusOK {
+		return WorkspaceProxy{}, ReadBodyAsError(res)
+	}
+
+	var resp WorkspaceProxy
+	return resp, json.NewDecoder(res.Body).Decode(&resp)
+}
+
+func (c *Client) WorkspaceProxyByID(ctx context.Context, id uuid.UUID) (WorkspaceProxy, error) {
+	return c.WorkspaceProxyByName(ctx, id.String())
+}
+
 type RegionsResponse struct {
 	Regions []Region `json:"regions"`
 }

diff --git a/enterprise/cli/workspaceproxy.go b/enterprise/cli/workspaceproxy.go
@@ -32,6 +32,83 @@ func (r *RootCmd) workspaceProxy() *clibase.Cmd {
 	return cmd
 }
 
+func (r *RootCmd) patchProxy() *clibase.Cmd {
+	var (
+		proxyName   string
+		displayName string
+		proxyIcon   string
+		formatter   = cliui.NewOutputFormatter(
+			// Text formatter should be human readable.
+			cliui.ChangeFormatterData(cliui.TextFormat(), func(data any) (any, error) {
+				response, ok := data.(codersdk.WorkspaceProxy)
+				if !ok {
+					return nil, xerrors.Errorf("unexpected type %T", data)
+				}
+				return fmt.Sprintf("Workspace Proxy %q updated successfully.", response.Name), nil
+			}),
+			cliui.JSONFormat(),
+			// Table formatter expects a slice, make a slice of one.
+			cliui.ChangeFormatterData(cliui.TableFormat([]codersdk.WorkspaceProxy{}, []string{"proxy name", "proxy url"}),
+				func(data any) (any, error) {
+					response, ok := data.(codersdk.WorkspaceProxy)
+					if !ok {
+						return nil, xerrors.Errorf("unexpected type %T", data)
+					}
+					return []codersdk.WorkspaceProxy{response}, nil
+				}),
+		)
+	)
+	client := new(codersdk.Client)
+	cmd := &clibase.Cmd{
+		Use:   "edit <name|id>",
+		Short: "Edit a workspace proxy",
+		Middleware: clibase.Chain(
+			clibase.RequireNArgs(1),
+			r.InitClient(client),
+		),
+		Handler: func(inv *clibase.Invocation) error {
+			ctx := inv.Context()
+			// This is cheeky, but you can also use a uuid string in
+			// 'DeleteWorkspaceProxyByName' and it will work.
+			proxy, err := client.WorkspaceProxyByName(ctx, inv.Args[0])
+			if err != nil {
+				return xerrors.Errorf("fetch workspace proxy %q: %w", inv.Args[0], err)
+			}
+
+			updated, err := client.PatchWorkspaceProxy(ctx, codersdk.PatchWorkspaceProxy{
+				ID:          proxy.ID,
+				Name:        proxyName,
+				DisplayName: displayName,
+				Icon:        proxyIcon,
+			})
+
+			_, _ = formatter.Format(ctx, updated)
+			return nil
+		},
+	}
+
+	formatter.AttachOptions(&cmd.Options)
+	cmd.Options.Add(
+		clibase.Option{
+			Flag:        "name",
+			Description: "(Optional) Name of the proxy. This is used to identify the proxy.",
+			Value:       clibase.StringOf(&proxyName),
+		},
+		clibase.Option{
+			Flag:        "display-name",
+			Description: "(Optional) Display of the proxy. If omitted, the name is reused as the display name.",
+			Value:       clibase.StringOf(&displayName),
+		},
+		clibase.Option{
+			Flag:        "icon",
+			Description: "(Optional) Display icon of the proxy.",
+			Value:       clibase.StringOf(&proxyIcon),
+		},
+	)
+
+	return cmd
+}
+
 func (r *RootCmd) deleteProxy() *clibase.Cmd {
 	client := new(codersdk.Client)
 	cmd := &clibase.Cmd{

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -120,6 +120,8 @@ func New(ctx context.Context, options *Options) (*API, error) {
 					httpmw.ExtractWorkspaceProxyParam(api.Database),
 				)
 
+				r.Get("/", api.getWorkspaceProxy)
+				r.Patch("/", api.patchWorkspaceProxy)
 				r.Delete("/", api.deleteWorkspaceProxy)
 			})
 		})