feat: support created_at filter for the GET /users endpoint

joobisb · joobisb · commit c0ff16314529 · 2024-11-23T00:30:40.000+05:30
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -5648,6 +5648,16 @@ func (q *FakeQuerier) GetUsers(_ context.Context, params database.GetUsersParams
 		users = usersFilteredByRole
 	}
 
+	if !params.CreatedAt.IsZero() {
+		usersFilteredByCreatedAt := make([]database.User, 0, len(users))
+		for i, user := range users {
+			if user.CreatedAt.Equal(params.CreatedAt) {
+				usersFilteredByCreatedAt = append(usersFilteredByCreatedAt, users[i])
+			}
+		}
+		users = usersFilteredByCreatedAt
+	}
+
 	if !params.LastSeenBefore.IsZero() {
 		usersFilteredByLastSeen := make([]database.User, 0, len(users))
 		for i, user := range users {
diff --git a/coderd/database/modelqueries.go b/coderd/database/modelqueries.go
@@ -390,6 +390,7 @@ func (q *sqlQuerier) GetAuthorizedUsers(ctx context.Context, arg GetUsersParams,
 		pq.Array(arg.RbacRole),
 		arg.LastSeenBefore,
 		arg.LastSeenAfter,
+		arg.CreatedAt,
 		arg.OffsetOpt,
 		arg.LimitOpt,
 	)
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/users.sql b/coderd/database/queries/users.sql
@@ -199,6 +199,12 @@ WHERE
 			last_seen_at >= @last_seen_after
 		ELSE true
 	END
+	-- Filter by created_at
+	AND CASE
+		WHEN @created_at :: timestamp with time zone != '0001-01-01 00:00:00Z' THEN
+			DATE(created_at) = DATE(@created_at)
+		ELSE true
+	END
 	-- End of filters
 
 	-- Authorize Filter clause will be injected below in GetAuthorizedUsers
diff --git a/coderd/searchquery/search.go b/coderd/searchquery/search.go
@@ -70,6 +70,7 @@ func Users(query string) (database.GetUsersParams, []codersdk.ValidationError) {
 		RbacRole:       parser.Strings(values, []string{}, "role"),
 		LastSeenAfter:  parser.Time3339Nano(values, time.Time{}, "last_seen_after"),
 		LastSeenBefore: parser.Time3339Nano(values, time.Time{}, "last_seen_before"),
+		CreatedAt:      parser.Time3339Nano(values, time.Time{}, "created_at"),
 	}
 	parser.ErrorExcessParams(values)
 	return filter, parser.Errors
diff --git a/coderd/users.go b/coderd/users.go
@@ -317,6 +317,7 @@ func (api *API) GetUsers(rw http.ResponseWriter, r *http.Request) ([]database.Us
 		RbacRole:       params.RbacRole,
 		LastSeenBefore: params.LastSeenBefore,
 		LastSeenAfter:  params.LastSeenAfter,
+		CreatedAt:      params.CreatedAt,
 		OffsetOpt:      int32(paginationParams.Offset),
 		LimitOpt:       int32(paginationParams.Limit),
 	})
diff --git a/coderd/users_test.go b/coderd/users_test.go
@@ -1467,6 +1467,7 @@ func TestUsersFilter(t *testing.T) {
 
 	firstUser, err := client.User(ctx, codersdk.Me)
 	require.NoError(t, err, "fetch me")
+	createdAt := firstUser.CreatedAt
 
 	// Noon on Jan 18 is the "now" for this test for last_seen timestamps.
 	// All these values are equal
@@ -1655,6 +1656,16 @@ func TestUsersFilter(t *testing.T) {
 				return u.LastSeenAt.Before(end) && u.LastSeenAt.After(start)
 			},
 		},
+		{
+			Name: "CreatedAt",
+			Filter: codersdk.UsersRequest{
+				SearchQuery: fmt.Sprintf(`created_at:%q`, createdAt.Format(time.RFC3339)),
+			},
+			FilterF: func(_ codersdk.UsersRequest, u codersdk.User) bool {
+				target := time.Date(2023, 1, 18, 12, 0, 0, 0, time.UTC)
+				return u.CreatedAt.Equal(target)
+			},
+		},
 	}
 
 	for _, c := range testCases {
diff --git a/docs/admin/users/index.md b/docs/admin/users/index.md
@@ -185,8 +185,9 @@ to use the Coder's filter query:
 
 - To find active users, use the filter `status:active`.
 - To find admin users, use the filter `role:admin`.
-- To find users have not been active since July 2023:
+- To find users who have not been active since July 2023:
   `status:active last_seen_before:"2023-07-01T00:00:00Z"`
+- To find users created at January 18, 2023: `created_at:"2023-01-18T00:00:00Z"`
 
 The following filters are supported:
 
@@ -195,6 +196,7 @@ The following filters are supported:
 - `role` - Represents the role of the user. You can refer to the
   [TemplateRole documentation](https://pkg.go.dev/github.com/coder/coder/v2/codersdk#TemplateRole)
   for a list of supported user roles.
-- `last_seen_before` and `last_seen_after` - The last time a used has used the
+- `last_seen_before` and `last_seen_after` - The last time a user has used the
   platform (e.g. logging in, any API requests, connecting to workspaces). Uses
   the RFC3339Nano format.
+- `created_at` - The time a user was created. Uses the RFC3339Nano format.

Original file line number	Diff line number	Diff line change
`@@ -390,6 +390,7 @@ func (q *sqlQuerier) GetAuthorizedUsers(ctx context.Context, arg GetUsersParams,`
`390`	`390`	`pq.Array(arg.RbacRole),`
`391`	`391`	`arg.LastSeenBefore,`
`392`	`392`	`arg.LastSeenAfter,`
	`393`	`+ arg.CreatedAt,`
`393`	`394`	`arg.OffsetOpt,`
`394`	`395`	`arg.LimitOpt,`
`395`	`396`	`)`
Original file line number	Diff line number	Diff line change
`@@ -70,6 +70,7 @@ func Users(query string) (database.GetUsersParams, []codersdk.ValidationError) {`
`70`	`70`	`RbacRole: parser.Strings(values, []string{}, "role"),`
`71`	`71`	`LastSeenAfter: parser.Time3339Nano(values, time.Time{}, "last_seen_after"),`
`72`	`72`	`LastSeenBefore: parser.Time3339Nano(values, time.Time{}, "last_seen_before"),`
	`73`	`+ CreatedAt: parser.Time3339Nano(values, time.Time{}, "created_at"),`
`73`	`74`	`}`
`74`	`75`	`parser.ErrorExcessParams(values)`
`75`	`76`	`return filter, parser.Errors`