Add traceID in error logging of stackit api calls

formatting fix

preserve consistent formatting

Author: whtssub

pkg/stackit/client/helper.go

@@ -16,9 +16,10 @@ func withResponseID[T any](ctx context.Context, call func(context.Context) (T, e
 	resp, err := call(ctx)
 	if err != nil {
 		var zero T
+		err = stackiterrors.WrapError(err, "X-Trace-Id", runtime.GetTraceId(ctx))
 		if httpResp != nil {
 			reqID := httpResp.Header.Get(sdkWait.XRequestIDHeader)
-			return zero, stackiterrors.WrapErrorWithResponseID(err, reqID)
+			err = stackiterrors.WrapErrorWithResponseID(err, reqID)
 		}
 		return zero, err
 	}

pkg/stackit/client/helper_test.go

@@ -0,0 +1,27 @@
+package client
+
+import (
+	"context"
+	"errors"
+	"net/http"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+	sdkconfig "github.com/stackitcloud/stackit-sdk-go/core/config"
+)
+
+var _ = Describe("withResponseID", func() {
+	It("wraps API errors with trace and request IDs", func() {
+		_, err := withResponseID(context.Background(), func(ctx context.Context) (int, error) {
+			response, ok := ctx.Value(sdkconfig.ContextHTTPResponse).(**http.Response)
+			Expect(ok).To(BeTrue())
+			*response = &http.Response{Header: http.Header{
+				"X-Trace-Id":   {"trace-123"},
+				"X-Request-Id": {"request-456"},
+			}}
+			return 0, errors.New("api error")
+		})
+
+		Expect(err).To(MatchError("[X-Request-Id:request-456]: [X-Trace-Id:trace-123]: api error"))
+	})
+})

pkg/stackit/stackiterrors/errors.go

@@ -40,16 +40,20 @@ func IgnoreNotFound(err error) error {
 	return err
 }
 
-// WrapErrorWithResponseID wraps the error with the X-Request-Id but only if the error is not nil
-func WrapErrorWithResponseID(err error, reqID string) error {
+// WrapError wraps the error with an identifier but only if the error is not nil.
+func WrapError(err error, name, id string) error {
 	if err == nil {
 		return nil
 	}
-	// if the request id is empty we don't wrap the error
-	if reqID == "" {
+	if id == "" {
 		return err
 	}
-	return fmt.Errorf("[%s:%s]: %w", wait.XRequestIDHeader, reqID, err)
+	return fmt.Errorf("[%s:%s]: %w", name, id, err)
+}
+
+// WrapErrorWithResponseID wraps the error with the X-Request-Id.
+func WrapErrorWithResponseID(err error, reqID string) error {
+	return WrapError(err, wait.XRequestIDHeader, reqID)
 }
 
 func IsInvalidError(err error) bool {

pkg/stackit/stackiterrors/errors_test.go

@@ -95,6 +95,23 @@ var _ = Describe("Errors", func() {
 		})
 	})
 
+	Describe("WrapError", func() {
+		It("wraps the error with the provided identifier", func() {
+			err := errors.New("test error")
+			expected := fmt.Errorf("[X-Trace-Id:12345]: %w", err)
+			Expect(WrapError(err, "X-Trace-Id", "12345")).To(Equal(expected))
+		})
+
+		It("returns the original error when the identifier is empty", func() {
+			err := errors.New("test error")
+			Expect(WrapError(err, "trace-id", "")).To(Equal(err))
+		})
+
+		It("returns nil when the error is nil", func() {
+			Expect(WrapError(nil, "trace-id", "12345")).To(Succeed())
+		})
+	})
+
 	Describe("IsInvalidError", func() {
 		Context("when error is a BadRequest error", func() {
 			It("should return true", func() {