User report cleanup (#2367)

* ensure user report cleanup time isn't too low

* add log

* push settings read to SQL

* comments

Author: mikehelmick

pkg/config/cleanup_server_config.go

@@ -77,7 +77,7 @@ type CleanupConfig struct {
 	VerificationTokenMaxAge      time.Duration `env:"VERIFICATION_TOKEN_MAX_AGE, default=24h"`
 
 	// UserReportUnclaimedMaxAge is how long a user report phone hash will be kept if the record goes unclaimed.
-	UserReportUnclaimedMaxAge time.Duration `env:"USER_REPORT_UNCLAIMED_MAX_AGE, default=30m"`
+	UserReportUnclaimedMaxAge time.Duration `env:"USER_REPORT_UNCLAIMED_MAX_AGE, default=60m"`
 	// UserReportMaxAge is how long a claimed user report phone hash will be kept.
 	UserReportMaxAge time.Duration `env:"USER_REPORT_MAX_AGE, default=720h"` // 720h = 30 days
 }

pkg/controller/cleanup/handle_cleanup.go

@@ -266,7 +266,20 @@ func (c *Controller) HandleCleanup() http.Handler {
 		func() {
 			defer enobs.RecordLatency(ctx, time.Now(), mLatencyMs, &result, &item)
 			item = tag.Upsert(itemTagKey, "UNCLAIMED_USER_REPORTS")
-			if count, err := c.db.PurgeUnclaimedUserReports(c.config.UserReportUnclaimedMaxAge); err != nil {
+
+			realmMaxAge, err := c.db.MaximumUserReportTimeout()
+			if err != nil {
+				merr = multierror.Append(merr, fmt.Errorf("failed to determine max user report timeout: %w", err))
+				result = enobs.ResultError("FAILED")
+				return
+			}
+			maxAge := c.config.UserReportMaxAge
+			if realmMaxAge > maxAge {
+				logger.Warnw("overriding user report max age cleanup due to realm settings", "config", c.config.UserPurgeMaxAge, "using", realmMaxAge)
+				maxAge = realmMaxAge
+			}
+
+			if count, err := c.db.PurgeUnclaimedUserReports(maxAge); err != nil {
 				merr = multierror.Append(merr, fmt.Errorf("failed to purge unclaimed user reports: %w", err))
 				result = enobs.ResultError("FAILED")
 			} else {

pkg/database/realm.go

@@ -56,6 +56,7 @@ const (
 	TestTypeLikely
 	TestTypeNegative
 	TestTypeUserReport
+	// if a 5 test type is added, update MaximumUserReportTimeout
 )
 
 func (t TestType) Display() string {
@@ -1294,6 +1295,27 @@ func (r *Realm) ValidTestType(typ string) bool {
 	}
 }
 
+func (db *Database) MaximumUserReportTimeout() (time.Duration, error) {
+	// TestTypeUserReport == 16
+	// If we ever add ANOTHER test type, this statement would need
+	// to be updated.
+	sql := `
+	SELECT
+		MAX(code_duration) AS duration
+	FROM realms
+	WHERE
+	    allowed_test_types >= 16;`
+
+	var result struct {
+		Duration int64 `gorm:"column:duration;"`
+	}
+	if err := db.db.Raw(sql).Scan(&result).Error; err != nil {
+		return 0, err
+	}
+	timeout := time.Duration(result.Duration) * time.Second
+	return timeout, nil
+}
+
 func (db *Database) FindRealmByRegion(region string) (*Realm, error) {
 	var realm Realm
 	if err := db.db.

pkg/database/realm_test.go

@@ -42,6 +42,7 @@ func TestTestType(t *testing.T) {
 		{TestTypeConfirmed, 2},
 		{TestTypeLikely, 4},
 		{TestTypeNegative, 8},
+		{TestTypeUserReport, 16},
 	}
 
 	for _, tc := range cases {
@@ -692,6 +693,46 @@ func TestRealm_FindVerificationCodeByUUID(t *testing.T) {
 	}
 }
 
+func TestRealm_Maximum(t *testing.T) {
+	t.Parallel()
+
+	db, _ := testDatabaseInstance.NewDatabase(t, nil)
+
+	realm1 := NewRealmWithDefaults("realm1")
+	realm1.RegionCode = "US-MOO"
+	realm1.AllowedTestTypes = TestTypeConfirmed | TestTypeUserReport
+	realm1.CodeDuration = FromDuration(15 * time.Minute)
+	if err := db.SaveRealm(realm1, SystemTest); err != nil {
+		t.Fatal(err)
+	}
+
+	realm2 := NewRealmWithDefaults("realm2")
+	realm2.RegionCode = "US-FOO"
+	realm2.AllowedTestTypes = TestTypeConfirmed | TestTypeUserReport
+	realm2.CodeDuration = FromDuration(42 * time.Minute)
+	if err := db.SaveRealm(realm2, SystemTest); err != nil {
+		t.Fatal(err)
+	}
+
+	realm3 := NewRealmWithDefaults("realm3")
+	realm3.RegionCode = "US-BAR"
+	realm3.AllowedTestTypes = TestTypeConfirmed
+	realm3.CodeDuration = FromDuration(59 * time.Minute)
+	if err := db.SaveRealm(realm3, SystemTest); err != nil {
+		t.Fatal(err)
+	}
+
+	maxDuration, err := db.MaximumUserReportTimeout()
+	if err != nil {
+		t.Fatalf("Unable to read max user report timeout: %v", err)
+	}
+
+	want := 42 * time.Minute
+	if want != maxDuration {
+		t.Fatalf("Incorrect max timeout, want: %v ,got: %v", want, maxDuration)
+	}
+}
+
 func TestRealm_FindRealm(t *testing.T) {
 	t.Parallel()