Communication: Include imageUrl for reactions

[FelberMartin]

Checklist

General

• 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.

Motivation and Context

The Android app currently expects the reaction authors to also include a imageUrl (basically to have the same format as the author for a post entity). While they are not currently needed for displaying them in the UI, it messes with the database entries.

Additionally, this change is needed for planned future improvements of the reaction overview in Android, which will show the reaction authors profile picture in the BottomSheet.

Description

Included the imageUrl to be returned for reactions.

Steps for Testing

Prerequisites:

• 1 User
• 1 Course with communication enabled

1. Log in to Artemis
2. Navigate to the course communication
3. If there are no posts / reactions yet, create some
4. Open Browser dev tools > Network
5. Refresh
6. Click on entry "messages?postSortCriterions=...." > Response
7. Expand the response and see that the reaction user now includes the imageUrl

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

Summary by CodeRabbit

• New Features
  • Enhanced user information in JSON representation by including the imageUrl property alongside id and name in the Reaction class.

This update improves the data available for users without altering existing functionalities.

[coderabbitai]

Walkthrough

The changes involve an update to the Reaction class in the src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java file. The @JsonIncludeProperties annotation for the user field has been modified to include an additional property, imageUrl, alongside the existing id and name properties. This adjustment allows the imageUrl to be included in the JSON serialization of the user object.

Changes

File Path	Change Summary
src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java	Updated @JsonIncludeProperties annotation for user field to include imageUrl.

Possibly related PRs

• Communication: Add profile pictures to channel member overview #9450: This PR adds a new imageUrl field to the UserPublicInfoDTO, which is directly related to the changes made in the Reaction class where the imageUrl property is now included in the JSON representation of the user object.
• Communication: Fix an issue that stops channels from loading messages #9745: This PR addresses an issue with loading messages in a communication channel, which may involve user data that includes the imageUrl property, thus connecting it to the changes in the Reaction class that enhance user information serialization.

Suggested labels

client, component:Communication

Suggested reviewers

• krusche
• edkaya
• pzdr7

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 pmd (7.7.0)

src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java

The following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7feed75 and 1e63fa6.

📒 Files selected for processing (1)

• src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4eaba4e and 7feed75.

📒 Files selected for processing (1)

• src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/communication/domain/Reaction.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

[PaRangger]

Tested on TS1, the response includes the imageUrl now 👍 Code changes LGTM.

[SimonEntholzer]

code

[HawKhiem]

Tested on TS1. Works as described

[krusche]

I don't think this is a good change. We want to keep the information minimal here. Can you not change the Android way of handling this?

[FelberMartin]

I don't think this is a good change. We want to keep the information minimal here. Can you not change the Android way of handling this?

I actually did this as a workaround in the Android app for now.

However, I think including the imageUrl here does not expose any private information (can be accessed anyway for a users post).

Additionally this would then also be required in the future to improve the reaction display in the Android app (and maybe also iOS). I assume we want to implement the mobile reaction overview similar to Slack or Whatsapp, both of which show the profile picture in the BottomSheets next to the reactors name.

How it looks like in slack:

Adding this is on the feature collection for Android (see here).

EDIT: I updated the PR description to also reflect the benefits in future updates

[krusche]

I don't think this is a good approach, can you try to fix it in the Android app instead?

[FelberMartin]

Yes, this PR already includes a workaround for this on Android.

I am not sure whether I understand correctly, should we then just re-open this PR once we want to start working on the reaction overview improvements?

[FelberMartin]

It was decided that including the imageUrl in the reactions is not required, as it is not needed in the webapp and would be too much information the send for every reaction.

For the mobile apps, if they want to show the ProfilePictures for reactions, they should rather fetch the users separately and get the imageUrl from there.