Development: Display more in-depth health information about the hermes service

[PaRangger]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the server coding and design guidelines.
• I documented the Java code using JavaDoc style.

Motivation and Context

Currently, Artemis checks if Hermes is running by calling the base url and looking if it returns a 200 response code. While working, this does not provide a lot of information to the admins.

Description

I implemented a new /api/health api in the Hermes Repository that provides the information whether or not Hermes was able to connect to the APNS or to Firebase. Additionally, it returns the version number of Hermes. This information is displayed in the "details" section when viewing the service health in the admin panel.

Steps for Testing

Prerequisites:

• 1 Artemis Admin (On TS3 your TUM Online Account should be admin)

1. Log in to Artemis
2. Navigate to Server Administration > Health in the navbar
3. Check if the Hermes service is displayed as online
4. Click the "Eye" icon to view the details
5. Check if the additional info (firebase_up, apns_up and version) are displayed. (It should say "up" in 99% of cases.)

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Screenshots

Summary by CodeRabbit

• New Features

  • Enhanced health checking mechanism for Hermes push notification service
  • Added support for retrieving detailed health status from a new endpoint

• Bug Fixes

  • Improved service availability detection with fallback mechanism

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.

[SimonEntholzer]

Code

[cremertim]

tested on ts3, works as described

[egekocabas]

Removed the lock label as we have migrated to Helios for test server deployments. Please refer to the Helios deployment guide for instructions on deploying to test servers 👍🏻