chore: implement fuzzy name matching for templates (#14211)

Emyrk · web-flow · commit 591385f2ca0e · 2024-08-09T10:21:26.000-05:00
* chore: add fuzzy name search for templates
* chore: implement fuzzy name matching for templates

Templates search query defaults to a fuzzy name match
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -9647,6 +9647,11 @@ func (q *FakeQuerier) GetAuthorizedTemplates(ctx context.Context, arg database.G
 		if arg.Deprecated.Valid && arg.Deprecated.Bool == (template.Deprecated != "") {
 			continue
 		}
+		if arg.FuzzyName != "" {
+			if !strings.Contains(strings.ToLower(template.Name), strings.ToLower(arg.FuzzyName)) {
+				continue
+			}
+		}
 
 		if len(arg.IDs) > 0 {
 			match := false
diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -76,6 +76,7 @@ func (q *sqlQuerier) GetAuthorizedTemplates(ctx context.Context, arg GetTemplate
 		arg.Deleted,
 		arg.OrganizationID,
 		arg.ExactName,
+		arg.FuzzyName,
 		pq.Array(arg.IDs),
 		arg.Deprecated,
 	)
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,12 @@ WHERE
 			LOWER("name") = LOWER(@exact_name)
 		ELSE true
 	END
+  	-- Filter by name, matching on substring
+  	AND CASE
+		  WHEN @fuzzy_name :: text != '' THEN
+			  lower(name) ILIKE '%' || lower(@fuzzy_name) || '%'
+		  ELSE true
+	END
 	-- Filter by ids
 	AND CASE
 		WHEN array_length(@ids :: uuid[], 1) > 0 THEN
diff --git a/coderd/searchquery/search.go b/coderd/searchquery/search.go
@@ -198,6 +198,7 @@ func Templates(ctx context.Context, db database.Store, query string) (database.G
 
 	parser := httpapi.NewQueryParamParser()
 	filter := database.GetTemplatesWithFilterParams{
+		FuzzyName:  parser.String(values, "", "name"),
 		Deleted:    parser.Boolean(values, false, "deleted"),
 		ExactName:  parser.String(values, "", "exact_name"),
 		IDs:        parser.UUIDs(values, []uuid.UUID{}, "ids"),
diff --git a/coderd/searchquery/search_test.go b/coderd/searchquery/search_test.go
@@ -469,6 +469,13 @@ func TestSearchTemplates(t *testing.T) {
 			Query:    "",
 			Expected: database.GetTemplatesWithFilterParams{},
 		},
+		{
+			Name:  "OnlyName",
+			Query: "foobar",
+			Expected: database.GetTemplatesWithFilterParams{
+				FuzzyName: "foobar",
+			},
+		},
 	}
 
 	for _, c := range testCases {
diff --git a/coderd/templates_test.go b/coderd/templates_test.go
@@ -438,8 +438,12 @@ func TestTemplatesByOrganization(t *testing.T) {
 		user := coderdtest.CreateFirstUser(t, client)
 		version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
 		version2 := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, nil)
-		coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
-		coderdtest.CreateTemplate(t, client, user.OrganizationID, version2.ID)
+		foo := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID, func(request *codersdk.CreateTemplateRequest) {
+			request.Name = "foobar"
+		})
+		bar := coderdtest.CreateTemplate(t, client, user.OrganizationID, version2.ID, func(request *codersdk.CreateTemplateRequest) {
+			request.Name = "barbaz"
+		})
 
 		ctx := testutil.Context(t, testutil.WaitLong)
 
@@ -460,6 +464,27 @@ func TestTemplatesByOrganization(t *testing.T) {
 			require.Equal(t, tmpl.OrganizationDisplayName, org.DisplayName, "organization display name")
 			require.Equal(t, tmpl.OrganizationIcon, org.Icon, "organization display name")
 		}
+
+		// Check fuzzy name matching
+		templates, err = client.Templates(ctx, codersdk.TemplateFilter{
+			FuzzyName: "bar",
+		})
+		require.NoError(t, err)
+		require.Len(t, templates, 2)
+
+		templates, err = client.Templates(ctx, codersdk.TemplateFilter{
+			FuzzyName: "foo",
+		})
+		require.NoError(t, err)
+		require.Len(t, templates, 1)
+		require.Equal(t, foo.ID, templates[0].ID)
+
+		templates, err = client.Templates(ctx, codersdk.TemplateFilter{
+			FuzzyName: "baz",
+		})
+		require.NoError(t, err)
+		require.Len(t, templates, 1)
+		require.Equal(t, bar.ID, templates[0].ID)
 	})
 }
 
diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -405,8 +405,10 @@ func (c *Client) TemplatesByOrganization(ctx context.Context, organizationID uui
 }
 
 type TemplateFilter struct {
-	OrganizationID uuid.UUID
-	ExactName      string
+	OrganizationID uuid.UUID `typescript:"-"`
+	ExactName      string    `typescript:"-"`
+	FuzzyName      string    `typescript:"-"`
+	SearchQuery    string    `json:"q,omitempty"`
 }
 
 // asRequestOption returns a function that can be used in (*Client).Request.
@@ -424,6 +426,13 @@ func (f TemplateFilter) asRequestOption() RequestOption {
 			params = append(params, fmt.Sprintf("exact_name:%q", f.ExactName))
 		}
 
+		if f.FuzzyName != "" {
+			params = append(params, fmt.Sprintf("name:%q", f.FuzzyName))
+		}
+		if f.SearchQuery != "" {
+			params = append(params, f.SearchQuery)
+		}
+
 		q := r.URL.Query()
 		q.Set("q", strings.Join(params, " "))
 		r.URL.RawQuery = q.Encode()
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,7 @@ func (q *sqlQuerier) GetAuthorizedTemplates(ctx context.Context, arg GetTemplate`
`76`	`76`	`arg.Deleted,`
`77`	`77`	`arg.OrganizationID,`
`78`	`78`	`arg.ExactName,`
	`79`	`+ arg.FuzzyName,`
`79`	`80`	`pq.Array(arg.IDs),`
`80`	`81`	`arg.Deprecated,`
`81`	`82`	`)`