Launcher, app/base, sentry, update service

internal/crash/actions.go

@@ -0,0 +1,42 @@
+// Copyright (c) 2020 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.
+//
+// ProtonMail 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.
+//
+// ProtonMail 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 ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package crash
+
+import (
+	"fmt"
+
+	"github.com/0xAX/notificator"
+)
+
+// ShowErrorNotification shows a system notification that the app with the given appName has crashed.
+// NOTE: Icons shouldn't be hardcoded.
+func ShowErrorNotification(appName string) RecoveryAction {
+	return func(r interface{}) error {
+		notify := notificator.New(notificator.Options{
+			DefaultIcon: "../frontend/ui/icon/icon.png",
+			AppName:     appName,
+		})
+
+		return notify.Push(
+			"Fatal Error",
+			fmt.Sprintf("%v has encountered a fatal error.", appName),
+			"/frontend/icon/icon.png",
+			notificator.UR_CRITICAL,
+		)
+	}
+}

internal/crash/handler.go

@@ -0,0 +1,54 @@
+// Copyright (c) 2021 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.
+//
+// ProtonMail 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.
+//
+// ProtonMail 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 ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+// Package crash implements a crash handler with configurable recovery actions.
+package crash
+
+import (
+	"github.com/ProtonMail/proton-bridge/pkg/sentry"
+	"github.com/sirupsen/logrus"
+)
+
+type RecoveryAction func(interface{}) error
+
+type Handler struct {
+	actions []RecoveryAction
+}
+
+func NewHandler(actions ...RecoveryAction) *Handler {
+	return &Handler{actions: actions}
+}
+
+func (h *Handler) AddRecoveryAction(action RecoveryAction) *Handler {
+	h.actions = append(h.actions, action)
+	return h
+}
+
+func (h *Handler) HandlePanic() {
+	sentry.SkipDuringUnwind()
+
+	r := recover()
+	if r == nil {
+		return
+	}
+
+	for _, action := range h.actions {
+		if err := action(r); err != nil {
+			logrus.WithError(err).Error("Failed to execute recovery action")
+		}
+	}
+}

internal/crash/handler_test.go

@@ -0,0 +1,58 @@
+// Copyright (c) 2021 Proton Technologies AG
+//
+// This file is part of ProtonMail Bridge.
+//
+// ProtonMail 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.
+//
+// ProtonMail 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 ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.
+
+package crash
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestHandler(t *testing.T) {
+	var s string
+
+	h := NewHandler(
+		func(r interface{}) error {
+			s += fmt.Sprintf("1: %v\n", r)
+			return nil
+		},
+		func(r interface{}) error {
+			s += fmt.Sprintf("2: %v\n", r)
+			return nil
+		},
+	)
+
+	h.
+		AddRecoveryAction(func(r interface{}) error {
+			s += fmt.Sprintf("3: %v\n", r)
+			return nil
+		}).
+		AddRecoveryAction(func(r interface{}) error {
+			s += fmt.Sprintf("4: %v\n", r)
+			return nil
+		})
+
+	defer func() {
+		assert.Equal(t, "1: thing\n2: thing\n3: thing\n4: thing\n", s)
+	}()
+
+	defer h.HandlePanic()
+
+	panic("thing")
+}