Development: Improve course overview component

[rabeatwork]

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.

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

Enhance the Menu Sidebar Code to facilitate the creation of a reusable generic component for the course management view.

Description

• Improved the use of NgbDropdown Component (Is used for the More Item, which appears on small screens)
• Implemented ng-template for reusable code.
• Streamlined and simplified some logic.

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

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
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• New Features

  • Enhanced dropdown functionality in the Course Overview with improved visibility handling.

• Bug Fixes

  • Fixed dropdown behavior to ensure consistent open/close actions.

• Refactor

  • Renamed methods for better clarity and alignment with new dropdown functionality.
  • Updated test cases to incorporate new dropdown behavior controls.

• Tests

  • Implemented tests for new dropdown open/close methods to ensure reliability.

[coderabbitai]

Walkthrough

The updates enhance the dropdown functionality in the CourseOverviewComponent by incorporating the NgbDropdown component and adjusting the test mocks accordingly. Significant changes include replacing earlier dropdown handling mechanisms with NgbDropdown, refactoring test cases, and introducing methods to manage dropdown states directly. These modifications streamline dropdown behavior and improve dropdown visibility features.

Changes

File Path	Change Summary
src/test/.../course-overview.component.spec.ts	Added NgbDropdown and NgbDropdownMocksModule for dropdown functionality. Refactored methods and test cases to use new dropdown handling.
src/test/.../mocks/directive/ngbDropdownMocks.module.ts	Updated NgbDropdownMockDirective to replace open with isOpen, and introduced open() and close() methods for explicit state management.

---

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

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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: 4

[coderabbitai]

Actionable comments posted: 2

[JohannesWt]

Code 👍 (nice refactoring)

[egekurt123]

Code LGTM

[florian-glombik]

Tested on ts3, course switching and More dropdown worked as expected.

The Code looks good, thanks for the refactoring!

When testing I noticed a flickering of the icon (seems to be present on previous versions, not introduced by this PR - I think this is something we should address.

[edkaya]

Tested on ts3, didn't face any problems in more option and course switching. Code also lgtm

[edkaya]

Reapprove after latest changes

[edkaya]

Reapprove

[florian-glombik]

Tested on ts1, I think that the more tab should close on selection (would have expected the more section to close on selection and it appears to be the behaviour on production right now)

moreDoesNotCloseOnSelection.mp4

[rabeatwork]

Tested on ts1, I think that the more tab should close on selection (would have expected the more section to close on selection and it appears to be the behaviour on production right now)

moreDoesNotCloseOnSelection.mp4

Please deploy the current version again. This should be fixed already. 👯

[florian-glombik]

Tested on ts1, course switching and more button worked fine for me

The mentioned flickering is out of scope for this PR #8971 (review)

[JohannesWt]

Code reapprove 👍

[egekurt123]

Reapprove, looks good on TS1