Skip to content

CRUD API improvements #335

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

Merged
merged 6 commits into from
Oct 9, 2023
Merged

CRUD API improvements #335

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f8ed81e
doc: make crud options description more specific
DifferentialOrange Oct 5, 2023
5fc8483
crud: fix Get options
DifferentialOrange Oct 5, 2023
c33f351
crud: support fetch_latest_metadata option
DifferentialOrange Oct 6, 2023
be8ba74
crud: more careful response process
DifferentialOrange Oct 6, 2023
a81e8a2
crud: support noreturn option
DifferentialOrange Oct 6, 2023
b844e21
doc: clarify crud error process decoding
DifferentialOrange Oct 6, 2023
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
Prev Previous commit
doc: clarify crud error process decoding 
It is a bit confusing for non-experienced vmihailenco/msgpack users than
`nil` values are actually parsed by `DecodeMapLen`, `DecodeUint64` and
`DecodeBool` methods to some default value. So I decided to leave a note
here.
  • Loading branch information
@DifferentialOrange
DifferentialOrange committed Oct 9, 2023
commit b844e21cbc63e3d5df85d7b7badbab58143df506
9 changes: 9 additions & 0 deletions crud/result.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ func (r *Result) DecodeMsgpack(d *msgpack.Decoder) error {
return fmt.Errorf("unexpected empty response array")
}

// DecodeMapLen processes `nil` as zero length map,
// so in `return nil, err` case we don't miss error info.
// https://github.com/vmihailenco/msgpack/blob/3f7bd806fea698e7a9fe80979aa3512dea0a7368/decode_map.go#L79-L81
l, err := d.DecodeMapLen()
if err != nil {
return err
Expand Down Expand Up @@ -184,6 +187,9 @@ func (r *NumberResult) DecodeMsgpack(d *msgpack.Decoder) error {
return fmt.Errorf("unexpected empty response array")
}

// DecodeUint64 processes `nil` as `0`,
// so in `return nil, err` case we don't miss error info.
// https://github.com/vmihailenco/msgpack/blob/3f7bd806fea698e7a9fe80979aa3512dea0a7368/decode_number.go#L91-L93
if r.Value, err = d.DecodeUint64(); err != nil {
return err
}
Expand Down Expand Up @@ -225,6 +231,9 @@ func (r *BoolResult) DecodeMsgpack(d *msgpack.Decoder) error {
return fmt.Errorf("unexpected empty response array")
}

// DecodeBool processes `nil` as `false`,
// so in `return nil, err` case we don't miss error info.
// https://github.com/vmihailenco/msgpack/blob/3f7bd806fea698e7a9fe80979aa3512dea0a7368/decode.go#L367-L369
if r.Value, err = d.DecodeBool(); err != nil {
return err
}
Expand Down