PR feedback

coder · Kira-Pilot · Jun 12, 2023 · Jun 1, 2023 · Jun 2, 2023 · Jun 5, 2023
commit 96971202280684097320a73b98ca28dd9913f3f6
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/searchquery/search.go b/coderd/searchquery/search.go
@@ -79,9 +79,7 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 		Limit:  int32(page.Limit),
 	}
 
-	postFilter := PostFilter{
-		DeletingBy: nil,
-	}
+	var postFilter PostFilter
 
 	if query == "" {
 		return filter, postFilter, nil
@@ -115,8 +113,7 @@ func Workspaces(query string, page codersdk.Pagination, agentInactiveDisconnectT
 	filter.HasAgent = parser.String(values, "", "has-agent")
 
 	if _, ok := values["deleting_by"]; ok {
-		db := parser.Time(values, time.Time{}, "deleting_by", "2006-01-02")
-		postFilter.DeletingBy = ptr.Ref(db)
+		postFilter.DeletingBy = ptr.Ref(parser.Time(values, time.Time{}, "deleting_by", "2006-01-02"))
 	}
 
 	parser.ErrorExcessParams(values)

diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -106,7 +106,7 @@ func (api *API) workspace(rw http.ResponseWriter, r *http.Request) {
 // @Param name query string false "Filter with partial-match by workspace name"
 // @Param status query string false "Filter by workspace status" Enums(pending,running,stopping,stopped,failed,canceling,canceled,deleted,deleting)
 // @Param has_agent query string false "Filter by agent status" Enums(connected,connecting,disconnected,timeout)
-// @Param deleting_by query string false "Filter by DeletingAt time"
+// @Param deleting_by query string false "Filter workspaces scheduled to be deleted by this time"
 // @Success 200 {object} codersdk.WorkspacesResponse
 // @Router /workspaces [get]
 func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {
@@ -189,10 +189,11 @@ func (api *API) workspaces(rw http.ResponseWriter, r *http.Request) {
 				continue
 			}
 			// get the beginning of the day on which deletion is scheduled
-			truncatedDeletionAt := v.DeletingAt.Truncate(24 * time.Hour)
-			if v.DeletingAt != nil && (truncatedDeletionAt.Before(*postFilter.DeletingBy) || truncatedDeletionAt.Equal(*postFilter.DeletingBy)) {
-				filteredWorkspaces = append(filteredWorkspaces, v)
+			truncatedDeletionAt := time.Date(v.DeletingAt.Year(), v.DeletingAt.Month(), v.DeletingAt.Day(), 0, 0, 0, 0, v.DeletingAt.Location())
+			if truncatedDeletionAt.After(*postFilter.DeletingBy) {
+				continue
 			}
+			filteredWorkspaces = append(filteredWorkspaces, v)
 		}
 	}
 

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1019,7 +1019,7 @@ func TestWorkspaceFilterManual(t *testing.T) {
 			TemplateScheduleStore: schedule.MockTemplateScheduleStore{
 				SetFn: func(ctx context.Context, db database.Store, template database.Template, options schedule.TemplateScheduleOptions) (database.Template, error) {
 					if atomic.AddInt64(&setCalled, 1) == 2 {
-						require.Equal(t, inactivityTTL, options.InactivityTTL)
+						assert.Equal(t, inactivityTTL, options.InactivityTTL)
 					}
 					template.InactivityTTL = int64(options.InactivityTTL)
 					return template, nil
@@ -1044,8 +1044,8 @@ func TestWorkspaceFilterManual(t *testing.T) {
 			InactivityTTLMillis: inactivityTTL.Milliseconds(),
 		})
 
-		require.NoError(t, err)
-		require.Equal(t, inactivityTTL.Milliseconds(), template.InactivityTTLMillis)
+		assert.NoError(t, err)
+		assert.Equal(t, inactivityTTL.Milliseconds(), template.InactivityTTLMillis)
 
 		workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
 		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
@@ -1058,9 +1058,9 @@ func TestWorkspaceFilterManual(t *testing.T) {
 			FilterQuery: fmt.Sprintf("deleting_by:%s", time.Now().Add(inactivityTTL).Format("2006-01-02")),
 		})
 
-		require.NoError(t, err)
-		require.Len(t, res.Workspaces, 1)
-		require.Equal(t, workspace.ID, res.Workspaces[0].ID)
+		assert.NoError(t, err)
+		assert.Len(t, res.Workspaces, 1)
+		assert.Equal(t, workspace.ID, res.Workspaces[0].ID)
 	})
 }
 

diff --git a/docs/api/workspaces.md b/docs/api/workspaces.md
@@ -381,14 +381,14 @@ curl -X GET http://coder-server:8080/api/v2/workspaces \
 
 ### Parameters
 
-| Name          | In    | Type   | Required | Description                                 |
-| ------------- | ----- | ------ | -------- | ------------------------------------------- |
-| `owner`       | query | string | false    | Filter by owner username                    |
-| `template`    | query | string | false    | Filter by template name                     |
-| `name`        | query | string | false    | Filter with partial-match by workspace name |
-| `status`      | query | string | false    | Filter by workspace status                  |
-| `has_agent`   | query | string | false    | Filter by agent status                      |
-| `deleting_by` | query | string | false    | Filter by DeletingAt time                   |
+| Name          | In    | Type   | Required | Description                                            |
+| ------------- | ----- | ------ | -------- | ------------------------------------------------------ |
+| `owner`       | query | string | false    | Filter by owner username                               |
+| `template`    | query | string | false    | Filter by template name                                |
+| `name`        | query | string | false    | Filter with partial-match by workspace name            |
+| `status`      | query | string | false    | Filter by workspace status                             |
+| `has_agent`   | query | string | false    | Filter by agent status                                 |
+| `deleting_by` | query | string | false    | Filter workspaces scheduled to be deleted by this time |
 
 #### Enumerated Values