Exam mode: Fix navigation when clicking open repository

[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 authorities to all new routes and checked the course groups for displaying navigation elements (links, buttons).
• I added multiple screenshots/screencasts of my UI changes.

Motivation and Context

#8878

Description

When clicking on "Open Repository", "Open Commit History" or a Commit Hash the user was redirected to the exam overview page.

Steps for Testing

Prerequisites:

• 1 Instructor
• 1 Student
• 1 Exam with a Programming Exercise

1. Log in to Artemis as student
2. Navigate to Exam
3. Participate in the exam
4. Open a programming exercise within the exam
5. click "Open Repository"
6. verify that you're navigated to a read-only code editor that shows the repo
7. click on "Open Commit History"
8. Verify that you see the commit history
9. click on a Commit Hash
10. Verify that you see a Diff view

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

Exam Mode Test

• Test 1
• Test 2

Screenshots

https://github.com/ls1intum/Artemis/assets/75392103/63d99ccd-4565-4f0f-97d0-038f17d62d14

Summary by CodeRabbit

• New Features

  • Introduced routes for repository views, commit history, and commit details for exercises within courses and exams.
  • Enabling interaction with exercise repositories as part of course activities.

• Removals

  • Removed routes and configurations related to RepositoryViewComponent, CommitHistoryComponent, and CommitDetailsViewComponent from exam participation routes.

[coderabbitai]

Walkthrough

The changes enhance the routing system of the web application by integrating additional routes for repository views and participation in exercises across courses and exams. This involves introducing new components like RepositoryViewComponent, CommitHistoryComponent, and CommitDetailsViewComponent while removing similar configurations from a related module (examParticipationRoute). Another new modification adds a route for programming-repository-routing.module enabling users to interact with exercise repositories within course activities.

Changes

Files/Paths	Change Summary
src/main/webapp/app/app-routing.module.ts	Added routes for RepositoryViewComponent, CommitHistoryComponent, CommitDetailsViewComponent, and indicated data configurations and guards. Introduced a route for programming-repository-routing.module.
src/main/webapp/app/exam/participate/exam-participation.route.ts	Removed routes and related data configurations and guards for RepositoryViewComponent, CommitHistoryComponent, and CommitDetailsViewComponent.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AppRoutingModule
    participant RepositoryViewComponent
    participant CommitHistoryComponent
    participant CommitDetailsViewComponent
    participant UserRouteAccessService
    participant LocalVCGuard

    User ->> AppRoutingModule: Access Repository View URL
    AppRoutingModule ->> UserRouteAccessService: Check User Access
    UserRouteAccessService -->> AppRoutingModule: Access Granted
    AppRoutingModule ->> RepositoryViewComponent: Load Repository View
    RepositoryViewComponent ->> LocalVCGuard: Check Local VC Guard
    LocalVCGuard -->> RepositoryViewComponent: Guard Passed
    RepositoryViewComponent -->> User: Display Repository View

    User ->> AppRoutingModule: Access Commit History URL
    AppRoutingModule ->> UserRouteAccessService: Check User Access
    UserRouteAccessService -->> AppRoutingModule: Access Granted
    AppRoutingModule ->> CommitHistoryComponent: Load Commit History
    CommitHistoryComponent ->> LocalVCGuard: Check Local VC Guard
    LocalVCGuard -->> CommitHistoryComponent: Guard Passed
    CommitHistoryComponent -->> User: Display Commit History

    User ->> AppRoutingModule: Access Commit Details URL
    AppRoutingModule ->> UserRouteAccessService: Check User Access
    UserRouteAccessService -->> AppRoutingModule: Access Granted
    AppRoutingModule ->> CommitDetailsViewComponent: Load Commit Details
    CommitDetailsViewComponent ->> LocalVCGuard: Check Local VC Guard
    LocalVCGuard -->> CommitDetailsViewComponent: Guard Passed
    CommitDetailsViewComponent -->> User: Display Commit Details

Loading

sequenceDiagram
    participant User
    participant AppRoutingModule
    participant ArtemisProgrammingRepositoryRoutingModule

    User ->> AppRoutingModule: Access Programming Repository URL
    AppRoutingModule ->> ArtemisProgrammingRepositoryRoutingModule: Load Programming Repository Module
    ArtemisProgrammingRepositoryRoutingModule -->> User: Display Programming Repository Interfaces

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 91612d3 and e7b27b1.

Files selected for processing (1)

• src/main/webapp/app/app-routing.module.ts (1 hunks)

Additional context used

Path-based instructions (1)

src/main/webapp/app/app-routing.module.ts (1)

Pattern src/main/webapp/**/*.ts: angular_style:https://angular.io/guide/styleguide;methods_in_html:false;lazy_loading:true;code_reuse:true;tests:meaningful;types:PascalCase;enums:PascalCase;funcs:camelCase;props:camelCase;no_priv_prefix:true;strings:single_quotes;localize:true;btns:functionality;links:navigation;icons_text:newline;labels:associate;code_style:arrow_funcs,curly_braces,open_braces_same_line,indent_4;memory_leak_prevention:true;routes:naming_schema;chart_framework:ngx-charts;responsive_layout:true

Additional comments not posted (1)

src/main/webapp/app/app-routing.module.ts (1)

104-106: Approve the addition of the new route for programming repositories.

The route is correctly configured for lazy loading, which is great for performance. However, consider adding a comment to describe the purpose of this route, enhancing maintainability and readability for future developers.

+                    // This route allows students to access the programming repository in a read-only mode during exams

---

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 Configration 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: 2

[pzdr7]

Thanks for fixing this. Tested on TS1; works as expected 👍

[florian-glombik]

Approve code, thanks for removing the outdated routing code :)

[egekurt123]

Code LGTM