fix: Sort private attributes for improved stable encoding #401
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
To help increase cache hits, we want to always use a stable encoding for the context. This was done in a previous commit when we added the `encoder.outputFormatting = [.sortedKeys]` modification. A context's private attributes are sorted as a set, which makes no guarantee about encoding order. To address this, we are sorting the private attributes prior to the JSON encoding phase. As a result, we would expect to see an increase in cache hits for customers.
tanderson-ld
approved these changes
Aug 5, 2024
keelerm84
pushed a commit
that referenced
this pull request
Aug 7, 2024
🤖 I have created a release *beep* *boop* --- ## [9.10.0](9.9.0...9.10.0) (2024-08-07) ### Features * Update caching strategy to allow for greater cache use ([#404](#404)) ([62587ad](62587ad)) ### Bug Fixes * Sort private attributes for improved stable encoding ([#401](#401)) ([90bf896](90bf896)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: LaunchDarklyReleaseBot <LaunchDarklyReleaseBot@launchdarkly.com>
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.
To help increase cache hits, we want to always use a stable encoding for the context. This was done in a previous commit when we added the
encoder.outputFormatting = [.sortedKeys]modification.A context's private attributes are sorted as a set, which makes no guarantee about encoding order. To address this, we are sorting the private attributes prior to the JSON encoding phase. As a result, we would expect to see an increase in cache hits for customers.