refactor(libreoffice): classify Pdf errors and set span error.type

This commit is contained in:
Julien Neuhart
2026-06-02 19:07:26 +02:00
parent 8e1ab0110f
commit 525102b991
2 changed files with 53 additions and 12 deletions
+20 -12
View File
@@ -635,20 +635,11 @@ func (a *Api) Pdf(ctx context.Context, logger *slog.Logger, inputPath, outputPat
reason := ""
if err != nil {
switch {
case errors.Is(err, context.DeadlineExceeded):
status = "error"
if errors.Is(err, context.DeadlineExceeded) {
status = "timeout"
reason = "timeout"
case errors.Is(err, context.Canceled):
status = "error"
reason = "context_cancelled"
case errors.Is(err, gotenberg.ErrMaximumQueueSizeExceeded) || errors.Is(err, gotenberg.ErrProcessAlreadyRestarting):
status = "error"
reason = "libreoffice_unavailable"
default:
status = "error"
reason = "unknown"
}
reason = libreofficeErrorType(err)
}
// Record metrics.
@@ -657,6 +648,7 @@ func (a *Api) Pdf(ctx context.Context, logger *slog.Logger, inputPath, outputPat
if reason != "" {
a.errsCounter.Add(ctx, 1, metric.WithAttributes(attribute.String("reason", reason)))
gotenberg.SpanErrorType(span, reason)
}
if !conversionStart.IsZero() {
@@ -688,6 +680,22 @@ func (a *Api) Pdf(ctx context.Context, logger *slog.Logger, inputPath, outputPat
return fmt.Errorf("supervisor run task: %w", err)
}
// libreofficeErrorType maps a conversion error to LibreOffice's bounded reason
// value, reused as the span error.type. Generic failures fall back to
// [gotenberg.ClassifyError].
func libreofficeErrorType(err error) string {
switch {
case errors.Is(err, ErrInvalidPdfFormats):
return gotenberg.ErrorTypeInvalidInput
case errors.Is(err, ErrUnoException), errors.Is(err, ErrRuntimeException):
return "libreoffice_exception"
case errors.Is(err, gotenberg.ErrMaximumQueueSizeExceeded), errors.Is(err, gotenberg.ErrProcessAlreadyRestarting):
return "libreoffice_unavailable"
default:
return gotenberg.ClassifyError(err)
}
}
// Extensions returns the file extensions available for conversions.
// FIXME: don't care, take all on the route level?
func (a *Api) Extensions() []string {
@@ -0,0 +1,33 @@
package api
import (
"context"
"errors"
"testing"
"github.com/gotenberg/gotenberg/v8/pkg/gotenberg"
)
func TestLibreofficeErrorType(t *testing.T) {
for _, tc := range []struct {
name string
err error
want string
}{
{"deadline", context.DeadlineExceeded, "timeout"},
{"canceled", context.Canceled, "context_cancelled"},
{"invalid pdf formats", ErrInvalidPdfFormats, "invalid_input"},
{"uno exception", ErrUnoException, "libreoffice_exception"},
{"runtime exception", ErrRuntimeException, "libreoffice_exception"},
{"queue size exceeded", gotenberg.ErrMaximumQueueSizeExceeded, "libreoffice_unavailable"},
{"process restarting", gotenberg.ErrProcessAlreadyRestarting, "libreoffice_unavailable"},
{"core dumped", ErrCoreDumped, "unknown"},
{"unknown", errors.New("boom"), "unknown"},
} {
t.Run(tc.name, func(t *testing.T) {
if got := libreofficeErrorType(tc.err); got != tc.want {
t.Errorf("libreofficeErrorType(%v) = %q, want %q", tc.err, got, tc.want)
}
})
}
}