Avoid unmarshalling QueryRes.Hits into json default types #744
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.
Describe your change
Unmarshal QueryRes.Hits into a dedicated
Hit
struct that holdsjson.RawMessage
(alias for[]byte
) and the bare minimum of object attributes. Implement customUnmarshalJSON
andMarshalJSON
to handle this json optimization.It should be a considered a breaking change because QueryRes.Hits was previously exported as
[]map[string]interface
. However, not breaking for developers usingQueryRes.UnmarshalHits
.What problem is this fixing?
During the unmarshalling of the QueryRes object, the existing implementation will completely unmarshal each hit object into json default types. As a result, the method QueryRes.UnmarshalHits remarshals the default types just to unmarshal again into the users's desired type. For large result sets and/or large objects, this can be wasteful.
Updated 2024-05-08:
The gap between the green http.request span and the UnmarshalHits span is where the Aloglia client unmarshals the response into the
QueryRes
struct andHits map[string]interface{}
. The UnmarshalHits span takes even longer than the gap because the client re-marshals the Hits just to unmarshal into the user's desired struct.