Updating docs and interation exit condition to not check the final page

geramirez · web-flow · commit 34f9c0a67c20 · 2021-10-06T14:18:44.000Z
diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go
@@ -194,16 +194,18 @@ type getCodespacesListResponse struct {
 }
 
 // ListCodespaces returns a list of codespaces for the user.
+// It consumes all pages returned by the API until all codespaces have been fetched.
 func (a *API) ListCodespaces(ctx context.Context) (codespaces []*Codespace, err error) {
+	per_page := 50
 	for page := 1; ; page++ {
 		response, err := a.fetchCodespaces(ctx, page)
 		if err != nil {
 			return nil, fmt.Errorf("%w", err)
 		}
-		if len(codespaces) >= response.TotalCount || len(response.Codespaces) == 0 {
+		codespaces = append(codespaces, response.Codespaces...)
+		if page*per_page >= response.TotalCount {
 			break
 		}
-		codespaces = append(codespaces, response.Codespaces...)
 	}
 
 	return codespaces, nil
diff --git a/internal/codespaces/api/api_test.go b/internal/codespaces/api/api_test.go
@@ -50,6 +50,8 @@ func createFakeListEndpointServer(t *testing.T, initalTotal int, finalTotal int)
 		} else if page == 2 {
 			response.Codespaces = generateCodespaceList(per_page, per_page*2)
 			response.TotalCount = finalTotal
+		} else {
+			t.Fatal("Should not check extra page")
 		}
 
 		data, _ := json.Marshal(response)

Original file line number	Diff line number	Diff line change
`@@ -194,16 +194,18 @@ type getCodespacesListResponse struct {`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`// ListCodespaces returns a list of codespaces for the user.`
	`197`	`+// It consumes all pages returned by the API until all codespaces have been fetched.`
`197`	`198`	`func (a API) ListCodespaces(ctx context.Context) (codespaces []Codespace, err error) {`
	`199`	`+ per_page := 50`
`198`	`200`	`for page := 1; ; page++ {`
`199`	`201`	`response, err := a.fetchCodespaces(ctx, page)`
`200`	`202`	`if err != nil {`
`201`	`203`	`return nil, fmt.Errorf("%w", err)`
`202`	`204`	`}`
`203`		`- if len(codespaces) >= response.TotalCount \|\| len(response.Codespaces) == 0 {`
	`205`	`+ codespaces = append(codespaces, response.Codespaces...)`
	`206`	`+ if page*per_page >= response.TotalCount {`
`204`	`207`	`break`
`205`	`208`	`}`
`206`		`- codespaces = append(codespaces, response.Codespaces...)`
`207`	`209`	`}`
`208`	`210`
`209`	`211`	`return codespaces, nil`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,8 @@ func createFakeListEndpointServer(t *testing.T, initalTotal int, finalTotal int)`
`50`	`50`	`} else if page == 2 {`
`51`	`51`	`response.Codespaces = generateCodespaceList(per_page, per_page*2)`
`52`	`52`	`response.TotalCount = finalTotal`
	`53`	`+ } else {`
	`54`	`+ t.Fatal("Should not check extra page")`
`53`	`55`	`}`
`54`	`56`
`55`	`57`	`data, _ := json.Marshal(response)`