fix: support substring search on workspace name (#2096)

f0ssel · kylecarbs · commit 585e16c1d547 · 2022-06-10T17:02:42.000Z
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -330,7 +330,7 @@ func (q *fakeQuerier) GetWorkspacesWithFilter(_ context.Context, arg database.Ge
 		if !arg.Deleted && workspace.Deleted {
 			continue
 		}
-		if arg.Name != "" && workspace.Name != arg.Name {
+		if arg.Name != "" && !strings.Contains(workspace.Name, arg.Name) {
 			continue
 		}
 		workspaces = append(workspaces, workspace)
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaces.sql b/coderd/database/queries/workspaces.sql
@@ -28,10 +28,10 @@ WHERE
 				owner_id = @owner_id
 		  ELSE true
 	END
-	-- Filter by name
+	-- Filter by name, matching on substring
 	AND CASE
 		  WHEN @name :: text != '' THEN
-				LOWER(name) = LOWER(@name)
+				LOWER(name) LIKE '%' || LOWER(@name) || '%'
 		  ELSE true
 	END
 ;
diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -232,6 +232,42 @@ func TestWorkspaceByOwnerAndName(t *testing.T) {
 	})
 }
 
+func TestWorkspaceFilter(t *testing.T) {
+	t.Parallel()
+	t.Run("Name", 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)
+		workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
+
+		// full match
+		ws, err := client.Workspaces(context.Background(), codersdk.WorkspaceFilter{
+			Name: workspace.Name,
+		})
+		require.NoError(t, err)
+		require.Len(t, ws, 1, workspace.Name)
+		require.Equal(t, workspace.ID, ws[0].ID)
+
+		// partial match
+		ws, err = client.Workspaces(context.Background(), codersdk.WorkspaceFilter{
+			Name: workspace.Name[1 : len(workspace.Name)-2],
+		})
+		require.NoError(t, err)
+		require.Len(t, ws, 1)
+		require.Equal(t, workspace.ID, ws[0].ID)
+
+		// no match
+		ws, err = client.Workspaces(context.Background(), codersdk.WorkspaceFilter{
+			Name: "$$$$",
+		})
+		require.NoError(t, err)
+		require.Len(t, ws, 0)
+	})
+}
+
 func TestPostWorkspaceBuild(t *testing.T) {
 	t.Parallel()
 	t.Run("NoTemplateVersion", func(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ func (q *fakeQuerier) GetWorkspacesWithFilter(_ context.Context, arg database.Ge`
`330`	`330`	`if !arg.Deleted && workspace.Deleted {`
`331`	`331`	`continue`
`332`	`332`	`}`
`333`		`- if arg.Name != "" && workspace.Name != arg.Name {`
	`333`	`+ if arg.Name != "" && !strings.Contains(workspace.Name, arg.Name) {`
`334`	`334`	`continue`
`335`	`335`	`}`
`336`	`336`	`workspaces = append(workspaces, workspace)`