Programming exercises: Prevent unnecessary page refreshes when opening repositories

[pzdr7]

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• 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.

Motivation and Context

Sometimes, clicking on links or buttons caused a reload of the entire angular app, e.g.

• when opening a LocalVC repository from the participations or the details page of a programming exercise
• when viewing the diff of a commit

This caused longer load times and unnecessary REST calls.

Description

I changed [href] to [routerLink] and simplified the links where appropriate, leaving external links as-is (although I did fix some target="_blank"s).

Steps for Testing

Prerequisites:

• Test server with LocalCI
• 1 Programming exercise
• 1 Instructor

Open repository (participant)

1. Log in
2. Navigate to Courses > your course > your programming exercise, click on, and click on "Open Repository".
3. Go to the commit history and click on a commit hash. Verify that the Angular app does not refresh when you do this.

Open repository (exercise details view)

5. Navigate to Course management > your course > exercises and click on the title of your programming exercise.
6. For the template, solution, and test repositories: click "Open Repository" and ensure that the Angular app does not refresh when you do so.

Open repository (participantions)

7. Still on the details page, open the "Participations" view.
8. Click "Open repository" on any participation. Ensure there is no refresh of the Angular app.

Testserver States

Note

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

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

Summary by CodeRabbit

• Refactor
  • Enhanced navigation links in the "Commits Info" component for improved user experience.
  • Streamlined code by removing unused imports and dependencies in various Angular components.
  • Improved routing logic in multiple components for consistent and reliable navigation behavior.

[coderabbitai]

Walkthrough

The changes aim to enhance navigation within an Angular application by shifting from direct href links to using Angular's routerLink for internal routing. This update improves routing efficiency and control in the application. Additionally, the TypeScript components have been optimized by removing unnecessary router imports and associated logic, simplifying the codebase.

Changes

File Path	Change Summary
.../commits-info.component.html	Updated to use [routerLink] instead of [href] for navigation, impacting link generation logic.
.../commits-info.component.ts	Removed Router import and associated logic, leading to a more concise component structure.
.../detail-overview-list.component.html	Corrected target attribute values and adjusted [routerLink] binding syntax for proper navigation.
.../detail-overview-list.component.ts	Eliminated unused router dependency, routerLink property assignment, and Router import.
.../participation.component.html	Modified [href] attribute to [routerLink] with an array parameter for routing, affecting link logic.
.../participation.component.ts	Removed Router dependency, routerLink property, and related usage, impacting component initialization.

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 13f899e and 2656171.

Files selected for processing (1)

• src/main/webapp/app/exercises/shared/participation/participation.component.html (1 hunks)

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

• src/main/webapp/app/exercises/shared/participation/participation.component.html

---

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.

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

[krusche]

code looks good 👍 this is a great improvement, thank you!

[rstief]

Code LGTM ❤️

[Jan-Thurner]

Code lgtm

[coderabbitai]

Actionable comments posted: 1

Out of diff range and nitpick comments (1)

src/main/webapp/app/detail-overview-list/detail-overview-list.component.ts (1)

Line range hint 1-1: Ensure all unused imports are removed to keep the code clean.

[JohannesWt]

Demonstrated in on-site testing session - works as promised 👍