Skip to content

Refactor use sendgrid for email transactions #26

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

Merged
merged 7 commits into from
Jul 21, 2025

Conversation

fulleni
Copy link
Member

@fulleni fulleni commented Jul 21, 2025

Status

READY/IN DEVELOPMENT/HOLD

Description

Type of Change

  • ✨ New feature (non-breaking change which adds functionality)
  • 🛠️ Bug fix (non-breaking change which fixes an issue)
  • ❌ Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactor
  • ✅ Build configuration change
  • 📝 Documentation
  • 🗑️ Chore

fulleni added 7 commits July 21, 2025 09:29
- Added SENDGRID_API_KEY
- Added DEFAULT_SENDER_EMAIL
- Added OTP_TEMPLATE_ID
- Added SENDGRID_API_URL (optional)
- Replaced in-memory email client.
- Added SendGrid email client.
- Updated pubspec.yaml dependencies.
- Added sendGridApiKey getter
- Added defaultSenderEmail getter
- Added otpTemplateId getter
- Added sendGridApiUrl getter
- Improved error handling
- Replaced HtEmailInMemoryClient with HtEmailSendGrid.
- Configured SendGrid API key and URL.
- Added HtHttpClient for SendGrid integration.
- Implemented token provider for SendGrid auth.
- Updated email repository dependency.
- Added sender email to email sending
- Used environment config for template ID
- Improved email sending robustness
@fulleni fulleni merged commit 910c1c8 into main Jul 21, 2025
1 check failed
@fulleni fulleni deleted the refactor_use_sendgrid_for_email_transactions branch July 21, 2025 08:35
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @fulleni, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily refactors the application's email sending functionality to leverage SendGrid for transactional emails, replacing the previous in-memory solution. This change enhances the application's ability to send real emails, requiring new environment configurations and updates to the authentication service's email dispatch logic. Additionally, it includes general code cleanup and formatting improvements across various files.

Highlights

  • Email Service Transition: The application's email sending mechanism has been migrated from an in-memory implementation (ht_email_inmemory) to use SendGrid via the ht_email_sendgrid package. This involves updating dependencies and the application's dependency injection setup.
  • Environment Configuration: New environment variables (SENDGRID_API_KEY, DEFAULT_SENDER_EMAIL, OTP_TEMPLATE_ID, SENDGRID_API_URL) have been introduced in .env.example and are now read and enforced by EnvironmentConfig for SendGrid integration.
  • Auth Service Updates: The AuthService now passes the required sender email and SendGrid template ID (retrieved from EnvironmentConfig) when sending One-Time Password (OTP) emails, aligning with SendGrid's transactional email capabilities.
  • Code Cleanup and Formatting: Several files received minor formatting adjustments, whitespace cleanups, and simplified logging statements, improving overall code readability and consistency. Obsolete in-memory code entry classes were also removed from verification_code_storage_service.dart.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the email sending functionality to use SendGrid. I've identified a potential issue with the SendGrid API base URL construction and suggested refactoring duplicated code in the environment configuration.

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