feat: add filter by status on GET /users (#1206)

coderd/database/databasefake/databasefake.go

@@ -212,6 +212,16 @@ func (q *fakeQuerier) GetUsers(_ context.Context, params database.GetUsersParams
 		users = tmp
 	}
 
+	if params.Status != "" {
+		usersFilteredByStatus := make([]database.User, 0, len(users))
+		for i, user := range users {
+			if params.Status == string(user.Status) {
+				usersFilteredByStatus = append(usersFilteredByStatus, users[i])
+			}
+		}
+		users = usersFilteredByStatus
+	}
+
 	if params.OffsetOpt > 0 {
 		if int(params.OffsetOpt) > len(users)-1 {
 			return []database.User{}, nil
@@ -225,6 +235,7 @@ func (q *fakeQuerier) GetUsers(_ context.Context, params database.GetUsersParams
 		}
 		users = users[:params.LimitOpt]
 	}
+
 	tmp := make([]database.User, len(users))
 	copy(tmp, users)
 

coderd/database/queries.sql.go

@@ -1919,25 +1919,38 @@ WHERE
 			)
 			ELSE true
 	END
+	-- Start filters
+	-- Filter by name, email or username
 	AND CASE
 		WHEN $2 :: text != '' THEN (
 			email LIKE concat('%', $2, '%')
 			OR username LIKE concat('%', $2, '%')
+		)	
+		ELSE true
+	END
+	-- Filter by status
+	AND CASE
+		-- @status needs to be a text because it can be empty, If it was
+		-- user_status enum, it would not.
+		WHEN $3 :: text != '' THEN (
+			status = $3 :: user_status
 		)
 		ELSE true
 	END
+	-- End of filters
 ORDER BY
     -- Deterministic and consistent ordering of all users, even if they share
     -- a timestamp. This is to ensure consistent pagination.
-	(created_at, id) ASC OFFSET $3
+	(created_at, id) ASC OFFSET $4
 LIMIT
 	-- A null limit means "no limit", so -1 means return all
-	NULLIF($4 :: int, -1)
+	NULLIF($5 :: int, -1)
 `
 
 type GetUsersParams struct {
 	AfterUser uuid.UUID `db:"after_user" json:"after_user"`
 	Search    string    `db:"search" json:"search"`
+	Status    string    `db:"status" json:"status"`
 	OffsetOpt int32     `db:"offset_opt" json:"offset_opt"`
 	LimitOpt  int32     `db:"limit_opt" json:"limit_opt"`
 }
@@ -1946,6 +1959,7 @@ func (q *sqlQuerier) GetUsers(ctx context.Context, arg GetUsersParams) ([]User,
 	rows, err := q.db.QueryContext(ctx, getUsers,
 		arg.AfterUser,
 		arg.Search,
+		arg.Status,
 		arg.OffsetOpt,
 		arg.LimitOpt,
 	)

coderd/database/queries/users.sql

@@ -76,13 +76,25 @@ WHERE
 			)
 			ELSE true
 	END
+	-- Start filters
+	-- Filter by name, email or username
 	AND CASE
 		WHEN @search :: text != '' THEN (
 			email LIKE concat('%', @search, '%')
 			OR username LIKE concat('%', @search, '%')
+		)	
+		ELSE true
+	END
+	-- Filter by status
+	AND CASE
+		-- @status needs to be a text because it can be empty, If it was
+		-- user_status enum, it would not.
+		WHEN @status :: text != '' THEN (
+			status = @status :: user_status
 		)
 		ELSE true
 	END
+	-- End of filters
 ORDER BY
     -- Deterministic and consistent ordering of all users, even if they share
     -- a timestamp. This is to ensure consistent pagination.

coderd/users.go

@@ -90,10 +90,11 @@ func (api *api) postFirstUser(rw http.ResponseWriter, r *http.Request) {
 
 func (api *api) users(rw http.ResponseWriter, r *http.Request) {
 	var (
-		afterArg   = r.URL.Query().Get("after_user")
-		limitArg   = r.URL.Query().Get("limit")
-		offsetArg  = r.URL.Query().Get("offset")
-		searchName = r.URL.Query().Get("search")
+		afterArg     = r.URL.Query().Get("after_user")
+		limitArg     = r.URL.Query().Get("limit")
+		offsetArg    = r.URL.Query().Get("offset")
+		searchName   = r.URL.Query().Get("search")
+		statusFilter = r.URL.Query().Get("status")
 	)
 
 	// createdAfter is a user uuid.
@@ -136,6 +137,7 @@ func (api *api) users(rw http.ResponseWriter, r *http.Request) {
 		OffsetOpt: int32(offset),
 		LimitOpt:  int32(pageLimit),
 		Search:    searchName,
+		Status:    statusFilter,
 	})
 	if err != nil {
 		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{

coderd/users_test.go

@@ -330,19 +330,54 @@ func TestUserByName(t *testing.T) {
 
 func TestGetUsers(t *testing.T) {
 	t.Parallel()
-	client := coderdtest.New(t, nil)
-	user := coderdtest.CreateFirstUser(t, client)
-	client.CreateUser(context.Background(), codersdk.CreateUserRequest{
-		Email:          "alice@email.com",
-		Username:       "alice",
-		Password:       "password",
-		OrganizationID: user.OrganizationID,
+	t.Run("AllUsers", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		user := coderdtest.CreateFirstUser(t, client)
+		client.CreateUser(context.Background(), codersdk.CreateUserRequest{
+			Email:          "alice@email.com",
+			Username:       "alice",
+			Password:       "password",
+			OrganizationID: user.OrganizationID,
+		})
+		// No params is all users
+		users, err := client.Users(context.Background(), codersdk.UsersRequest{})
+		require.NoError(t, err)
+		require.Len(t, users, 2)
+		require.Len(t, users[0].OrganizationIDs, 1)
+	})
+	t.Run("ActiveUsers", func(t *testing.T) {
+		t.Parallel()
+		client := coderdtest.New(t, nil)
+		first := coderdtest.CreateFirstUser(t, client)
+		active := make([]codersdk.User, 0)
+		alice, err := client.CreateUser(context.Background(), codersdk.CreateUserRequest{
+			Email:          "alice@email.com",
+			Username:       "alice",
+			Password:       "password",
+			OrganizationID: first.OrganizationID,
+		})
+		require.NoError(t, err)
+		active = append(active, alice)
+
+		bruno, err := client.CreateUser(context.Background(), codersdk.CreateUserRequest{
+			Email:          "bruno@email.com",
+			Username:       "bruno",
+			Password:       "password",
+			OrganizationID: first.OrganizationID,
+		})
+		require.NoError(t, err)
+		active = append(active, bruno)
+
+		_, err = client.SuspendUser(context.Background(), first.UserID)
+		require.NoError(t, err)
+
+		users, err := client.Users(context.Background(), codersdk.UsersRequest{
+			Status: string(codersdk.UserStatusActive),
+		})
+		require.NoError(t, err)
+		require.ElementsMatch(t, active, users)
 	})
-	// No params is all users
-	users, err := client.Users(context.Background(), codersdk.UsersRequest{})
-	require.NoError(t, err)
-	require.Len(t, users, 2)
-	require.Len(t, users[0].OrganizationIDs, 1)
 }
 
 func TestOrganizationsByUser(t *testing.T) {