[GSK-1199] Implement websocket to get worker status

[henchaves]

Description

The idea of this PR is to implement a WebSocket to provide a channel through which the backend can send the ML Worker status without any request from the front.

This improvement will be divided into two phases:
1- Implement WebSocket on back and frontend, send the worker status periodically from Spring app, and update Vue components to use websocket instead of store. (CURRENT PR)
2- Make the backend only send a message to the channel when the worker status change, instead of sending it every N seconds. Also, send the last worker status whenever a new subscriber appears.

Related Issue

GSK-1199 (available on Linear)

Type of Change

• 📚 Examples / docs / tutorials / dependencies update
• 🔧 Bug fix (non-breaking change which fixes an issue)
• 🥂 Improvement (non-breaking change which improves an existing feature)
• 🚀 New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to change)
• 🔐 Security fix

[linear]

GSK-1199 Create websocket to get worker status

This issue is a improvement of GSK-1099

[andreybavt]

@henchaves on my end I don't get notifications when running Giskard in production mode (in docker).

Also when testing in dev mode I had to use the UI for a bit before I started receiving ML Worker connected/disconnected messages:

• I installed a blank instance
• connected the worker - no notification ❌
• disconnected the worker - no notification ❌
• created project, connected/disconnected worker - no notification ❌
• ran the onboarding code and connected/disconnected worker - no notification ❌
• opened the test suite and connected/disconnected worker - got notification ✅

[henchaves]

@henchaves on my end I don't get notifications when running Giskard in production mode (in docker).

Also when testing in dev mode I had to use the UI for a bit before I started receiving ML Worker connected/disconnected messages:

• I installed a blank instance
• connected the worker - no notification ❌
• disconnected the worker - no notification ❌
• created project, connected/disconnected worker - no notification ❌
• ran the onboarding code and connected/disconnected worker - no notification ❌
• opened the test suite and connected/disconnected worker - got notification ✅

@andreybavt, you will only get notifications if you are interacting with a page (component) that imports the ML Worker state

[andreybavt]

Well, it should be enabled on a global level (except for the login page). It's important to know if a worker gets disconnected even if you're not immediately using it

[henchaves]

@andreybavt, I added worker notifications for all components inside Main.vue. Can you try again the use cases you mentioned? I tried it on my side, and it's working now.

[andreybavt]

@henchaves , sure I'll retest now. Did you try in Docker too?

[henchaves]

@andreybavt not yet. Let me try that

[andreybavt]

I also spotted an unhandled corner case: when you logout (available with a paid license) you don't unsubscribe from the websocket events and thus still continue receiving the notifications

[henchaves]

@andreybavt, everything should be working now (including using Docker)

[andreybavt]

@henchaves ok, I'm checking again and then it's good to merge

[andreybavt]

@henchaves , one other thing I noticed is that the security question isn't solved in this PR. You can connect to this WS endpoint and send/receive STOMP messages from any client without being authenticated

[andreybavt]

Once the build passes it should be OK to merge

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

24.1% Coverage
0.0% Duplication