add pagination for pull requests

Author: vistaarjuneja

client/client.go

@@ -20,6 +20,9 @@ import (
 var (
 	defaultBaseURL = "https://app.harness.io/"
 
+	// these can be moved to a level above if we want to make this a generic
+	// client, keeping these here to ensure we don't end up returning too much info
+	// when different tools get added.
 	defaultPageSize = 5
 	maxPageSize     = 20
 

client/pullrequest.go

@@ -32,65 +32,84 @@ func (p *PullRequestService) Get(ctx context.Context, scope dto.Scope, repoID st
 	return pr, nil
 }
 
+// setDefaultPaginationForPR sets default pagination values for PullRequestOptions
+// We don't use the generic functions here since it follows a different naming
+// (uses page and limit instead of page and size)
+func setDefaultPaginationForPR(opts *dto.PullRequestOptions) {
+	if opts == nil {
+		return
+	}
+	if opts.Page <= 0 {
+		opts.Page = 1
+	}
+
+	if opts.Limit <= 0 {
+		opts.Limit = defaultPageSize
+	} else if opts.Limit > maxPageSize {
+		opts.Limit = maxPageSize
+	}
+}
+
 func (p *PullRequestService) List(ctx context.Context, scope dto.Scope, repoID string, opts *dto.PullRequestOptions) ([]*dto.PullRequest, error) {
 	path := fmt.Sprintf(pullRequestListPath, repoID)
 	params := make(map[string]string)
 	addScope(scope, params)
 
-	// Add query parameters from options
-	if opts != nil {
-		if len(opts.State) > 0 {
-			params["state"] = strings.Join(opts.State, ",")
-		}
-		if opts.SourceRepoRef != "" {
-			params["source_repo_ref"] = opts.SourceRepoRef
-		}
-		if opts.SourceBranch != "" {
-			params["source_branch"] = opts.SourceBranch
-		}
-		if opts.TargetBranch != "" {
-			params["target_branch"] = opts.TargetBranch
-		}
-		if opts.Query != "" {
-			params["query"] = opts.Query
-		}
-		if len(opts.CreatedBy) > 0 {
-			createdByStrings := make([]string, len(opts.CreatedBy))
-			for i, id := range opts.CreatedBy {
-				createdByStrings[i] = fmt.Sprintf("%d", id)
-			}
-			params["created_by"] = strings.Join(createdByStrings, ",")
-		}
-		if opts.Order != "" {
-			params["order"] = opts.Order
-		}
-		if opts.Sort != "" {
-			params["sort"] = opts.Sort
-		}
-		if opts.CreatedLt > 0 {
-			params["created_lt"] = fmt.Sprintf("%d", opts.CreatedLt)
-		}
-		if opts.CreatedGt > 0 {
-			params["created_gt"] = fmt.Sprintf("%d", opts.CreatedGt)
-		}
-		if opts.UpdatedLt > 0 {
-			params["updated_lt"] = fmt.Sprintf("%d", opts.UpdatedLt)
-		}
-		if opts.UpdatedGt > 0 {
-			params["updated_gt"] = fmt.Sprintf("%d", opts.UpdatedGt)
-		}
-		if opts.Page > 0 {
-			params["page"] = fmt.Sprintf("%d", opts.Page)
-		}
-		if opts.Limit > 0 {
-			params["limit"] = fmt.Sprintf("%d", opts.Limit)
-		}
-		if opts.AuthorID > 0 {
-			params["author_id"] = fmt.Sprintf("%d", opts.AuthorID)
-		}
-		if opts.IncludeChecks {
-			params["include_checks"] = "true"
+	// Handle nil options by creating default options
+	if opts == nil {
+		opts = &dto.PullRequestOptions{}
+	}
+
+	setDefaultPaginationForPR(opts)
+
+	params["page"] = fmt.Sprintf("%d", opts.Page)
+	params["limit"] = fmt.Sprintf("%d", opts.Limit)
+
+	if len(opts.State) > 0 {
+		params["state"] = strings.Join(opts.State, ",")
+	}
+	if opts.SourceRepoRef != "" {
+		params["source_repo_ref"] = opts.SourceRepoRef
+	}
+	if opts.SourceBranch != "" {
+		params["source_branch"] = opts.SourceBranch
+	}
+	if opts.TargetBranch != "" {
+		params["target_branch"] = opts.TargetBranch
+	}
+	if opts.Query != "" {
+		params["query"] = opts.Query
+	}
+	if len(opts.CreatedBy) > 0 {
+		createdByStrings := make([]string, len(opts.CreatedBy))
+		for i, id := range opts.CreatedBy {
+			createdByStrings[i] = fmt.Sprintf("%d", id)
 		}
+		params["created_by"] = strings.Join(createdByStrings, ",")
+	}
+	if opts.Order != "" {
+		params["order"] = opts.Order
+	}
+	if opts.Sort != "" {
+		params["sort"] = opts.Sort
+	}
+	if opts.CreatedLt > 0 {
+		params["created_lt"] = fmt.Sprintf("%d", opts.CreatedLt)
+	}
+	if opts.CreatedGt > 0 {
+		params["created_gt"] = fmt.Sprintf("%d", opts.CreatedGt)
+	}
+	if opts.UpdatedLt > 0 {
+		params["updated_lt"] = fmt.Sprintf("%d", opts.UpdatedLt)
+	}
+	if opts.UpdatedGt > 0 {
+		params["updated_gt"] = fmt.Sprintf("%d", opts.UpdatedGt)
+	}
+	if opts.AuthorID > 0 {
+		params["author_id"] = fmt.Sprintf("%d", opts.AuthorID)
+	}
+	if opts.IncludeChecks {
+		params["include_checks"] = "true"
 	}
 
 	var prs []*dto.PullRequest