handlers/session_recordings: add pagination support

hashicorp · Dec 18, 2023 · 6260815 · 6260815
1 parent 91e4578
commit 6260815
Show file tree

Hide file tree

Showing 5 changed files with 277 additions and 102 deletions.
diff --git a/internal/daemon/controller/handler.go b/internal/daemon/controller/handler.go
@@ -209,6 +209,7 @@ func (c *Controller) registerGrpcServices(s *grpc.Server) error {
 			c.IamRepoFn,
 			c.workerStatusGracePeriod,
 			c.kms,
+			c.conf.RawConfig.Controller.MaxPageSize,
 			c.ControllerExtension)
 		if err != nil {
 			return fmt.Errorf("failed to create session recording handler service: %w", err)

diff --git a/internal/daemon/controller/handlers/session_recordings/session_recording_service.go b/internal/daemon/controller/handlers/session_recordings/session_recording_service.go
@@ -43,6 +43,7 @@ var NewServiceFn = func(ctx context.Context,
 	iamRepoFn common.IamRepoFactory,
 	workerStatusGracePeriod *atomic.Int64,
 	kms *kms.Kms,
+	maxPageSize uint,
 	controllerExt intglobals.ControllerExtension,
 ) (pbs.SessionRecordingServiceServer, error) {
 	return Service{}, nil

diff --git a/internal/gen/controller.swagger.json b/internal/gen/controller.swagger.json
@@ -2881,6 +2881,21 @@
             "in": "query",
             "required": false,
             "type": "boolean"
+          },
+          {
+            "name": "list_token",
+            "description": "An opaque token used to continue an existing iteration or\nrequest updated items. If not specified, pagination\nwill start from the beginning.",
+            "in": "query",
+            "required": false,
+            "type": "string"
+          },
+          {
+            "name": "page_size",
+            "description": "The maximum size of a page in this iteration.\nIf unset, the default page size configured will be used.\nIf the page_size is greater than the max page size configured,\nthe page size will be truncated to this number.",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "format": "int64"
           }
         ],
         "tags": [
@@ -7895,7 +7910,35 @@
             "type": "object",
             "$ref": "#/definitions/controller.api.resources.sessionrecordings.v1.SessionRecording"
           },
-          "description": "All Session recordings, ordered by start_time descending (most recently started first)."
+          "description": "The items returned in this page."
+        },
+        "response_type": {
+          "type": "string",
+          "description": "The type of response, either \"delta\" or \"complete\".\nDelta signifies that this is part of a paginated result\nor an update to a previously completed pagination.\nComplete signifies that it is the last page."
+        },
+        "list_token": {
+          "type": "string",
+          "description": "An opaque token used to continue an existing pagination or\nrequest updated items. Use this token in the next list request\nto request the next page."
+        },
+        "sort_by": {
+          "type": "string",
+          "description": "The name of the field which the items are sorted by."
+        },
+        "sort_dir": {
+          "type": "string",
+          "description": "The direction of the sort, either \"asc\" or \"desc\"."
+        },
+        "removed_ids": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "A list of item IDs that have been removed since they were returned\nas part of a pagination. They should be dropped from any client cache.\nThis may contain items that are not known to the cache, if they were\ncreated and deleted between listings."
+        },
+        "est_item_count": {
+          "type": "integer",
+          "format": "int64",
+          "description": "An estimate at the total items available. This may change during pagination."
         }
       }
     },