Update /xh endpoints and config for version/instance change detection
#387
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
…ropriate defaults
|
Associated with HR PR: xh/hoist-react#3768 |
6 tasks
lbwexler
reviewed
Aug 28, 2024
| @@ -219,8 +219,8 @@ class XhController extends BaseController { | |||
| renderJSON(environmentService.getEnvironment()) | |||
| } | |||
|
|
|||
| def version() { | |||
| def options = configService.getMap('xhAppVersionCheck', [:]) | |||
| def status() { | |||
There was a problem hiding this comment.
confusing with our status monitors?
There was a problem hiding this comment.
- We could continue with
/status, but plan to expand the payload here at a later point to include
health/readiness information.- Could include some highly summarized version of the actual status monitor outputs (eg counts only), if only to acknowledge those have some claim to "status". Although for this whitelisted endpoint we obvs would not want to output anything more detailed (not even, say, the names of monitors).
- But thinking ahead to this including some general
ready:trueindicator helps to justify the name - which I like (mostly because it's difficult to come up with another, better name...)
/instance,/instanceInfoor/instanceDetailswould be my other suggestion. It might be a bit weird to have the other version-check related instructions in a return with that name, but not that weird.- If we felt the need, we could always nest those under a sub-key in the return, like
versionCheck
- If we felt the need, we could always nest those under a sub-key in the return, like
tldr; I am OK with status if we plan to expand the payload to ready checks, but suggest instance otherwise.
amcclain
reviewed
Aug 29, 2024
| @@ -219,8 +219,8 @@ class XhController extends BaseController { | |||
| renderJSON(environmentService.getEnvironment()) | |||
| } | |||
|
|
|||
| def version() { | |||
| def options = configService.getMap('xhAppVersionCheck', [:]) | |||
| def status() { | |||
There was a problem hiding this comment.
- We could continue with
/status, but plan to expand the payload here at a later point to include
health/readiness information.- Could include some highly summarized version of the actual status monitor outputs (eg counts only), if only to acknowledge those have some claim to "status". Although for this whitelisted endpoint we obvs would not want to output anything more detailed (not even, say, the names of monitors).
- But thinking ahead to this including some general
ready:trueindicator helps to justify the name - which I like (mostly because it's difficult to come up with another, better name...)
/instance,/instanceInfoor/instanceDetailswould be my other suggestion. It might be a bit weird to have the other version-check related instructions in a return with that name, but not that weird.- If we felt the need, we could always nest those under a sub-key in the return, like
versionCheck
- If we felt the need, we could always nest those under a sub-key in the return, like
tldr; I am OK with status if we plan to expand the payload to ready checks, but suggest instance otherwise.
# Conflicts: # CHANGELOG.md
+ Tailor /xh/environment return based on auth user - support minimal unauthorized payload for backwards compat with existing usages, but mix-in full details for authenticated users. + Client now calls this endpoint both for initial load and for ongoing polling. + Rework `xhAppStatusCheck` to `xhEnvPollingConfig`, nest within authenticated /xh/environment return. Client reads and respects changes to config updates, with some sanity checks. + Restore /xh/version for backwards compat, return minimal environment summary.
amcclain
changed the title
xhAppVersionCheck -> xhAppStatusCheck and provide more app…/xh endpoints and config for version/instance change detection
|
Had a discussion with Lee earler this evening and throwing these changes over the wall to see if you guys think this holds together. While the client-side code does not save down all the data produced by Retained |
# Conflicts: # CHANGELOG.md
+ Remove dedicated `PingController` + Add extra info - appCode, timestamp, success:true - from ping to version output.
amcclain
approved these changes
Sep 3, 2024
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.
…ropriate defaults