all: Recover from marshalling event data panic

TheThingsNetwork · Dec 5, 2024 · 9e374c3 · 9e374c3
1 parent d17525f
commit 9e374c3
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/config/messages.json b/config/messages.json
@@ -4832,6 +4832,15 @@
       "file": "pattern.go"
     }
   },
+  "error:pkg/events:marshal_data": {
+    "translations": {
+      "en": "failed to marshal data"
+    },
+    "description": {
+      "package": "pkg/events",
+      "file": "events.go"
+    }
+  },
   "error:pkg/events:no_matching_events": {
     "translations": {
       "en": "no matching events for regexp `{regexp}`"

diff --git a/pkg/events/events.go b/pkg/events/events.go
@@ -25,7 +25,9 @@ import (
 	"strings"
 	"time"
 
+	"github.com/getsentry/sentry-go"
 	"go.thethings.network/lorawan-stack/v3/pkg/errors"
+	sentryerrors "go.thethings.network/lorawan-stack/v3/pkg/errors/sentry"
 	"go.thethings.network/lorawan-stack/v3/pkg/goproto"
 	"go.thethings.network/lorawan-stack/v3/pkg/jsonpb"
 	"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
@@ -176,7 +178,25 @@ func New(ctx context.Context, name, description string, opts ...Option) Event {
 	return (&definition{name: name, description: description}).New(ctx, opts...)
 }
 
+var errMarshalData = errors.Define("marshal_data", "failed to marshal data")
+
 func marshalData(data any) (anyPB *anypb.Any, err error) {
+	defer func() {
+		if p := recover(); p != nil {
+			if pErr, ok := p.(error); ok {
+				err = errMarshalData.WithCause(pErr)
+			} else {
+				err = errMarshalData.WithAttributes("panic", p)
+			}
+			event := sentryerrors.NewEvent(err)
+			sentry.CaptureEvent(event)
+		}
+	}()
+
+	return mustMarshalData(data)
+}
+
+func mustMarshalData(data any) (anyPB *anypb.Any, err error) {
 	if protoMessage, ok := data.(proto.Message); ok {
 		anyPB, err = anypb.New(protoMessage)
 		if err != nil {

diff --git a/pkg/webui/locales/ja.json b/pkg/webui/locales/ja.json
@@ -2362,6 +2362,7 @@
   "error:pkg/events/redis:channel_closed": "チャネルが閉じています",
   "error:pkg/events/redis:unknown_encoding": "不明なエンコーディング",
   "error:pkg/events:invalid_regexp": "無効な正規表現",
+  "error:pkg/events:marshal_data": "",
   "error:pkg/events:no_matching_events": "正規表現`{regexp}`に一致するイベントがありません",
   "error:pkg/events:unknown_event_name": "不明なイベント`{name}`",
   "error:pkg/fetch:fetch_file": "ファイル `{filename}` を取得できません",