feat: add impending deletion filter to workspaces page (#7860)

* add workspace deletion dialog

* add deleting_by query param

* added test

* filtering on workspaces to be deleted

* cleaned up form

* added story

* added banner filter

* PR feedback

* fix lint and stories

* PR feedback

* added enterprise test

* added unit tests in search_test.go

* remove unused fn

* unstaged changes

coderd/searchquery/search.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/httpapi"
+	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 )
 
@@ -66,7 +67,11 @@ func Users(query string) (database.GetUsersParams, []codersdk.ValidationError) {
 	return filter, parser.Errors
 }
 
-func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectTimeout time.Duration) (database.GetWorkspacesParams, []codersdk.ValidationError) {
+type PostFilter struct {
+	DeletingBy *time.Time `json:"deleting_by" format:"date-time"`
+}
+
+func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectTimeout time.Duration) (database.GetWorkspacesParams, PostFilter, []codersdk.ValidationError) {
 	filter := database.GetWorkspacesParams{
 		AgentInactiveDisconnectTimeoutSeconds: int64(agentInactiveDisconnectTimeout.Seconds()),
 
@@ -74,8 +79,10 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 		Limit:  int32(page.Limit),
 	}
 
+	var postFilter PostFilter
+
 	if query == "" {
-		return filter, nil
+		return filter, postFilter, nil
 	}
 
 	// Always lowercase for all searches.
@@ -95,7 +102,7 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 		return nil
 	})
 	if len(errors) > 0 {
-		return filter, errors
+		return filter, postFilter, errors
 	}
 
 	parser := httpapi.NewQueryParamParser()
@@ -104,8 +111,13 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 	filter.Name = parser.String(values, "", "name")
 	filter.Status = string(httpapi.ParseCustom(parser, values, "", "status", httpapi.ParseEnum[database.WorkspaceStatus]))
 	filter.HasAgent = parser.String(values, "", "has-agent")
+
+	if _, ok := values["deleting_by"]; ok {
+		postFilter.DeletingBy = ptr.Ref(parser.Time(values, time.Time{}, "deleting_by", "2006-01-02"))
+	}
+
 	parser.ErrorExcessParams(values)
-	return filter, parser.Errors
+	return filter, postFilter, parser.Errors
 }
 
 func searchTerms(query string, defaultKey func(term string, values url.Values) error) (url.Values, []codersdk.ValidationError) {

coderd/searchquery/search_test.go

@@ -6,11 +6,13 @@ import (
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/coder/coder/coderd/database"
 	"github.com/coder/coder/coderd/rbac"
 	"github.com/coder/coder/coderd/searchquery"
+	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 )
 
@@ -148,17 +150,18 @@ func TestSearchWorkspace(t *testing.T) {
 		c := c
 		t.Run(c.Name, func(t *testing.T) {
 			t.Parallel()
-			values, errs := searchquery.Workspaces(c.Query, codersdk.Pagination{}, 0)
+			values, postFilter, errs := searchquery.Workspaces(c.Query, codersdk.Pagination{}, 0)
 			if c.ExpectedErrorContains != "" {
-				require.True(t, len(errs) > 0, "expect some errors")
+				assert.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)
+				assert.Contains(t, s.String(), c.ExpectedErrorContains)
 			} else {
-				require.Len(t, errs, 0, "expected no error")
-				require.Equal(t, c.Expected, values, "expected values")
+				assert.Empty(t, postFilter)
+				assert.Len(t, errs, 0, "expected no error")
+				assert.Equal(t, c.Expected, values, "expected values")
 			}
 		})
 	}
@@ -167,10 +170,51 @@ func TestSearchWorkspace(t *testing.T) {
 
 		query := ``
 		timeout := 1337 * time.Second
-		values, errs := searchquery.Workspaces(query, codersdk.Pagination{}, timeout)
+		values, _, errs := searchquery.Workspaces(query, codersdk.Pagination{}, timeout)
 		require.Empty(t, errs)
 		require.Equal(t, int64(timeout.Seconds()), values.AgentInactiveDisconnectTimeoutSeconds)
 	})
+
+	t.Run("TestSearchWorkspacePostFilter", func(t *testing.T) {
+		t.Parallel()
+		testCases := []struct {
+			Name     string
+			Query    string
+			Expected searchquery.PostFilter
+		}{
+			{
+				Name:     "Empty",
+				Query:    "",
+				Expected: searchquery.PostFilter{},
+			},
+			{
+				Name:  "DeletingBy",
+				Query: "deleting_by:2023-06-09",
+				Expected: searchquery.PostFilter{
+					DeletingBy: ptr.Ref(time.Date(
+						2023, 6, 9, 0, 0, 0, 0, time.UTC)),
+				},
+			},
+			{
+				Name:  "MultipleParams",
+				Query: "deleting_by:2023-06-09 name:workspace-name",
+				Expected: searchquery.PostFilter{
+					DeletingBy: ptr.Ref(time.Date(
+						2023, 6, 9, 0, 0, 0, 0, time.UTC)),
+				},
+			},
+		}
+
+		for _, c := range testCases {
+			c := c
+			t.Run(c.Name, func(t *testing.T) {
+				t.Parallel()
+				_, postFilter, errs := searchquery.Workspaces(c.Query, codersdk.Pagination{}, 0)
+				assert.Len(t, errs, 0, "expected no error")
+				assert.Equal(t, c.Expected, postFilter, "expected values")
+			})
+		}
+	})
 }
 
 func TestSearchAudit(t *testing.T) {