Skip to content

Improve JSON decode error messages with path context #4302

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Improve JSON decode error messages with path context #4302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
696d0db
Improve JSON decode error messages with path context
devin-ai-integration[bot] Oct 14, 2025
69033f6
Optimize path tracking to avoid string allocations
devin-ai-integration[bot] Oct 14, 2025
01617e9
Add tests for error context in JSON decoding
devin-ai-integration[bot] Oct 14, 2025
1981f47
Refactor all decode methods to use WithContext versions
devin-ai-integration[bot] Oct 15, 2025
6a54ee2
Improve JSON decode error messages with path context
devin-ai-integration[bot] Oct 15, 2025
a33eba3
improve decoding: keep decoding path for all properties and indices
turbolent Oct 16, 2025
84d6b45
Merge branch 'master' into bastian/improve-json-cdc-decoding
turbolent Oct 16, 2025
0a4b6d6
fix error formatting
turbolent Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 28 additions & 7 deletions encoding/ccf/ccf_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2582,7 +2582,10 @@ func TestDecodeWord128Invalid(t *testing.T) {
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
})
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: failed to decode Word128: cbor: cannot decode CBOR tag type to big.Int", err.Error())
assert.ErrorContains(t,
err,
"failed to decode Word128: cbor: cannot decode CBOR tag type to big.Int",
)
}
}

Expand Down Expand Up @@ -2682,7 +2685,10 @@ func TestDecodeWord256Invalid(t *testing.T) {
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
})
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: failed to decode Word256: cbor: cannot decode CBOR tag type to big.Int", err.Error())
assert.ErrorContains(t,
err,
"failed to decode Word256: cbor: cannot decode CBOR tag type to big.Int",
)
}
}

Expand Down Expand Up @@ -10921,7 +10927,10 @@ func TestEncodeType(t *testing.T) {

_, err := ccf.Decode(nil, encodedData)
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: unexpected empty intersection type", err.Error())
assert.ErrorContains(t,
err,
"unexpected empty intersection type",
)

})

Expand Down Expand Up @@ -10952,7 +10961,10 @@ func TestEncodeType(t *testing.T) {

_, err := ccf.Decode(nil, encodedData)
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: unexpected empty intersection type", err.Error())
assert.ErrorContains(t,
err,
"unexpected empty intersection type",
)
})

t.Run("with static intersection type", func(t *testing.T) {
Expand Down Expand Up @@ -12816,7 +12828,10 @@ func TestDecodeInvalidType(t *testing.T) {
for _, dm := range decModes {
_, err := dm.Decode(nil, encodedData)
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: invalid type ID for built-in: ``", err.Error())
assert.ErrorContains(t,
err,
"invalid type ID for built-in: ``",
)
}
})

Expand Down Expand Up @@ -12874,7 +12889,10 @@ func TestDecodeInvalidType(t *testing.T) {
for _, dm := range decModes {
_, err := dm.Decode(nil, encodedData)
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: invalid type ID `I`: invalid identifier location type ID: missing location", err.Error())
assert.ErrorContains(t,
err,
"invalid type ID `I`: invalid identifier location type ID: missing location",
)
}
})

Expand Down Expand Up @@ -12932,7 +12950,10 @@ func TestDecodeInvalidType(t *testing.T) {
for _, dm := range decModes {
_, err := dm.Decode(nil, encodedData)
require.Error(t, err)
assert.Equal(t, "ccf: failed to decode: invalid type ID for built-in: `N.PublicKey`", err.Error())
assert.ErrorContains(t,
err,
"invalid type ID for built-in: `N.PublicKey`",
)
}
})
}
Expand Down
4 changes: 2 additions & 2 deletions encoding/ccf/decode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ func (d *Decoder) decodeValue(t cadence.Type, types *cadenceTypeByCCFTypeID) (ca
default:
err := decodeCBORTagWithKnownNumber(d.dec, CBORTagTypeAndValue)
if err != nil {
return nil, fmt.Errorf("unexpected encoded value of Cadence type %s (%T): %s", t.ID(), t, err.Error())
return nil, fmt.Errorf("unexpected encoded value of Cadence type %s (%T): %w", t.ID(), t, err)
}

// Decode ccf-type-and-value-message.
Expand Down Expand Up @@ -1538,7 +1538,7 @@ func (d *Decoder) decodeCapability(typ *cadence.CapabilityType, types *cadenceTy
if nextType == cbor.TagType {
err := decodeCBORTagWithKnownNumber(d.dec, CBORTagTypeAndValue)
if err != nil {
return nil, fmt.Errorf("unexpected encoded value of Cadence type %s (%T): %s", typ.ID(), typ, err.Error())
return nil, fmt.Errorf("unexpected encoded value of Cadence type %s (%T): %w", typ.ID(), typ, err)
}

// Decode ccf-type-and-value-message.
Expand Down
Loading
Loading