⚡️ Avoid blocking request when sending new participant notification #1538
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
Warning Rate limit exceeded@lukevella has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 4 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThe pull request introduces a new asynchronous function Changes
Sequence DiagramsequenceDiagram
participant Router
participant NotificationFunc
participant EmailClient
participant Database
Router->>NotificationFunc: Call with pollId, pollTitle, participantName
NotificationFunc->>Database: Retrieve poll watchers
Database-->>NotificationFunc: Return watcher list
NotificationFunc->>EmailClient: Construct and send emails
EmailClient-->>NotificationFunc: Confirm email sending
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
apps/web/src/trpc/routers/polls/participants.ts (2)
20-28: Fix typo in function name.The function name has a typo: "Notifcation" should be "Notification".
-async function sendNewParticipantNotifcationEmail({ +async function sendNewParticipantNotificationEmail({
29-44: Add pagination to watchers query.The watchers query should be paginated to avoid potential memory issues with large result sets.
const watchers = await prisma.watcher.findMany({ where: { pollId, }, + take: 100, // Process in batches of 100 select: { id: true, userId: true, user: { select: { email: true, name: true, locale: true, }, }, }, });
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/web/src/trpc/routers/polls/participants.ts(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Unit tests
- GitHub Check: Linting
- GitHub Check: Type check
- GitHub Check: Integration tests
🔇 Additional comments (2)
apps/web/src/trpc/routers/polls/participants.ts (2)
199-205: LGTM! Good use of background processing.The implementation correctly uses
waitUntilto handle notifications asynchronously without blocking the response.
4-4: Verify email client configuration.The imports look good. Since we're using
waitUntilfor background processing andgetEmailClientfor notifications, ensure that:
- The email client is properly configured for the production environment
- The background tasks complete within the serverless function timeout
Also applies to: 7-7
✅ Verification successful
Email client and templates are properly configured ✅
The email system is properly set up with:
- Templates in
packages/emails/src/templates/- Full i18n support in
packages/emails/locales/- Preview system for testing
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check email client configuration and related files # Check for email client configuration rg -A 5 "getEmailClient" # Check for email templates fd "NewParticipantEmail.tsx" -x cat fd "NewParticipantConfirmationEmail.tsx" -x catLength of output: 9528
Script:
#!/bin/bash # Search for email templates and configuration # Look for React email templates in various locations fd -e tsx -e ts -e jsx -e js "email" --type f # Check for email-related configuration files fd -g "*email*" --type f # Search for specific template references rg -l "NewParticipantEmail" rg -l "NewParticipantConfirmationEmail"Length of output: 2593
| for (const watcher of watchers) { | ||
| const email = watcher.user.email; | ||
| const watcherLocale = watcher.user.locale ?? undefined; | ||
| const token = await createToken<DisableNotificationsPayload>( | ||
| { watcherId: watcher.id, pollId }, | ||
| { ttl: 0 }, | ||
| ); | ||
| getEmailClient(watcherLocale).queueTemplate("NewParticipantEmail", { | ||
| to: email, | ||
| props: { | ||
| participantName, | ||
| pollUrl: absoluteUrl(`/poll/${pollId}`), | ||
| disableNotificationsUrl: absoluteUrl( | ||
| `/api/notifications/unsubscribe?token=${token}`, | ||
| ), | ||
| title: pollTitle, | ||
| }, | ||
| }); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling and parallel processing for email sending.
The current implementation:
- Lacks error handling for email sending
- Processes emails sequentially which could be slow for many watchers
- for (const watcher of watchers) {
+ await Promise.all(watchers.map(async (watcher) => {
+ try {
const email = watcher.user.email;
const watcherLocale = watcher.user.locale ?? undefined;
const token = await createToken<DisableNotificationsPayload>(
{ watcherId: watcher.id, pollId },
{ ttl: 0 },
);
getEmailClient(watcherLocale).queueTemplate("NewParticipantEmail", {
to: email,
props: {
participantName,
pollUrl: absoluteUrl(`/poll/${pollId}`),
disableNotificationsUrl: absoluteUrl(
`/api/notifications/unsubscribe?token=${token}`,
),
title: pollTitle,
},
});
+ } catch (error) {
+ console.error(
+ `Failed to send notification to ${watcher.user.email}:`,
+ error
+ );
+ }
+ }));
- }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| for (const watcher of watchers) { | |
| const email = watcher.user.email; | |
| const watcherLocale = watcher.user.locale ?? undefined; | |
| const token = await createToken<DisableNotificationsPayload>( | |
| { watcherId: watcher.id, pollId }, | |
| { ttl: 0 }, | |
| ); | |
| getEmailClient(watcherLocale).queueTemplate("NewParticipantEmail", { | |
| to: email, | |
| props: { | |
| participantName, | |
| pollUrl: absoluteUrl(`/poll/${pollId}`), | |
| disableNotificationsUrl: absoluteUrl( | |
| `/api/notifications/unsubscribe?token=${token}`, | |
| ), | |
| title: pollTitle, | |
| }, | |
| }); | |
| } | |
| await Promise.all(watchers.map(async (watcher) => { | |
| try { | |
| const email = watcher.user.email; | |
| const watcherLocale = watcher.user.locale ?? undefined; | |
| const token = await createToken<DisableNotificationsPayload>( | |
| { watcherId: watcher.id, pollId }, | |
| { ttl: 0 }, | |
| ); | |
| getEmailClient(watcherLocale).queueTemplate("NewParticipantEmail", { | |
| to: email, | |
| props: { | |
| participantName, | |
| pollUrl: absoluteUrl(`/poll/${pollId}`), | |
| disableNotificationsUrl: absoluteUrl( | |
| `/api/notifications/unsubscribe?token=${token}`, | |
| ), | |
| title: pollTitle, | |
| }, | |
| }); | |
| } catch (error) { | |
| console.error( | |
| `Failed to send notification to ${watcher.user.email}:`, | |
| error | |
| ); | |
| } | |
| })); |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/web/src/trpc/routers/polls/participants.ts (1)
21-21: Fix typo in function name.The function name has a typo: "Notifcation" should be "Notification".
-async function sendNewParticipantNotifcationEmail({ +async function sendNewParticipantNotificationEmail({
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/web/src/trpc/routers/polls/participants.ts(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Unit tests
- GitHub Check: Integration tests
- GitHub Check: Linting
- GitHub Check: Type check
🔇 Additional comments (3)
apps/web/src/trpc/routers/polls/participants.ts (3)
3-3: LGTM! Good choice of dependencies.The addition of Sentry for error tracking and waitUntil for non-blocking operations aligns well with the PR's objective.
Also applies to: 5-5
47-69: Consider using parallel processing for better performance.The current sequential email processing could be slow when there are many watchers. Consider using Promise.all for parallel processing.
- for (const watcher of watchers) { + await Promise.all(watchers.map(async (watcher) => { try { const email = watcher.user.email; const watcherLocale = watcher.user.locale ?? undefined; const token = await createToken<DisableNotificationsPayload>( { watcherId: watcher.id, pollId }, { ttl: 0 }, ); getEmailClient(watcherLocale).queueTemplate("NewParticipantEmail", { to: email, props: { participantName, pollUrl: absoluteUrl(`/poll/${pollId}`), disableNotificationsUrl: absoluteUrl( `/api/notifications/unsubscribe?token=${token}`, ), title: pollTitle, }, }); } catch (err) { Sentry.captureException(err); } - } + }));
204-210: LGTM! Good implementation of non-blocking notifications.The use of
waitUntileffectively achieves the PR's objective of avoiding blocking requests when sending notifications, while ensuring the notification task completes.
Summary by CodeRabbit
New Features
Improvements