Skip to content

feat: add support for template in workspace filter #2134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions coderd/database/databasefake/databasefake.go
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,18 @@ func (q *fakeQuerier) GetWorkspacesWithFilter(_ context.Context, arg database.Ge
if arg.Name != "" && !strings.Contains(workspace.Name, arg.Name) {
continue
}
if len(arg.TemplateIds) > 0 {
match := false
for _, id := range arg.TemplateIds {
if workspace.TemplateID == id {
match = true
break
}
}
if !match {
continue
}
}
workspaces = append(workspaces, workspace)
}

Expand Down Expand Up @@ -761,6 +773,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()
Expand Down
1 change: 1 addition & 0 deletions coderd/database/querier.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

70 changes: 64 additions & 6 deletions coderd/database/queries.sql.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions coderd/database/queries/templates.sql
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
6 changes: 6 additions & 0 deletions coderd/database/queries/workspaces.sql
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ WHERE
owner_id = @owner_id
ELSE true
END
-- Filter by template_ids
AND CASE
WHEN array_length(@template_ids :: uuid[], 1) > 0 THEN
template_id = ANY(@template_ids)
ELSE true
END
-- Filter by name, matching on substring
AND CASE
WHEN @name :: text != '' THEN
Expand Down
40 changes: 22 additions & 18 deletions coderd/workspaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -103,41 +103,45 @@ 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
}
}

nameFilter := r.URL.Query().Get("name")
if nameFilter != "" {
filter.Name = nameFilter
}

templateFilter := r.URL.Query().Get("template")
if templateFilter != "" {
ts, err := api.Database.GetTemplatesByName(r.Context(), database.GetTemplatesByNameParams{
Name: templateFilter,
})
if err == nil {
for _, t := range ts {
filter.TemplateIds = append(filter.TemplateIds, t.ID)
}
}
}

workspaces, err := api.Database.GetWorkspacesWithFilter(r.Context(), filter)
if err != nil {
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
Expand Down
24 changes: 24 additions & 0 deletions coderd/workspaces_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,30 @@ func TestWorkspaceFilter(t *testing.T) {
require.NoError(t, err)
require.Len(t, ws, 0)
})
t.Run("Template", func(t *testing.T) {
t.Parallel()
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerD: true})
user := coderdtest.CreateFirstUser(t, client)
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
template2 := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
_ = coderdtest.CreateWorkspace(t, client, user.OrganizationID, template2.ID)

// empty
ws, err := client.Workspaces(context.Background(), codersdk.WorkspaceFilter{})
require.NoError(t, err)
require.Len(t, ws, 2)

// single template
ws, err = client.Workspaces(context.Background(), codersdk.WorkspaceFilter{
Template: template.Name,
})
require.NoError(t, err)
require.Len(t, ws, 1)
require.Equal(t, workspace.ID, ws[0].ID)
})
}

func TestPostWorkspaceBuild(t *testing.T) {
Expand Down
10 changes: 8 additions & 2 deletions codersdk/workspaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -237,6 +240,9 @@ func (f WorkspaceFilter) asRequestOption() requestOption {
if f.Name != "" {
q.Set("name", f.Name)
}
if f.Template != "" {
q.Set("template", f.Template)
}
r.URL.RawQuery = q.Encode()
}
}
Expand Down
3 changes: 2 additions & 1 deletion site/src/api/typesGenerated.ts
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ export interface WorkspaceBuildsRequest extends Pagination {
readonly WorkspaceID: string
}

// From codersdk/workspaces.go:261:6
// From codersdk/workspaces.go:267:6
export interface WorkspaceByOwnerAndNameParams {
readonly include_deleted?: boolean
}
Expand All @@ -472,6 +472,7 @@ export interface WorkspaceByOwnerAndNameParams {
export interface WorkspaceFilter {
readonly organization_id?: string
readonly owner?: string
readonly template?: string
readonly name?: string
}

Expand Down