chore: Bastei Bridge 3.12.0 changelog.

Changelog.md

@@ -3,6 +3,27 @@
 Changelog [format](http://keepachangelog.com/en/1.0.0/)
 
 
+## Bastei Bridge 3.12.0
+
+### Added
+* BRIDGE-75: Bridge repair button.
+* BRIDGE-79: Add New Outlook for Mac KB disclaimer.
+
+### Changed
+* BRIDGE-16: Bump version Go 1.21.9 Qt 6.4.3.
+* BRIDGE-23: Update gluon to go 1.21.
+* BRIDGE-22: Update gpa to go 1.21.
+
+### Fixed
+* BRIDGE-90: Disable repair button when bridge cannot connect to proton servers; bump GPA.
+* BRIDGE-69: Explicitly handle semver panic for last bridge version from vault.
+* BRIDGE-29: Bump gluon version.
+* BRIDGE-49: Configure gitleaks baseline and grype config.
+* BRIDGE-21: Missing panic handling.
+* BRIDGE-17: Broken telemetry heartbeat test.
+* BRIDGE-10: Bumped gluon version.
+
+
 ## Alcantara Bridge 3.11.1
 
 ### Fixed

Makefile

@@ -12,7 +12,7 @@ ROOT_DIR:=$(realpath .)
 .PHONY: build build-gui build-nogui build-launcher versioner hasher
 
 # Keep version hardcoded so app build works also without Git repository.
-BRIDGE_APP_VERSION?=3.11.1+git
+BRIDGE_APP_VERSION?=3.12.0+git
 APP_VERSION:=${BRIDGE_APP_VERSION}
 APP_FULL_NAME:=Proton Mail Bridge
 APP_VENDOR:=Proton AG

internal/bridge/bridge.go

@@ -573,7 +573,7 @@ func (bridge *Bridge) Repair() {
 		wg.Add(1)
 		go func(userID string) {
 			defer wg.Done()
-			if err = bridgeUser.ResyncIMAP(); err != nil {
+			if err = bridgeUser.TriggerRepair(); err != nil {
 				logPkg.WithError(err).Error("Failed re-syncing IMAP for userID", userID)
 			}
 		}(userID)

internal/kb/kbArticleList.json

@@ -432,19 +432,28 @@
       "Sending",
       "Outlook",
       "Configuration",
-      "Sync"
+      "Sync",
+      "New Outlook"
     ]
   },
   {
     "index": 38,
     "url": "https://proton.me/support/proton-mail-bridge-new-outlook-for-windows-set-up-guide",
+    "title": "What is the Recovered Messages folder in Bridge (and your email client)?",
+    "keywords": [
+      "recovered messages",
+      "recovered messages folder"
+    ]
+  },
+  {
+    "index": 39,
+    "url": "https://proton.me/support/proton-mail-bridge-new-outlook-for-windows-set-up-guide",
     "title": "Proton Mail Bridge New Outlook for Windows set up guide",
     "keywords": [
-      "Outlook",
+      "app password",
-      "New Outlook",
+      "INVALIDCREDENTIALS",
-      "Configuration",
+      "TEMPORARILYUNAVAILABLE",
-      "Configure",
+      "New Outlook"
-      "Setup"
     ]
   }
 ]

internal/telemetry/repair.go

@@ -0,0 +1,43 @@
+// Copyright (c) 2024 Proton AG
+//
+// This file is part of Proton Mail Bridge.
+//
+// Proton Mail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Proton Mail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Proton Mail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package telemetry
+
+type RepairData struct {
+	MeasurementGroup string
+	Event            string
+	Values           map[string]string
+	Dimensions       map[string]string
+}
+
+func NewRepairTriggerData() RepairData {
+	return RepairData{
+		MeasurementGroup: "bridge.any.repair",
+		Event:            "repair_trigger",
+		Values:           map[string]string{},
+		Dimensions:       map[string]string{},
+	}
+}
+
+func NewRepairDeferredTriggerData() RepairData {
+	return RepairData{
+		MeasurementGroup: "bridge.any.repair",
+		Event:            "repair_deferred_trigger",
+		Values:           map[string]string{},
+		Dimensions:       map[string]string{},
+	}
+}

internal/user/repair_telemetry.go

@@ -0,0 +1,65 @@
+// Copyright (c) 2024 Proton AG
+//
+// This file is part of Proton Mail Bridge.
+//
+// Proton Mail Bridge is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Proton Mail Bridge is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Proton Mail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package user
+
+import (
+	"context"
+	"encoding/json"
+
+	"github.com/ProtonMail/proton-bridge/v3/internal/telemetry"
+)
+
+func (user *User) SendRepairTrigger(ctx context.Context) {
+	if !user.IsTelemetryEnabled(ctx) {
+		return
+	}
+
+	triggerData := telemetry.NewRepairTriggerData()
+	data, err := json.Marshal(triggerData)
+	if err != nil {
+		user.log.WithError(err).Error("Failed to parse repair trigger data.")
+		return
+	}
+
+	if err := user.SendTelemetry(ctx, data); err != nil {
+		user.log.WithError(err).Error("Failed to send repair trigger event.")
+		return
+	}
+
+	user.log.Info("Repair trigger event successfully sent.")
+}
+
+func (user *User) SendRepairDeferredTrigger(ctx context.Context) {
+	if !user.IsTelemetryEnabled(ctx) {
+		return
+	}
+
+	deferredTriggerData := telemetry.NewRepairDeferredTriggerData()
+	data, err := json.Marshal(deferredTriggerData)
+	if err != nil {
+		user.log.WithError(err).Error("Failed to parse deferred repair trigger data.")
+		return
+	}
+
+	if err := user.SendTelemetry(ctx, data); err != nil {
+		user.log.WithError(err).Error("Failed to send deferred repair trigger event.")
+		return
+	}
+
+	user.log.Info("Deferred repair trigger event successfully sent.")
+}

internal/user/user.go

@@ -727,12 +727,18 @@ func (user *User) VerifyResyncAndExecute() {
 			user.log.WithError(err).Error("Failed to disable re-sync flag in user vault. UserID:", user.ID())
 		}
 
-		if err := user.ResyncIMAP(); err != nil {
+		user.SendRepairDeferredTrigger(context.Background())
+		if err := user.resyncIMAP(); err != nil {
 			user.log.WithError(err).Error("Failed re-syncing IMAP for userID", user.ID())
 		}
 	}
 }
 
-func (user *User) ResyncIMAP() error {
+func (user *User) TriggerRepair() error {
+	user.SendRepairTrigger(context.Background())
+	return user.resyncIMAP()
+}
+
+func (user *User) resyncIMAP() error {
 	return user.imapService.Resync(context.Background())
 }