feat(GODT-2713): Send config_progress event once a day if the configuration is stucked in pending for more than a day.

internal/configstatus/configuration_progress.go

@@ -17,4 +17,41 @@
 
 package configstatus
 
-// GODT-2713
+import "time"
+
+type ConfigProgressValues struct {
+	NbDay          int `json:"nb_day"`
+	NbDaySinceLast int `json:"nb_day_since_last"`
+}
+
+type ConfigProgressData struct {
+	MeasurementGroup string
+	Event            string
+	Values           ConfigProgressValues
+	Dimensions       struct{}
+}
+
+type ConfigProgressBuilder struct{}
+
+func (*ConfigProgressBuilder) New(data *ConfigurationStatusData) ConfigProgressData {
+	return ConfigProgressData{
+		MeasurementGroup: "bridge.any.configuration",
+		Event:            "bridge_config_progress",
+		Values: ConfigProgressValues{
+			NbDay:          numberOfDay(time.Now(), data.DataV1.PendingSince),
+			NbDaySinceLast: numberOfDay(time.Now(), data.DataV1.LastProgress),
+		},
+	}
+}
+
+func numberOfDay(now, prev time.Time) int {
+	if now.Year() > prev.Year() {
+		if now.YearDay() > prev.YearDay() {
+			return 365 + (now.YearDay() - prev.YearDay())
+		}
+		return (prev.YearDay() + now.YearDay()) - 365
+	} else if now.YearDay() > prev.YearDay() {
+		return now.YearDay() - prev.YearDay()
+	}
+	return 0
+}

internal/configstatus/types_config_status.go

@@ -23,6 +23,8 @@ import (
 	"github.com/ProtonMail/proton-bridge/v3/internal/safe"
 )
 
+const ProgressCheckInterval = time.Hour
+
 type Metadata struct {
 	Version string `json:"version"`
 }

internal/user/config_status.go

@@ -82,4 +82,33 @@ func (user *User) SendConfigStatusRecovery() {
 }
 
 func (user *User) SendConfigStatusProgress() {
+	if !user.telemetryManager.IsTelemetryAvailable() {
+		return
+	}
+	if !user.configStatus.IsPending() {
+		return
+	}
+
+	var builder configstatus.ConfigProgressBuilder
+	progress := builder.New(user.configStatus.Data)
+	if progress.Values.NbDaySinceLast == 0 || progress.Values.NbDay == 0 {
+		return
+	}
+
+	data, err := json.Marshal(progress)
+	if err != nil {
+		if err := user.reporter.ReportMessageWithContext("Cannot parse config_progress data.", reporter.Context{
+			"error": err,
+		}); err != nil {
+			user.log.WithError(err).Error("Failed to report config_progress data parsing error.")
+		}
+		return
+	}
+
+	if err := user.SendTelemetry(context.Background(), data); err == nil {
+		user.log.Info("Configuration Status Progress event sent.")
+		if err := user.configStatus.ApplyProgress(); err != nil {
+			user.log.WithError(err).Error("Failed to ApplyProgress on config_status.")
+		}
+	}
 }

internal/user/user.go

@@ -98,6 +98,8 @@ type User struct {
 
 	configStatus     *configstatus.ConfigurationStatus
 	telemetryManager telemetry.Availability
+	// goStatusProgress triggers a check/sending if progress is needed.
+	goStatusProgress func()
 }
 
 // New returns a new user.
@@ -176,6 +178,12 @@ func New(
 		telemetryManager: telemetryManager,
 	}
 
+	// Check for status_progress when triggered.
+	user.goStatusProgress = user.tasks.PeriodicOrTrigger(configstatus.ProgressCheckInterval, 0, func(ctx context.Context) {
+		user.SendConfigStatusProgress()
+	})
+	defer user.goStatusProgress()
+
 	// Initialize the user's update channels for its current address mode.
 	user.initUpdateCh(encVault.AddressMode())