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

Adaptive learning: Fix query performance when retrieving exercise information for mastery calculation #8871

Conversation

JohannesStoehr
Copy link
Contributor

@JohannesStoehr JohannesStoehr commented Jun 24, 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

#8791 introduced a new query to calculate the mastery of a student. Somehow important join conditions got lost, which leads to a high load on the data base.

Description

Fixes the query to correctly use join conditions and only load the relevant data.

Steps for Testing

Manual testing difficult, since only huge data leads to performance issues...

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

  • New Features
    • Enhanced competency tracking by adding user-specific exercise details.

@JohannesStoehr JohannesStoehr requested a review from a team as a code owner June 24, 2024 18:54
Copy link

coderabbitai bot commented Jun 24, 2024

Warning

Rate limit exceeded

@JohannesStoehr has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 26 minutes and 49 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 298d2b6 and 1e364a9.

Walkthrough

Recent updates to the Artemis platform focused on improving user-specific data retrieval for competency-related exercises. By introducing a user parameter in repository and service layer methods, the platform now provides personalized exercise information. This enhancement refines data join conditions and integrates user context, ensuring a more customized experience for each user engaging with competency exercises.

Changes

File Path Change Summary
.../CompetencyRepository.java Enhanced findAllExerciseInfoByCompetencyId method to include a user parameter.
.../CompetencyProgressService.java Updated method findAllExerciseInfoByCompetencyId to include a user parameter.

Sequence Diagram(s)

Existing Flow

sequenceDiagram
    participant User
    participant Service as CompetencyProgressService
    participant Repo as CompetencyRepository
    User->>Service: findAllExerciseInfoByCompetencyId(competencyId)
    Service->>Repo: findAllExerciseInfoByCompetencyId(competencyId)
    Repo-->>Service: Exercise Info
    Service-->>User: Exercise Info
Loading

Updated Flow

sequenceDiagram
    participant User
    participant Service as CompetencyProgressService
    participant Repo as CompetencyRepository
    User->>Service: findAllExerciseInfoByCompetencyId(competencyId, user)
    Service->>Repo: findAllExerciseInfoByCompetencyId(competencyId, user)
    Repo-->>Service: Personalized Exercise Info
    Service-->>User: Personalized Exercise Info
Loading

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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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 server Pull requests that update Java code. (Added Automatically!) label Jun 24, 2024
coderabbitai[bot]
coderabbitai bot previously approved these changes Jun 24, 2024
@krusche krusche changed the title Adaptive learning: Fix query to retrieve exercise information for mastery calculation Adaptive learning: Fix query performance when retrieving exercise information for mastery calculation Jun 24, 2024
@krusche krusche added this to the 7.3.0 milestone Jun 24, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Copy link
Member

@krusche krusche left a comment

Choose a reason for hiding this comment

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

Code changes look good and should fix the performance issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance priority:critical ready for review server Pull requests that update Java code. (Added Automatically!) tests
Projects
Archived in project
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants