Add pagination to bugsnag and generic api controller

src/main/java/org/opentripplanner/middleware/controllers/api/ApiController.java

@@ -9,6 +9,7 @@
 import org.eclipse.jetty.http.HttpStatus;
 import org.opentripplanner.middleware.auth.Auth0Connection;
 import org.opentripplanner.middleware.auth.Auth0UserProfile;
+import org.opentripplanner.middleware.controllers.response.ResponseList;
 import org.opentripplanner.middleware.models.Model;
 import org.opentripplanner.middleware.models.OtpUser;
 import org.opentripplanner.middleware.persistence.TypedPersistence;
@@ -119,7 +120,7 @@ protected void buildEndpoint(ApiEndpoint baseEndpoint) {
                     // Note: there exists a method withResponseAsCollection, but unlike what its name suggests,
                     // it does exactly the same as .withResponseType and does not generate a return type array.
                     // See issue https://github.com/manusant/spark-swagger/issues/12.
-                    .withResponseType(Array.newInstance(clazz, 0).getClass()),
+                    .withResponseType(ResponseList.class),
                 this::getMany, JsonUtils::toJson
             )
 
@@ -172,23 +173,26 @@ protected void buildEndpoint(ApiEndpoint baseEndpoint) {
      */
     // FIXME Maybe better if the user check (and filtering) was done in a pre hook?
     // FIXME Will require further granularity for admin
-    private List<T> getMany(Request req, Response res) {
-
+    private ResponseList<T> getMany(Request req, Response res) {
+        List<T> list;
+        int limit = Integer.parseInt(req.queryParamOrDefault("limit", "10"));
+        int page = Integer.parseInt(req.queryParamOrDefault("page", "0"));
         Auth0UserProfile requestingUser = getUserFromRequest(req);
         if (isUserAdmin(requestingUser)) {
             // If the user is admin, the context is presumed to be the admin dashboard, so we deliver all entities for
             // management or review without restriction.
-            return persistence.getAll();
+            list = persistence.getAll();
         } else if (persistence.clazz == OtpUser.class) {
             // If the required entity is of type 'OtpUser' the assumption is that a call is being made via the
             // OtpUserController. Therefore, the request should be limited to return just the entity matching the
             // requesting user.
-            return getObjectsFiltered("_id", requestingUser.otpUser.id);
+            list = getObjectsFiltered("_id", requestingUser.otpUser.id);
         } else {
             // For all other cases the assumption is that the request is being made by an Otp user and the requested
             // entities have a 'userId' parameter. Only entities that match the requesting user id are returned.
-            return getObjectsFiltered("userId", requestingUser.otpUser.id);
+            list = getObjectsFiltered("userId", requestingUser.otpUser.id);
         }
+        return new ResponseList<>(list, page, limit);
     }
 
     /**

src/main/java/org/opentripplanner/middleware/controllers/api/BugsnagController.java

@@ -5,6 +5,7 @@
 import com.mongodb.client.model.Filters;
 import org.bson.conversions.Bson;
 import org.opentripplanner.middleware.bugsnag.EventSummary;
+import org.opentripplanner.middleware.controllers.response.ResponseList;
 import org.opentripplanner.middleware.models.BugsnagEvent;
 import org.opentripplanner.middleware.models.BugsnagProject;
 import org.opentripplanner.middleware.persistence.Persistence;
@@ -15,7 +16,9 @@
 import spark.Response;
 
 import java.util.ArrayList;
+import java.util.Comparator;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import static com.beerboy.ss.descriptor.EndpointDescriptor.endpointPath;
 import static com.beerboy.ss.descriptor.MethodDescriptor.path;
@@ -56,17 +59,22 @@ public void bind(final SparkSwagger restApi) {
     /**
      * Get all Bugsnag events from Mongo and replace the project id with the project name and return
      */
-    private static List<EventSummary> getEventSummary(Request request, Response response) {
+    private static ResponseList<EventSummary> getEventSummary(Request req, Response res) {
         List<EventSummary> eventSummaries = new ArrayList<>();
         List<BugsnagEvent> events = bugsnagEvents.getAll();
+        int limit = Integer.parseInt(req.queryParamOrDefault("limit", "10"));
+        int page = Integer.parseInt(req.queryParamOrDefault("page", "0"));
 
         // FIXME: Group by error/project type?
         for (BugsnagEvent event : events) {
             Bson filter = Filters.eq("projectId", event.projectId);
             BugsnagProject project = bugsnagProjects.getOneFiltered(filter);
             eventSummaries.add(new EventSummary(project, event));
         }
-
-        return eventSummaries;
+        List<EventSummary> sorted = eventSummaries.stream()
+            .sorted(Comparator.comparing(eventSummary -> eventSummary.received))
+            .collect(Collectors.toList());
+        // For now return first 100 events. Otherwise, this list could grow to thousands of items and cause a request timeout.
+        return new ResponseList<>(sorted, page, limit);
     }
 }

src/main/java/org/opentripplanner/middleware/controllers/response/ResponseList.java

@@ -0,0 +1,29 @@
+package org.opentripplanner.middleware.controllers.response;
+
+import java.util.Date;
+import java.util.List;
+
+/**
+ * Generic class for wrapping a paginated list response for a 'get all' HTTP endpoint.
+ */
+public class ResponseList<T> {
+    public final List<T> data;
+    public final int page;
+    public final int limit;
+    public final int total;
+    public final Date timestamp;
+
+    /**
+     * Constructor for generating a paginated response list.
+     * @param data - list of entities to limit
+     * @param page - from index to abbreviate data
+     * @param limit - number of entities to include in list
+     */
+    public ResponseList(List<T> data, int page, int limit){
+        this.page = page;
+        this.limit = limit;
+        this.total = data.size();
+        this.data = data.subList(page * limit, Math.min(this.total, (page + 1) * limit));
+        this.timestamp = new Date();
+    }
+}

src/main/resources/latest-spark-swagger-output.yaml

@@ -72,7 +72,7 @@ paths:
         "200":
           description: "successful operation"
           schema:
-            $ref: "#/definitions/AdminUser[]"
+            $ref: "#/definitions/ResponseList"
     post:
       tags:
       - "api/admin/user"
@@ -237,7 +237,7 @@ paths:
         "200":
           description: "successful operation"
           schema:
-            $ref: "#/definitions/ApiUser[]"
+            $ref: "#/definitions/ResponseList"
     post:
       tags:
       - "api/secure/application"
@@ -330,7 +330,7 @@ paths:
         "200":
           description: "successful operation"
           schema:
-            $ref: "#/definitions/MonitoredTrip[]"
+            $ref: "#/definitions/ResponseList"
     post:
       tags:
       - "api/secure/monitoredtrip"
@@ -527,7 +527,7 @@ paths:
         "200":
           description: "successful operation"
           schema:
-            $ref: "#/definitions/OtpUser[]"
+            $ref: "#/definitions/ResponseList"
     post:
       tags:
       - "api/secure/user"
@@ -684,8 +684,25 @@ definitions:
         format: "date"
       id:
         type: "string"
-  AdminUser[]:
+  ResponseList:
     type: "object"
+    properties:
+      data:
+        type: "array"
+        items:
+          type: "string"
+      page:
+        type: "integer"
+        format: "int32"
+      limit:
+        type: "integer"
+        format: "int32"
+      total:
+        type: "integer"
+        format: "int32"
+      timestamp:
+        type: "string"
+        format: "date"
   ApiKey:
     type: "object"
     properties:
@@ -714,10 +731,6 @@ definitions:
         type: "boolean"
       name:
         type: "string"
-  ApiUser[]:
-    type: "object"
-  MonitoredTrip[]:
-    type: "object"
   EncodedPolyline:
     type: "object"
     properties:
@@ -1116,8 +1129,6 @@ definitions:
         type: "boolean"
       applicationId:
         type: "string"
-  OtpUser[]:
-    type: "object"
   GetUsageResult:
     type: "object"
     properties: