Adaptive learning: Omit competency taxonomy icon on dashboard if no taxonomy is set

[MaximilianAnzinger]

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

Description

Omits competency icon if no taxonomy is set.

Steps for Testing

Prerequisites:

• 1 Student
• Course with Adaptive Dashboard enabled
• 2 Competencies (One with Taxonomy set, one without Taxonomy)

1. Log in to Artemis
2. Navigate to Course Dashboard
3. Competency with taxonomy should display icon
4. Competency without should omit icon

Testserver States

Note

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

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• New Features

  • Improved competency tooltip logic to display icons conditionally based on the presence of competency.taxonomy.

• Bug Fixes

  • Fixed an issue where tooltips were displayed for competencies without a taxonomy by adding a conditional check.

• Refactor

  • Updated the taxonomy property in CompetencyInformation to be optional for better data handling.

[coderabbitai]

Walkthrough

The changes improve the handling of taxonomy within the competency module and student metrics. Specifically, the competency-accordion.component.html file now conditionally renders an icon based on the presence of competency.taxonomy, and the taxonomy property in student-metrics.model.ts is now optional, enhancing flexibility in the model.

Changes

Files	Change Summary
src/main/webapp/app/course/competencies/competency-accordion/competency-accordion.component.html	Updated tooltip generation to conditionally render <fa-icon> based on competency.taxonomy.
src/main/webapp/app/entities/student-metrics.model.ts	Made taxonomy property optional in CompetencyInformation class.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 501956f and bbdc067.

Files selected for processing (2)

• src/main/webapp/app/course/competencies/competency-accordion/competency-accordion.component.html (1 hunks)
• src/main/webapp/app/entities/student-metrics.model.ts (1 hunks)

Additional context used

Path-based instructions (2)

src/main/webapp/app/entities/student-metrics.model.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

src/main/webapp/app/course/competencies/competency-accordion/competency-accordion.component.html (1)

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

Additional comments not posted (1)

src/main/webapp/app/course/competencies/competency-accordion/competency-accordion.component.html (1)

9-16: The implementation of the conditional rendering of the <fa-icon> using the new @if syntax is clean and adheres to Angular best practices. Good use of data binding and tooltips.

---

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

[FelixTJDietrich]

Code looks good ans works as expected.
I verified it on TS1 (TS2 seems broken) with my course.