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

enhancing analytics #8616

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

enhancing analytics #8616

wants to merge 5 commits into from

Conversation

Eldies
Copy link
Contributor

@Eldies Eldies commented Oct 30, 2024

Motivation and context

  1. Minimize payload for create:tags, create:shapes, create:tracks, update:tags, update:shapes, update:tracks, delete:tags, delete:shapes, delete:tracks
  2. sending update/create/delete for Memberships, Invitations, Webhooks

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

  • Bug Fixes
    • Refined event logging by removing unnecessary fields from processed data, enhancing clarity and efficiency.

Copy link
Contributor

coderabbitai bot commented Oct 30, 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 in this pull request focus on the handle_annotations_change function within the cvat/apps/events/handlers.py file. The modifications involve the removal of the "frame" and "attributes" fields from the filtered_data dictionary. Additionally, the conditional check for label_id has been updated to utilize the walrus operator (:=), streamlining the logic of the function without altering its overall structure or control flow.

Changes

File Path Change Summary
cvat/apps/events/handlers.py Removed "frame" and "attributes" from filtered_data; updated label_id check using walrus operator (:=).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EventHandler
    participant DataFilter

    User->>EventHandler: Trigger annotations change
    EventHandler->>DataFilter: Process annotations
    DataFilter->>DataFilter: Filter data (remove "frame" and "attributes")
    DataFilter->>EventHandler: Return filtered data
    EventHandler->>User: Log event
Loading

🐇 "In the handler's dance, fields take flight,
'Frame' and 'attributes' bid goodnight.
With a swift walrus, logic shines bright,
Simplifying paths, making it right.
Hooray for the changes, hop with delight!" 🐇


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.21%. Comparing base (5520212) to head (650f0a0).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8616      +/-   ##
===========================================
+ Coverage    74.19%   74.21%   +0.01%     
===========================================
  Files          401      401              
  Lines        43504    43516      +12     
  Branches      3950     3950              
===========================================
+ Hits         32278    32295      +17     
+ Misses       11226    11221       -5     
Components Coverage Δ
cvat-ui 78.49% <ø> (-0.01%) ⬇️
cvat-server 70.55% <100.00%> (+0.04%) ⬆️

@Eldies Eldies changed the title minimizing payload for tags,tracks,shapes events enhancing analytics Nov 13, 2024
Copy link

sonarcloud bot commented Nov 13, 2024

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.

2 participants