Adaptive learning: Fix loading of programming exercises in learning path view

[MaximilianAnzinger]

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 (e.g. using paging).
• I strictly followed the principle of data economy for all client-server REST calls.
• 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

When students want to work on programming exercises in the learning path view, the UI does not display the exercise immediately. They are required to open a dropdown to trigger the change detection.

Resolves #10196

Description

• triggers change detection after loading exercise in component

Steps for Testing

Prerequisites:

• 1 Student
• 1 Course (Learning Paths enabled)
• 1 Competency
• 1 Programming exercise linked to the competency

1. Log in to Artemis as a Student
2. Navigate to the course > Learning Path
3. The Learning path should load and display the programming exercise as usual.

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

unchanged

Summary by CodeRabbit

• New Features
  • The exercise header now appears only when a relevant icon is available, ensuring a cleaner display.
  • Updates to exercise details are now promptly reflected in the view, enhancing the overall user experience.

[coderabbitai]

Walkthrough

The changes modify the exercise details component by introducing conditional rendering in the HTML template and enhancing the update mechanism in the TypeScript file. The template now displays the exercise header only if an exerciseIcon exists, while the component uses a newly injected ChangeDetectorRef to trigger a view update via detectChanges() after new exercise details are loaded. No changes were made to any exported or public entities.

Changes

File(s)	Change Summary
src/.../course-exercise-details.component.html	Added a conditional check to render the exercise header only when exerciseIcon is truthy.
src/.../course-exercise-details.component.ts	Injected ChangeDetectorRef and invoked detectChanges() in handleNewExercise to force view update.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller/Service
    participant Component as CourseExerciseDetailsComponent
    participant CDR as ChangeDetectorRef
    participant View as Angular View

    Caller->>Component: handleNewExercise(newExerciseDetails)
    Component->>Component: Update exercise property with new details
    Component->>CDR: detectChanges()
    CDR->>View: Trigger view update

Loading

sequenceDiagram
    participant Template as HTML Template
    participant Check as Conditional Check

    Template->>Check: Evaluate if exerciseIcon exists
    alt exerciseIcon exists
        Check-->>Template: Render header with icon
    else
        Check-->>Template: Do not render header
    end

Loading

Suggested labels

client, bugfix, ready to merge, small, tests

Suggested reviewers

• JohannesStoehr
• SimonEntholzer
• florian-glombik
• krusche
• HanyangXu0508

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93eba08 and abe5003.

📒 Files selected for processing (2)

• src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html (1 hunks)
• src/main/webapp/app/overview/exercise-details/course-exercise-details.component.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

`src/main/webapp/**/*.html`: @if and @for are new and valid ...

src/main/webapp/**/*.html: @if and @for are new and valid Angular syntax replacing *ngIf and *ngFor. They should always be used over the old style.

• src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html

`src/main/webapp/**/*.ts`: angular_style:https://angular.io/...

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

• src/main/webapp/app/overview/exercise-details/course-exercise-details.component.ts

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: Call Build Workflow / Build .war artifact
• GitHub Check: Call Build Workflow / Build and Push Docker Image
• GitHub Check: Codacy Static Code Analysis
• GitHub Check: server-style
• GitHub Check: server-tests
• GitHub Check: client-tests
• GitHub Check: Analyse

🔇 Additional comments (4)

src/main/webapp/app/overview/exercise-details/course-exercise-details.component.html (1)

5-7: Proper use of conditional rendering with @if directive.

The implementation correctly uses Angular's new @if directive instead of the older *ngIf style as required by the coding guidelines. This conditional rendering ensures the exercise header only displays when there's a valid icon, preventing visual glitches during loading.

src/main/webapp/app/overview/exercise-details/course-exercise-details.component.ts (3)

1-1: Correctly imports ChangeDetectorRef from Angular core.

The proper import of ChangeDetectorRef from @angular/core is included alongside the existing imports.

---

117-117: Good use of dependency injection for ChangeDetectorRef.

The component correctly uses Angular's inject function to get a reference to ChangeDetectorRef, following Angular's recommended dependency injection pattern.

---

228-228: Effective solution for learning path view loading issue.

The call to this.cdr.detectChanges() immediately after setting the exercise property is exactly what's needed to address the PR objective. This ensures the view is updated promptly after loading the exercise data, without requiring user interaction to trigger change detection.

The descriptive comment also helps other developers understand the purpose of this change, which is important for maintainability.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere 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.

[ole-ve]

code