Skip to content

chore: Delay email and upgrade Resend#2152

Merged
perkinsjr merged 3 commits intomainfrom
delay-email
Oct 2, 2024
Merged

chore: Delay email and upgrade Resend#2152
perkinsjr merged 3 commits intomainfrom
delay-email

Conversation

@perkinsjr
Copy link
Member

@perkinsjr perkinsjr commented Oct 2, 2024

What does this PR do?

Delays our Welcome email 5 minutes from sign up. It also upgrades to 4.0 which includes some changes to the way an email is sent.

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • New Features
    • Enhanced email functionality with the ability to schedule welcome emails.
  • Improvements
    • Standardized naming convention for the reply-to field in email methods.
  • Dependency Updates
    • Updated the version of the resend dependency to improve overall package performance.

Adds a five minute delay to our Welcome email
@perkinsjr perkinsjr requested a review from chronark as a code owner October 2, 2024 16:18
@changeset-bot
Copy link

changeset-bot bot commented Oct 2, 2024

⚠️ No Changeset found

Latest commit: 38b3912

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 2, 2024

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

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 4:24pm
play ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 4:24pm
workflows ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 4:24pm
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 2, 2024 4:24pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
planetfall ⬜️ Ignored (Inspect) Visit Preview Oct 2, 2024 4:24pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

📝 Walkthrough

Walkthrough

The pull request includes updates to the package.json of the @unkey/resend package, changing the version of the resend dependency from ^3.4.0 to ^4.0.0. Additionally, modifications to the Resend class in internal/resend/src/client.tsx are made, primarily focusing on renaming the reply_to property to replyTo across several email sending methods. The sendWelcomeEmail method is enhanced with a new variable for scheduling emails five minutes in advance.

Changes

File Change Summary
internal/resend/package.json Updated resend dependency version from ^3.4.0 to ^4.0.0.
internal/resend/src/client.tsx Renamed reply_to to replyTo in multiple methods; added fiveMinutesFromNow to sendWelcomeEmail for scheduling. Method signatures updated for sendTrialEnded, sendSubscriptionEnded, sendWelcomeEmail, sendPaymentIssue, and sendLeakedKeyEmail.

Possibly related PRs

  • chore(email): update styling, copy, urls #2141: The changes in this PR involve refactoring email components that are likely related to the methods in the Resend class, particularly those that send emails like sendTrialEnded, sendSubscriptionEnded, and sendWelcomeEmail, which have been updated in the main PR.

Suggested reviewers

  • chronark
  • perkinsjr

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 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.

@perkinsjr perkinsjr changed the title Chore: Delay email and upgrade Resend chore: Delay email and upgrade Resend Oct 2, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2024

Thank you for following the naming conventions for pull request titles! 🙏

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
internal/resend/src/client.tsx (2)

52-52: LGTM: Consistent naming convention applied

The renaming of reply_to to replyTo is consistent with the changes made in other methods.

Consider addressing the TODO comment about deprecating this method if it's indeed unused. You might want to add a deprecation notice or remove the method entirely if it's no longer needed.


Missing 'resend' Package Declaration in Dependencies

  • The resend package is being imported and used in internal/resend/src/client.tsx but is not listed in package.json under dependencies, devDependencies, peerDependencies, or optionalDependencies.
  • This omission can lead to runtime errors as the resend package may not be installed when the application runs.
🔗 Analysis chain

Line range hint 1-134: Consider enhancing API key security and verify Resend upgrade

  1. API Key Security:
    The current implementation passes the API key as a string. Consider using environment variables or a secure key management system to enhance security.

  2. Resend Upgrade:
    The PR objectives mention upgrading to Resend v4.0, but this isn't explicitly visible in the code changes. Please verify that the upgrade has been implemented correctly, possibly in the package.json file or elsewhere in the project.

To verify the Resend upgrade, you can run the following command:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the installed version of Resend
npm list resend
# Or if using yarn
# yarn why resend

Length of output: 88


Script:

#!/bin/bash
# Check the installed version of Resend using yarn
yarn why resend

Length of output: 89


Script:

#!/bin/bash
# Extract the version of 'resend' from package.json using jq
jq -r '.dependencies.resend // .devDependencies.resend // "not found"' package.json

Length of output: 95


Script:

#!/bin/bash
# Extract the version of 'resend' from all dependency sections in package.json using jq
jq -r '.dependencies.resend // .devDependencies.resend // .peerDependencies.resend // .optionalDependencies.resend // "not found"' package.json

Length of output: 155

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b7f9828 and 38b3912.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • internal/resend/package.json (1 hunks)
  • internal/resend/src/client.tsx (5 hunks)
🔇 Additional comments (7)
internal/resend/package.json (3)

35-35: LGTM: Resend dependency updated to version 4.0.0

The update of the Resend dependency to version 4.0.0 aligns with the PR objectives.


Line range hint 1-37: Inquiry: Implementation of 5-minute email delay

The PR objectives mention implementing a 5-minute delay for the Welcome email. However, this change is not reflected in the package.json file. Could you please clarify:

  1. Where is the email delay implementation located?
  2. Are there any additional dependencies or configuration changes required for this feature?
  3. If the implementation is missing, in which file should it be added?

To help locate potential email-related code, you can run the following script:

#!/bin/bash
# Description: Search for email-related code in the codebase

# Test: Look for email-related functions or configurations
echo "Searching for email-related code:"
rg --type typescript --type javascript 'email|sendEmail|welcomeEmail' -A 10

35-35: Verify the impact of the Resend upgrade

Upgrading to a new major version (3.x to 4.0) might introduce breaking changes. Please ensure that:

  1. The existing functionality using Resend is not affected.
  2. Any necessary code changes to accommodate the new version have been made.
  3. The application has been thoroughly tested with the new version.

To help with the verification, you can run the following script to check for Resend usage in the codebase:

internal/resend/src/client.tsx (4)

28-28: LGTM: Consistent naming convention applied

The renaming of reply_to to replyTo improves code consistency and adheres to camelCase naming conventions in JavaScript/TypeScript.


66-67: LGTM: Welcome email delay implemented correctly

The changes successfully implement the 5-minute delay for the welcome email as specified in the PR objectives:

  1. The fiveMinutesFromNow variable correctly calculates a timestamp 5 minutes in the future.
  2. The scheduledAt property is added to the email sending options, using the calculated delay.
  3. The replyTo property renaming is consistent with other methods.

These changes align well with the PR's goal of delaying the welcome email by 5 minutes.

Also applies to: 73-73, 76-76


97-97: LGTM: Consistent naming convention applied

The renaming of reply_to to replyTo is consistent with the changes made in other methods.


122-122: LGTM: Consistent naming convention applied

The renaming of reply_to to replyTo is consistent with the changes made in other methods.

@perkinsjr perkinsjr enabled auto-merge October 2, 2024 17:58
@perkinsjr perkinsjr disabled auto-merge October 2, 2024 18:13
@perkinsjr perkinsjr merged commit 0d30308 into main Oct 2, 2024
@perkinsjr perkinsjr deleted the delay-email branch October 2, 2024 18:14
@coderabbitai coderabbitai bot mentioned this pull request Oct 2, 2024
18 tasks
harshsbhat pushed a commit to harshsbhat/unkey that referenced this pull request Oct 3, 2024
* chore: Adds a five minute delay to emails

Adds a five minute delay to our Welcome email

* pnpm lock update

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
mcstepp pushed a commit that referenced this pull request Oct 8, 2024
* chore: Adds a five minute delay to emails

Adds a five minute delay to our Welcome email

* pnpm lock update

* [autofix.ci] apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
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.

2 participants