Assessment: Fix an issue where instructors accidentally override presentation scores

[krusche]

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.

Server

• Important: I implemented the changes with a very good performance and prevented too many (unnecessary) and too complex database calls.
• I strictly followed the server coding and design guidelines.

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.

Motivation and Context

Fix an issue with overriding the presentation score with a temporary workaround

Steps for Testing

Prerequisites:

• 1 Instructor

1. Create a grading key with presentation score (course management --> scores --> grading key)
2. Update the course settings (e.g. end date)
3. Make sure the grading key with presentation score still exists and is not overrridden

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

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Summary by CodeRabbit

• Code Refactoring

  • Removed direct getter and setter methods for posts in the Course class
  • Simplified course resource by removing grading scale service dependency
  • Updated course update component with improved type safety and code readability

• Technical Improvements

  • Streamlined repository access for grading scale information
  • Enhanced type casting in course update process

Summary by CodeRabbit

• Code Refactoring
  • Removed getPosts() and setPosts() methods from the Course class
  • Simplified CourseResource by removing GradingScaleService dependency
  • Updated type casting and code structure in course-update.component.ts

[coderabbitai]

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 pmd (7.8.0)

src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java

The following rules are missing or misspelled in your ruleset file category/vm/bestpractices.xml: BooleanInstantiation, DontImportJavaLang, DuplicateImports, EmptyFinallyBlock, EmptyIfStmt, EmptyInitializer, EmptyStatementBlock, EmptyStatementNotInLoop, EmptySwitchStatements, EmptySynchronizedBlock, EmptyTryBlock, EmptyWhileStmt, ExcessiveClassLength, ExcessiveMethodLength, ImportFromSamePackage, MissingBreakInSwitch, SimplifyBooleanAssertion. Please check your ruleset configuration.

Walkthrough

The pull request involves modifications to the course management system across multiple files. Changes include removing getter and setter methods for posts in the Course class, simplifying the grading scale handling in the CourseResource by directly using the repository instead of a service, and enhancing type safety and code readability in the course-update.component.ts TypeScript file. These changes indicate a refactoring effort to streamline course-related functionality and improve code structure.

Changes

File	Change Summary
src/main/java/de/tum/cit/aet/artemis/core/domain/Course.java	Removed getPosts() and setPosts(Set<Post> posts) methods
src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java	Removed GradingScaleService dependency, now directly using gradingScaleRepository
src/main/webapp/app/course/manage/course-update.component.ts	Updated save() method with explicit Course type casting and improved property assignment syntax

Possibly related PRs

• Learning paths: Redesign learning path instructor view #9144: The main PR involves the removal of methods related to managing posts in the Course class, which may connect to changes in how course data is handled in the instructor view, as seen in the redesign of the learning path instructor view.
• General: Redesign the course overview #9221: The changes in the course management service and course card component may relate to the overall management of course data, which is impacted by the removal of the getPosts() and setPosts() methods in the main PR.
• General: Fix an issue with course deletion summary entries #9856: The modifications to the CourseDeletionSummaryDTO and CourseService to include additional metrics may be relevant, as they enhance the data structure that could be affected by the removal of direct post management methods in the Course class.

Suggested Labels

bugfix, assessment, ready for review, tests

Suggested Reviewers

• Hialus
• SimonEntholzer
• florian-glombik
• b-fein

---

📜 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 4fae2b2 and 292cc91.

📒 Files selected for processing (1)

• src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

🔇 Additional comments (2)

src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (2)

197-200: LGTM!

The constructor parameters have been properly organized for better readability.

---

1341-1341: Verify grading scale retrieval behavior.

The grading scale retrieval is now directly using the repository instead of a service. This change aligns with the PR objective to prevent accidental overriding of presentation scores.

Run the following script to verify the usage of grading scale repository across the codebase:

✅ Verification successful

Direct repository usage for grading scale is consistent and safe.

The grading scale repository is consistently used across the codebase with proper null handling patterns, and the direct repository access aligns with preventing accidental overrides of presentation scores.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistent usage of grading scale repository
# Test: Search for all usages of gradingScaleRepository to ensure consistent pattern
rg -A 3 'gradingScaleRepository\.findByCourseId'

Length of output: 8104

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 (2)

src/main/webapp/app/course/manage/course-update.component.ts (2)

298-301: Good type safety improvement, but consider addressing the technical debt.

The explicit type casting and preservation of presentationScore effectively prevents accidental overrides. However, the TODO comment suggests a better long-term solution.

Consider creating a follow-up task to move presentationScore to gradingScale for a more maintainable solution. This would eliminate the need for special handling in the save method.

---

304-309: LGTM! Clear and consistent configuration handling.

The logic for setting courseInformationSharingConfiguration is well-structured and handles all states appropriately.

Consider using an early return pattern to reduce nesting:

-if (this.communicationEnabled && this.messagingEnabled) {
-    course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.COMMUNICATION_AND_MESSAGING;
-} else if (this.communicationEnabled && !this.messagingEnabled) {
-    course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.COMMUNICATION_ONLY;
-} else {
-    this.communicationEnabled = false;
-    course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.DISABLED;
-}
+if (this.communicationEnabled && this.messagingEnabled) {
+    course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.COMMUNICATION_AND_MESSAGING;
+    return;
+}
+
+if (this.communicationEnabled && !this.messagingEnabled) {
+    course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.COMMUNICATION_ONLY;
+    return;
+}
+
+this.communicationEnabled = false;
+course.courseInformationSharingConfiguration = CourseInformationSharingConfiguration.DISABLED;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0646b25 and 4fae2b2.

📒 Files selected for processing (3)

• src/main/java/de/tum/cit/aet/artemis/core/domain/Course.java (0 hunks)
• src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (2 hunks)
• src/main/webapp/app/course/manage/course-update.component.ts (1 hunks)

💤 Files with no reviewable changes (1)

• src/main/java/de/tum/cit/aet/artemis/core/domain/Course.java

🧰 Additional context used

📓 Path-based instructions (2)

src/main/webapp/app/course/manage/course-update.component.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/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (1)

Pattern src/main/java/**/*.java: naming:CamelCase; principles:{single_responsibility,small_methods,no_duplication}; db:{perf_queries,datetime_not_timestamp}; rest:{stateless,singleton,delegate_logic,http_only,minimal_dtos}; dtos:{java_records,no_entities,min_data,single_resp}; di:constructor_injection; kiss:simple_code; file_handling:os_indep_paths; practices:{least_access,avoid_transactions,code_reuse,static_member_ref,prefer_primitives}; sql:{param_annotation,uppercase,avoid_subqueries};java:avoid_star_imports

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

• GitHub Check: client-tests
• GitHub Check: server-tests
• GitHub Check: Build and Push Docker Image
• GitHub Check: Analyse

🔇 Additional comments (2)

src/main/java/de/tum/cit/aet/artemis/core/web/CourseResource.java (2)

192-194: LGTM!

The constructor parameter reordering and reformatting improves readability while maintaining the same functionality.

---

1334-1334: Verify the direct repository usage impact.

The change from using gradingScaleService to directly using gradingScaleRepository simplifies the code but bypasses the service layer. While this works, it's worth verifying that we're not losing any important business logic that was previously handled by the service.

Run this script to check for any business logic in the removed service that we might be missing:

[github-actions]

⚠️ Unable to deploy to test servers ⚠️

Testserver "artemis-test2.artemis.cit.tum.de" is already in use by PR #10134.

[HawKhiem]

Tested on TS5. I generated a grading key with presentation score the set the end date of a course to today. The grading key is still visible