Decode BSON documents correctly in API responses #32
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously the BSON documents in the result sets were decoded as
bson.D when stored in EiffelEvent.Data. This meant that the original
objects turned up as slices of objects,
[{"Key": "name", "Value": "foo"]
instead of objects,
{"name": "foo"}
which obviously meant that they were no longer valid Eiffel events.
We address this by deriving the EiffelEvent data type from
map[string]interface{} which is the same underlying type as bson.M,
the unordered map type.
This made the internal/schema package more or less empty so the
remaining EiffelEvent definition was moved to internal/database/drivers
where the database driver interface is defined.
When we implement other API endpoints we'll need to access members
of the Eiffel events in the responses and there are a few different
ways of doing that, but let's deal with that later.
The projections of the MongoDB queries were also adjusted to omit the
unwanted "_id" field.
Adding eiffelevents-sdk-go and running "go mod tidy" resulted in an
extra "require" section in go.mod. Not entirely sure why.
t-persson
approved these changes
Feb 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Applicable Issues
Fixes #19
Description of the Change
Previously the BSON documents in the result sets were decoded as bson.D when stored in EiffelEvent.Data. This meant that the original objects turned up as slices of objects,
instead of objects,
which obviously meant that they were no longer valid Eiffel events. We address this by deriving the EiffelEvent data type from map[string]interface{} which is the same underlying type as bson.M,the unordered map type.
This made the internal/schema package more or less empty so the remaining EiffelEvent definition was moved to internal/database/driverswhere the database driver interface is defined.
When we implement other API endpoints we'll need to access members of the Eiffel events in the responses and there are a few differentways of doing that, but let's deal with that later.
The projections of the MongoDB queries were also adjusted to omit the unwanted
_idfield.Adding eiffelevents-sdk-go and running "go mod tidy" resulted in an extra "require" section in go.mod. Not entirely sure why.
Alternate Designs
See associated issue for background.
Benefits
Proper API responses.
Possible Drawbacks
None.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Signed-off-by: Magnus Bäck <magnus.back@axis.com>