[功能] 添加对应用结果的警告支持，优化配置激活和回滚逻辑

2026-10-09 00:56:37 +08:00 · 2026-03-18 13:09:28 +08:00
parent 2ece13d08e
commit e2202d1456
9 changed files with 1121 additions and 828 deletions
@@ -4,15 +4,18 @@ import (
 	"context"
 	"crypto/sha256"
 	"encoding/hex"
+	"fmt"
 	"log/slog"
 	"strings"

+	"openflare-agent/internal/nginx"
 	"openflare-agent/internal/protocol"
 	"openflare-agent/internal/state"
 )

 const (
 	ApplyResultSuccess = "success"
+	ApplyResultWarning = "warning"
 	ApplyResultFailed  = "failed"
 )

@@ -22,7 +25,7 @@ type ConfigClient interface {
 }

 type NginxManager interface {
-	Apply(ctx context.Context, mainConfig string, routeConfig string, supportFiles []protocol.SupportFile) error
+	Apply(ctx context.Context, mainConfig string, routeConfig string, supportFiles []protocol.SupportFile) nginx.ApplyOutcome
 	EnsureRuntime(ctx context.Context, recreate bool) error
 	CurrentChecksum() (string, error)
 }
@@ -154,55 +157,79 @@ func (s *Service) applyIfNeeded(ctx context.Context, mode string, startup bool,
 	mainConfigChecksum := checksumString(config.MainConfig)
 	routeConfigChecksum := checksumString(routeConfig)
 	slog.Info("applying new openresty config", "mode", mode, "from_version", snapshot.CurrentVersion, "to_version", config.Version, "old_checksum", currentChecksum, "new_checksum", config.Checksum)
-	if err := s.nginxManager.Apply(ctx, config.MainConfig, routeConfig, config.SupportFiles); err != nil {
-		slog.Error("apply openresty config failed", "mode", mode, "version", config.Version, "error", err)
-		snapshot.LastError = err.Error()
-		snapshot.OpenrestyStatus = protocol.OpenrestyStatusUnhealthy
-		snapshot.OpenrestyMessage = err.Error()
-		_ = s.stateStore.Save(snapshot)
-		reportErr := s.client.ReportApplyLog(ctx, protocol.ApplyLogPayload{
-			NodeID:              snapshot.NodeID,
-			Version:             config.Version,
-			Result:              ApplyResultFailed,
-			Message:             err.Error(),
-			Checksum:            config.Checksum,
-			MainConfigChecksum:  mainConfigChecksum,
-			RouteConfigChecksum: routeConfigChecksum,
-			SupportFileCount:    len(config.SupportFiles),
-		})
-		if reportErr != nil {
-			slog.Error("report failed apply log failed", "version", config.Version, "error", reportErr)
-			return reportErr
+	outcome := s.nginxManager.Apply(ctx, config.MainConfig, routeConfig, config.SupportFiles)
+	message := strings.TrimSpace(outcome.Message)
+	if outcome.Status == "" {
+		outcome.Status = nginx.ApplyStatusFatal
+		if message == "" {
+			message = "openresty apply returned empty outcome"
 		}
-		slog.Warn("failed apply log reported", "version", config.Version)
-		return err
 	}
-	slog.Info("openresty config applied successfully", "mode", mode, "version", config.Version)
-	snapshot.CurrentVersion = config.Version
-	snapshot.CurrentChecksum = config.Checksum
-	snapshot.LastError = ""
-	snapshot.OpenrestyStatus = protocol.OpenrestyStatusHealthy
-	snapshot.OpenrestyMessage = ""
+
+	reportResult := ApplyResultFailed
+	switch outcome.Status {
+	case nginx.ApplyStatusSuccess:
+		slog.Info("openresty config applied successfully", "mode", mode, "version", config.Version)
+		snapshot.CurrentVersion = config.Version
+		snapshot.CurrentChecksum = config.Checksum
+		snapshot.LastError = ""
+		snapshot.OpenrestyStatus = protocol.OpenrestyStatusHealthy
+		snapshot.OpenrestyMessage = ""
+		reportResult = ApplyResultSuccess
+		if message == "" {
+			message = "apply success"
+		}
+	case nginx.ApplyStatusWarning:
+		if message == "" {
+			message = "apply rolled back to previous config"
+		}
+		slog.Warn("openresty config apply rolled back", "mode", mode, "version", config.Version, "message", message)
+		snapshot.LastError = message
+		snapshot.OpenrestyStatus = protocol.OpenrestyStatusHealthy
+		snapshot.OpenrestyMessage = message
+		reportResult = ApplyResultWarning
+	default:
+		if message == "" {
+			message = "openresty apply failed"
+		}
+		slog.Error("apply openresty config failed", "mode", mode, "version", config.Version, "message", message)
+		snapshot.LastError = message
+		snapshot.OpenrestyStatus = protocol.OpenrestyStatusUnhealthy
+		snapshot.OpenrestyMessage = message
+	}
+
 	if err := s.stateStore.Save(snapshot); err != nil {
 		return err
 	}
 	if err := s.client.ReportApplyLog(ctx, protocol.ApplyLogPayload{
 		NodeID:              snapshot.NodeID,
 		Version:             config.Version,
-		Result:              ApplyResultSuccess,
-		Message:             "apply success",
+		Result:              reportResult,
+		Message:             message,
 		Checksum:            config.Checksum,
 		MainConfigChecksum:  mainConfigChecksum,
 		RouteConfigChecksum: routeConfigChecksum,
 		SupportFileCount:    len(config.SupportFiles),
 	}); err != nil {
-		slog.Error("report successful apply log failed", "version", config.Version, "error", err)
+		slog.Error("report apply log failed", "version", config.Version, "result", reportResult, "error", err)
 		return err
 	}
-	slog.Debug("successful apply log reported", "version", config.Version)
+	if reportResult == ApplyResultFailed {
+		slog.Warn("failed apply log reported", "version", config.Version)
+		return outcomeError(config.Version, message)
+	}
+	slog.Debug("apply log reported", "version", config.Version, "result", reportResult)
 	return nil
 }

+func outcomeError(version string, message string) error {
+	trimmed := strings.TrimSpace(message)
+	if trimmed == "" {
+		trimmed = "openresty apply failed"
+	}
+	return fmt.Errorf("apply version %s failed: %s", version, trimmed)
+}
+
 func checksumString(content string) string {
 	sum := sha256.Sum256([]byte(content))
 	return hex.EncodeToString(sum[:])
@@ -24,7 +24,7 @@ type fakeClient struct {
 }

 type fakeManager struct {
-	applyErr           error
+	applyOutcome       nginx.ApplyOutcome
 	currentChecksum    string
 	currentChecksumErr error
 	ensureErr          error
@@ -64,11 +64,14 @@ func (f *fakeClient) ReportApplyLog(ctx context.Context, payload protocol.ApplyL
 	return nil
 }

-func (m *fakeManager) Apply(ctx context.Context, mainConfig string, routeConfig string, supportFiles []protocol.SupportFile) error {
+func (m *fakeManager) Apply(ctx context.Context, mainConfig string, routeConfig string, supportFiles []protocol.SupportFile) nginx.ApplyOutcome {
 	m.applyMainContents = append(m.applyMainContents, mainConfig)
 	m.applyRouteContents = append(m.applyRouteContents, routeConfig)
 	m.applyFiles = append(m.applyFiles, append([]protocol.SupportFile(nil), supportFiles...))
-	return m.applyErr
+	if m.applyOutcome.Status == "" {
+		return nginx.ApplyOutcome{Status: nginx.ApplyStatusSuccess}
+	}
+	return m.applyOutcome
 }

 func (m *fakeManager) EnsureRuntime(ctx context.Context, recreate bool) error {
@@ -166,17 +169,7 @@ func TestSyncOnceRollbackOnNginxFailure(t *testing.T) {
 		},
 	}

-	tempDir := t.TempDir()
-	mainPath := filepath.Join(tempDir, "nginx.conf")
-	routePath := filepath.Join(tempDir, "routes.conf")
-	if err := os.WriteFile(mainPath, []byte("worker_processes auto;"), 0o644); err != nil {
-		t.Fatalf("failed to seed main file: %v", err)
-	}
-	if err := os.WriteFile(routePath, []byte("server { listen 80; }"), 0o644); err != nil {
-		t.Fatalf("failed to seed route file: %v", err)
-	}
-
-	stateStore := state.NewStore(filepath.Join(tempDir, "state.json"))
+	stateStore := state.NewStore(filepath.Join(t.TempDir(), "state.json"))
 	nodeID, err := stateStore.EnsureNodeID()
 	if err != nil {
 		t.Fatalf("EnsureNodeID failed: %v", err)
@@ -189,11 +182,10 @@ func TestSyncOnceRollbackOnNginxFailure(t *testing.T) {
 		t.Fatalf("failed to seed state: %v", err)
 	}

-	service := New(client, &nginx.Manager{
-		MainConfigPath:  mainPath,
-		RouteConfigPath: routePath,
-		Executor: &fakeExecutor{
-			testErr: context.DeadlineExceeded,
+	service := New(client, &fakeManager{
+		applyOutcome: nginx.ApplyOutcome{
+			Status:  nginx.ApplyStatusFatal,
+			Message: "openresty failed after rollback",
 		},
 	}, stateStore)

@@ -202,22 +194,7 @@ func TestSyncOnceRollbackOnNginxFailure(t *testing.T) {
 		Checksum: client.config.Checksum,
 	})
 	if err == nil {
-		t.Fatal("expected SyncOnce to fail when nginx test fails")
-	}
-
-	data, readErr := os.ReadFile(routePath)
-	if readErr != nil {
-		t.Fatalf("failed to read route file after rollback: %v", readErr)
-	}
-	if string(data) != "server { listen 80; }" {
-		t.Fatal("expected original route config to be restored after rollback")
-	}
-	mainData, readErr := os.ReadFile(mainPath)
-	if readErr != nil {
-		t.Fatalf("failed to read main file after rollback: %v", readErr)
-	}
-	if string(mainData) != "worker_processes auto;" {
-		t.Fatal("expected original main config to be restored after rollback")
+		t.Fatal("expected SyncOnce to fail when apply outcome is fatal")
 	}
 	snapshot, loadErr := stateStore.Load()
 	if loadErr != nil {
@@ -226,6 +203,9 @@ func TestSyncOnceRollbackOnNginxFailure(t *testing.T) {
 	if snapshot.CurrentVersion != "20260309-001" {
 		t.Fatal("expected failed sync not to overwrite current version")
 	}
+	if snapshot.OpenrestyStatus != protocol.OpenrestyStatusUnhealthy {
+		t.Fatalf("expected unhealthy openresty status, got %q", snapshot.OpenrestyStatus)
+	}
 	if len(client.reports) != 1 || client.reports[0].Result != ApplyResultFailed {
 		t.Fatal("expected failed apply report to be sent")
 	}
@@ -240,6 +220,64 @@ func TestSyncOnceRollbackOnNginxFailure(t *testing.T) {
 	}
 }

+func TestSyncOnceReportsWarningWhenRollbackKeepsOpenrestyHealthy(t *testing.T) {
+	client := &fakeClient{
+		config: protocol.ActiveConfigResponse{
+			Version:        "20260309-002",
+			Checksum:       "checksum-2",
+			MainConfig:     "worker_processes 2;",
+			RouteConfig:    "server { listen 81; }",
+			RenderedConfig: "server { listen 81; }",
+			SupportFiles:   []protocol.SupportFile{{Path: "1.crt", Content: "cert"}},
+			CreatedAt:      time.Now().Format(time.RFC3339),
+		},
+	}
+
+	stateStore := state.NewStore(filepath.Join(t.TempDir(), "state.json"))
+	nodeID, err := stateStore.EnsureNodeID()
+	if err != nil {
+		t.Fatalf("EnsureNodeID failed: %v", err)
+	}
+	if err = stateStore.Save(&state.Snapshot{
+		NodeID:          nodeID,
+		CurrentVersion:  "20260309-001",
+		CurrentChecksum: "checksum-1",
+	}); err != nil {
+		t.Fatalf("failed to seed state: %v", err)
+	}
+
+	service := New(client, &fakeManager{
+		applyOutcome: nginx.ApplyOutcome{
+			Status:  nginx.ApplyStatusWarning,
+			Message: "apply failed, rolled back to previous config",
+		},
+	}, stateStore)
+
+	if err = service.SyncOnce(context.Background(), &protocol.ActiveConfigMeta{
+		Version:  client.config.Version,
+		Checksum: client.config.Checksum,
+	}); err != nil {
+		t.Fatalf("expected warning outcome to keep sync successful, got %v", err)
+	}
+
+	snapshot, err := stateStore.Load()
+	if err != nil {
+		t.Fatalf("failed to load state: %v", err)
+	}
+	if snapshot.CurrentVersion != "20260309-001" || snapshot.CurrentChecksum != "checksum-1" {
+		t.Fatal("expected warning apply to keep previous version state")
+	}
+	if snapshot.OpenrestyStatus != protocol.OpenrestyStatusHealthy {
+		t.Fatalf("expected healthy openresty after rollback, got %q", snapshot.OpenrestyStatus)
+	}
+	if snapshot.LastError == "" {
+		t.Fatal("expected rollback warning to be recorded")
+	}
+	if len(client.reports) != 1 || client.reports[0].Result != ApplyResultWarning {
+		t.Fatal("expected warning apply report to be sent")
+	}
+}
+
 func TestSyncOnStartupRecreatesRuntimeWhenChecksumMatches(t *testing.T) {
 	client := &fakeClient{
 		config: protocol.ActiveConfigResponse{