feat: add panic handling for all the plugin handlers (#287)

Skarlso · web-flow · commit c7f0912ab5fd · 2025-06-26T14:50:27.000+02:00
Signed-off-by: Gergely Brautigam &lt;182850+Skarlso@users.noreply.github.com&gt;
diff --git a/bindings/go/plugin/client/sdk/plugin.go b/bindings/go/plugin/client/sdk/plugin.go
@@ -150,7 +150,7 @@ func (p *Plugin) listen(ctx context.Context) error {
 
 	m := http.NewServeMux()
 	for _, h := range p.handlers {
-		m.HandleFunc(h.Location, h.Handler)
+		m.HandleFunc(h.Location, p.panicRecovery(h.Handler))
 	}
 
 	m.HandleFunc("/shutdown", p.Shutdown)
@@ -186,6 +186,22 @@ func (p *Plugin) listen(ctx context.Context) error {
 	return server.Serve(conn)
 }
 
+func (p *Plugin) panicRecovery(f func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		defer func() {
+			if err := recover(); err != nil {
+				p.logger.ErrorContext(r.Context(), "panic recovered", "error", err)
+				plugins.NewError(
+					errors.New("panic recovered"),
+					http.StatusInternalServerError).
+					Write(w)
+			}
+		}()
+
+		f(w, r)
+	}
+}
+
 func (p *Plugin) determineLocation() (_ string, err error) {
 	switch p.Config.Type {
 	case types.Socket:
diff --git a/bindings/go/plugin/client/sdk/plugin_test.go b/bindings/go/plugin/client/sdk/plugin_test.go
@@ -201,6 +201,45 @@ func TestHealthCheckInvalidMethod(t *testing.T) {
 	r.Contains(string(content), "this endpoint may only be called with either HEAD or GET method")
 }
 
+func TestPanicRecovery(t *testing.T) {
+	r := require.New(t)
+	location := "/tmp/test-plugin-panic-plugin.socket"
+	output := bytes.NewBuffer(nil)
+	ctx := context.Background()
+	p := NewPlugin(ctx, slog.Default(), types.Config{
+		ID:         "test-plugin-panic",
+		Type:       types.Socket,
+		PluginType: types.ComponentVersionRepositoryPluginType,
+	}, output)
+
+	t.Cleanup(func() {
+		r.NoError(os.RemoveAll(location))
+	})
+
+	r.NoError(p.RegisterHandlers(endpoints.Handler{
+		Handler: func(writer http.ResponseWriter, request *http.Request) {
+			panic("test panic")
+		},
+		Location: "/panic-endpoint",
+	}))
+
+	go func() {
+		_ = p.Start(ctx)
+	}()
+
+	httpClient := createHttpClient(location)
+	waitForPlugin(r, httpClient)
+
+	resp, err := httpClient.Get("http://unix/panic-endpoint")
+	r.NoError(err)
+	r.Equal(http.StatusInternalServerError, resp.StatusCode)
+	content, err := io.ReadAll(resp.Body)
+	r.NoError(err)
+	r.Contains(string(content), "panic recovered")
+
+	r.NoError(p.GracefulShutdown(ctx))
+}
+
 func waitForPlugin(r *require.Assertions, httpClient *http.Client) {
 	r.Eventually(func() bool {
 		resp, err := httpClient.Get("http://unix/healthz")
