Update runs get to use cursor-based pagination (#273)

* Use cursor-based pagination when getting runs from the API server Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Remove includeCursor query parameter Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Swap cursor condition order Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Turn on includeCursor parameter Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Remove log statement Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> * Use 'from:desc' as the default sort for runs get Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> --------- Signed-off-by: Eamonn Mansour <47121388+eamansour@users.noreply.github.com> Signed-off-by: Aashir Siddiqui <aashir_sidiki@hotmail.com>
galasa-dev · Sep 18, 2024 · 364a909 · 364a909
1 parent 967d8c8
commit 364a909
Show file tree

Hide file tree

Showing 3 changed files with 163 additions and 130 deletions.
diff --git a/pkg/runs/runsDownload_test.go b/pkg/runs/runsDownload_test.go
@@ -12,7 +12,6 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"os"
-	"strconv"
 	"strings"
 	"testing"
 	"time"
@@ -237,10 +236,7 @@ func WriteMockRasRunsResponse(
 	writer.Header().Set("Content-Type", "application/json")
 
 	values := req.URL.Query()
-	pageRequestedStr := values.Get("page")
 	runNameQueryParameter := values.Get("runname")
-	pageRequested, _ := strconv.Atoi(pageRequestedStr)
-	assert.Equal(t, pageRequested, 1)
 
 	assert.Equal(t, runNameQueryParameter, runName)
 
@@ -254,9 +250,7 @@ func WriteMockRasRunsResponse(
 
 	writer.Write([]byte(fmt.Sprintf(`
 	{
-		"pageNumber": 1,
 		"pageSize": 1,
-		"numPages": 1,
 		"amountOfRuns": %d,
 		"runs":[ %s ]
 	}`, len(runResultStrings), combinedRunResultStrings)))

diff --git a/pkg/runs/runsGet.go b/pkg/runs/runsGet.go
@@ -222,6 +222,7 @@ func GetRunsFromRestApi(
 	var pageNumberWanted int32 = 1
 	gotAllResults := false
 	var restApiVersion string
+	var pageCursor string
 
 	restApiVersion, err = embedded.GetGalasactlRestApiVersion()
 
@@ -232,7 +233,7 @@ func GetRunsFromRestApi(
 			var runData *galasaapi.RunResults
 			var httpResponse *http.Response
 			log.Printf("Requesting page '%d' ", pageNumberWanted)
-			apicall := apiClient.ResultArchiveStoreAPIApi.GetRasSearchRuns(context).ClientApiVersion(restApiVersion)
+			apicall := apiClient.ResultArchiveStoreAPIApi.GetRasSearchRuns(context).ClientApiVersion(restApiVersion).IncludeCursor("true")
 			if fromAgeMins != 0 {
 				apicall = apicall.From(fromTime)
 			}
@@ -251,8 +252,10 @@ func GetRunsFromRestApi(
 			if shouldGetActive {
 				apicall = apicall.Status(activeStatusNames)
 			}
-			apicall = apicall.Page(pageNumberWanted)
-			apicall = apicall.Sort("to:desc")
+			if pageCursor != "" {
+				apicall = apicall.Cursor(pageCursor)
+			}
+			apicall = apicall.Sort("from:desc")
 			runData, httpResponse, err = apicall.Execute()
 
 			if err != nil {
@@ -271,9 +274,10 @@ func GetRunsFromRestApi(
 					results = append(results, runsOnThisPage...)
 
 					// Have we processed the last page ?
-					if pageNumberWanted == runData.GetNumPages() {
+					if !runData.HasNextCursor() || len(runsOnThisPage) < int(runData.GetPageSize()) {
 						gotAllResults = true
 					} else {
+						pageCursor = runData.GetNextCursor()
 						pageNumberWanted++
 					}
 				}