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

Digest Notifications #590

Merged
merged 1 commit into from
Feb 6, 2025
Merged

Digest Notifications #590

merged 1 commit into from
Feb 6, 2025

Conversation

nevo-david
Copy link
Contributor

@nevo-david nevo-david commented Feb 6, 2025

Summary by CodeRabbit

  • New Features

    • Introduced an aggregated email digest that collects and delivers recent notifications.
    • Improved notification handling to ensure timely email updates to organizations.
  • Chores

    • Streamlined the integration with social and notification services by removing redundant code.

Copy link

vercel bot commented Feb 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
gitroom ⬜️ Ignored (Inspect) Feb 6, 2025 6:55am
postiz ⬜️ Ignored (Inspect) Feb 6, 2025 6:55am

Copy link

coderabbitai bot commented Feb 6, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce new methods and modifications to support digest email functionality and enhanced notification handling. A new sendDigestEmail method is added to the PostsController, which triggers a digest email flow in the PostsService. In the notification-related modules, a getNotificationsSince method has been added to both the NotificationService and NotificationsRepository, along with changes to the in-app notification logic and the addition of a sendEmailsToOrg method. Additionally, a new constructor parameter integrating BullMQ has been incorporated, and an unused import has been removed from the Bluesky provider.

Changes

File(s) Change Summary
apps/workers/.../posts.controller.ts
libraries/nestjs-libraries/.../posts.service.ts
Added sendDigestEmail methods; PostsController listens to a Redis event and calls PostsService to construct and send a digest email based on recent notifications.
libraries/nestjs-libraries/.../notifications/notification.service.ts
libraries/nestjs-libraries/.../notifications/notifications.repository.ts
Added getNotificationsSince method; updated NotificationService’s inAppNotification to include a digest parameter; and introduced sendEmailsToOrg to deliver emails to organization members. Also integrated BullMQ for event emission.
libraries/nestjs-libraries/.../integrations/social/bluesky.provider.ts Removed unused NotEnoughScopes import.

Sequence Diagram(s)

sequenceDiagram
    participant R as Redis Event
    participant PC as PostsController
    participant PS as PostsService
    participant NS as NotificationService
    participant NR as NotificationsRepository
    participant BMC as BullMqClient

    R-->PC: "sendDigestEmail" event (data: subject, org, since)
    PC->>PS: sendDigestEmail(subject, org, since)
    PS->>NS: getNotificationsSince(org, since)
    NS->>NR: Query notifications for org since [date]
    NR-->>NS: Return notifications
    alt Notifications exist
        PS->>NS: sendEmailsToOrg(org, subject, message)
        NS->>BMC: Emit digest email event
    else No notifications
        PS-->>PC: Return without sending email
    end
Loading

Poem

I'm a rabbit, coding with delight,
Hopping through the changes both day and night.
Digest emails and notifications now sing,
With queues and Redis, our code takes wing.
Nibble on bugs, and hop to new heights—
Celebrate with code and magical bytes! 🐰

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 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 136f20b and 6716360.

📒 Files selected for processing (5)
  • apps/workers/src/app/posts.controller.ts (1 hunks)
  • libraries/nestjs-libraries/src/database/prisma/notifications/notification.service.ts (2 hunks)
  • libraries/nestjs-libraries/src/database/prisma/notifications/notifications.repository.ts (1 hunks)
  • libraries/nestjs-libraries/src/database/prisma/posts/posts.service.ts (6 hunks)
  • libraries/nestjs-libraries/src/integrations/social/bluesky.provider.ts (0 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@nevo-david nevo-david merged commit dc3296a into main Feb 6, 2025
8 of 9 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.

1 participant