chore: Implement enterprise endpoints for moons

coder · Emyrk · Apr 4, 2023 · Mar 30, 2023 · Mar 31, 2023 · Mar 31, 2023
commit 5bd1392cab4fd75279f01e1ccbe03f636e056755
diff --git a/coderd/audit/diff.go b/coderd/audit/diff.go
@@ -16,7 +16,8 @@ type Auditable interface {
 		database.GitSSHKey |
 		database.WorkspaceBuild |
 		database.AuditableGroup |
-		database.License
+		database.License |
+		database.WorkspaceProxy
 }
 
 // Map is a map of changed fields in an audited resource. It maps field names to

diff --git a/coderd/database/dbauthz/querier.go b/coderd/database/dbauthz/querier.go
@@ -1647,10 +1647,8 @@ func (q *querier) GetWorkspaceByWorkspaceAppID(ctx context.Context, workspaceApp
 	return fetch(q.log, q.auth, q.db.GetWorkspaceByWorkspaceAppID)(ctx, workspaceAppID)
 }
 
-func (q *querier) GetWorkspaceProxies(ctx context.Context) ([]database.WorkspaceProxy, error) {
-	return fetchWithPostFilter(q.auth, func(ctx context.Context, _ any) ([]database.WorkspaceProxy, error) {
-		return q.db.GetWorkspaceProxies(ctx)
-	})(ctx, nil)
+func (q *querier) GetWorkspaceProxies(ctx context.Context, organizationID uuid.UUID) ([]database.WorkspaceProxy, error) {
+	return fetchWithPostFilter(q.auth, q.GetWorkspaceProxies)(ctx, organizationID)
 }
 
 func (q *querier) GetWorkspaceProxyByID(ctx context.Context, id uuid.UUID) (database.WorkspaceProxy, error) {

diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -4896,12 +4896,16 @@ func (q *fakeQuerier) UpdateWorkspaceAgentStartupLogOverflowByID(_ context.Conte
 	return sql.ErrNoRows
 }
 
-func (q *fakeQuerier) GetWorkspaceProxies(ctx context.Context) ([]database.WorkspaceProxy, error) {
+func (q *fakeQuerier) GetWorkspaceProxies(ctx context.Context, organizationID uuid.UUID) ([]database.WorkspaceProxy, error) {
 	q.mutex.Lock()
 	defer q.mutex.Unlock()
 
-	cpy := make([]database.WorkspaceProxy, len(q.workspaceProxies))
-	copy(cpy, q.workspaceProxies)
+	cpy := make([]database.WorkspaceProxy, 0, len(q.workspaceProxies))
+	for _, p := range q.workspaceProxies {
+		if p.OrganizationID == organizationID && !p.Deleted {
+			cpy = append(cpy, p)
+		}
+	}
 	return cpy, nil
 }
 

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
@@ -52,4 +52,5 @@ SELECT
 FROM
 	workspace_proxies
 WHERE
-	deleted = false;
+	deleted = false
+    AND organization_id = @organization_id;
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -1570,6 +1570,10 @@ const (
 	// for all users.
 	ExperimentTemplateEditor Experiment = "template_editor"
 
+	// ExperimentMoons enabled the workspace proxy endpoints and CRUD. This
+	// feature is not yet complete in functionality.
+	ExperimentMoons Experiment = "moons"
+
 	// Add new experiments here!
 	// ExperimentExample Experiment = "example"
 )

diff --git a/codersdk/workspaceproxy.go b/codersdk/workspaceproxy.go
@@ -0,0 +1,28 @@
+package codersdk
+
+import (
+	"time"
+
+	"github.com/google/uuid"
+)
+
+type CreateWorkspaceProxyRequest struct {
+	Name        string `json:"name"`
+	Icon        string `json:"icon"`
+	URL         string `json:"url"`
+	WildcardURL string `json:"wildcard_url"`
+}
+
+type WorkspaceProxy struct {
+	ID             uuid.UUID `db:"id" json:"id"`
+	OrganizationID uuid.UUID `db:"organization_id" json:"organization_id"`
+	Name           string    `db:"name" json:"name"`
+	Icon           string    `db:"icon" json:"icon"`
+	// Full url including scheme of the proxy api url: https://us.example.com
+	Url string `db:"url" json:"url"`
+	// URL with the wildcard for subdomain based app hosting: https://*.us.example.com
+	WildcardUrl string    `db:"wildcard_url" json:"wildcard_url"`
+	CreatedAt   time.Time `db:"created_at" json:"created_at"`
+	UpdatedAt   time.Time `db:"updated_at" json:"updated_at"`
+	Deleted     bool      `db:"deleted" json:"deleted"`
+}
diff --git a/enterprise/audit/table.go b/enterprise/audit/table.go
@@ -160,6 +160,17 @@ var auditableResourcesTypes = map[any]map[string]Action{
 		"exp":         ActionTrack,
 		"uuid":        ActionTrack,
 	},
+	&database.WorkspaceProxy{}: {
+		"id":              ActionTrack,
+		"organization_id": ActionTrack,
+		"name":            ActionTrack,
+		"icon":            ActionTrack,
+		"url":             ActionTrack,
+		"wildcard_url":    ActionTrack,
+		"created_at":      ActionTrack,
+		"updated_at":      ActionTrack,
+		"deleted":         ActionTrack,
+	},
 }
 
 // auditMap converts a map of struct pointers to a map of struct names as

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -81,6 +81,23 @@ func New(ctx context.Context, options *Options) (*API, error) {
 			r.Get("/", api.licenses)
 			r.Delete("/{id}", api.deleteLicense)
 		})
+		r.Route("/organizations/{organization}/workspaceproxys", func(r chi.Router) {
+			r.Use(
+				apiKeyMiddleware,
+				api.moonsEnabledMW,
+				httpmw.ExtractOrganizationParam(api.Database),
+			)
+			r.Post("/", api.postWorkspaceProxyByOrganization)
+			r.Get("/", api.workspaceProxiesByOrganization)
+			// TODO: Add specific workspace proxy endpoints.
+			//r.Route("/{proxyName}", func(r chi.Router) {
+			//	r.Use(
+			//		httpmw.ExtractWorkspaceProxyByNameParam(api.Database),
+			//	)
+			//
+			//	r.Get("/", api.workspaceProxyByName)
+			//})
+		})
 		r.Route("/organizations/{organization}/groups", func(r chi.Router) {
 			r.Use(
 				apiKeyMiddleware,

diff --git a/enterprise/coderd/templates.go b/enterprise/coderd/templates.go
@@ -279,3 +279,13 @@ func (api *API) templateRBACEnabledMW(next http.Handler) http.Handler {
 		next.ServeHTTP(rw, r)
 	})
 }
+
+func (api *API) moonsEnabledMW(next http.Handler) http.Handler {
+	return http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+		if !api.AGPL.Experiments.Enabled(codersdk.ExperimentMoons) {
+			httpapi.RouteNotFound(rw)
+			return
+		}
+		next.ServeHTTP(rw, r)
+	})
+}
diff --git a/enterprise/coderd/workspaceproxy.go b/enterprise/coderd/workspaceproxy.go
@@ -0,0 +1,118 @@
+package coderd
+
+import (
+	"database/sql"
+	"fmt"
+	"net/http"
+
+	"golang.org/x/xerrors"
+
+	"github.com/coder/coder/coderd/audit"
+	"github.com/coder/coder/coderd/database"
+	"github.com/coder/coder/coderd/httpapi"
+	"github.com/coder/coder/coderd/httpmw"
+	"github.com/coder/coder/codersdk"
+	"github.com/google/uuid"
+)
+
+// @Summary Create workspace proxy for organization
+// @ID create-workspace-proxy-for-organization
+// @Security CoderSessionToken
+// @Accept json
+// @Produce json
+// @Tags Templates
+// @Param request body codersdk.CreateWorkspaceProxyRequest true "Create workspace proxy request"
+// @Param organization path string true "Organization ID"
+// @Success 201 {object} codersdk.WorkspaceProxy
+// @Router /organizations/{organization}/workspaceproxys [post]
+func (api *API) postWorkspaceProxyByOrganization(rw http.ResponseWriter, r *http.Request) {
+	var (
+		ctx               = r.Context()
+		org               = httpmw.OrganizationParam(r)
+		auditor           = api.AGPL.Auditor.Load()
+		aReq, commitAudit = audit.InitRequest[database.WorkspaceProxy](rw, &audit.RequestParams{
+			Audit:   *auditor,
+			Log:     api.Logger,
+			Request: r,
+			Action:  database.AuditActionCreate,
+		})
+	)
+	defer commitAudit()
+
+	var req codersdk.CreateWorkspaceProxyRequest
+	if !httpapi.Read(ctx, rw, r, &req) {
+		return
+	}
+
+	proxy, err := api.Database.InsertWorkspaceProxy(ctx, database.InsertWorkspaceProxyParams{
+		ID:             uuid.New(),
+		OrganizationID: org.ID,
+		Name:           req.Name,
+		Icon:           req.Icon,
+		// TODO: validate URLs
+		Url:         req.URL,
+		WildcardUrl: req.WildcardURL,
+		CreatedAt:   database.Now(),
+		UpdatedAt:   database.Now(),
+	})
+	if database.IsUniqueViolation(err) {
+		httpapi.Write(ctx, rw, http.StatusConflict, codersdk.Response{
+			Message: fmt.Sprintf("Workspace proxy with name %q already exists.", req.Name),
+		})
+		return
+	}
+	if err != nil {
+		httpapi.InternalServerError(rw, err)
+		return
+	}
+
+	aReq.New = proxy
+	httpapi.Write(ctx, rw, http.StatusCreated, convertProxy(proxy))
+}
+
+// @Summary Get workspace proxies
+// @ID get-workspace-proxies
+// @Security CoderSessionToken
+// @Produce json
+// @Tags Enterprise
+// @Param organization path string true "Organization ID" format(uuid)
+// @Success 200 {array} codersdk.WorkspaceProxy
+// @Router /organizations/{organization}/workspaceproxys [get]
+func (api *API) workspaceProxiesByOrganization(rw http.ResponseWriter, r *http.Request) {
+	var (
+		ctx = r.Context()
+		org = httpmw.OrganizationParam(r)
+	)
+
+	proxies, err := api.Database.GetWorkspaceProxies(ctx, org.ID)
+	if err != nil && !xerrors.Is(err, sql.ErrNoRows) {
+		httpapi.InternalServerError(rw, err)
+		return
+	}
+
+	httpapi.Write(ctx, rw, http.StatusOK, convertProxies(proxies))
+}
+
+
+
+func convertProxies(p []database.WorkspaceProxy) []codersdk.WorkspaceProxy {
+	resp := make([]codersdk.WorkspaceProxy, 0, len(p))
+	for _, proxy := range p {
+		resp = append(resp, convertProxy(proxy))
+	}
+	return resp
+}
+
+func convertProxy(p database.WorkspaceProxy) codersdk.WorkspaceProxy {
+	return codersdk.WorkspaceProxy{
+		ID:             p.ID,
+		OrganizationID: p.OrganizationID,
+		Name:           p.Name,
+		Icon:           p.Icon,
+		Url:            p.Url,
+		WildcardUrl:    p.WildcardUrl,
+		CreatedAt:      p.CreatedAt,
+		UpdatedAt:      p.UpdatedAt,
+		Deleted:        p.Deleted,
+	}
+}