fix(dev): cache GitHub pull requests
This commit is contained in:
2 files changed
+92
-7
No files matched your search
@@ -6,9 +6,22 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
"strings"
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
const Repo = "homarr-labs/homarr"
|
const Repo = "homarr-labs/homarr"
|
||||||
|
const prCacheTTL = 5 * time.Minute
|
||||||
|
|
||||||
|
var prListCache = struct {
|
||||||
|
sync.Mutex
|
||||||
|
entries map[int]cachedPRs
|
||||||
|
}{entries: make(map[int]cachedPRs)}
|
||||||
|
|
||||||
|
type cachedPRs struct {
|
||||||
|
prs []PR
|
||||||
|
fetchedAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
func isBot(login string) bool {
|
func isBot(login string) bool {
|
||||||
return strings.HasSuffix(login, "[bot]") || strings.HasPrefix(login, "app/")
|
return strings.HasSuffix(login, "[bot]") || strings.HasPrefix(login, "app/")
|
||||||
@@ -78,13 +91,30 @@ func rollupState(checks []rawCheck) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func ListPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
func ListPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
||||||
|
return listPRs(ctx, limit, includeBots, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func RefreshPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
||||||
|
return listPRs(ctx, limit, includeBots, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
func listPRs(ctx context.Context, limit int, includeBots, refresh bool) ([]PR, error) {
|
||||||
|
cached, fetchedAt := cachedPRList(limit)
|
||||||
|
if !refresh && !fetchedAt.IsZero() && time.Since(fetchedAt) < prCacheTTL {
|
||||||
|
return filterPRs(cached, includeBots), nil
|
||||||
|
}
|
||||||
|
|
||||||
out, err := exec.CommandContext(ctx, "gh", "pr", "list",
|
out, err := exec.CommandContext(ctx, "gh", "pr", "list",
|
||||||
"--repo", Repo,
|
"--repo", Repo,
|
||||||
"--state", "open",
|
"--state", "open",
|
||||||
"--limit", fmt.Sprint(limit),
|
"--limit", fmt.Sprint(limit),
|
||||||
"--json", "number,title,author,headRefName,updatedAt,isDraft,statusCheckRollup",
|
"--json", "number,title,author,headRefName,updatedAt,isDraft,statusCheckRollup",
|
||||||
).Output()
|
).CombinedOutput()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
err = commandError(err, out)
|
||||||
|
if len(cached) > 0 {
|
||||||
|
return filterPRs(cached, includeBots), fmt.Errorf("%w; showing cached PRs from %s", err, fetchedAt.Format(time.Kitchen))
|
||||||
|
}
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -95,9 +125,6 @@ func ListPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
|||||||
|
|
||||||
prs := make([]PR, 0, len(raws))
|
prs := make([]PR, 0, len(raws))
|
||||||
for _, r := range raws {
|
for _, r := range raws {
|
||||||
if !includeBots && isBot(r.Author.Login) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
prs = append(prs, PR{
|
prs = append(prs, PR{
|
||||||
Number: r.Number,
|
Number: r.Number,
|
||||||
Title: r.Title,
|
Title: r.Title,
|
||||||
@@ -108,16 +135,48 @@ func ListPRs(ctx context.Context, limit int, includeBots bool) ([]PR, error) {
|
|||||||
UpdatedAt: r.UpdatedAt,
|
UpdatedAt: r.UpdatedAt,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
return prs, nil
|
storePRList(limit, prs)
|
||||||
|
return filterPRs(prs, includeBots), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func cachedPRList(limit int) ([]PR, time.Time) {
|
||||||
|
prListCache.Lock()
|
||||||
|
defer prListCache.Unlock()
|
||||||
|
entry := prListCache.entries[limit]
|
||||||
|
return append([]PR(nil), entry.prs...), entry.fetchedAt
|
||||||
|
}
|
||||||
|
|
||||||
|
func storePRList(limit int, prs []PR) {
|
||||||
|
prListCache.Lock()
|
||||||
|
defer prListCache.Unlock()
|
||||||
|
prListCache.entries[limit] = cachedPRs{prs: append([]PR(nil), prs...), fetchedAt: time.Now()}
|
||||||
|
}
|
||||||
|
|
||||||
|
func filterPRs(prs []PR, includeBots bool) []PR {
|
||||||
|
filtered := make([]PR, 0, len(prs))
|
||||||
|
for _, pr := range prs {
|
||||||
|
if includeBots || !isBot(pr.Author) {
|
||||||
|
filtered = append(filtered, pr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return filtered
|
||||||
|
}
|
||||||
|
|
||||||
|
func commandError(err error, output []byte) error {
|
||||||
|
detail := strings.TrimSpace(string(output))
|
||||||
|
if detail == "" {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return fmt.Errorf("%s: %w", detail, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
func GetPR(ctx context.Context, number int) (*PR, error) {
|
func GetPR(ctx context.Context, number int) (*PR, error) {
|
||||||
out, err := exec.CommandContext(ctx, "gh", "pr", "view", fmt.Sprint(number),
|
out, err := exec.CommandContext(ctx, "gh", "pr", "view", fmt.Sprint(number),
|
||||||
"--repo", Repo,
|
"--repo", Repo,
|
||||||
"--json", "number,title,author,headRefName,updatedAt,isDraft,statusCheckRollup",
|
"--json", "number,title,author,headRefName,updatedAt,isDraft,statusCheckRollup",
|
||||||
).Output()
|
).CombinedOutput()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, commandError(err, out)
|
||||||
}
|
}
|
||||||
|
|
||||||
var r rawPR
|
var r rawPR
|
||||||
|
|||||||
@@ -1,8 +1,11 @@
|
|||||||
package gh
|
package gh
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"errors"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestIsBot(t *testing.T) {
|
func TestIsBot(t *testing.T) {
|
||||||
@@ -42,6 +45,29 @@ func TestRollupStateHandlesChecksAndStatuses(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestCachedPRListFiltersBotsWithoutMutatingCache(t *testing.T) {
|
||||||
|
limit := 9876
|
||||||
|
storePRList(limit, []PR{{Number: 1, Author: "developer"}, {Number: 2, Author: "bot[bot]"}})
|
||||||
|
|
||||||
|
prs, fetchedAt := cachedPRList(limit)
|
||||||
|
if time.Since(fetchedAt) >= prCacheTTL {
|
||||||
|
t.Fatal("new cache entry is already expired")
|
||||||
|
}
|
||||||
|
if filtered := filterPRs(prs, false); len(filtered) != 1 || filtered[0].Number != 1 {
|
||||||
|
t.Fatalf("filtered PRs = %#v", filtered)
|
||||||
|
}
|
||||||
|
if unfiltered := filterPRs(prs, true); len(unfiltered) != 2 {
|
||||||
|
t.Fatalf("unfiltered PR count = %d, want 2", len(unfiltered))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCommandErrorIncludesGitHubOutput(t *testing.T) {
|
||||||
|
err := commandError(errors.New("exit status 1"), []byte("GraphQL: API rate limit exceeded\n"))
|
||||||
|
if !strings.Contains(err.Error(), "API rate limit exceeded") {
|
||||||
|
t.Fatalf("error = %q", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestListPRsExcludesBotsIntegration(t *testing.T) {
|
func TestListPRsExcludesBotsIntegration(t *testing.T) {
|
||||||
if os.Getenv("HOMARR_INTEGRATION_TEST") != "1" {
|
if os.Getenv("HOMARR_INTEGRATION_TEST") != "1" {
|
||||||
t.Skip("set HOMARR_INTEGRATION_TEST=1 to query GitHub")
|
t.Skip("set HOMARR_INTEGRATION_TEST=1 to query GitHub")
|
||||||
|
|||||||
Reference in new issue
Block a user