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

Optimized number of queries on GET /projects, GET /project/<id>/preview and GET /labels endpoints. #8155

Merged
merged 23 commits into from
Jul 31, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Jul 12, 2024

Motivation and context

Retrieving a list of projects and previews:

Before:
image

After:
image

Retrieving a list of labels for a project O(number of labels) with 10 labels:
Before:
image

After:
image

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Enhanced project and task preview functionality to include related data, providing more detailed information.
  • Bug Fixes

    • Improved handling of task subsets and dimension to ensure more accurate and efficient data representation.

Copy link
Contributor

coderabbitai bot commented Jul 12, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes involve optimizing data processing in the to_representation method within serializers.py by using generators. Additionally, new handling for a preview action was added in views.py to filter Project or Task objects based on certain conditions and to fetch related data more efficiently.

Changes

File Change Summary
cvat/apps/engine/serializers.py Updated to_representation method in Meta class to use generators for deriving task_subsets and dimension.
cvat/apps/engine/views.py Added handling for preview action to filter objects and modified query to include related data for preview fetching.

Poem

In the realm of code, where tasks abound,
Generators leap, and filters are found.
With subsets and dimensions, refined with care,
Preview paths now shine, like stars in clear air.
Hopping through data, with a joyful cheer,
More efficient processes, make the future near.


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

Copy link
Contributor

@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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54e857d and deb3996.

Files selected for processing (2)
  • cvat/apps/engine/serializers.py (1 hunks)
  • cvat/apps/engine/views.py (3 hunks)
Additional comments not posted (6)
cvat/apps/engine/serializers.py (2)

1347-1348: Good use of generators for memory efficiency!

Using generators to collect subsets and dimensions is a memory-efficient improvement.


1349-1352: Ensure the first dimension is correctly retrieved

The use of next(dimensions, None) retrieves the first dimension or None if the generator is empty. Verify that this behavior is intended and correct.

cvat/apps/engine/views.py (4)

292-293: Ensure correctness of the filtering logic for preview action.

The code changes are approved.

However, ensure that the filtering logic for the preview action is appropriate and efficient.


630-630: Ensure correctness of the data fetching logic for the first task in preview method.

The code changes are approved.

However, ensure that necessary related data is included and the method handles cases where no tasks are available.


869-870: Ensure correctness of the filtering logic for preview action.

The code changes are approved.

However, ensure that the filtering logic for the preview action is appropriate and efficient.


870-870: Ensure correctness of the data fetching logic for the first task in preview method.

The code changes are approved.

However, ensure that necessary related data is included and the method handles cases where no tasks are available.

@codecov-commenter
Copy link

codecov-commenter commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (develop@b5d48c7). Learn more about missing BASE report.
Report is 27 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##             develop    #8155   +/-   ##
==========================================
  Coverage           ?   83.31%           
==========================================
  Files              ?      388           
  Lines              ?    41354           
  Branches           ?     3856           
==========================================
  Hits               ?    34454           
  Misses             ?     6900           
  Partials           ?        0           
Components Coverage Δ
cvat-ui 79.64% <ø> (?)
cvat-server 86.60% <100.00%> (?)

@bsekachev bsekachev changed the title Optimized number of queries on Projects page Optimized number of queries on GET /projects, GET /project/<id>/preview and GET /labels endpoints. Jul 15, 2024
cvat/apps/engine/views.py Outdated Show resolved Hide resolved
Comment on lines 286 to 289
if self.action in ('list', 'retrieve', 'partial_update', 'update') :
queryset = queryset.select_related(
'annotation_guide', 'source_storage', 'target_storage',
).prefetch_related('tasks')
Copy link
Contributor

Choose a reason for hiding this comment

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

How about export/import backup/dataset v1/v2? I remember that at least target_storage/source_storage is used when exporting/importing a project resource.

Copy link
Member Author

Choose a reason for hiding this comment

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

I will check

Copy link
Member Author

Choose a reason for hiding this comment

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

Added 'source_storage', 'target_storage' to the default queryset.

cvat/apps/engine/views.py Outdated Show resolved Hide resolved
cvat/apps/engine/views.py Show resolved Hide resolved
cvat/apps/engine/views.py Outdated Show resolved Hide resolved
@bsekachev
Copy link
Member Author

bsekachev commented Jul 26, 2024

@Marishka17
Any more comments?

Copy link
Contributor

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

sonarcloud bot commented Jul 30, 2024

@bsekachev bsekachev merged commit 2191ffa into develop Jul 31, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/queries_optimization branch July 31, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants