async signals

[felipao-mx]

• adds blinker dependency to setup.py Add blinker as a dependency #91
• enables async receivers for pre/post-save events with AsyncDocument

Summary by CodeRabbit

Summary by CodeRabbit

• New Features

  • Introduced asynchronous pre-save and post-save event hooks for document save operations.
  • Added support for custom asynchronous event handling during saves.

• Tests

  • Added tests verifying asynchronous signal handlers trigger correctly before and after saving documents.

• Chores

  • Updated the version to 1.2.0.
  • Added a new dependency on the 'blinker' package.

[coderabbitai]

Walkthrough

This change introduces asynchronous signal handling for save operations on asynchronous MongoEngine documents. A new module, async_signals.py, defines an asynchronous signals namespace with pre_save and post_save signals. The AsyncDocument.async_save method is updated to send these signals asynchronously before and after the save operation. The version number is incremented to 1.2.0. Additionally, a new test module is added to verify that asynchronous signal handlers for pre_save and post_save are triggered correctly during asynchronous save operations. The setup.py is updated to include a new dependency on blinker for signal support.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15–20 minutes

• Complexity: The core logic for async signal dispatch is straightforward but introduces a new async signaling mechanism and requires careful review for correct async integration and signal handling. The new test ensures the feature works as intended, and overall changes are limited in scope and file count but touch critical save logic.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75f377b and 92a6f41.

📒 Files selected for processing (2)

• mongoengine_plus/version.py (1 hunks)
• setup.py (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• setup.py

🚧 Files skipped from review as they are similar to previous changes (1)

• mongoengine_plus/version.py

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch async-signals

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (c75b088) to head (92a6f41).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #93   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        15    +1     
  Lines          243       252    +9     
  Branches        22        22           
=========================================
+ Hits           243       252    +9     

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.