chore: Add endpoint to register workspace proxies

coder · Emyrk · Apr 20, 2023 · Apr 13, 2023 · Apr 13, 2023 · Apr 17, 2023
commit d237b19a243dac7cfcc962a377b6881ed6988be8
diff --git a/coderd/database/dbauthz/querier.go b/coderd/database/dbauthz/querier.go
@@ -1709,11 +1709,11 @@ 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) {
+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)
 	}
-	return updateWithReturn(q.log, q.auth, fetch, q.db.UpdateWorkspaceProxy)(ctx, arg)
+	return updateWithReturn(q.log, q.auth, fetch, q.db.RegisterWorkspaceProxy)(ctx, arg)
 }
 
 func (q *querier) UpdateWorkspaceProxyDeleted(ctx context.Context, arg database.UpdateWorkspaceProxyDeletedParams) error {

diff --git a/coderd/database/dbauthz/querier_test.go b/coderd/database/dbauthz/querier_test.go
@@ -444,9 +444,9 @@ func (s *MethodTestSuite) TestWorkspaceProxy() {
 			ID: uuid.New(),
 		}).Asserts(rbac.ResourceWorkspaceProxy, rbac.ActionCreate)
 	}))
-	s.Run("UpdateWorkspaceProxy", s.Subtest(func(db database.Store, check *expects) {
+	s.Run("RegisterWorkspaceProxy", s.Subtest(func(db database.Store, check *expects) {
 		p, _ := dbgen.WorkspaceProxy(s.T(), db, database.WorkspaceProxy{})
-		check.Args(database.UpdateWorkspaceProxyParams{
+		check.Args(database.RegisterWorkspaceProxyParams{
 			ID: p.ID,
 		}).Asserts(p, rbac.ActionUpdate)
 	}))

diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -5172,14 +5172,12 @@ func (q *fakeQuerier) InsertWorkspaceProxy(_ context.Context, arg database.Inser
 	return p, nil
 }
 
-func (q *fakeQuerier) UpdateWorkspaceProxy(_ context.Context, arg database.UpdateWorkspaceProxyParams) (database.WorkspaceProxy, error) {
+func (q *fakeQuerier) RegisterWorkspaceProxy(_ context.Context, arg database.RegisterWorkspaceProxyParams) (database.WorkspaceProxy, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
 
 	for i, p := range q.workspaceProxies {
 		if p.ID == arg.ID {
-			p.Name = arg.Name
-			p.Icon = arg.Icon
 			p.Url = arg.Url
 			p.WildcardHostname = arg.WildcardHostname
 			p.UpdatedAt = database.Now()

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
@@ -15,15 +15,12 @@ INSERT INTO
 VALUES
 	($1, $2, $3, $4, $5, $6, $7, $8, $9, false) RETURNING *;
 
--- name: UpdateWorkspaceProxy :one
+-- name: RegisterWorkspaceProxy :one
 UPDATE
 	workspace_proxies
 SET
-	name = @name,
-	display_name = @display_name,
 	url = @url,
 	wildcard_hostname = @wildcard_hostname,
-	icon = @icon,
 	updated_at = Now()
 WHERE
 	id = @id

diff --git a/coderd/workspaceapps/token.go b/coderd/workspaceapps/token.go
@@ -54,6 +54,10 @@ func (t SignedToken) MatchesRequest(req Request) bool {
 // two keys.
 type SecurityKey [96]byte
 
+func (k SecurityKey) String() string {
+	return hex.EncodeToString(k[:])
+}
+
 func (k SecurityKey) signingKey() []byte {
 	return k[:64]
 }

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -100,6 +100,7 @@ func New(ctx context.Context, options *Options) (*API, error) {
 					}),
 				)
 				r.Post("/issue-signed-app-token", api.workspaceProxyIssueSignedAppToken)
+				r.Post("/register", api.workspaceProxyRegister)
 			})
 			r.Route("/{workspaceproxy}", func(r chi.Router) {
 				r.Use(

diff --git a/enterprise/coderd/workspaceproxy.go b/enterprise/coderd/workspaceproxy.go
@@ -251,3 +251,66 @@ func (api *API) workspaceProxyIssueSignedAppToken(rw http.ResponseWriter, r *htt
 		SignedTokenStr: tokenStr,
 	})
 }
+
+// workspaceProxyRegister is used to register a new workspace proxy. When a proxy
+// comes online, it will announce itself to this endpoint. This updates its values
+// in the database and returns a signed token that can be used to authenticate
+// tokens.
+//
+// @Summary Register workspace proxy
+// @ID register-workspace-proxy
+// @Security CoderSessionToken
+// @Accept json
+// @Produce json
+// @Tags Enterprise
+// @Param request body wsproxysdk.RegisterWorkspaceProxyRequest true "Issue signed app token request"
+// @Success 201 {object} wsproxysdk.RegisterWorkspaceProxyResponse
+// @Router /workspaceproxies/me/register [post]
+// @x-apidocgen {"skip": true}
+func (api *API) workspaceProxyRegister(rw http.ResponseWriter, r *http.Request) {
+	var (
+		ctx   = r.Context()
+		proxy = httpmw.WorkspaceProxy(r)
+	)
+
+	var req wsproxysdk.RegisterWorkspaceProxyRequest
+	if !httpapi.Read(ctx, rw, r, &req) {
+		return
+	}
+
+	if err := validateProxyURL(req.AccessURL); err != nil {
+		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+			Message: "URL is invalid.",
+			Detail:  err.Error(),
+		})
+		return
+	}
+
+	if req.WildcardHostname != "" {
+		if _, err := httpapi.CompileHostnamePattern(req.WildcardHostname); err != nil {
+			httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
+				Message: "Wildcard URL is invalid.",
+				Detail:  err.Error(),
+			})
+			return
+		}
+	}
+
+	_, err := api.Database.RegisterWorkspaceProxy(ctx, database.RegisterWorkspaceProxyParams{
+		ID:               proxy.ID,
+		Url:              req.AccessURL,
+		WildcardHostname: req.WildcardHostname,
+	})
+	if httpapi.Is404Error(err) {
+		httpapi.ResourceNotFound(rw)
+		return
+	}
+	if err != nil {
+		httpapi.InternalServerError(rw, err)
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusCreated, wsproxysdk.RegisterWorkspaceProxyResponse{
+		AppSecurityKey: api.AppSecurityKey.String(),
+	})
+}
diff --git a/enterprise/wsproxy/wsproxysdk/wsproxysdk.go b/enterprise/wsproxy/wsproxysdk/wsproxysdk.go
@@ -142,3 +142,31 @@ func (c *Client) IssueSignedAppTokenHTML(ctx context.Context, rw http.ResponseWr
 	}
 	return res, true
 }
+
+type RegisterWorkspaceProxyRequest struct {
+	// AccessURL that hits the workspace proxy api.
+	AccessURL string `json:"access_url"`
+	// WildcardHostname that the workspace proxy api is serving for subdomain apps.
+	WildcardHostname string `json:"wildcard_hostname"`
+}
+
+type RegisterWorkspaceProxyResponse struct {
+	AppSecurityKey string `json:"app_security_key"`
+}
+
+func (c *Client) RegisterWorkspaceProxy(ctx context.Context, req RegisterWorkspaceProxyRequest) (RegisterWorkspaceProxyResponse, error) {
+	res, err := c.Request(ctx, http.MethodPost,
+		"/api/v2/workspaceproxies/me/register",
+		req,
+	)
+	if err != nil {
+		return RegisterWorkspaceProxyResponse{}, xerrors.Errorf("make request: %w", err)
+	}
+	defer res.Body.Close()
+
+	if res.StatusCode != http.StatusCreated {
+		return RegisterWorkspaceProxyResponse{}, codersdk.ReadBodyAsError(res)
+	}
+	var resp RegisterWorkspaceProxyResponse
+	return resp, json.NewDecoder(res.Body).Decode(&resp)
+}
-Original file line number
+Diff line change
@@ Expand Up @@
     					}),
     				)
     				r.Post("/issue-signed-app-token", api.workspaceProxyIssueSignedAppToken)
+    				r.Post("/register", api.workspaceProxyRegister)
     			})
     			r.Route("/{workspaceproxy}", func(r chi.Router) {
     				r.Use(
@@ Expand Down @@