Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Log client app version in websocket heartbeats to be displayed for admins #3948

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

RyanMG
Copy link

@RyanMG RyanMG commented Mar 18, 2025

Ticket #3947

Server update here

Hoist P/R Checklist

  • Caught up with develop branch as of last change.
  • Added CHANGELOG entry, or determined not required.
  • Reviewed for breaking changes, added breaking-change label + CHANGELOG if so.
  • Updated doc comments / prop-types, or determined not required.
  • Reviewed and tested on Mobile, or determined not required.
  • Created Toolbox branch / PR, or determined not required.

@amcclain
Copy link
Member

Great, thanks for jumping on this! Just had a chance to update the ticket with a proper description.

Goal is to get this version info into the Hoist admin console grid. We'll need to look at hoist-core to see how these messages are handled and thread that through into the HoistWebSocketChannel object, which is what is holding the state reported by that grid.

@RyanMG RyanMG changed the title Client websockets now send the client app version in payload Log client app version in websocket heartbeats to be displayed for admins Mar 18, 2025
type: 'string',
displayName: 'Client App Version'
},
width: 120
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

120 is holding "7.0 SNAPSHOT" with no issue, but unsure how much we expect this value could grow.

this.sendMessage({
topic: this.HEARTBEAT_TOPIC,
data: 'ping',
clientAppVersion: XH.appVersion
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I initially made data an object and sent clientAppVersion as a property in said object.

I am unsure though how clients may be using this service. If they are extending and overriding data in sendMessage we would lose this value. However, there is also nothing stopping them from overriding heartbeatOrReconnect either.
Open to suggestions or notes to help better understand real world use cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants