GitHub Rate-Aware Issue Fetcher

Build a helper that fetches open issues for a repository while honoring API rate limits and exposing rate metadata alongside results.

Capabilities

Returns issues with rate info

• Fetching the first page of open issues yields issue summaries and captures limit, remaining, and reset timestamp from the HTTP response metadata; retry-after should be zero when not provided. @test

Waits on exhausted limit

• When the current remaining count is zero, the helper waits until the documented reset moment before issuing the next request, then continues fetching subsequent pages. @test

Reports secondary limit guidance

• If the API signals a secondary rate limit with a retry-after duration, the helper surfaces the suggested wait time in the returned error detail. @test

Implementation

@generates

API

type RateInfo struct {
    Limit      int
    Remaining  int
    Reset      time.Time
    RetryAfter time.Duration
}

type IssueSummary struct {
    Number int
    Title  string
    URL    string
}

type RateAwareClient struct {
    // internal fields elided
}

func NewRateAwareClient(httpClient *http.Client, token string) (*RateAwareClient, error)

// ListOpenIssues retrieves open issues for the repository, respecting primary rate limits and surfacing secondary-limit retry hints.
// It aggregates across pages until completion or until a rate limit condition requires pausing.
func (c *RateAwareClient) ListOpenIssues(ctx context.Context, owner string, repo string, perPage int) ([]IssueSummary, RateInfo, error)

Dependencies { .dependencies }

github.com/google/go-github/v80/github { .dependency }

Typed client for GitHub's REST API with rate-limit metadata and typed response helpers.