Checklist

General

• I tested all changes and their related features with all corresponding user types 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 added pre-authorization annotations according to the guidelines and checked the course groups for all new REST Calls (security).
• I documented the Java code using JavaDoc style.

Client

• Important: I implemented the changes with a very good performance, prevented too many (unnecessary) REST calls and made sure the UI is responsive, even with large data (e.g. using paging).
• I strictly followed the principle of data economy for all client-server REST calls.
• I strictly followed the client coding and design guidelines.
• Following the theming guidelines, I specified colors only in the theming variable files and checked that the changes look consistent in both the light and the dark theme.
• I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
• I documented the TypeScript code using JSDoc style.
• I added multiple screenshots/screencasts of my UI changes.
• I translated all newly inserted strings into English and German.

Motivation and Context

Currently, the user has no option to store messages for later reference. This leads to them having to use other tools than artemis to create reminders for certain tasks. In slack, this is done by the "Save message for later" feature.

Description

I added the option for the user to save messages for later. This is done by adding a new model "saved_post" which keeps track of which user stored which message, similar to a pivot table. The model has the following structure:

id - Primary key
user_id - The ID of the user that stored the message
post_id - The ID of the saved post
post_type - An identifier to tell the system if the stored post is an "answer_post" or a "post"
status - An identifier to tell the system in which status the post is. Is used to mark posts as "In Progress", "Completed" or "Archived".
completed_at - The date and time when a post was marked as completed or archived. May be used for cleanup.

In the client, I added a new tab to the communication modules sidebar called "Saved Messages". There, the user can view the stored messages. To store a message, I added a new icon next to the edit icon, which can be used to store a message.

For cleanup I added the SavedPostSchedule Service, which will delete archived/completed SavedPosts after 100 days. Additionally, it will try to clean up orphaned SavedPosts, since they are not connected via foreign key to the posts. (If someone for example manually deletes a post from the database)

Known Issues for followup PRs:

• The Post/Answer Post models currently use a "isSaved" transitive value. This is due to the post not being forwarded in a DTO in various communication APIs. To fix this, a dedicated refactor PR will be created as followup.
• The saved_posts are currently not cached on client side. Due to the use case being that users will not save thousands of messages, rather 1-20, this has been handled as lower priority and will be resolved in a PR followup. However, to prevent "malicious" storing of a lot of messages, a cap of 100 stored messages was introduced.

Addresses #9697
Addresses #9639

Steps for Testing

Prerequisites:

• 1 Student
• 1 Course with communication enabled

1. Log in to Artemis
2. Navigate to course
3. Navigate to the communication tab
4. If there is none, write messages and answer to messages
5. Locate the bookmark icon on the top right of a post
6. Save some messages for later
7. Go to the "In Progress" tab of saved messages
8. Click on messages and look if they are displayed correctly
9. Go back to the "In Progress" tab of saved messages
10. Mark messages as "Completed" or "Archived" and verify they are in the corresponding tab

Testserver States

Review Progress

Performance Review

• I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance even for very large courses with more than 2000 students.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Test Coverage

Client

Server

Screenshots

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced functionality for managing saved posts, allowing users to save, update, and delete posts.
  • Added a new SavedPost entity to track saved posts and their statuses.
  • Enhanced UI components to display saved post options and statuses.
  • Implemented a scheduling service for cleaning up archived and orphaned saved posts.
  • Added new endpoints in the REST controller for managing saved posts.
  • Enhanced user management by ensuring saved posts are deleted when a user is anonymized.
  • Introduced new localization strings for saved posts and their statuses in multiple languages.
  • Added support for bookmarking posts with dynamic UI elements reflecting the saved state.

• Bug Fixes

  • Improved error handling for invalid statuses and types in saved post operations.

• Documentation

  • Updated localization files to include new strings related to saved posts and their statuses in multiple languages.

• Tests

  • Added comprehensive unit and integration tests for the new saved post functionalities, ensuring robust coverage and reliability.