feat: add support for template in workspace filter

coder · f0ssel · Jun 7, 2022 · Jun 8, 2022 · Jun 8, 2022 · Jun 8, 2022
commit 1a14a8c71a2686df14ea0e042e6b304a82469b9d
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -761,6 +761,26 @@ func (q *fakeQuerier) UpdateTemplateMetaByID(_ context.Context, arg database.Upd
 	return sql.ErrNoRows
 }
 
+func (q *fakeQuerier) GetTemplatesByName(_ context.Context, arg database.GetTemplatesByNameParams) ([]database.Template, error) {
+	q.mutex.RLock()
+	defer q.mutex.RUnlock()
+	var templates []database.Template
+	for _, template := range q.templates {
+		if !strings.EqualFold(template.Name, arg.Name) {
+			continue
+		}
+		if template.Deleted != arg.Deleted {
+			continue
+		}
+		templates = append(templates, template)
+	}
+	if len(templates) > 0 {
+		return templates, nil
+	}
+
+	return nil, sql.ErrNoRows
+}
+
 func (q *fakeQuerier) GetTemplateVersionsByTemplateID(_ context.Context, arg database.GetTemplateVersionsByTemplateIDParams) (version []database.TemplateVersion, err error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()

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/templates.sql b/coderd/database/queries/templates.sql
@@ -28,6 +28,15 @@ WHERE
 LIMIT
 	1;
 
+-- name: GetTemplatesByName :many
+SELECT
+	*
+FROM
+	templates
+WHERE
+	deleted = @deleted
+	AND LOWER("name") = LOWER(@name);
+
 -- name: GetTemplatesByOrganization :many
 SELECT
 	*

diff --git a/coderd/database/queries/workspaces.sql b/coderd/database/queries/workspaces.sql
@@ -28,6 +28,12 @@ WHERE
 				owner_id = @owner_id
 		  ELSE true
 	END
+	-- Filter by template_id
+	AND CASE
+		  WHEN @template_id :: uuid != '00000000-00000000-00000000-00000000' THEN
+				template_id = @template_id
+		  ELSE true
+	END
 	-- Filter by name, matching on substring
 	AND CASE
 		  WHEN @name :: text != '' THEN

diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -103,48 +103,56 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
 // Optional filters with query params
 func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {
 	apiKey := httpmw.APIKey(r)
+	filter := database.GetWorkspacesWithFilterParams{Deleted: false}
 
-	// Empty strings mean no filter
 	orgFilter := r.URL.Query().Get("organization_id")
-	ownerFilter := r.URL.Query().Get("owner")
-	nameFilter := r.URL.Query().Get("name")
-
-	filter := database.GetWorkspacesWithFilterParams{Deleted: false}
 	if orgFilter != "" {
 		orgID, err := uuid.Parse(orgFilter)
 		if err == nil {
 			filter.OrganizationID = orgID
 		}
 	}
+
+	ownerFilter := r.URL.Query().Get("owner")
 	if ownerFilter == "me" {
 		filter.OwnerID = apiKey.UserID
 	} else if ownerFilter != "" {
-		userID, err := uuid.Parse(ownerFilter)
-		if err != nil {
-			// Maybe it's a username
-			user, err := api.Database.GetUserByEmailOrUsername(r.Context(), database.GetUserByEmailOrUsernameParams{
-				// Why not just accept 1 arg and use it for both in the sql?
-				Username: ownerFilter,
-				Email:    ownerFilter,
-			})
-			if err == nil {
-				filter.OwnerID = user.ID
-			}
-		} else {
-			filter.OwnerID = userID
+		user, err := api.Database.GetUserByEmailOrUsername(r.Context(), database.GetUserByEmailOrUsernameParams{
+			Username: ownerFilter,
+		})
+		if err == nil {
+			filter.OwnerID = user.ID
 		}
 	}
+
+	templateFilter := r.URL.Query().Get("template")
+	var templates []database.Template
+	if templateFilter != "" {
+		ts, err := api.Database.GetTemplatesByName(r.Context(), database.GetTemplatesByNameParams{
+			Name: templateFilter,
+		})
+		if err == nil {
+			templates = ts
+		}
+	}
+
+	nameFilter := r.URL.Query().Get("name")
 	if nameFilter != "" {
 		filter.Name = nameFilter
 	}
 
-	workspaces, err := api.Database.GetWorkspacesWithFilter(r.Context(), filter)
-	if err != nil {
-		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
-			Message: "Internal error fetching workspaces.",
-			Detail:  err.Error(),
-		})
-		return
+	var workspaces []database.Workspace
+	for _, template := range templates {
+		filter.TemplateID = template.ID
+		ws, err := api.Database.GetWorkspacesWithFilter(r.Context(), filter)
+		if err != nil {
+			httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+				Message: "Internal error fetching workspaces.",
+				Detail:  err.Error(),
+			})
+			return
+		}
+		workspaces = append(workspaces, ws...)
 	}
 
 	// Only return workspaces the user can read

diff --git a/codersdk/workspaces.go b/codersdk/workspaces.go
@@ -218,9 +218,12 @@ func (c *Client) PutExtendWorkspace(ctx context.Context, id uuid.UUID, req PutEx
 
 type WorkspaceFilter struct {
 	OrganizationID uuid.UUID `json:"organization_id,omitempty"`
-	// Owner can be a user_id (uuid), "me", or a username
+	// Owner can be "me" or a username
 	Owner string `json:"owner,omitempty"`
-	Name  string `json:"name,omitempty"`
+	// Template is a template name
+	Template string `json:"template,omitempty"`
+	// Name will return partial matches
+	Name string `json:"name,omitempty"`
 }
 
 // asRequestOption returns a function that can be used in (*Client).Request.