Development: Prefer non empty json include annotation

[krusche]

Checklist

General

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

Motivation and Context

We want to always use @JsonInclude(JsonInclude.Include.NON_EMPTY).

Description

Added an architecture test and fixed its violations.

Steps for Testing

code review

Review Progress

Code Review

• Code Review 1
• Code Review 2

Summary by CodeRabbit

• Refactor
  • Improved JSON serialization handling of empty values across various classes for better data presentation in the application, impacting teams, notifications, participations, lecture units, quizzes, results, tutorial groups, learning paths, and science events.
• Tests
  • Introduced a new test method to ensure correct usage of updated JSON serialization annotations, maintaining data integrity and consistency.
• Chores
  • Added StringUtils import for StringUtils.isEmpty() method in LectureUnitProcessingService.java.
  • Replaced isEmpty() with isNullOrEmpty() in ResultServiceIntegrationTest.java for more precise point per criterion assertion.

[coderabbitai]

Walkthrough

The overall change across various files in the project involves updating the @JsonInclude annotation from NON_NULL to NON_EMPTY. This modification affects how JSON serialization handles null and empty values, aiming for a more concise and meaningful JSON output by excluding both null and empty fields. Additionally, a new test method has been introduced to ensure the correct application of this annotation across the project, enhancing the consistency and reliability of JSON data representation.

Changes

File(s)	Change Summary
.../domain/Team.java .../notification/NotificationTarget.java .../participation/StudentParticipation.java .../web/rest/dto/LectureUnitInformationDTO.java .../web/rest/dto/QuizBatchJoinDTO.java .../web/rest/dto/ResultWithPointsPerGradingCriterionDTO.java .../web/rest/dto/TutorialGroupFreePeriodDTO.java .../web/rest/dto/competency/LearningPathHealthDTO.java .../web/rest/dto/competency/NgxLearningPathDTO.java .../web/rest/dto/science/ScienceEventDTO.java	Changed the @JsonInclude annotation from NON_NULL to NON_EMPTY, affecting JSON serialization by excluding null and empty fields from the output.
.../service/LectureUnitProcessingService.java	Added an import statement for StringUtils from org.apache.commons.lang3 to use StringUtils.isEmpty() method for checking empty strings in LectureUnitProcessingService.java.
.../test/java/de/tum/in/www1/artemis/ArchitectureTest.java	Extended functionality to include a new test method testJsonIncludeNonEmpty() to verify the presence of @JsonInclude(JsonInclude.Include.NON_EMPTY) annotation, with added imports for JavaEnumConstant and HasAnnotations.
.../test/java/de/tum/in/www1/artemis/assessment/ResultServiceIntegrationTest.java	Replaced usages of isEmpty() with isNullOrEmpty() in two test methods for asserting points per criterion in results with points.

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.

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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.