feat: Guard search queries against common mistakes (#6404)

* feat: Error on excessive invalid search keys
* feat: Guard search queries against common mistakes
* Raise errors in FE on workspaces table
* All errors should be on newlines

coderd/workspaces_internal_test.go

@@ -1,163 +0,0 @@
-package coderd
-
-import (
-	"fmt"
-	"strings"
-	"testing"
-	"time"
-
-	"github.com/coder/coder/coderd/database"
-	"github.com/coder/coder/codersdk"
-
-	"github.com/stretchr/testify/require"
-)
-
-func TestSearchWorkspace(t *testing.T) {
-	t.Parallel()
-	testCases := []struct {
-		Name                  string
-		Query                 string
-		Expected              database.GetWorkspacesParams
-		ExpectedErrorContains string
-	}{
-		{
-			Name:     "Empty",
-			Query:    "",
-			Expected: database.GetWorkspacesParams{},
-		},
-		{
-			Name:  "Owner/Name",
-			Query: "Foo/Bar",
-			Expected: database.GetWorkspacesParams{
-				OwnerUsername: "foo",
-				Name:          "bar",
-			},
-		},
-		{
-			Name:  "Owner/NameWithSpaces",
-			Query: "     Foo/Bar     ",
-			Expected: database.GetWorkspacesParams{
-				OwnerUsername: "foo",
-				Name:          "bar",
-			},
-		},
-		{
-			Name:  "Name",
-			Query: "workspace-name",
-			Expected: database.GetWorkspacesParams{
-				Name: "workspace-name",
-			},
-		},
-		{
-			Name:  "Name+Param",
-			Query: "workspace-name TEMPLATE:docker",
-			Expected: database.GetWorkspacesParams{
-				Name:         "workspace-name",
-				TemplateName: "docker",
-			},
-		},
-		{
-			Name:  "OnlyParams",
-			Query: "name:workspace-name template:docker OWNER:Alice",
-			Expected: database.GetWorkspacesParams{
-				Name:          "workspace-name",
-				TemplateName:  "docker",
-				OwnerUsername: "alice",
-			},
-		},
-		{
-			Name:  "QuotedParam",
-			Query: `name:workspace-name template:"docker template" owner:alice`,
-			Expected: database.GetWorkspacesParams{
-				Name:          "workspace-name",
-				TemplateName:  "docker template",
-				OwnerUsername: "alice",
-			},
-		},
-		{
-			Name:  "QuotedKey",
-			Query: `"name":baz "template":foo "owner":bar`,
-			Expected: database.GetWorkspacesParams{
-				Name:          "baz",
-				TemplateName:  "foo",
-				OwnerUsername: "bar",
-			},
-		},
-		{
-			// This will not return an error
-			Name:     "ExtraKeys",
-			Query:    `foo:bar`,
-			Expected: database.GetWorkspacesParams{},
-		},
-		{
-			// Quotes keep elements together
-			Name:  "QuotedSpecial",
-			Query: `name:"workspace:name"`,
-			Expected: database.GetWorkspacesParams{
-				Name: "workspace:name",
-			},
-		},
-		{
-			Name:  "QuotedMadness",
-			Query: `"name":"foo:bar:baz/baz/zoo:zonk"`,
-			Expected: database.GetWorkspacesParams{
-				Name: "foo:bar:baz/baz/zoo:zonk",
-			},
-		},
-		{
-			Name:  "QuotedName",
-			Query: `"foo/bar"`,
-			Expected: database.GetWorkspacesParams{
-				Name: "foo/bar",
-			},
-		},
-		{
-			Name:  "QuotedOwner/Name",
-			Query: `"foo"/"bar"`,
-			Expected: database.GetWorkspacesParams{
-				Name:          "bar",
-				OwnerUsername: "foo",
-			},
-		},
-
-		// Failures
-		{
-			Name:                  "ExtraSlashes",
-			Query:                 `foo/bar/baz`,
-			ExpectedErrorContains: "can only contain 1 '/'",
-		},
-		{
-			Name:                  "ExtraColon",
-			Query:                 `owner:name:extra`,
-			ExpectedErrorContains: "can only contain 1 ':'",
-		},
-	}
-
-	for _, c := range testCases {
-		c := c
-		t.Run(c.Name, func(t *testing.T) {
-			t.Parallel()
-			values, errs := workspaceSearchQuery(c.Query, codersdk.Pagination{}, 0)
-			if c.ExpectedErrorContains != "" {
-				require.True(t, len(errs) > 0, "expect some errors")
-				var s strings.Builder
-				for _, err := range errs {
-					_, _ = s.WriteString(fmt.Sprintf("%s: %s\n", err.Field, err.Detail))
-				}
-				require.Contains(t, s.String(), c.ExpectedErrorContains)
-			} else {
-				require.Len(t, errs, 0, "expected no error")
-				require.Equal(t, c.Expected, values, "expected values")
-			}
-		})
-	}
-	t.Run("AgentInactiveDisconnectTimeout", func(t *testing.T) {
-		t.Parallel()
-
-		query := `foo:bar`
-		timeout := 1337 * time.Second
-		values, errs := workspaceSearchQuery(query, codersdk.Pagination{}, timeout)
-		require.Empty(t, errs)
-		require.Equal(t, int64(timeout.Seconds()), values.AgentInactiveDisconnectTimeoutSeconds)
-	})
-}