fix: handle omitted evaluation result value when deserializing client-side JSON payload #368
Conversation
This file contains hidden or 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
|
This pull request has been linked to Shortcut Story #203949: Treat omitted JSON values as if they were null. |
cwaldren-ld
changed the title
cwaldren-ld
changed the title
kinyoklion
approved these changes
Feb 13, 2024
Contributor
Author
|
Did a more deep audit of the code. I'm seeing an (un-contract-tested) problem in the handling of variations where That's not correct. So this PR shouldn't be merged yet until I make some contract tests that cover this (and fix it.) |
cwaldren-ld
force-pushed
the
cw/sc-203949/handle-omitted-evaluation-result-value
branch
from
e949229 to
bb2b99f
Compare
Contributor
Author
|
I'm going to merge this as it's a good defensive change in case the SDK is sent bad/malformed data. I've created a ticket to investigate whether a |
cwaldren-ld
deleted the
cw/sc-203949/handle-omitted-evaluation-result-value
branch
This was referenced Mar 13, 2024
Closed
Closed
Merged
cwaldren-ld
added a commit
that referenced
this pull request
Mar 19, 2024
🤖 I have created a release *beep* *boop* --- <details><summary>launchdarkly-cpp-client: 3.4.1</summary> ## [3.4.1](launchdarkly-cpp-client-v3.4.0...launchdarkly-cpp-client-v3.4.1) (2024-03-18) ### Dependencies * The following workspace dependencies were updated * dependencies * launchdarkly-cpp-internal bumped from 0.5.4 to 0.6.0 </details> <details><summary>launchdarkly-cpp-internal: 0.6.0</summary> ## [0.6.0](launchdarkly-cpp-internal-v0.5.4...launchdarkly-cpp-internal-v0.6.0) (2024-03-18) ### Features * always inline contexts for feature events ([#362](#362)) ([bc77e89](bc77e89)) * redact anonymous attributes within feature events ([#363](#363)) ([85fe237](85fe237)) ### Bug Fixes * handle omitted evaluation result value when deserializing client-side JSON payload ([#368](#368)) ([334ea51](334ea51)) </details> <details><summary>launchdarkly-cpp-server: 3.3.3</summary> ## [3.3.3](launchdarkly-cpp-server-v3.3.2...launchdarkly-cpp-server-v3.3.3) (2024-03-18) ### Dependencies * The following workspace dependencies were updated * dependencies * launchdarkly-cpp-internal bumped from 0.5.4 to 0.6.0 </details> <details><summary>launchdarkly-cpp-server-redis-source: 2.1.3</summary> ## [2.1.3](launchdarkly-cpp-server-redis-source-v2.1.2...launchdarkly-cpp-server-redis-source-v2.1.3) (2024-03-18) ### Dependencies * The following workspace dependencies were updated * dependencies * launchdarkly-cpp-server bumped from 3.3.2 to 3.3.3 </details> --- 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: Casey Waldren <cwaldren@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.
Background
When the client-side SDK is deserializing an evaluation result, it may encounter a
nullevaluation value for a particular flag. That is, the value is literallynullin JSON.It might also receive an evaliuation result with an omitted value. Some server-side SDKs may produce this because they don't treat null/missing as equivalent.
Problem
In that case, the client-side SDK would throw a schema error. This isn't correct since producing a null/omitted value is legitimate.
Solution
The deserialization code now takes into account the equivalence of null/omission and doesn't throw an error.