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

Development: Fix failing communication server test #8141

Merged
merged 2 commits into from
Mar 5, 2024

Conversation

TimOrtel
Copy link
Contributor

@TimOrtel TimOrtel commented Mar 5, 2024

Checklist

General

Server

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

Motivation and Context

We have a failing test on develop.

Description

Improved the loading logic to only load conversation participants if it is a group chat. Therefore, the participants are no longer loaded in case of channels.

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

Test Coverage

Screenshots

Summary by CodeRabbit

  • Refactor
    • Enhanced readability and separation of concerns in conversation service by delegating conversation loading for group chats to a new method.

@TimOrtel TimOrtel requested a review from a team as a code owner March 5, 2024 15:14
Copy link

coderabbitai bot commented Mar 5, 2024

Walkthrough

The recent modifications focus on enhancing the handling of conversations in a Java application. These changes aim to streamline the retrieval and management of conversation data by refining methods for fetching and interacting with conversations. The updates improve efficiency, readability, and maintainability by adjusting how conversations are fetched based on their ID and enhancing the handling of group chat conversations through better separation of concerns.

Changes

File Path Change Summary
.../metis/ConversationMessagingService.java Refactored the createMessage method to use a service for retrieving conversations, enhancing efficiency and maintainability.
.../metis/conversation/ConversationService.java Updated isMemberOrCreateForCourseWideElseThrow to delegate loading conversations to loadConversationWithParticipantsIfGroupChat for group chats, improving readability and separation of concerns.

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-tests 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 tests 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 tests.
    • @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 github-actions bot added the server Pull requests that update Java code. (Added Automatically!) label Mar 5, 2024
@artemis-bot artemis-bot added this to In progress in Artemis Development Mar 5, 2024
Comment on lines +108 to +109
var conversation = conversationService.isMemberOrCreateForCourseWideElseThrow(conversationId, author, Optional.empty())
.orElse(conversationService.loadConversationWithParticipantsIfGroupChat(conversationId));
Copy link

Choose a reason for hiding this comment

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

The refactoring to use conversationService.isMemberOrCreateForCourseWideElseThrow followed by orElse with conversationService.loadConversationWithParticipantsIfGroupChat introduces a more maintainable and potentially more efficient way to retrieve conversations. This change centralizes the logic for conversation retrieval, which is beneficial for future modifications and debugging. However, ensure that the isMemberOrCreateForCourseWideElseThrow method handles all necessary edge cases and permissions checks adequately, especially since it now plays a critical role in conversation retrieval. Additionally, verify that this change does not introduce any performance regressions, particularly in scenarios where many conversation retrievals occur in a short time frame.

Artemis Development automation moved this from In progress to Review in progress Mar 5, 2024
Strohgelaender
Strohgelaender previously approved these changes Mar 5, 2024
Copy link
Contributor

@Strohgelaender Strohgelaender left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link
Contributor

@reschandreas reschandreas left a comment

Choose a reason for hiding this comment

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

please fix the server style issues, otherwise lgtm

Copy link
Member

@julian-christl julian-christl left a comment

Choose a reason for hiding this comment

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

Server tests working again, thanks.

@bassner bassner added this to the 6.9.1 milestone Mar 5, 2024
@bassner bassner changed the title Development: Fix failing test on development Development: Fix failing communication server test Mar 5, 2024
@bassner bassner merged commit 3557a15 into develop Mar 5, 2024
28 of 32 checks passed
@bassner bassner deleted the fix/fix_failing_conversation_test branch March 5, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
server Pull requests that update Java code. (Added Automatically!)
Projects
No open projects
Artemis Development
  
Review in progress
Development

Successfully merging this pull request may close these issues.

None yet

5 participants