feat: add github rest client
This commit is contained in:
Vincent Koc
parent
15aa349cca
commit
cddee690e7
259
internal/github/client.go
Normal file
259
internal/github/client.go
Normal file
@ -0,0 +1,259 @@
|
||||
package github
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
)
|
||||
|
||||
type Reporter func(message string)
|
||||
|
||||
type Client struct {
|
||||
httpClient *http.Client
|
||||
baseURL string
|
||||
token string
|
||||
userAgent string
|
||||
pageDelay time.Duration
|
||||
}
|
||||
|
||||
type Options struct {
|
||||
Token string
|
||||
BaseURL string
|
||||
UserAgent string
|
||||
HTTPClient *http.Client
|
||||
PageDelay time.Duration
|
||||
}
|
||||
|
||||
type ListIssuesOptions struct {
|
||||
State string
|
||||
Since string
|
||||
Limit int
|
||||
}
|
||||
|
||||
type RequestError struct {
|
||||
Method string
|
||||
URL string
|
||||
Status int
|
||||
Body string
|
||||
}
|
||||
|
||||
func (e *RequestError) Error() string {
|
||||
if e.Body == "" {
|
||||
return fmt.Sprintf("github %s %s failed with status %d", e.Method, e.URL, e.Status)
|
||||
}
|
||||
return fmt.Sprintf("github %s %s failed with status %d: %s", e.Method, e.URL, e.Status, e.Body)
|
||||
}
|
||||
|
||||
func New(options Options) *Client {
|
||||
baseURL := strings.TrimRight(options.BaseURL, "/")
|
||||
if baseURL == "" {
|
||||
baseURL = "https://api.github.com"
|
||||
}
|
||||
httpClient := options.HTTPClient
|
||||
if httpClient == nil {
|
||||
httpClient = &http.Client{Timeout: 30 * time.Second}
|
||||
}
|
||||
userAgent := options.UserAgent
|
||||
if userAgent == "" {
|
||||
userAgent = "gitcrawl"
|
||||
}
|
||||
pageDelay := options.PageDelay
|
||||
if pageDelay == 0 {
|
||||
pageDelay = 250 * time.Millisecond
|
||||
}
|
||||
return &Client{
|
||||
httpClient: httpClient,
|
||||
baseURL: baseURL,
|
||||
token: options.Token,
|
||||
userAgent: userAgent,
|
||||
pageDelay: pageDelay,
|
||||
}
|
||||
}
|
||||
|
||||
func (c *Client) GetRepo(ctx context.Context, owner, repo string, reporter Reporter) (map[string]any, error) {
|
||||
var out map[string]any
|
||||
if err := c.doJSON(ctx, http.MethodGet, fmt.Sprintf("/repos/%s/%s", pathEscape(owner), pathEscape(repo)), nil, reporter, &out); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func (c *Client) GetIssue(ctx context.Context, owner, repo string, number int, reporter Reporter) (map[string]any, error) {
|
||||
var out map[string]any
|
||||
path := fmt.Sprintf("/repos/%s/%s/issues/%d", pathEscape(owner), pathEscape(repo), number)
|
||||
if err := c.doJSON(ctx, http.MethodGet, path, nil, reporter, &out); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func (c *Client) GetPull(ctx context.Context, owner, repo string, number int, reporter Reporter) (map[string]any, error) {
|
||||
var out map[string]any
|
||||
path := fmt.Sprintf("/repos/%s/%s/pulls/%d", pathEscape(owner), pathEscape(repo), number)
|
||||
if err := c.doJSON(ctx, http.MethodGet, path, nil, reporter, &out); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func (c *Client) ListRepositoryIssues(ctx context.Context, owner, repo string, options ListIssuesOptions, reporter Reporter) ([]map[string]any, error) {
|
||||
values := url.Values{}
|
||||
state := strings.TrimSpace(options.State)
|
||||
if state == "" {
|
||||
state = "open"
|
||||
}
|
||||
values.Set("state", state)
|
||||
values.Set("sort", "updated")
|
||||
values.Set("direction", "desc")
|
||||
values.Set("per_page", "100")
|
||||
if options.Since != "" {
|
||||
values.Set("since", options.Since)
|
||||
}
|
||||
path := fmt.Sprintf("/repos/%s/%s/issues?%s", pathEscape(owner), pathEscape(repo), values.Encode())
|
||||
return c.paginate(ctx, path, options.Limit, reporter)
|
||||
}
|
||||
|
||||
func (c *Client) ListIssueComments(ctx context.Context, owner, repo string, number int, reporter Reporter) ([]map[string]any, error) {
|
||||
path := fmt.Sprintf("/repos/%s/%s/issues/%d/comments?per_page=100", pathEscape(owner), pathEscape(repo), number)
|
||||
return c.paginate(ctx, path, 0, reporter)
|
||||
}
|
||||
|
||||
func (c *Client) ListPullReviews(ctx context.Context, owner, repo string, number int, reporter Reporter) ([]map[string]any, error) {
|
||||
path := fmt.Sprintf("/repos/%s/%s/pulls/%d/reviews?per_page=100", pathEscape(owner), pathEscape(repo), number)
|
||||
return c.paginate(ctx, path, 0, reporter)
|
||||
}
|
||||
|
||||
func (c *Client) ListPullReviewComments(ctx context.Context, owner, repo string, number int, reporter Reporter) ([]map[string]any, error) {
|
||||
path := fmt.Sprintf("/repos/%s/%s/pulls/%d/comments?per_page=100", pathEscape(owner), pathEscape(repo), number)
|
||||
return c.paginate(ctx, path, 0, reporter)
|
||||
}
|
||||
|
||||
func (c *Client) ListPullFiles(ctx context.Context, owner, repo string, number int, reporter Reporter) ([]map[string]any, error) {
|
||||
path := fmt.Sprintf("/repos/%s/%s/pulls/%d/files?per_page=100", pathEscape(owner), pathEscape(repo), number)
|
||||
return c.paginate(ctx, path, 0, reporter)
|
||||
}
|
||||
|
||||
func (c *Client) paginate(ctx context.Context, firstPath string, limit int, reporter Reporter) ([]map[string]any, error) {
|
||||
var out []map[string]any
|
||||
nextPath := firstPath
|
||||
page := 0
|
||||
for nextPath != "" {
|
||||
page++
|
||||
var rows []map[string]any
|
||||
resp, err := c.do(ctx, http.MethodGet, nextPath, nil, reporter)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if err := json.NewDecoder(resp.Body).Decode(&rows); err != nil {
|
||||
_ = resp.Body.Close()
|
||||
return nil, fmt.Errorf("decode github page: %w", err)
|
||||
}
|
||||
_ = resp.Body.Close()
|
||||
if limit > 0 && len(out)+len(rows) > limit {
|
||||
rows = rows[:limit-len(out)]
|
||||
}
|
||||
out = append(out, rows...)
|
||||
reporter.Printf("[github] page %d fetched count=%d accumulated=%d", page, len(rows), len(out))
|
||||
if limit > 0 && len(out) >= limit {
|
||||
break
|
||||
}
|
||||
nextPath = nextPage(resp.Header.Get("Link"))
|
||||
if nextPath != "" && c.pageDelay > 0 {
|
||||
select {
|
||||
case <-ctx.Done():
|
||||
return nil, ctx.Err()
|
||||
case <-time.After(c.pageDelay):
|
||||
}
|
||||
}
|
||||
}
|
||||
return out, nil
|
||||
}
|
||||
|
||||
func (c *Client) doJSON(ctx context.Context, method, path string, body io.Reader, reporter Reporter, out any) error {
|
||||
resp, err := c.do(ctx, method, path, body, reporter)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if err := json.NewDecoder(resp.Body).Decode(out); err != nil {
|
||||
return fmt.Errorf("decode github response: %w", err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (c *Client) do(ctx context.Context, method, path string, body io.Reader, reporter Reporter) (*http.Response, error) {
|
||||
fullURL := c.baseURL + path
|
||||
req, err := http.NewRequestWithContext(ctx, method, fullURL, body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("Accept", "application/vnd.github+json")
|
||||
req.Header.Set("X-GitHub-Api-Version", "2022-11-28")
|
||||
req.Header.Set("User-Agent", c.userAgent)
|
||||
if c.token != "" {
|
||||
req.Header.Set("Authorization", "Bearer "+c.token)
|
||||
}
|
||||
reporter.Printf("[github] request %s %s", method, path)
|
||||
resp, err := c.httpClient.Do(req)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("github request: %w", err)
|
||||
}
|
||||
if resp.StatusCode >= 200 && resp.StatusCode < 300 {
|
||||
return resp, nil
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
data, _ := io.ReadAll(io.LimitReader(resp.Body, 4096))
|
||||
return nil, &RequestError{Method: method, URL: path, Status: resp.StatusCode, Body: strings.TrimSpace(string(data))}
|
||||
}
|
||||
|
||||
func nextPage(linkHeader string) string {
|
||||
for _, part := range strings.Split(linkHeader, ",") {
|
||||
sections := strings.Split(part, ";")
|
||||
if len(sections) < 2 {
|
||||
continue
|
||||
}
|
||||
if strings.TrimSpace(sections[1]) != `rel="next"` {
|
||||
continue
|
||||
}
|
||||
rawURL := strings.Trim(strings.TrimSpace(sections[0]), "<>")
|
||||
parsed, err := url.Parse(rawURL)
|
||||
if err != nil {
|
||||
return ""
|
||||
}
|
||||
if parsed.RawQuery == "" {
|
||||
return parsed.Path
|
||||
}
|
||||
return parsed.Path + "?" + parsed.RawQuery
|
||||
}
|
||||
return ""
|
||||
}
|
||||
|
||||
func pathEscape(value string) string {
|
||||
return url.PathEscape(value)
|
||||
}
|
||||
|
||||
func (r Reporter) Printf(format string, args ...any) {
|
||||
if r != nil {
|
||||
r(fmt.Sprintf(format, args...))
|
||||
}
|
||||
}
|
||||
|
||||
func intValue(value any) int {
|
||||
switch typed := value.(type) {
|
||||
case float64:
|
||||
return int(typed)
|
||||
case int:
|
||||
return typed
|
||||
case json.Number:
|
||||
parsed, _ := strconv.Atoi(string(typed))
|
||||
return parsed
|
||||
default:
|
||||
return 0
|
||||
}
|
||||
}
|
||||
67
internal/github/client_test.go
Normal file
67
internal/github/client_test.go
Normal file
@ -0,0 +1,67 @@
|
||||
package github
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestListRepositoryIssuesPaginatesAndLimits(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
if r.Header.Get("Authorization") != "Bearer token" {
|
||||
t.Fatalf("missing auth header: %q", r.Header.Get("Authorization"))
|
||||
}
|
||||
switch r.URL.Query().Get("page") {
|
||||
case "":
|
||||
w.Header().Set("Link", `<`+serverURL(r)+`?page=2>; rel="next"`)
|
||||
_ = json.NewEncoder(w).Encode([]map[string]any{{"number": 1}, {"number": 2}})
|
||||
case "2":
|
||||
_ = json.NewEncoder(w).Encode([]map[string]any{{"number": 3}})
|
||||
default:
|
||||
t.Fatalf("unexpected page: %s", r.URL.RawQuery)
|
||||
}
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := New(Options{Token: "token", BaseURL: server.URL, PageDelay: -1})
|
||||
rows, err := client.ListRepositoryIssues(context.Background(), "openclaw", "gitcrawl", ListIssuesOptions{Limit: 3}, nil)
|
||||
if err != nil {
|
||||
t.Fatalf("list issues: %v", err)
|
||||
}
|
||||
if len(rows) != 3 {
|
||||
t.Fatalf("rows: got %d want 3", len(rows))
|
||||
}
|
||||
if intValue(rows[2]["number"]) != 3 {
|
||||
t.Fatalf("last number: %#v", rows[2]["number"])
|
||||
}
|
||||
}
|
||||
|
||||
func TestRequestErrorIncludesStatus(t *testing.T) {
|
||||
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
http.Error(w, "nope", http.StatusUnauthorized)
|
||||
}))
|
||||
defer server.Close()
|
||||
|
||||
client := New(Options{BaseURL: server.URL, PageDelay: -1})
|
||||
_, err := client.GetRepo(context.Background(), "openclaw", "gitcrawl", nil)
|
||||
if err == nil {
|
||||
t.Fatal("expected error")
|
||||
}
|
||||
requestErr, ok := err.(*RequestError)
|
||||
if !ok {
|
||||
t.Fatalf("error type: %T", err)
|
||||
}
|
||||
if requestErr.Status != http.StatusUnauthorized {
|
||||
t.Fatalf("status: got %d want %d", requestErr.Status, http.StatusUnauthorized)
|
||||
}
|
||||
}
|
||||
|
||||
func serverURL(r *http.Request) string {
|
||||
scheme := "http"
|
||||
if r.TLS != nil {
|
||||
scheme = "https"
|
||||
}
|
||||
return scheme + "://" + r.Host + r.URL.Path
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user