Support snapshot pagination

[jamessalvatore]

Description

Support limit and offset query parameters in the getFlagSnapshots API.

Motivation and Context

This change allows flag snapshots to be retrieved from the API using pagination, so you don't have to fetch all snapshots at once which can be slow for flags with many snapshots.

How Has This Been Tested?

Tested locally that the API is backwards compatible, such that it retrieves all snapshots when the query parameters are omitted:

curl http://localhost:18000/api/v1/flags/1/snapshots

[
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": false,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:51.882-04:00",
      "variants": []
    },
    "id": 3,
    "updatedAt": "2023-10-04T20:55:51Z"
  },
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": true,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:43.463-04:00",
      "variants": []
    },
    "id": 2,
    "updatedAt": "2023-10-04T20:55:43Z"
  },
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": false,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:38.469-04:00",
      "variants": []
    },
    "id": 1,
    "updatedAt": "2023-10-04T20:55:38Z"
  }
]

Tested locally that the new parameters worked:

curl http://localhost:18000/api/v1/flags/1/snapshots\?limit\=1

[
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": false,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:51.882-04:00",
      "variants": []
    },
    "id": 3,
    "updatedAt": "2023-10-04T20:55:51Z"
  }
]

curl http://localhost:18000/api/v1/flags/1/snapshots\?limit\=2\&offset\=1

[
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": true,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:43.463-04:00",
      "variants": []
    },
    "id": 2,
    "updatedAt": "2023-10-04T20:55:43Z"
  },
  {
    "flag": {
      "dataRecordsEnabled": false,
      "description": "test",
      "enabled": false,
      "id": 1,
      "key": "kgemgm1zhty1431sp",
      "segments": [],
      "tags": [],
      "updatedAt": "2023-10-04T16:55:38.469-04:00",
      "variants": []
    },
    "id": 1,
    "updatedAt": "2023-10-04T20:55:38Z"
  }
]

Additionally, unit tests were added for the new functionality.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[ghost]

👇 Click on the image for a new way to code review

Legend

[marceloboeira]

Thank you @jamessalvatore for the contribution!

[jamessalvatore]

Hi @marceloboeira , thank you for merging this! When would it be possible to create a new release that includes this change?

[marceloboeira]

Let me check and get back to you. In theory, if you use the latest docker image (or the commit reference) you could already use it.