TD-34: Solved comments made by reviewer

api/api.yml

@@ -69,6 +69,32 @@ components:
           type: string
       required:
         - username
+    #############################################
+    #  GetAllPlayersConfigurationData                                   #
+    #############################################
+    GetAllPlayersConfigurationData:
+      description: Configuration data for query for the getting all players endpoint
+      type: object
+      properties:
+        page:
+          type: integer
+          default: 0
+          description: "Page number (zero-based index)."
+        pageSize:
+          type: integer
+          default: 10
+          description: "Number of players per page."
+        sortBy:
+          type: string
+          default: "username"
+          description: "Field to sort by (default is username)."
+        order:
+          type: string
+          enum: [ascending, descending]
+          description: "Sorting order (asc or desc)."
+        username:
+          type: string
+          description: "Filter players by username (case-insensitive, partial match)."
   responses:
     201PlayerCreated:
       description: "201 - Player Created"
@@ -164,42 +190,11 @@ paths:
       operationId: "GetAllPlayers"
       summary: "Retrieve a paginated list of players"
       description: "Returns a paginated list of players, optionally filtered by username."
-      parameters:
+      requestBody:
-        - name: page
+        content:
-          in: query
+          application/json:
-          description: "Page number (zero-based index)."
+            schema:
-          required: false
+              $ref: "#/components/schemas/GetAllPlayersConfigurationData"
-          schema:
-            type: integer
-            default: 0
-        - name: pageSize
-          in: query
-          description: "Number of players per page."
-          required: false
-          schema:
-            type: integer
-            default: 10
-        - name: sortBy
-          in: query
-          description: "Field to sort by (default is username)."
-          required: false
-          schema:
-            type: string
-            default: "username"
-        - name: order
-          in: query
-          description: "Sorting order (asc or desc)."
-          required: false
-          schema:
-            type: string
-            enum: [asc, desc]
-            default: "asc"
-        - name: username
-          in: query
-          description: "Filter players by username (case-insensitive, partial match)."
-          required: false
-          schema:
-            type: string
       tags:
         - admin
       responses:

src/main/java/de/towerdefence/server/admin/AdminApiController.java

@@ -4,6 +4,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
 import de.towerdefence.server.auth.UserSession;
 import de.towerdefence.server.oas.AdminApi;
 import de.towerdefence.server.oas.models.AdminAuthInfo;
+import de.towerdefence.server.oas.models.GetAllPlayersConfigurationData;
 import de.towerdefence.server.oas.models.PlayerApiModel;
 import de.towerdefence.server.player.Player;
 import de.towerdefence.server.player.PlayerRepository;
@@ -53,15 +54,27 @@ public class AdminApiController implements AdminApi {
     }
 
     @Override
-    public ResponseEntity<List<PlayerApiModel>> getAllPlayers(Integer page, Integer pageSize, String sortBy,
+    public ResponseEntity<List<PlayerApiModel>> getAllPlayers(GetAllPlayersConfigurationData body) {
-                                                              String order, String username) {
 
-        Sort.Direction direction = order.equalsIgnoreCase("asc") ? Sort.Direction.ASC : Sort.Direction.DESC;
+        var order = body.getOrder();
+        var page = body.getPage();
+        var pageSize = body.getPageSize();
+        var sortBy = body.getSortBy();
+        var username = body.getUsername();
+
+        if (order == null) {
+            order = GetAllPlayersConfigurationData.OrderEnum.DESCENDING;
+        }
+        Sort.Direction direction = order == GetAllPlayersConfigurationData.OrderEnum.ASCENDING ? Sort.Direction.ASC : Sort.Direction.DESC;
         Pageable pageable = PageRequest.of(page, pageSize, Sort.by(direction, sortBy));
 
-        Page<Player> playerPage = (username != null && !username.trim().isEmpty())
+        Page<Player> playerPage;
-                ? playerRepository.findByUsernameContainingIgnoreCase(username, pageable)
+
-                : playerRepository.findAll(pageable);
+        if (username != null && !username.trim().isEmpty()) {
+            playerPage = playerRepository.findByUsernameContainingIgnoreCase(username, pageable);
+        } else {
+            playerPage = playerRepository.findAll(pageable);
+        }
 
         List<PlayerApiModel> playersMapped = playerMapperService.mapPlayerToApiPlayers(playerPage.getContent());
 

src/test/java/de/towerdefence/server/server/GetAllPlayersPaginatedAndSortedTest.java

@@ -4,21 +4,30 @@ import de.towerdefence.server.IntegrationTest;
 import org.junit.jupiter.api.Test;
 import org.springframework.http.MediaType;
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
 
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
 
 class GetAllPlayersPaginatedAndSortedTest extends IntegrationTest {
 
+    private MockHttpServletRequestBuilder createGetAllPlayersRequest(String requestBody) {
+        return MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(requestBody);
+    }
+
     @Test
     void playersExist() throws Exception {
-        //Testing if list ist being returned successfully
+        String requestBody = "{" +
-        this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                "\"page\": 0," +
-                        .param("page", "0")
+                "\"pageSize\": 10," +
-                        .param("pageSize", "10")
+                "\"sortBy\": \"username\"," +
-                        .param("sortBy", "username")
+                "\"order\": \"descending\"," +
-                        .param("order", "desc")
+                "\"username\": \"\"" +
-                        .contentType(MediaType.APPLICATION_JSON))
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
                 .andExpect(status().isOk())
                 .andExpect(jsonPath("$").isArray())
                 .andExpect(jsonPath("$[0]").exists());
@@ -26,29 +35,31 @@ class GetAllPlayersPaginatedAndSortedTest extends IntegrationTest {
 
     @Test
     void playersSortedByAsc() throws Exception {
-        //Test list ist being sorted correctly
+        String requestBody = "{" +
-        this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                "\"page\": 0," +
-                        .param("page", "0")
+                "\"pageSize\": 10," +
-                        .param("pageSize", "10")
+                "\"sortBy\": \"username\"," +
-                        .param("sortBy", "username")
+                "\"order\": \"ascending\"," +
-                        .param("order", "asc")
+                "\"username\": \"\"" +
-                        .contentType(MediaType.APPLICATION_JSON))
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
                 .andExpect(status().isOk())
                 .andExpect(jsonPath("$[0].username").value("Alex"))
                 .andExpect(jsonPath("$[1].username").value("Zorro"));
-
-
     }
 
     @Test
     void playersSortedByDesc() throws Exception {
-        //Test list ist being sorted correctly
+        String requestBody = "{" +
-        this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                "\"page\": 0," +
-                        .param("page", "0")
+                "\"pageSize\": 10," +
-                        .param("pageSize", "10")
+                "\"sortBy\": \"username\"," +
-                        .param("sortBy", "username")
+                "\"order\": \"descending\"," +
-                        .param("order", "desc")
+                "\"username\": \"\"" +
-                        .contentType(MediaType.APPLICATION_JSON))
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
                 .andExpect(status().isOk())
                 .andExpect(jsonPath("$[1].username").value("Alex"))
                 .andExpect(jsonPath("$[0].username").value("Zorro"));
@@ -56,15 +67,17 @@ class GetAllPlayersPaginatedAndSortedTest extends IntegrationTest {
 
     @Test
     void playersFiltered() throws Exception {
-        //testing if specific username that is being filtered by is in the result list
+        String requestBody = "{" +
-        this.mvc.perform(MockMvcRequestBuilders.get(baseUri + "/admin/players")
+                "\"page\": 0," +
-                        .param("page", "0")
+                "\"pageSize\": 10," +
-                        .param("pageSize", "10")
+                "\"username\": \"Alex\","+
-                        .param("username", "Alex")
+                "\"order\": \"ascending\""+
-                        .contentType(MediaType.APPLICATION_JSON))
+                "}";
+
+        this.mvc.perform(createGetAllPlayersRequest(requestBody))
                 .andExpect(status().isOk())
                 .andExpect(jsonPath("$").isArray())
                 .andExpect(jsonPath("$[0].username").value("Alex"))
                 .andExpect(jsonPath("$").isNotEmpty());
     }
-}
+}