feat: add filter by status on GET /users

BrunoQuaresma · BrunoQuaresma · commit 08fa3a7c530a · 2022-04-28T13:17:27.000Z
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -225,6 +225,17 @@ func (q *fakeQuerier) GetUsers(_ context.Context, params database.GetUsersParams
 		}
 		users = users[:params.LimitOpt]
 	}
+
+	if params.Status != "" {
+		usersFilteredByStatus := make([]database.User, 0, len(users))
+		for i, user := range users {
+			if user.Status == params.Status {
+				usersFilteredByStatus = append(usersFilteredByStatus, users[i])
+			}
+		}
+		users = usersFilteredByStatus
+	}
+
 	tmp := make([]database.User, len(users))
 	copy(tmp, users)
 
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
@@ -80,6 +80,9 @@ WHERE
 		WHEN @search :: text != '' THEN (
 			email LIKE concat('%', @search, '%')
 			OR username LIKE concat('%', @search, '%')
+		)	
+		WHEN @status :: user_status != '' THEN (
+			status = @status
 		)
 		ELSE true
 	END
diff --git a/coderd/users.go b/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:    database.UserStatus(statusFilter),
 	})
 
 	if err != nil {
diff --git a/coderd/users_test.go b/coderd/users_test.go
@@ -328,18 +328,44 @@ 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)
+	})
+	t.Run("ActiveUsers", 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,
+		})
+		suspendedUser, _ := client.CreateUser(context.Background(), codersdk.CreateUserRequest{
+			Email:          "bruno@email.com",
+			Username:       "bruno",
+			Password:       "password",
+			OrganizationID: user.OrganizationID,
+		})
+		client.SuspendUser(context.Background(), suspendedUser.ID)
+		users, err := client.Users(context.Background(), codersdk.UsersRequest{
+			Status: string(codersdk.UserStatusSuspended),
+		})
+		require.NoError(t, err)
+		require.Len(t, users, 2)
 	})
-	// No params is all users
-	users, err := client.Users(context.Background(), codersdk.UsersRequest{})
-	require.NoError(t, err)
-	require.Len(t, users, 2)
 }
 
 func TestOrganizationsByUser(t *testing.T) {
diff --git a/codersdk/users.go b/codersdk/users.go
@@ -14,6 +14,13 @@ import (
 // Me is used as a replacement for your own ID.
 var Me = uuid.Nil
 
+type UserStatus string
+
+const (
+	UserStatusActive    UserStatus = "active"
+	UserStatusSuspended UserStatus = "suspended"
+)
+
 type UsersRequest struct {
 	AfterUser uuid.UUID `json:"after_user"`
 	Search    string    `json:"search"`
@@ -26,15 +33,10 @@ type UsersRequest struct {
 	// To get the next page, use offset=<limit>*<page_number>.
 	// Offset is 0 indexed, so the first record sits at offset 0.
 	Offset int `json:"offset"`
+	// Filter users by status
+	Status string `json:"status"`
 }
 
-type UserStatus string
-
-const (
-	UserStatusActive    UserStatus = "active"
-	UserStatusSuspended UserStatus = "suspended"
-)
-
 // User represents a user in Coder.
 type User struct {
 	ID        uuid.UUID  `json:"id" validate:"required"`
@@ -242,6 +244,7 @@ func (c *Client) Users(ctx context.Context, req UsersRequest) ([]User, error) {
 		}
 		q.Set("offset", strconv.Itoa(req.Offset))
 		q.Set("search", req.Search)
+		q.Set("status", req.Status)
 		r.URL.RawQuery = q.Encode()
 	})
 	if err != nil {
