GODRIVER-2711 Deprecate BSON *Append and *With functions. #1251
Conversation
matthewdale
force-pushed
the
godriver2711-dep-bson-with
branch
2 times, most recently
from
319ae80
to
10a0e19
Compare
matthewdale
changed the title
matthewdale
force-pushed
the
godriver2711-dep-bson-with
branch
from
10a0e19
to
b58a4c9
Compare
| // Extended JSON by converting them to bson.Raw. | ||
| for { | ||
| doc, err := bson.ReadDocument(buf) | ||
| if err == io.EOF { |
There was a problem hiding this comment.
Do you think it is necessary to leave a comment on the io.EOF here as well?
There was a problem hiding this comment.
Yeah, that's a good ideal! I'll extend the comment above to mention that ReadDocument returns io.EOF when the input is empty.
bson/bsonrw/extjson_writer.go
Outdated
| // Always end top-level documents with a newline so that multiple documents can be encoded | ||
| // to the same writer. That matches the Go json.Encoder behavior and also works with | ||
| // bsonrw.NewExtJSONValueReader. | ||
| ejvw.buf = append(ejvw.buf, '\n') |
There was a problem hiding this comment.
This addition causes corpus failures:
go test -run Test_BsonCorpus
There was a problem hiding this comment.
Good catch! To match the behavior of the Go encoding/json library, we actually only want to apply this to the output generated by Encode and not by MarshalExtJSON. I'm not sure if the BSON corpus tests use Encode or MarshalExtJSON, but it's possible that change will resolve the failures. If not, I'll look into whether or not it's a good idea to trim whitespace in the BSON corpus tests.
There was a problem hiding this comment.
Updated to only add newlines when using Encoder.Encode.
matthewdale
force-pushed
the
godriver2711-dep-bson-with
branch
from
0219392
to
4ade632
Compare
Co-authored-by: Preston Vasquez <prestonvasquez@icloud.com>
matthewdale
force-pushed
the
godriver2711-dep-bson-with
branch
from
4ade632
to
04f1c97
Compare
GODRIVER-2711
Summary
bsonpackageMarshal/Unmarshalfunctions that append data to an existing byte slice. Recommend people use theEncoderorDecodertypes instead.bsonpackageMarshal/Unmarshalfunctions that accept aRegistry. Recommend people use theEncoderorDecodertypes instead.EncodeContextorDecodeContextduring marshaling or unmarshaling. Recommend people use theEncoderorDecoderconfiguration functions instead.EncoderandDecoderto achieve most deprecated behaviors.Background & Motivation
The
bsonpackage is cluttered with permutations of*WithRegistry,*WithContextand*Appendfunctions forMarshalandUnmarshal. The same behavior can be now be achieved with anEncoderorDecoder, making the*WithRegistry,*WithContext, and*Appendfunctions redundant. Provide examples to show users how to migrate their use cases toEncoderorDecoderand deprecate the redundant functions in preparation to remove them in Go Driver 2.0.