From 661c07f63f6d3cd114725f84999a1f63c3c8895c Mon Sep 17 00:00:00 2001
From: Faye Amacker <33205765+fxamacker@users.noreply.github.com>
Date: Fri, 5 Apr 2024 10:54:08 -0500
Subject: [PATCH] Fix error type for external errors during serialization

The wrong error type was returned when an external error
was encountered.

This commit returns the correct error type.
---
 array.go    |  3 ++-
 map.go      |  6 ++++--
 typeinfo.go | 15 +++++++++++++--
 3 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/array.go b/array.go
index 15381b5..ab2f651 100644
--- a/array.go
+++ b/array.go
@@ -722,7 +722,8 @@ func (a *ArrayDataSlab) encodeAsInlined(enc *Encoder) error {
 
 	extraDataIndex, err := enc.inlinedExtraData().addArrayExtraData(a.extraData)
 	if err != nil {
-		return NewEncodingError(err)
+		// err is already categorized by InlinedExtraData.addArrayExtraData().
+		return err
 	}
 
 	if extraDataIndex > maxInlinedExtraDataIndex {
diff --git a/map.go b/map.go
index 5c3d37a..b89474c 100644
--- a/map.go
+++ b/map.go
@@ -3009,7 +3009,8 @@ func (m *MapDataSlab) encodeAsInlinedMap(enc *Encoder) error {
 
 	extraDataIndex, err := enc.inlinedExtraData().addMapExtraData(m.extraData)
 	if err != nil {
-		return NewEncodingError(err)
+		// err is already categorized by InlinedExtraData.addMapExtraData().
+		return err
 	}
 
 	if extraDataIndex > maxInlinedExtraDataIndex {
@@ -3070,7 +3071,8 @@ func encodeAsInlinedCompactMap(
 
 	extraDataIndex, cachedKeys, err := enc.inlinedExtraData().addCompactMapExtraData(extraData, hkeys, keys)
 	if err != nil {
-		return NewEncodingError(err)
+		// err is already categorized by InlinedExtraData.addCompactMapExtraData().
+		return err
 	}
 
 	if len(keys) != len(cachedKeys) {
diff --git a/typeinfo.go b/typeinfo.go
index 4f62fd9..a5dadea 100644
--- a/typeinfo.go
+++ b/typeinfo.go
@@ -129,6 +129,7 @@ func (c *compactMapExtraData) Encode(enc *Encoder, encodeTypeInfo encodeTypeInfo
 	// element 0: map extra data
 	err = c.mapExtraData.Encode(enc, encodeTypeInfo)
 	if err != nil {
+		// err is already categorized by MapExtraData.Encode().
 		return err
 	}
 
@@ -160,7 +161,8 @@ func (c *compactMapExtraData) Encode(enc *Encoder, encodeTypeInfo encodeTypeInfo
 	for _, key := range c.keys {
 		err = key.Encode(enc)
 		if err != nil {
-			return NewEncodingError(err)
+			// Wrap err as external error (if needed) because err is returned by ComparableStorable.Encode().
+			return wrapErrorfAsExternalErrorIfNeeded(err, "failed to encode key's storable")
 		}
 	}
 
@@ -195,6 +197,7 @@ func newCompactMapExtraData(
 	// element 0: map extra data
 	mapExtraData, err := newMapExtraData(dec, decodeTypeInfo)
 	if err != nil {
+		// err is already categorized by newMapExtraData().
 		return nil, err
 	}
 
@@ -362,6 +365,7 @@ func (ied *InlinedExtraData) Encode(enc *Encoder) error {
 			return nil
 		})
 		if err != nil {
+			// err is already categorized by ExtraData.Encode().
 			return err
 		}
 	}
@@ -475,18 +479,21 @@ func newInlinedExtraDataFromData(
 		case CBORTagInlinedArrayExtraData:
 			inlinedExtraData[i], err = newArrayExtraData(dec, decodeTypeInfo)
 			if err != nil {
+				// err is already categorized by newArrayExtraData().
 				return nil, nil, err
 			}
 
 		case CBORTagInlinedMapExtraData:
 			inlinedExtraData[i], err = newMapExtraData(dec, decodeTypeInfo)
 			if err != nil {
+				// err is already categorized by newMapExtraData().
 				return nil, nil, err
 			}
 
 		case CBORTagInlinedCompactMapExtraData:
 			inlinedExtraData[i], err = newCompactMapExtraData(dec, decodeTypeInfo, decodeStorable)
 			if err != nil {
+				// err is already categorized by newCompactMapExtraData().
 				return nil, nil, err
 			}
 
@@ -504,6 +511,7 @@ func newInlinedExtraDataFromData(
 func (ied *InlinedExtraData) addArrayExtraData(data *ArrayExtraData) (int, error) {
 	encodedTypeInfo, err := getEncodedTypeInfo(data.TypeInfo)
 	if err != nil {
+		// err is already categorized by getEncodedTypeInfo().
 		return 0, err
 	}
 
@@ -528,6 +536,7 @@ func (ied *InlinedExtraData) addArrayExtraData(data *ArrayExtraData) (int, error
 func (ied *InlinedExtraData) addMapExtraData(data *MapExtraData) (int, error) {
 	encodedTypeInfo, err := getEncodedTypeInfo(data.TypeInfo)
 	if err != nil {
+		// err is already categorized by getEncodedTypeInfo().
 		return 0, err
 	}
 
@@ -546,6 +555,7 @@ func (ied *InlinedExtraData) addCompactMapExtraData(
 
 	encodedTypeInfo, err := getEncodedTypeInfo(data.TypeInfo)
 	if err != nil {
+		// err is already categorized by getEncodedTypeInfo().
 		return 0, nil, err
 	}
 
@@ -644,7 +654,8 @@ func getEncodedTypeInfo(ti TypeInfo) (string, error) {
 	enc := cbor.NewStreamEncoder(b)
 	err := ti.Encode(enc)
 	if err != nil {
-		return "", err
+		// Wrap err as external error (if needed) because err is returned by TypeInfo.Encode().
+		return "", wrapErrorfAsExternalErrorIfNeeded(err, "failed to encode type info")
 	}
 	enc.Flush()