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 plain text version for each email #1005

Merged
merged 2 commits into from
Jan 29, 2024
Merged

✨ Add plain text version for each email #1005

merged 2 commits into from
Jan 29, 2024

Conversation

lukevella
Copy link
Owner

@lukevella lukevella commented Jan 29, 2024

Summary by CodeRabbit

  • Refactor
    • Updated the email sending process to asynchronously render both HTML and plain text versions for improved performance and inclusivity.

Copy link

vercel bot commented Jan 29, 2024

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

Name Status Preview Comments Updated (UTC)
app 🛑 Canceled (Inspect) Jan 29, 2024 8:52am
landing ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 29, 2024 8:52am

Copy link
Contributor

coderabbitai bot commented Jan 29, 2024

Warning

Rate Limit Exceeded

@lukevella has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 12 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

Commits Files that changed from the base of the PR and between 9094fa3 and 64814e9.

Walkthrough

The update in the send-email.tsx file marks a significant shift towards asynchronous email content rendering. By leveraging the renderAsync function from the @react-email/render module, both HTML and plain text versions of emails are now rendered asynchronously. This enhancement not only streamlines the email generation process but also ensures the inclusion of a plain text version, enhancing accessibility and compatibility across different email clients.

Changes

File(s) Summary
packages/.../send-email.tsx Updated to use renderAsync for HTML and plain text rendering; includes plain text in emails

🐰✨
In the digital burrow, beneath the moon's glow,
A swift update flutters, making the emails flow.
HTML and text, in harmony they dance,
Asynchronous beauty, given a chance.
🌟📧

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.
  • 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 from git 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: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 02abaf4 and 9094fa3.
Files selected for processing (1)
  • packages/emails/src/send-email.tsx (2 hunks)
Additional comments: 2
packages/emails/src/send-email.tsx (2)
  • 90-93: The use of Promise.all to concurrently render HTML and plain text versions of the email is efficient. However, ensure that the renderAsync function is designed to handle the same component instance being passed to it concurrently without any side effects or race conditions.
  • 102-102: Including the plain text version of the email (text) alongside the HTML version (html) in the sendEmail function call is a good practice for accessibility and compatibility. This ensures that recipients can read the email content regardless of their email client's capabilities.

packages/emails/src/send-email.tsx Outdated Show resolved Hide resolved
packages/emails/src/send-email.tsx Show resolved Hide resolved
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