mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-11-16 23:04:24 +08:00
feat(updater): throttle auto-update checks with exponential backoff
Check GitHub releases at most every 6 hours and retry transient failures (release query, checksum or binary download) with exponential backoff from 1 minute up to 3 hours. Forced updates bypass the throttle.
This commit is contained in:
@@ -35,12 +35,16 @@ func TryAutoUpdate(ctx context.Context, updater *edgeupdater.Service, settings *
|
||||
if force && strings.TrimSpace(settings.UpdateChannel) != "" {
|
||||
channel = settings.UpdateChannel
|
||||
}
|
||||
slog.Info("checking for "+logLabel+" updates", "repo", settings.UpdateRepo, "channel", channel, "force", force)
|
||||
err := updater.CheckAndUpdate(ctx, settings.UpdateRepo, edgeupdater.UpdateOptions{
|
||||
opts := edgeupdater.UpdateOptions{
|
||||
Channel: channel,
|
||||
TagName: settings.UpdateTag,
|
||||
Force: force,
|
||||
})
|
||||
}
|
||||
if !updater.CanCheck(opts) {
|
||||
return
|
||||
}
|
||||
slog.Info("checking for "+logLabel+" updates", "repo", settings.UpdateRepo, "channel", channel, "force", force)
|
||||
err := updater.CheckAndUpdate(ctx, settings.UpdateRepo, opts)
|
||||
if err != nil {
|
||||
slog.Error(logLabel+" update check failed", "error", err)
|
||||
}
|
||||
|
||||
@@ -0,0 +1,102 @@
|
||||
// Copyright 2026 Arctel.net
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package heartbeat
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"log/slog"
|
||||
"net/http"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
edgeupdater "github.com/Rain-kl/Wavelet/internal/apps/edge/updater"
|
||||
)
|
||||
|
||||
type roundTripFunc func(req *http.Request) (*http.Response, error)
|
||||
|
||||
func (f roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
return f(req)
|
||||
}
|
||||
|
||||
func TestTryAutoUpdateThrottling(t *testing.T) {
|
||||
currentTime := time.Date(2026, 10, 17, 12, 0, 0, 0, time.UTC)
|
||||
requestCount := 0
|
||||
|
||||
httpClient := &http.Client{
|
||||
Transport: roundTripFunc(func(req *http.Request) (*http.Response, error) {
|
||||
requestCount++
|
||||
return &http.Response{
|
||||
StatusCode: http.StatusOK,
|
||||
Status: "200 OK",
|
||||
Header: make(http.Header),
|
||||
Body: io.NopCloser(strings.NewReader(`{"tag_name":"v1.0.0"}`)),
|
||||
}, nil
|
||||
}),
|
||||
}
|
||||
|
||||
updater := edgeupdater.New(edgeupdater.Config{
|
||||
LocalVersion: "v1.0.0",
|
||||
AssetPrefix: "openflare-agent",
|
||||
LogLabel: "agent",
|
||||
CheckInterval: 6 * time.Hour,
|
||||
InitialBackoff: 1 * time.Minute,
|
||||
MaxBackoff: 3 * time.Hour,
|
||||
NowFunc: func() time.Time { return currentTime },
|
||||
HTTPClient: httpClient,
|
||||
})
|
||||
|
||||
settings := &AutoUpdateSettings{
|
||||
AutoUpdate: true,
|
||||
UpdateRepo: "Rain-kl/OpenFlare",
|
||||
}
|
||||
|
||||
// 1. Initial call should be permitted
|
||||
opts := edgeupdater.UpdateOptions{Channel: "stable", Force: false}
|
||||
if !updater.CanCheck(opts) {
|
||||
t.Fatalf("expected CanCheck to be true initially")
|
||||
}
|
||||
|
||||
// Run first check manually or via TryAutoUpdate
|
||||
TryAutoUpdate(context.Background(), updater, settings, "agent")
|
||||
if requestCount != 1 {
|
||||
t.Fatalf("expected 1 request after first check, got %d", requestCount)
|
||||
}
|
||||
|
||||
// 2. Immediately after, CanCheck is false (throttled for 6 hours)
|
||||
if updater.CanCheck(opts) {
|
||||
t.Fatalf("expected CanCheck to be false after check")
|
||||
}
|
||||
|
||||
// Capture slog output to verify that throttled calls do NOT emit "checking for agent updates"
|
||||
var logBuf strings.Builder
|
||||
prevLogger := slog.Default()
|
||||
slog.SetDefault(slog.New(slog.NewTextHandler(&logBuf, nil)))
|
||||
defer slog.SetDefault(prevLogger)
|
||||
|
||||
// Calling TryAutoUpdate again while throttled should NOT perform any checks or log
|
||||
TryAutoUpdate(context.Background(), updater, settings, "agent")
|
||||
if strings.Contains(logBuf.String(), "checking for agent updates") {
|
||||
t.Fatalf("expected no log message when throttled, got: %s", logBuf.String())
|
||||
}
|
||||
if requestCount != 1 {
|
||||
t.Fatalf("expected no request when throttled, got %d requests", requestCount)
|
||||
}
|
||||
|
||||
// 3. Force check should still log and check even when regular check is throttled
|
||||
forceSettings := &AutoUpdateSettings{
|
||||
AutoUpdate: true,
|
||||
UpdateNow: true,
|
||||
UpdateRepo: "Rain-kl/OpenFlare",
|
||||
}
|
||||
logBuf.Reset()
|
||||
TryAutoUpdate(context.Background(), updater, forceSettings, "agent")
|
||||
if !strings.Contains(logBuf.String(), "checking for agent updates") {
|
||||
t.Fatalf("expected log message for force check, got: %s", logBuf.String())
|
||||
}
|
||||
if requestCount != 2 {
|
||||
t.Fatalf("expected force check to send a request, got %d requests", requestCount)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user