Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix: add retry logic with exponential backoff to send_welcome_email (#12450)

Alona872f2b87f20c
diff --git a/enterprise/sync/resend_keycloak.py b/enterprise/sync/resend_keycloak.py
index 4ea0463fa4..768d423ed7 100644
--- a/enterprise/sync/resend_keycloak.py
+++ b/enterprise/sync/resend_keycloak.py
@@ -96,7 +96,7 @@ class ResendAPIError(ResendSyncError):
EMAIL_REGEX = re.compile(r'^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$')
-def is_valid_email(email: str) -> bool:
+def is_valid_email(email: Optional[str]) -> bool:
"""Validate an email address format.
This uses a regex pattern that matches most valid email addresses
@@ -104,10 +104,10 @@ def is_valid_email(email: str) -> bool:
does not accept (e.g., exclamation marks).
Args:
- email: The email address to validate.
+ email: The email address to validate, or None.
Returns:
- True if the email is valid, False otherwise.
+ True if the email is valid, False otherwise (including for None).
"""
if not email:
return False
@@ -251,6 +251,15 @@ def add_contact_to_resend(
raise
+@retry(
+ stop=stop_after_attempt(MAX_RETRIES),
+ wait=wait_exponential(
+ multiplier=INITIAL_BACKOFF_SECONDS,
+ max=MAX_BACKOFF_SECONDS,
+ exp_base=BACKOFF_FACTOR,
+ ),
+ retry=retry_if_exception_type(ResendError),
+)
def send_welcome_email(
email: str,
first_name: Optional[str] = None,
@@ -267,7 +276,7 @@ def send_welcome_email(
The API response.
Raises:
- ResendError: If the API call fails.
+ ResendError: If the API call fails after retries.
"""
try:
# Prepare the recipient name
diff --git a/enterprise/tests/unit/sync/test_resend_keycloak.py b/enterprise/tests/unit/sync/test_resend_keycloak.py
index c248d3edf4..866726ddbc 100644
--- a/enterprise/tests/unit/sync/test_resend_keycloak.py
+++ b/enterprise/tests/unit/sync/test_resend_keycloak.py
@@ -1,6 +1,25 @@
-"""Tests for resend_keycloak email validation."""
+"""Tests for Resend Keycloak sync functionality."""
-from sync.resend_keycloak import is_valid_email
+import os
+from unittest.mock import MagicMock, patch
+
+import pytest
+from resend.exceptions import ResendError
+from tenacity import RetryError
+
+# Set required environment variables before importing the module
+# that reads them at import time
+os.environ['RESEND_API_KEY'] = 'test_api_key'
+os.environ['RESEND_AUDIENCE_ID'] = 'test_audience_id'
+os.environ['KEYCLOAK_SERVER_URL'] = 'http://localhost:8080'
+os.environ['KEYCLOAK_REALM_NAME'] = 'test_realm'
+os.environ['KEYCLOAK_ADMIN_PASSWORD'] = 'test_password'
+
+from enterprise.sync.resend_keycloak import ( # noqa: E402
+ add_contact_to_resend,
+ is_valid_email,
+ send_welcome_email,
+)
class TestIsValidEmail:
@@ -115,3 +134,134 @@ class TestIsValidEmail:
"""Test that validation works for uppercase emails."""
assert is_valid_email('[email protected]') is True
assert is_valid_email('[email protected]') is True
+
+
+class TestSendWelcomeEmail:
+ """Tests for send_welcome_email function."""
+
+ @patch('enterprise.sync.resend_keycloak.resend.Emails.send')
+ def test_send_welcome_email_success(self, mock_send: MagicMock) -> None:
+ """Test successful welcome email sending."""
+ mock_send.return_value = {'id': 'email_123'}
+
+ result = send_welcome_email(
+ first_name='John',
+ last_name='Doe',
+ )
+
+ assert result == {'id': 'email_123'}
+ mock_send.assert_called_once()
+ call_args = mock_send.call_args[0][0]
+ assert call_args['to'] == ['[email protected]']
+ assert call_args['subject'] == 'Welcome to OpenHands Cloud'
+ assert 'Hi John Doe,' in call_args['html']
+
+ @patch('enterprise.sync.resend_keycloak.resend.Emails.send')
+ def test_send_welcome_email_retries_on_rate_limit(
+ self, mock_send: MagicMock
+ ) -> None:
+ """Test that send_welcome_email retries on rate limit errors."""
+ # First two calls raise rate limit error, third succeeds
+ mock_send.side_effect = [
+ ResendError(
+ code=429,
+ message='Too many requests',
+ error_type='rate_limit_exceeded',
+ suggested_action='',
+ ),
+ ResendError(
+ code=429,
+ message='Too many requests',
+ error_type='rate_limit_exceeded',
+ suggested_action='',
+ ),
+ {'id': 'email_123'},
+ ]
+
+ result = send_welcome_email(
+ first_name='John',
+ last_name='Doe',
+ )
+
+ assert result == {'id': 'email_123'}
+ assert mock_send.call_count == 3
+
+ @patch('enterprise.sync.resend_keycloak.resend.Emails.send')
+ def test_send_welcome_email_fails_after_max_retries(
+ self, mock_send: MagicMock
+ ) -> None:
+ """Test that send_welcome_email fails after max retries."""
+ # All calls raise rate limit error
+ mock_send.side_effect = ResendError(
+ code=429,
+ message='Too many requests',
+ error_type='rate_limit_exceeded',
+ suggested_action='',
+ )
+
+ # Tenacity wraps the final exception in RetryError
+ with pytest.raises(RetryError):
+ send_welcome_email(
+ first_name='John',
+ last_name='Doe',
+ )
+
+ # Default MAX_RETRIES is 3
+ assert mock_send.call_count == 3
+
+ @patch('enterprise.sync.resend_keycloak.resend.Emails.send')
+ def test_send_welcome_email_no_name(self, mock_send: MagicMock) -> None:
+ """Test welcome email with no name provided."""
+ mock_send.return_value = {'id': 'email_123'}
+
+ result = send_welcome_email(email='[email protected]')
+
+ assert result == {'id': 'email_123'}
+ call_args = mock_send.call_args[0][0]
+ assert 'Hi there,' in call_args['html']
+
+
+class TestAddContactToResend:
+ """Tests for add_contact_to_resend function."""
+
+ @patch('enterprise.sync.resend_keycloak.resend.Contacts.create')
+ def test_add_contact_to_resend_success(self, mock_create: MagicMock) -> None:
+ """Test successful contact addition."""
+ mock_create.return_value = {'id': 'contact_123'}
+
+ result = add_contact_to_resend(
+ audience_id='test_audience',
+ first_name='John',
+ last_name='Doe',
+ )
+
+ assert result == {'id': 'contact_123'}
+ mock_create.assert_called_once()
+
+ @patch('enterprise.sync.resend_keycloak.resend.Contacts.create')
+ def test_add_contact_to_resend_retries_on_rate_limit(
+ self, mock_create: MagicMock
+ ) -> None:
+ """Test that add_contact_to_resend retries on rate limit errors."""
+ # First call raises rate limit error, second succeeds
+ mock_create.side_effect = [
+ ResendError(
+ code=429,
+ message='Too many requests',
+ error_type='rate_limit_exceeded',
+ suggested_action='',
+ ),
+ {'id': 'contact_123'},
+ ]
+
+ result = add_contact_to_resend(
+ audience_id='test_audience',
+ )
+
+ assert result == {'id': 'contact_123'}
+ assert mock_create.call_count == 2