cvat Optimize DB requests in project list, job list, and other endpoints

trafficstars

Motivation and context

Added an option to use the organization instance from the object in question, if provided (many viewsets prefetch this)
Removed .first() calls, leading to extra db requests for projects
Added prefetch for source and target storages of jobs
Optimized calls to related manifests in cloudstorages api (however, manifests should be either moved to a separate endpoint or should be limited in maximum number per CS)
Optimized unnecessary DB requests to related models in IAM requests

All this primarily affected GET /api/projects and GET /api/jobs, but other endpoints also benefited from this a little bit.

Examples: 4 projects, > 100 tasks, > 100 jobs

Before: Screenshot from 2024-08-07 18-27-34

Screenshot from 2024-08-07 18-28-00

After: Screenshot from 2024-08-07 18-25-54

Screenshot from 2024-08-07 18-24-19

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 performance of data retrieval in views by optimizing related fields in the JobViewSet.
- Improved handling of organization data in permissions, ensuring more robust checks and reducing unnecessary database queries.
Bug Fixes
- Refined output of serialized data to include only valid task subsets and handle dimensions correctly.
Documentation
- Updates made to improve clarity on serialized responses and organization permission handling.

Aug 07 '24 15:08 zhiltsov-max

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

Recent updates enhance the reliability and performance of the CVAT application by improving data serialization and query optimization. Key changes include filtering empty task subsets in serializers, refining dimension retrieval logic, and expanding related fields in database queries for the JobViewSet. Additionally, the permission logic now handles organization retrieval more efficiently, returning None when inputs are invalid and checking for existing organization associations before querying the database.

Changes

Files	Change Summary
`cvat/apps/engine/serializers.py`	Updated `to_representation` method to filter out empty task subsets and improve dimension retrieval.
`cvat/apps/engine/views.py`	Enhanced `JobViewSet` with additional fields in `select_related` to optimize database queries.
`cvat/apps/iam/permissions.py`	Modified `get_organization` to return `None` for falsy `organization_id` and check for existing organization associations.

Poem

🐰 A hop, a skip, a change so grand,
In serializers' heart, we take a stand.
No empty tasks to cloud the way,
With dimensions clear, we greet the day!
Queries optimized, oh what a delight,
In CVAT’s world, everything feels right! 🌟

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.

Aug 07 '24 15:08 coderabbitai[bot]

/api/jobs now takes longer time (on queries metric)

Each /api/jobs/id/preview also now takes longer time (on queries metric) [significantly] In the second request we do not need many JOINS, so, I would suggest to reduce number of select_related arguments.

Aug 07 '24 15:08 bsekachev

Codecov Report

Attention: Patch coverage is 81.81818% with 6 lines in your changes missing coverage. Please review.

Project coverage is 73.91%. Comparing base (29cde3e) to head (04b1958). Report is 13 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8275      +/-   ##
===========================================
- Coverage    73.94%   73.91%   -0.03%     
===========================================
  Files          435      435              
  Lines        45595    45661      +66     
  Branches      3924     3924              
===========================================
+ Hits         33716    33752      +36     
- Misses       11879    11909      +30

Components	Coverage Δ
cvat-ui	`77.53% <ø> (-0.03%)`	:arrow_down:
cvat-server	`71.00% <81.81%> (-0.02%)`	:arrow_down:

:rocket: New features to boost your workflow:

:snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
:package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Aug 07 '24 16:08 codecov-commenter

I've increased the page_size to get more representative output: http://localhost:7000/api/jobs?page_size=1000 (in my case it returned first 1000 of 2250 jobs).

Baseline:

Screenshot from 2024-08-07 19-29-46

Select_related (source_storage, target_storage, organization, owner), 12 joins:

Screenshot from 2024-08-07 19-29-53

Select_related (source_storage, target_storage) + prefetch_related(organization, owner), 10 joins:

Screenshot from 2024-08-07 19-29-58

And the same, but for 12 jobs (as UI presents):

Screenshot from 2024-08-07 19-28-42

I think, it makes sense to choose one of the 2 optimized variants. I think, the version with 10 joins is a good tradeoff for now, it provides a good balance between the two others.

Aug 07 '24 16:08 zhiltsov-max