Merge pull request #1074 from hashicorp/TF-24585-go-tfe-gh-issue-1073-remove-total-count-from-run-list-for-organization-interface

BREAKING: removes TotalCount/TotalPages from ListForOrganization

Author: brandonc

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+## BREAKING CHANGES
+
+In the last release, Runs interface method `ListForOrganization` included pagination fields `TotalCount` and `TotalPages`, but these are being removed as this feature approaches general availablity by @brandonc [#1074](https://github.com/hashicorp/go-tfe/pull/1074)
+
 # v1.76.0
 
 ## Enhancements

mocks/run_mocks.go

@@ -22,7 +22,7 @@ type Runs interface {
 	List(ctx context.Context, workspaceID string, options *RunListOptions) (*RunList, error)
 
 	// List all the runs of the given organization.
-	ListForOrganization(ctx context.Context, organization string, options *RunListForOrganizationOptions) (*RunList, error)
+	ListForOrganization(ctx context.Context, organization string, options *RunListForOrganizationOptions) (*OrganizationRunList, error)
 
 	// Create a new run with the given options.
 	Create(ctx context.Context, options RunCreateOptions) (*Run, error)
@@ -120,6 +120,14 @@ type RunList struct {
 	Items []*Run
 }
 
+// OrganizationRunList represents a list of runs across an organization. It
+// differs from the RunList in that it does not include a TotalCount of records
+// in the pagination details
+type OrganizationRunList struct {
+	*PaginationNextPrev
+	Items []*Run
+}
+
 // Run represents a Terraform Enterprise run.
 type Run struct {
 	ID                     string               `jsonapi:"primary,runs"`
@@ -448,7 +456,7 @@ func (s *runs) List(ctx context.Context, workspaceID string, options *RunListOpt
 }
 
 // List all the runs of the given workspace.
-func (s *runs) ListForOrganization(ctx context.Context, organization string, options *RunListForOrganizationOptions) (*RunList, error) {
+func (s *runs) ListForOrganization(ctx context.Context, organization string, options *RunListForOrganizationOptions) (*OrganizationRunList, error) {
 	if !validStringID(&organization) {
 		return nil, ErrInvalidOrg
 	}
@@ -462,7 +470,7 @@ func (s *runs) ListForOrganization(ctx context.Context, organization string, opt
 		return nil, err
 	}
 
-	rl := &RunList{}
+	rl := &OrganizationRunList{}
 	err = req.Do(ctx, rl)
 	if err != nil {
 		return nil, err

run.go

@@ -750,7 +750,7 @@ func TestRunsListForOrganization(t *testing.T) {
 		assert.Contains(t, found, rTest1.ID)
 		assert.Contains(t, found, rTest2.ID)
 		assert.Equal(t, 1, rl.CurrentPage)
-		assert.Equal(t, 2, rl.TotalCount)
+		assert.Empty(t, rl.NextPage)
 	})
 
 	t.Run("without list options and include as nil", func(t *testing.T) {
@@ -768,7 +768,7 @@ func TestRunsListForOrganization(t *testing.T) {
 		assert.Contains(t, found, rTest1.ID)
 		assert.Contains(t, found, rTest2.ID)
 		assert.Equal(t, 1, rl.CurrentPage)
-		assert.Equal(t, 2, rl.TotalCount)
+		assert.Empty(t, rl.NextPage)
 	})
 
 	t.Run("with list options", func(t *testing.T) {
@@ -784,7 +784,7 @@ func TestRunsListForOrganization(t *testing.T) {
 		require.NoError(t, err)
 		assert.Empty(t, rl.Items)
 		assert.Equal(t, 999, rl.CurrentPage)
-		assert.Equal(t, 2, rl.TotalCount)
+		assert.Empty(t, rl.NextPage)
 	})
 
 	t.Run("with workspace included", func(t *testing.T) {
@@ -818,7 +818,7 @@ func TestRunsListForOrganization(t *testing.T) {
 		assert.Contains(t, found, rTest1.ID)
 		assert.Contains(t, found, rTest2.ID)
 		assert.Equal(t, 1, rl.CurrentPage)
-		assert.Equal(t, 2, rl.TotalCount)
+		assert.Empty(t, rl.NextPage)
 	})
 
 	t.Run("with filter by workspace", func(t *testing.T) {
@@ -840,6 +840,6 @@ func TestRunsListForOrganization(t *testing.T) {
 		require.NotNil(t, rl.Items[1].Workspace)
 		assert.NotEmpty(t, rl.Items[1].Workspace.Name)
 		assert.Equal(t, 1, rl.CurrentPage)
-		assert.Equal(t, 2, rl.TotalCount)
+		assert.Empty(t, rl.NextPage)
 	})
 }

run_integration_test.go

@@ -857,11 +857,10 @@ func unmarshalResponse(responseBody io.Reader, model interface{}) error {
 
 	// Try to get the Items and Pagination struct fields.
 	items := dst.FieldByName("Items")
-	pagination := dst.FieldByName("Pagination")
 
 	// Unmarshal a single value if model does not contain the
 	// Items and Pagination struct fields.
-	if !items.IsValid() || !pagination.IsValid() {
+	if !items.IsValid() {
 		return jsonapi.UnmarshalPayload(responseBody, model)
 	}
 
@@ -892,15 +891,25 @@ func unmarshalResponse(responseBody io.Reader, model interface{}) error {
 	// Pointer-swap the result.
 	items.Set(result)
 
+	pagination := dst.FieldByName("Pagination")
+	paginationWithoutTotals := dst.FieldByName("PaginationNextPrev")
+
 	// As we are getting a list of values, we need to decode
 	// the pagination details out of the response body.
-	p, err := parsePagination(body)
-	if err != nil {
-		return err
-	}
-
 	// Pointer-swap the decoded pagination details.
-	pagination.Set(reflect.ValueOf(p))
+	if paginationWithoutTotals.IsValid() {
+		p, err := parsePaginationWithoutTotal(body)
+		if err != nil {
+			return err
+		}
+		paginationWithoutTotals.Set(reflect.ValueOf(p))
+	} else if pagination.IsValid() {
+		p, err := parsePagination(body)
+		if err != nil {
+			return err
+		}
+		pagination.Set(reflect.ValueOf(p))
+	}
 
 	return nil
 }
@@ -915,13 +924,35 @@ type ListOptions struct {
 	PageSize int `url:"page[size],omitempty"`
 }
 
-// Pagination is used to return the pagination details of an API request.
+// PaginationNextPrev is used to return the pagination details of an API request.
+type PaginationNextPrev struct {
+	CurrentPage  int `json:"current-page"`
+	PreviousPage int `json:"prev-page"`
+	NextPage     int `json:"next-page"`
+}
+
+// Pagination is used to return the pagination details of an API request including TotalCount.
 type Pagination struct {
 	CurrentPage  int `json:"current-page"`
 	PreviousPage int `json:"prev-page"`
 	NextPage     int `json:"next-page"`
-	TotalPages   int `json:"total-pages"`
 	TotalCount   int `json:"total-count"`
+	TotalPages   int `json:"total-pages"`
+}
+
+func parsePaginationWithoutTotal(body io.Reader) (*PaginationNextPrev, error) {
+	var raw struct {
+		Meta struct {
+			Pagination PaginationNextPrev `jsonapi:"pagination"`
+		} `jsonapi:"meta"`
+	}
+
+	// JSON decode the raw response.
+	if err := json.NewDecoder(body).Decode(&raw); err != nil {
+		return &PaginationNextPrev{}, err
+	}
+
+	return &raw.Meta.Pagination, nil
 }
 
 func parsePagination(body io.Reader) (*Pagination, error) {