End User is notified when Bürokratt is not working

[rasmusei]

AS AN End User I WANT TO have a clear understanding if Bürokratt is not working SO THAT I could make contact using other channels

Acceptance Criteria

Business requirements

• [x] When Bürokratt is not working and the widget is still active on the organization's website then Chatbot displays a message that Bürokratt is unavailable "Bürokratt ei ole hetkel saadaval"
• [x] Another option is when Bürokratt is not working then the widget on the organization's website is automatically disabled and not visible to End Users

GUI

• [ ] GUI makes a request to an appropriate /healthz or similar endpoint
• [ ] Above endpoint is requested if widget gets not HTTP 200 response from Ruuter
• [ ] Above endpoint is requested periodically after every 30 seconds (period must be configurable)

Endpoints

Service /healthz/chat

• [ ] Content of /healthz/chat endpoint is provided by DSL developments
• [ ] Chat widget can be configured to ping /healthz/chat endpoint within a predefined timeframe
• [ ] Chat widget can be configured to only appear on the website if /healthz/chat endpoint responds with HTTP 200 OK
• [ ] Chat widget can be configured to be inactive and provide a custom error message if /healthz/chat endpoint responds with HTTP 503 Service Unavailable

[turnerrainer]

Before there is an active chat session established

• A REST endpoint for GUI to turn to to get Bürokratt's status;
• GUI responds based on that status.

After there is an active chat session established

• Status is received via active (currently only) SSE session;
• GUI responds based on that status.

[ceirowe]

@rasmusei a few questions regarding GUI:

1. Should health checking happen on each initialization or only after an error occured / not OK status code recieved?
2. Should health checking stop pinging, if the status is OK 200 and restart after an error occurs?

[rasmusei]

@ceirowe

1. Health check should happen all the time in every 30 sec
2. In active chat health check should happen in every 10 sec
3. When Bürokratt stopped working during active chat then in chat message "Bürokratt ei ole hetkel tehnilistel põhjustel saadaval" is displayed same way as an emergency message.
4. When Bürokratt starts working again in active chat then in chat message "Bürokratt on jälle saadaval!" is displayed same way as an emergency message, previous message ("Bürokratt ei ole hetkel tehnilistel põhjustel saadaval") is not displayed anymore. When Bürokratt has detected activity (mouse movement, keystroke) by End User, then message "Bürokratt on jälle saadaval!" will disappear is 5 sec.

[joonasroosalung]

@turnerrainer Uses existing /healthz endpoint on ruuter?

[turnerrainer]

@turnerrainer Uses existing /healthz endpoint on ruuter?

No, this one needs a lot more attention. Maybe needs an additional grooming?

Just pinging definitely Ruuter won't do.

[joonasroosalung]

Rasa bot should have a /health or /healthcheck endpoint, will double check today/tomorrow

[ceirowe]

@turnerrainer GUI needs a way to test changes against working Ruuter.

[joonasroosalung]

Ruuter components already covered with existing v1 conf:

• Ruuter itself
• TIM
• Dmapper
• Resql

The existing conf https://github.com/buerokratt/Buerokratt-Chatbot/blob/main/DSL.Ruuter-v1.private/cs-get-components-healthz-status.json, which internally uses https://github.com/buerokratt/Buerokratt-Chatbot/blob/main/DSL.Ruuter-v1.private/cs-get-resql-healthz.json to check resql through an extra step. Don't remember the precise technical reason for that, likely due to http status response codes, Ruuter wants to return 200 almost always.

The existing endpoint responds with

{"data":{"set_healthz_response":{"data":[{"name":"TIM","version":"1.0"},{"name":"RUUTER","version":"1.0"},{"name":"DMAPPER","version":"1.0"},{"name":"RESQL","version":"1.0"}]}},"error":null}

Version will be an empty string "" if any component is down and of course ther will be no response from the endpoint if ruuter itself is down.

[turnerrainer]

@turnerrainer Uses existing /healthz endpoint on ruuter?

No, this one needs a lot more attention. Maybe needs an additional grooming?

Just pinging definitely Ruuter won't do.

@joonasroosalung I'll take it back - the current /healthz endpoint is sufficient in case it's also available for public Ruuter as well.

[sergeirudz]

PR: https://github.com/buerokratt/Chat-Widget/pull/20