sfe: Periodically import approved rate limit override tickets (#8372)

Author: beautifulentropy

cmd/sfe/main.go

@@ -5,6 +5,7 @@ import (
 	"flag"
 	"net/http"
 	"os"
+	"sync"
 
 	"github.com/jmhodges/clock"
 
@@ -78,6 +79,21 @@ type Config struct {
 			// in this file must be identical to those in the RA.
 			Defaults string `validate:"required_with=Redis"`
 		}
+
+		// OverridesImporter configures the periodic import of approved rate
+		// limit override requests from Zendesk.
+		OverridesImporter struct {
+			// Mode controls which tickets are processed. Valid values are:
+			//   - "all": process all tickets
+			//   - "even": process only tickets with even IDs
+			//   - "odd": process only tickets with odd IDs
+			// If unspecified or empty, defaults to "all".
+			Mode string `validate:"omitempty,required_with=Interval,oneof=all even odd"`
+			// Interval is the amount of time between runs of the importer. If
+			// zero or unspecified, the importer is disabled. Minimum value is
+			// 20 minutes.
+			Interval config.Duration `validate:"omitempty,required_with=Mode,min=1200s"`
+		} `validate:"omitempty,dive"`
 		Features features.Config
 	}
 
@@ -141,6 +157,8 @@ func main() {
 	}
 
 	var zendeskClient *zendesk.Client
+	var overridesImporterShutdown func()
+	var overridesImporterWG sync.WaitGroup
 	if c.SFE.Zendesk != nil {
 		zendeskToken, err := c.SFE.Zendesk.Token.Pass()
 		cmd.FailOnError(err, "Failed to load Zendesk token")
@@ -162,6 +180,30 @@ func main() {
 		if err != nil {
 			cmd.FailOnError(err, "Failed to create Zendesk client")
 		}
+
+		if c.SFE.OverridesImporter.Interval.Duration > 0 {
+			mode := sfe.ProcessMode(c.SFE.OverridesImporter.Mode)
+			if mode == "" {
+				mode = sfe.ProcessAll
+			}
+
+			importer, err := sfe.NewOverridesImporter(
+				mode,
+				c.SFE.OverridesImporter.Interval.Duration,
+				zendeskClient,
+				rac,
+				clk,
+				logger,
+			)
+			cmd.FailOnError(err, "Creating overrides importer")
+
+			var ctx context.Context
+			ctx, overridesImporterShutdown = context.WithCancel(context.Background())
+			overridesImporterWG.Go(func() {
+				importer.Start(ctx)
+			})
+			logger.Infof("Overrides importer started with mode=%s interval=%s", mode, c.SFE.OverridesImporter.Interval.Duration)
+		}
 	}
 
 	var limiter *ratelimits.Limiter
@@ -211,6 +253,10 @@ func main() {
 	defer func() {
 		ctx, cancel := context.WithTimeout(context.Background(), c.SFE.ShutdownStopTimeout.Duration)
 		defer cancel()
+		if overridesImporterShutdown != nil {
+			overridesImporterShutdown()
+			overridesImporterWG.Wait()
+		}
 		_ = srv.Shutdown(ctx)
 		oTelShutdown(ctx)
 	}()

sfe/overrides.go

@@ -47,6 +47,9 @@ const (
 	// reviewStatusDefault is the initial status of a ticket when created.
 	reviewStatusDefault = "review-status-pending"
 
+	// reviewStatusApproved is the status of a ticket when it has been approved.
+	reviewStatusApproved = "review-status-approved"
+
 	// validateOverrideFieldBodyLimit is the maximum size of request body
 	// accepted by validateOverrideFieldHandler. It should be large enough to
 	// accommodate the JSON encoded validationRequest struct, but small enough

sfe/overrides_test.go

@@ -21,10 +21,11 @@ const (
 	apiToken      = "someToken"
 )
 
-func createFakeZendeskClientServer(t *testing.T) *zendesk.Client {
+func createFakeZendeskClientServer(t *testing.T) (*zendeskfake.Server, *zendesk.Client) {
 	t.Helper()
 
-	ts := httptest.NewServer(zendeskfake.NewServer(apiTokenEmail, apiToken, nil).Handler())
+	server := zendeskfake.NewServer(apiTokenEmail, apiToken, nil)
+	ts := httptest.NewServer(server.Handler())
 	t.Cleanup(ts.Close)
 
 	client, err := zendesk.NewClient(ts.URL, apiTokenEmail, apiToken, map[string]int64{
@@ -39,7 +40,7 @@ func createFakeZendeskClientServer(t *testing.T) *zendesk.Client {
 	if err != nil {
 		t.Errorf("NewClient(%q) returned error: %s", ts.URL, err)
 	}
-	return client
+	return server, client
 }
 
 func minimalTemplates(t *testing.T) *template.Template {
@@ -142,7 +143,7 @@ func TestSubmitOverrideRequestHandlerErrors(t *testing.T) {
 
 	sfe, _ := setupSFE(t)
 	sfe.templatePages = minimalTemplates(t)
-	client := createFakeZendeskClientServer(t)
+	_, client := createFakeZendeskClientServer(t)
 	sfe.zendeskClient = client
 	mockPardotClient, mockImpl := mocks.NewMockPardotClientImpl()
 	sfe.ee = mocks.NewMockExporterImpl(mockPardotClient)
@@ -190,7 +191,7 @@ func TestSubmitOverrideRequestHandlerSuccess(t *testing.T) {
 
 	sfe, _ := setupSFE(t)
 	sfe.templatePages = minimalTemplates(t)
-	client := createFakeZendeskClientServer(t)
+	_, client := createFakeZendeskClientServer(t)
 	sfe.zendeskClient = client
 
 	// All of these fields are perfectly valid.
@@ -429,7 +430,7 @@ func TestSubmitOverrideRequestHandlerRateLimited(t *testing.T) {
 
 	sfe, _ := setupSFE(t)
 	sfe.templatePages = minimalTemplates(t)
-	client := createFakeZendeskClientServer(t)
+	_, client := createFakeZendeskClientServer(t)
 	sfe.zendeskClient = client
 
 	for attempt := range 101 {