improve State and API marshaling and add keystore status support
#2
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
aead
force-pushed
the
status
branch
4 times, most recently
from
0d9190d
to
879e1c8
Compare
This commit improves the `State` and `API` JSON marshaling by decoupling it from the struct representation and adding additional checks for invalid data. Further, this commit adds support for the keystore status information exposed by minio/kes#339 Signed-off-by: Andreas Auernhammer <hi@aead.dev>
Comment on lines
+36
to
+43
| UpTime time.Duration `json:"uptime,omitempty"` | ||
| CPUs int `json:"num_cpu,omitempty"` | ||
| UsableCPUs int `json:"num_cpu_used,omitempty"` | ||
| HeapAlloc uint64 `json:"mem_heap_used,omitempty"` | ||
| StackAlloc uint64 `json:"mem_stack_used,omitempty"` | ||
| KeyStoreLatency time.Duration `json:"keystore_latency,omitempty"` | ||
| KeyStoreUnreachable bool `json:"keystore_unreachable,omitempty"` | ||
| KeyStoreUnavailable bool `json:"keystore_unavailable,omitempty"` |
There was a problem hiding this comment.
can we keep camelCased JSON tags for go styling reasons?
Comment on lines
+75
to
+82
| UpTime time.Duration `json:"uptime"` | ||
| CPUs int `json:"num_cpu"` | ||
| UsableCPUs int `json:"num_cpu_used"` | ||
| HeapAlloc uint64 `json:"mem_heap_used"` | ||
| StackAlloc uint64 `json:"mem_stack_used"` | ||
| KeyStoreLatency time.Duration `json:"keystore_latency"` | ||
| KeyStoreUnreachable bool `json:"keystore_unreachable"` | ||
| KeyStoreUnavailable bool `json:"keystore_unavailable"` |
There was a problem hiding this comment.
can we keep camelCased JSON tags for go styling reasons?
There was a problem hiding this comment.
is this because we already used snake cased tags and we need to follow this for backward compatibility reasons?
There was a problem hiding this comment.
Mainly yes, we need to preserve compatibility. Also, snake vs. camel case conventions aren't strict for JSON - esp. since these fields are part of the KES server JSON API - which may not only be consumed by Go.
For Go identifiers we should follow camel case convention as long as possible 👍
Praveenrajmani
approved these changes
Mar 8, 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.
This commit improves the
StateandAPIJSONmarshaling by decoupling it from the struct
representation and adding additional checks for
invalid data.
Further, this commit adds support for the keystore status information exposed by minio/kes#339