Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tutorial groups: Add utilization and attendance to tutorial groups sidebar #8586

Merged
merged 4 commits into from
May 17, 2024

Conversation

rabeatwork
Copy link
Contributor

@rabeatwork rabeatwork commented May 13, 2024

Checklist

General

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.
  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Motivation and Context

The utilization rate is an important indicator for students whose tutorial groups have been canceled due to a public holiday, for example. It allows them to easily see which alternative tutorial groups they can attend instead.

Description

Add the Utilization (and attendance if not capacity is available) to the sidebar.

Steps for Testing

Prerequisites:

  • 1 Instructor
  • 1 Students
  • 1 Tutorial Group with capacity and attendance
  • 1 Tutorial Group with no capacity
  1. Log in to Artemis
  2. Navigate to Tutorial Groups
  3. See the capacity/average attendance for the tutorial group

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

Screenshots

Screenshot 2024-05-13 at 15 29 02

@rabeatwork rabeatwork requested a review from a team as a code owner May 13, 2024 13:37
Copy link

coderabbitai bot commented May 13, 2024

Warning

Rate Limit Exceeded

@rabeatwork has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 24 minutes and 17 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between c3e7c0c and de25548.

Walkthrough

The recent updates focus on improving localization and functionality in a web application. The CourseOverviewService now includes additional dependencies and a new method for utilization calculation. Localization files for English and German have been expanded to include new entries related to upcoming sessions and attendance, enhancing the user experience across different languages.

Changes

File Path Change Summary
.../course-overview.service.ts Added TranslateService to constructor; new method getUtilization()
.../i18n/de/student-dashboard.json, .../i18n/en/student-dashboard.json Added localization for "noUpcomingSession" in German and English
.../i18n/de/tutorialGroups.json, .../i18n/en/tutorialGroups.json Added localization for "attendance" in German and English

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

@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label May 13, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes May 13, 2024
az108
az108 previously approved these changes May 13, 2024
Copy link
Contributor

@az108 az108 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM and tested it on Testserver 1, works as expected

Copy link
Contributor

@JohannesStoehr JohannesStoehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also color the tutorials according to their utilization like the exercises are colored for difficulty? There is also a utilization meter in Artemis that uses color as well:
Bildschirmfoto 2024-05-12 um 23 07 33

src/main/webapp/app/overview/course-overview.service.ts Outdated Show resolved Hide resolved
src/main/webapp/i18n/de/student-dashboard.json Outdated Show resolved Hide resolved
pzdr7
pzdr7 previously approved these changes May 13, 2024
Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested on TS1.

  • G1 Created a tutor group; left capacity blank; registered 2 students; average attendance 8
  • G2 Created a tutor group; capacity 7; registered 2 students; average attendance 3
  • G3 Created a blank tutor group (no capacity, no students)

image

-> Works as expected! ✅

egekurt123
egekurt123 previously approved these changes May 14, 2024
Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested manually on TS1, works as expected

coderabbitai[bot]
coderabbitai bot previously approved these changes May 14, 2024
@rabeatwork rabeatwork force-pushed the chore/tutorial-groups/add-utilization-to-sidebar branch from c3e7c0c to aab137f Compare May 14, 2024 13:54
Copy link
Contributor

@JohannesStoehr JohannesStoehr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code and screenshots look good to me

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reapprove

Copy link
Contributor

@az108 az108 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reapprove

Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reapprove after small changes

@krusche krusche added this to the 7.1.0 milestone May 17, 2024
@krusche krusche merged commit 5a80983 into develop May 17, 2024
33 of 38 checks passed
@krusche krusche deleted the chore/tutorial-groups/add-utilization-to-sidebar branch May 17, 2024 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Pull requests that update TypeScript code. (Added Automatically!) small
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

None yet

6 participants