Recover from potential panic when doing map to JSON serialization #161
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
…c-gnmi into panic_recover_and_logging
qiluo-msft
reviewed
Oct 14, 2023
sonic_data_client/db_client.go
Outdated
| jv, err := emitJSON(&msi) | ||
| if err != nil { | ||
| log.V(2).Infof("emitJSON err %s for %v", err, msi) | ||
| return nil, fmt.Errorf("emitJSON err %s for %v", err, msi) | ||
| } | ||
| if jv == nil { // json is nil because of potential panic happen | ||
| return nil, fmt.Errorf("emitJSON failed due to panic") |
There was a problem hiding this comment.
The idea here is that on 823, both the json value and the err value would be nil, since if emitJSON has panicked and we have recovered, the values of jv and err would be the zero values which is nil. I can instead say "emitJSON was unable to grab json value of map due to potential panic". In other cases where emitJSON would have failed to get json value we would see that err != nil.
|
Tried it on lab device, we can see recover from panic: |
qiluo-msft
approved these changes
Oct 16, 2023
zbud-msft
added a commit
to zbud-msft/sonic-gnmi
that referenced
this pull request
Oct 18, 2023
…nic-net#161) It is possible that in some edge cases, json.Marshal is unable to serialize map to JSON and panics. I am adding some additional logging at a higher log level and the ability for the function to recover from the panic with a deferred recover function. Add deferred recover function when JSON serialization is done and drop the query when unable to provide a JSON to gnmi TypedValue. Add additional logging to give more context of state of map as well as data retrieved from Redis. UT
zbud-msft
added a commit
to zbud-msft/sonic-gnmi
that referenced
this pull request
Oct 18, 2023
…nic-net#161) It is possible that in some edge cases, json.Marshal is unable to serialize map to JSON and panics. I am adding some additional logging at a higher log level and the ability for the function to recover from the panic with a deferred recover function. Add deferred recover function when JSON serialization is done and drop the query when unable to provide a JSON to gnmi TypedValue. Add additional logging to give more context of state of map as well as data retrieved from Redis. UT
yxieca
added a commit
that referenced
this pull request
Oct 25, 2023
Recover from potential panic when doing map to JSON serialization (#161)
zbud-msft
added a commit
to zbud-msft/sonic-gnmi
that referenced
this pull request
Oct 26, 2023
…nic-net#161) It is possible that in some edge cases, json.Marshal is unable to serialize map to JSON and panics. I am adding some additional logging at a higher log level and the ability for the function to recover from the panic with a deferred recover function. Add deferred recover function when JSON serialization is done and drop the query when unable to provide a JSON to gnmi TypedValue. Add additional logging to give more context of state of map as well as data retrieved from Redis. UT
6 tasks
zbud-msft
added a commit
that referenced
this pull request
Oct 27, 2023
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.
Why I did it
ADO: 25341563
It is possible that in some edge cases, json.Marshal is unable to serialize map to JSON and panics. I am adding some additional logging at a higher log level and the ability for the function to recover from the panic with a deferred recover function.
How I did it
Add deferred recover function when JSON serialization is done and drop the query when unable to provide a JSON to gnmi TypedValue. Add additional logging to give more context of state of map as well as data retrieved from Redis.
How to verify it
UT
Which release branch to backport (provide reason below if selected)
Description for the changelog
Link to config_db schema for YANG module changes
A picture of a cute animal (not mandatory but encouraged)