General: Display total LLM cost as text instead of pie chart

[wasnertobias]

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

• 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 a screenshot of my UI changes.

Motivation and Context

There is no max value for LLM usage given. Hence, displaying it as a pie chart does not make sense.

Description

Instead, the total LLM cost is displayed as text in the course details view. In a future PR the design will be improved as it will be integrated in the existing statistics page.

Steps for Testing

Prerequisites:

• 1 Instructor of course A
• IRIS or Athena usage in course A is enabled

1. Log in to Artemis
2. Navigate to Course Details view
3. See that "Total LLM Cost" is displayed

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.
• I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance even for very large courses with more than 2000 students.

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Exam Mode Test

• Test 1
• Test 2

Performance Tests

• Test 1
• Test 2

Test Coverage

Screenshots

Summary by CodeRabbit

• UI Improvements
  • Simplified doughnut chart statistics display in course detail view
  • Replaced LLM cost doughnut chart with a direct text display of total cost
  • Streamlined rendering of percentage and absolute values in chart component

[coderabbitai]

Walkthrough

This pull request modifies the presentation of LLM cost and statistics in the course detail view. The changes involve simplifying the doughnut chart component's HTML template and updating the course detail component to display the LLM cost as a text element instead of a graphical chart. The modifications aim to improve the clarity and readability of cost and statistical information in the user interface.

Changes

File	Change Summary
src/main/webapp/app/course/manage/detail/course-detail-doughnut-chart.component.html	Simplified conditional rendering of percentage and absolute values, ensuring consistent display of statistics
src/main/webapp/app/course/manage/detail/course-detail.component.html	Replaced doughnut chart for LLM cost with a text-based display, maintaining conditional rendering based on irisChatEnabled or isAthenaEnabled flags

Sequence Diagram

sequenceDiagram
    participant UI as User Interface
    participant Component as Course Detail Component
    participant Service as Data Service

    UI->>Component: Request Course Details
    Component->>Service: Fetch Course Statistics
    Service-->>Component: Return Statistics
    alt LLM Chat Enabled
        Component->>UI: Display LLM Cost as Text
    else LLM Chat Disabled
        Component->>UI: Hide LLM Cost
    end

Loading

Possibly related PRs

• General: Display total LLM cost in course detail view #10019: Adds a doughnut chart to display total LLM cost in the course detail view

Suggested labels

feature, user interface, ready for review, code quality

Suggested reviewers

• krusche
• florian-glombik
• SimonEntholzer
• HawKhiem
• cremertim

---

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>, 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/main/webapp/app/course/manage/detail/course-detail.component.html (1)

44-48: LGTM! Successfully replaces chart with text display.

The implementation aligns with the PR objective to display LLM cost as text instead of a pie chart. The conditional rendering and translation handling are correct.

Consider these improvements for better i18n support:

-{{ 'artemisApp.course.detail.currentTotalLLMCostTitle' | artemisTranslate }}{{ ': ' + courseDTO?.currentTotalLlmCostInEur + ' €' }}
+{{ 'artemisApp.course.detail.currentTotalLLMCostWithValue' | artemisTranslate: { cost: courseDTO?.currentTotalLlmCostInEur } }}

This assumes adding a new translation key that includes the full format with currency symbol, allowing for proper localization of both the text format and currency symbol.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d6a1b81 and 2f87092.

📒 Files selected for processing (2)

• src/main/webapp/app/course/manage/detail/course-detail-doughnut-chart.component.html (1 hunks)
• src/main/webapp/app/course/manage/detail/course-detail.component.html (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/main/webapp/app/course/manage/detail/course-detail-doughnut-chart.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.

src/main/webapp/app/course/manage/detail/course-detail.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 (1)

src/main/webapp/app/course/manage/detail/course-detail-doughnut-chart.component.html (1)

13-14: LGTM! Clean template simplification.

The simplified display of statistics improves readability while maintaining all necessary information. The template correctly uses the new Angular @if syntax as per guidelines.