`Exam mode`: Show exercise group title in breadcrumbs
Checklist
General
- [ ] I tested all changes and their related features with all corresponding user types on a test server.
- [x] This is a small issue that I tested locally and was confirmed by another developer on a test server.
- [x] Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
- [x] I chose a title conforming to the naming conventions for pull requests.
Client
- [x] 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).
- [x] I strictly followed the principle of data economy for all client-server REST calls.
- [x] I strictly followed the client coding and design guidelines.
- [x] 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.
- [x] I added multiple integration tests (Jest) related to the features (with a high test coverage), while following the test guidelines.
- [x] I added
authoritiesto all new routes and checked the course groups for displaying navigation elements (links, buttons). - [x] I documented the TypeScript code using JSDoc style.
- [x] I added multiple screenshots/screencasts of my UI changes.
- [ ] I translated all newly inserted strings into English and German.
Motivation and Context
For the exam mode we only want to show the exercise group title to students, not the exercise title. However in some cases the exercise title was still shown in the breadcrums.
Description
I fixed places where the wrong title got saved in the title service by introducing a short method.
Steps for Testing
Open pages for exam exercises where the title is shown in the breadcrumbs, e.g. the repository view for programming exercises. Verify that the exercise group title is visible here, not the exercise title.
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 even for very large courses with more than 2000 students.
Code Review
- [x] Code Review 1
- [ ] Code Review 2
Manual Tests
- [x] Test 1
- [ ] Test 2
Performance Tests
- [ ] Test 1
- [ ] Test 2
Test Coverage
Screenshots
old:
new:
Summary by CodeRabbit
-
New Features
- Introduced a new method for setting exercise titles, enhancing clarity and relevance in the user interface.
-
Improvements
- Streamlined the handling of exercise titles across various services, improving code readability and maintainability.
- Enhanced test coverage for exercise title handling based on user roles and exercise configurations.
Walkthrough
The changes involve refactoring the management of exercise titles across multiple services in the application. The setTitle method has been replaced with a new method, setExerciseTitle, in various classes to centralize and simplify the logic for handling exercise titles. Additionally, new test cases have been introduced to cover different scenarios for setting exercise titles based on user roles.
Changes
| Files | Change Summary |
|---|---|
src/main/webapp/app/course/manage/course-management.service.ts |
Replaced setTitle with setExerciseTitle for exercise title management. |
src/main/webapp/app/exercises/programming/manage/services/programming-exercise-participation.service.ts |
Replaced setTitle with setExerciseTitle for exercise title handling; reorganized import statements. |
src/main/webapp/app/exercises/shared/exercise/exercise.service.ts |
Simplified sendExerciseTitleToTitleService to directly call setExerciseTitle if exercise is present. |
src/main/webapp/app/shared/layouts/navbar/entity-title.service.ts |
Introduced a new public method setExerciseTitle for managing exercise titles based on user roles. |
src/test/javascript/spec/service/entity-title.service.spec.ts |
Added new test cases for EntityTitleService focusing on exercise title handling based on user roles. |
src/test/javascript/spec/service/exercise.service.spec.ts |
Updated tests to use setExerciseTitle instead of setTitle; removed obsolete test case. |
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaior@coderabbitai titleanywhere 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.