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

Add email notifications for landlord account status changes and booking confirmations #17

Merged
merged 2 commits into from
Mar 11, 2024

Conversation

SirSanctified
Copy link
Owner

@SirSanctified SirSanctified commented Mar 9, 2024

This pull request adds email notifications for landlord account status changes (banned, activated, suspended) and booking confirmations. The sendmail function has been updated to use the sendmail.delay method from the celery library for asynchronous email sending. This improves the performance of the application by offloading the email sending task to a separate worker process.

Summary by CodeRabbit

  • New Features

    • Implemented enhanced data integrity checks for room creation by verifying existing rooms with the same name in a property before creation.
    • Adjusted room and associated image creation logic for improved error handling and custom validation errors.
  • Refactor

    • Introduced asynchronous email sending using Celery tasks for landlord account status changes, booking notifications, and verification request notifications.
    • Simplified error messages for bed validations in the clean method.

Copy link
Contributor

coderabbitai bot commented Mar 9, 2024

Walkthrough

The recent updates focus on enhancing the email notification system and tightening the property creation process. Email notifications for various events, such as landlord account status changes, booking confirmations, cancellations, and verification requests, are now sent asynchronously using Celery tasks. Additionally, a new permission check ensures that only landlords can create properties, promoting a more secure and efficient user experience.

Changes

File Location Change Summary
backend/core/models.py Added unique_together constraint for property and name fields; adjusted bed validation messages.
backend/core/serializers.py Improved room creation logic to check for existing rooms; handled exceptions and validation errors.
backend/core/views.py Implemented async email sending for various events; added landlord-only property creation permission.
backend/utils/sendmail.py Decorated sendmail function with @shared_task for async processing via Celery.

🐇✨
In the digital burrow, beneath the moon's soft glow,
Tasks queue silently, in the night they flow.
With each async send, through the web they dart,
A rabbit's work, done with a coder's heart.
🌟📧
To secure, to notify, a leap towards the smart.
🐾

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 091057f and a729682.
Files selected for processing (2)
  • backend/core/views.py (8 hunks)
  • backend/utils/sendmail.py (1 hunks)
Additional comments: 4
backend/core/views.py (4)
  • 67-80: The implementation of asynchronous email sending using sendmail.delay is correct and aligns with the PR objectives. However, consider extracting the email content to templates or a configuration file. This approach enhances maintainability, allows for easier updates, and supports internationalization if needed in the future.

Also applies to: 87-99, 106-119

  • 150-154: The addition of a permission check to ensure only landlords can create properties is a good practice for enforcing role-based access control. This change enhances the application's security by preventing unauthorized property creation.
  • 322-330: The implementation of asynchronous email sending using sendmail.delay for booking operations is correct and aligns with the PR objectives. However, consider extracting the email content to templates or a configuration file for the same reasons mentioned in the LandlordViewSet review.

Also applies to: 383-388, 433-439

  • 568-568: The implementation of asynchronous email sending using sendmail.delay for verification request notifications is correct and aligns with the PR objectives. However, consider extracting the email content to templates or a configuration file for the same reasons mentioned in previous reviews.

Also applies to: 611-611, 631-631

backend/utils/sendmail.py Outdated Show resolved Hide resolved
backend/core/views.py Dismissed Show dismissed Hide dismissed
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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a729682 and ae3a0e9.
Files selected for processing (4)
  • backend/core/models.py (4 hunks)
  • backend/core/serializers.py (2 hunks)
  • backend/core/views.py (9 hunks)
  • backend/utils/sendmail.py (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • backend/core/views.py
  • backend/utils/sendmail.py
Additional comments: 4
backend/core/serializers.py (1)
  • 284-290: The addition of a check to prevent the creation of rooms with duplicate names within the same property is a good practice for data integrity. However, consider using a more specific exception type than ValidationError for clarity.
backend/core/models.py (3)
  • 183-183: Adding the unique_together constraint for property and name fields in the Room model is a solid improvement for ensuring data integrity at the database level.
  • 238-238: Calling self.clean() in the save method is a good practice to ensure model validation before saving. However, ensure that this does not introduce any performance issues, especially with bulk operations.
  • 256-268: The simplification of error messages in the clean method makes them more user-friendly. However, ensure that these messages are consistent with the rest of the application's error handling practices.

backend/core/serializers.py Show resolved Hide resolved
@SirSanctified SirSanctified merged commit 3bb1700 into main Mar 11, 2024
5 checks passed
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

1 participant