Development: Refactor the conversation-sidebar-section component

[MaximilianJG]

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.

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.
• 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 added authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• 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

This PR is connected to issue #7995.
The change is required to address a code quality issue that was exposed by PR #7535, where the conversation-sidebar-section component was found to be repeating the jhi-conversation-sidebar-entry component multiple times in its template. This repetition lead to code redundancy, which increases code complexity and maintenance costs.

Description

To address the issue I refactored the HTML file of the conversation-sidebar-section component. I extracted the common structure and parameters of these instances into a ng-template. I then utilized this template using the ng-container, passing the specific parameters for each instance where necessary.

Steps for Testing

Prerequisites:
-1 Course
-1 Student / Instructor / Admin

-Navigate to messages tab in the course and make sure everything works as before.
-Review the Code

Testserver States

Note

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

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• Refactor
  • Streamlined the conversation selection sidebar for improved maintainability by introducing a reusable template.

[coderabbitai]

Walkthrough

This change involves a significant refactoring of the HTML template for a conversation selection sidebar within a web application. By replacing repetitive list item elements with a single, reusable ng-template, the update streamlines the structure of the code and enhances its maintainability. This approach not only reduces redundancy but also promotes a cleaner, more organized codebase.

Changes

Files	Change Summary
.../conversation-sidebar-section.component.html	Refactored to use ng-template for list items, improving code reusability and maintainability.

Related issues

• Development: Refactor the conversation-sidebar-section component #7995: The objectives of refactoring the conversation-sidebar-section component and improving code quality through the use of ng-container and ng-template align closely with the changes made in this PR. This issue could potentially be linked as it directly addresses the mentioned objectives.

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[nityanandaz]

Code review: Looks good. Thanks for addressing the issue!

[rstief]

Code LGTM 👍

[egekurt123]

code LGTM and works normally on TS5

[pzdr7]

Tested on TS5. Looks good to me!