Add error handling for bad pagination RQs to avoid giant queries and errors

Author: jloux-brapi

src/main/java/org/brapi/test/BrAPITestServer/controller/germ/CrossesApiController.java

@@ -59,8 +59,8 @@ public ResponseEntity<CrossesListResponse> crossesGet(
 		validateSecurityContext(request, "ROLE_ANONYMOUS", "ROLE_USER");
 		validateAcceptHeader(request);
 		Metadata metadata = generateMetaDataTemplate(page, pageSize);
-		List<Cross> data = crossService.findCrosses(crossingProjectDbId, crossingProjectName, crossDbId, crossName,
-				commonCropName, programDbId, externalReferenceId, externalReferenceID, externalReferenceSource,
+		List<Cross> data = crossService.findCrosses(crossingProjectDbId, crossDbId,
+				externalReferenceID, externalReferenceSource,
 				metadata);
 		return responseOK(new CrossesListResponse(), new CrossesListResponseResult(), data, metadata);
 	}

src/main/java/org/brapi/test/BrAPITestServer/controller/germ/CrossingProjectsApiController.java

@@ -60,8 +60,8 @@ public ResponseEntity<CrossingProjectsListResponse> crossingProjectsGet(
 		validateAcceptHeader(request);
 		Metadata metadata = generateMetaDataTemplate(page, pageSize);
 		List<CrossingProject> data = crossingProjectService.findCrossingProjects(crossingProjectDbId,
-				crossingProjectName, includePotentialParents, commonCropName, programDbId, externalReferenceId,
-				externalReferenceID, externalReferenceSource, metadata);
+				crossingProjectName, includePotentialParents, commonCropName, programDbId,
+                externalReferenceID, externalReferenceSource, metadata);
 		return responseOK(new CrossingProjectsListResponse(), new CrossingProjectsListResponseResult(), data, metadata);
 	}
 

src/main/java/org/brapi/test/BrAPITestServer/controller/germ/PlannedCrossesApiController.java

@@ -60,8 +60,8 @@ public ResponseEntity<PlannedCrossesListResponse> plannedCrossesGet(
 		validateSecurityContext(request, "ROLE_ANONYMOUS", "ROLE_USER");
 		validateAcceptHeader(request);
 		Metadata metadata = generateMetaDataTemplate(page, pageSize);
-		List<PlannedCross> data = crossService.findPlannedCrosses(crossingProjectDbId, crossingProjectName,
-				plannedCrossDbId, plannedCrossName, status, commonCropName, programDbId, externalReferenceId,
+		List<PlannedCross> data = crossService.findPlannedCrosses(crossingProjectDbId,
+				plannedCrossDbId,
 				externalReferenceID, externalReferenceSource, metadata);
 		return responseOK(new PlannedCrossesListResponse(), new PlannedCrossesListResponseResult(), data, metadata);
 	}

src/main/java/org/brapi/test/BrAPITestServer/controller/germ/SeedLotsApiController.java

@@ -66,7 +66,7 @@ public ResponseEntity<SeedLotListResponse> seedlotsGet(
 		validateAcceptHeader(request);
 		Metadata metadata = generateMetaDataTemplate(page, pageSize);
 		List<SeedLot> data = seedLotService.findSeedLots(seedLotDbId, germplasmDbId, germplasmName, crossDbId,
-				crossName, commonCropName, programDbId, externalReferenceId, externalReferenceID,
+				crossName, commonCropName, programDbId, externalReferenceID,
 				externalReferenceSource, metadata);
 		return responseOK(new SeedLotListResponse(), new SeedLotListResponseResult(), data, metadata);
 	}
@@ -156,7 +156,7 @@ public ResponseEntity<SeedLotTransactionListResponse> seedlotsTransactionsGet(
 		validateAcceptHeader(request);
 		Metadata metadata = generateMetaDataTemplate(page, pageSize);
 		List<SeedLotTransaction> data = seedLotService.findSeedLotTransactions(transactionDbId, seedLotDbId,
-				germplasmDbId, germplasmName, crossDbId, crossName, commonCropName, programDbId, externalReferenceId,
+				germplasmDbId, germplasmName, crossDbId, crossName, commonCropName, programDbId,
 				externalReferenceID, externalReferenceSource, metadata);
 		return responseOK(new SeedLotTransactionListResponse(), new SeedLotTransactionListResponseResult(), data,
 				metadata);

src/main/java/org/brapi/test/BrAPITestServer/exceptions/InvalidPagingException.java

@@ -4,9 +4,18 @@
 
 public class InvalidPagingException extends BrAPIServerException {
 	private static final long serialVersionUID = 6250184179200451757L;
+
+	private static final String pageNumExceedsTotalPages =
+			"A page was requested which exceeds total amount of data available. Please make a RQ with page < totalPages - 1. " +
+					"Page numbers start at 0, and you can find out totalPages by making a RQ with \"page\": 0";
 
 	public InvalidPagingException(String field) {
 		super(HttpStatus.BAD_REQUEST, "\'" + field + "\' value is invalid");
 	}
+
+	// This constructor should only be used when the pageNum of the RQ exceeds the total number of pages available.
+	public InvalidPagingException() {
+		super(HttpStatus.BAD_REQUEST, pageNumExceedsTotalPages);
+	}
 
 }

src/main/java/org/brapi/test/BrAPITestServer/factory/BrAPIComponent.java

@@ -4,11 +4,12 @@
 import io.swagger.model.SearchRequest;
 import io.swagger.model.core.BatchDeleteTypes;
 import jakarta.validation.Valid;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 
 import java.util.List;
 
 public interface BrAPIComponent<T, R extends SearchRequest> {
-    List<T> findEntities(@Valid R request, Metadata metadata);
+    List<T> findEntities(@Valid R request, Metadata metadata) throws BrAPIServerException;
     BatchDeleteTypes getBatchDeleteType();
     List<String> collectDbIds(List<T> entities);
     void deleteBatchDeleteData(List<String> dbIds);

src/main/java/org/brapi/test/BrAPITestServer/factory/core/ListComponent.java

@@ -5,6 +5,7 @@
 import io.swagger.model.core.ListSearchRequest;
 import io.swagger.model.core.ListSummary;
 import jakarta.validation.Valid;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 import org.brapi.test.BrAPITestServer.factory.BrAPIComponent;
 import org.brapi.test.BrAPITestServer.service.core.ListService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -23,7 +24,8 @@ public ListComponent(ListService listService) {
     }
 
     @Override
-    public List<ListSummary> findEntities(@Valid ListSearchRequest request, Metadata metadata) {
+    public List<ListSummary> findEntities(@Valid ListSearchRequest request, Metadata metadata)
+        throws BrAPIServerException {
         return listService.findLists(request, metadata);
     }
 

src/main/java/org/brapi/test/BrAPITestServer/factory/core/TrialComponent.java

@@ -4,6 +4,7 @@
 import io.swagger.model.core.BatchDeleteTypes;
 import io.swagger.model.core.Trial;
 import io.swagger.model.core.TrialSearchRequest;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 import org.brapi.test.BrAPITestServer.factory.BrAPIComponent;
 import org.brapi.test.BrAPITestServer.service.core.TrialService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -22,7 +23,8 @@ public TrialComponent(TrialService trialService) {
     }
 
     @Override
-    public List<Trial> findEntities(TrialSearchRequest request, Metadata metadata) {
+    public List<Trial> findEntities(TrialSearchRequest request, Metadata metadata)
+        throws BrAPIServerException {
         return trialService.findTrials(request, metadata);
     }
 

src/main/java/org/brapi/test/BrAPITestServer/factory/geno/PlateComponent.java

@@ -5,6 +5,7 @@
 import io.swagger.model.geno.Plate;
 import io.swagger.model.geno.PlateSearchRequest;
 import org.apache.commons.lang3.NotImplementedException;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 import org.brapi.test.BrAPITestServer.factory.BrAPIComponent;
 import org.brapi.test.BrAPITestServer.service.geno.PlateService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -23,7 +24,8 @@ public PlateComponent(PlateService plateService) {
     }
 
     @Override
-    public List<Plate> findEntities(PlateSearchRequest request, Metadata metadata) {
+    public List<Plate> findEntities(PlateSearchRequest request, Metadata metadata)
+        throws BrAPIServerException  {
         return plateService.findPlates(request, metadata);
     }
 

src/main/java/org/brapi/test/BrAPITestServer/factory/geno/SampleComponent.java

@@ -4,6 +4,7 @@
 import io.swagger.model.core.BatchDeleteTypes;
 import io.swagger.model.geno.Sample;
 import io.swagger.model.geno.SampleSearchRequest;
+import org.brapi.test.BrAPITestServer.exceptions.BrAPIServerException;
 import org.brapi.test.BrAPITestServer.factory.BrAPIComponent;
 import org.brapi.test.BrAPITestServer.service.geno.SampleService;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -22,7 +23,8 @@ public SampleComponent(SampleService sampleService) {
     }
 
     @Override
-    public List<Sample> findEntities(SampleSearchRequest request, Metadata metadata) {
+    public List<Sample> findEntities(SampleSearchRequest request, Metadata metadata)
+        throws BrAPIServerException {
         return sampleService.findSamples(request, metadata);
     }