clienterrors: add (one possible) way to fix the missing errors

osbuild · May 8, 2024 · bba6087 · bba6087
1 parent 7316e67
commit bba6087
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 4 deletions.
diff --git a/internal/worker/clienterrors/errors.go b/internal/worker/clienterrors/errors.go
@@ -1,6 +1,7 @@
 package clienterrors
 
 import (
+	"encoding/json"
 	"fmt"
 )
 
@@ -49,15 +50,35 @@ const (
 type ClientErrorCode int
 
 type Error struct {
-	ID      ClientErrorCode `json:"id"`
-	Reason  string          `json:"reason"`
-	Details interface{}     `json:"details,omitempty"`
+	ID      ClientErrorCode
+	Reason  string
+	Details interface{}
 }
 
 func (e *Error) String() string {
 	return fmt.Sprintf("Code: %d, Reason: %s, Details: %v", e.ID, e.Reason, e.Details)
 }
 
+func (e *Error) MarshalJSON() ([]byte, error) {
+	var details interface{}
+	switch v := e.Details.(type) {
+	case error:
+		details = v.Error()
+	default:
+		details = v
+	}
+
+	return json.Marshal(&struct {
+		ID      ClientErrorCode `json:"id"`
+		Reason  string          `json:"reason"`
+		Details interface{}     `json:"details,omitempty"`
+	}{
+		ID:      e.ID,
+		Reason:  e.Reason,
+		Details: details,
+	})
+}
+
 const (
 	JobStatusSuccess        = "2xx"
 	JobStatusUserInputError = "4xx"

diff --git a/internal/worker/clienterrors/errors_test.go b/internal/worker/clienterrors/errors_test.go
@@ -34,5 +34,5 @@ func TestErrorJSONMarshal(t *testing.T) {
 
 	json, err := json.Marshal(clienterrors.WorkerClientError(2, "details", err))
 	assert.NoError(t, err)
-	assert.Equal(t, `{"id":2,"reason":"details","details":{"some-error"}}`, string(json))
+	assert.Equal(t, `{"id":2,"reason":"details","details":"some-error"}`, string(json))
 }