Development: Make Telemetry service async

[SimonEntholzer]

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 principle of data economy for all database calls.
• I strictly followed the server coding and design guidelines.
• I added multiple integration tests (Spring) related to the features (with a high test coverage).
• I documented the Java code using JavaDoc style.

Motivation and Context

In production, the telemetry service sends telemetry data to https://telemetry.artemis.cit.tum.de/. We want to make sure this sending operation is not blocking any other parts of the Artemis application from starting up.

Description

We split the TelemetryService into two services, to use the @Async annotation. With this the further startup can continue, even if the operation of the TelemetrySendingService would block indefinitely.

Steps for Testing

You can only really test this locally, as the feature is disabled for dev in the code.
What you could do, is to manually comment out the code disabling it, setting up a local instance of the Telemetry collection service: Artemis-Telemetry Service, and start the server.
As before it should send the data correctly.
(Functionality should not be changed in any way by this PR)

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

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features
  • Introduced a new service for asynchronous telemetry data transmission, enhancing system observability.
• Refactor
  • Improved the structure of the telemetry functionality by separating concerns between services.
  • Streamlined dependency injection in the telemetry service for better maintainability.
• Tests
  • Enhanced test reliability by implementing asynchronous verification methods to accommodate potential delays.

[coderabbitai]

Walkthrough

The changes introduce a new TelemetrySendingService class to handle the asynchronous sending of telemetry data, improving modularity by separating concerns from the existing TelemetryService. The TelemetryService is refactored to utilize the new service, removing several fields and methods related to telemetry data handling. Additionally, test assertions in TelemetryServiceTest are enhanced for reliability, particularly regarding asynchronous operations.

Changes

Files	Change Summary
src/main/java/de/tum/in/www1/artemis/service/telemetry/...	Introduced TelemetrySendingService class for sending telemetry data asynchronously. Added sendTelemetryByPostRequest method and TelemetryData record.
src/main/java/de/tum/in/www1/artemis/service/telemetry/...	Refactored TelemetryService to remove telemetry sending logic, now utilizing TelemetrySendingService. Updated constructor for better dependency injection.
src/test/java/de/tum/in/www1/artemis/telemetry/...	Enhanced test assertions in TelemetryServiceTest using Awaitility for more robust verification of asynchronous operations. Adjusted field declaration order.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 3

[az108]

Code 👍

[undernagruzez]

code

[az108]

Reapprove Code after Merge Conflicts 👍

[undernagruzez]

re approved

[undernagruzez]

manual test

[BBesrour]

Tested in a testing session, works as described

[iyannsch]

Code LGTM - nice changes!

[pzdr7]

Code LGTM