refatctor mailchimp_utils.subscribe_mailchimp for sync and async versions

Author: Johnetordoff

osf/management/commands/update_mailchimp_email.py

@@ -13,7 +13,7 @@ def update_mailchimp_email():
     for user in OSFUser.objects.filter(deleted__isnull=True):
         for list_name, subscription in user.mailchimp_mailing_lists.items():
             if subscription:
-                mailchimp_utils.subscribe_mailchimp(list_name, user._id)
+                mailchimp_utils.subscribe_mailchimp_async(list_name, user._id)
         users_updated += 1
 
     return users_updated

osf/models/user.py

@@ -1073,7 +1073,7 @@ def save(self, *args, **kwargs):
         if 'username' in dirty_fields:
             for list_name, subscription in self.mailchimp_mailing_lists.items():
                 if subscription:
-                    mailchimp_utils.subscribe_mailchimp(list_name, self._id)
+                    mailchimp_utils.subscribe_mailchimp_async(list_name, self._id)
         return ret
 
     # Legacy methods

scripts/fix_user_mailchimp.py

@@ -9,7 +9,7 @@
 setup_django()
 from osf.models import OSFUser
 from scripts import utils as script_utils
-from website.mailchimp_utils import subscribe_mailchimp
+from website.mailchimp_utils import subscribe_mailchimp_async
 from website import settings
 
 logger = logging.getLogger(__name__)
@@ -31,7 +31,7 @@ def main():
         for user in users:
             if settings.MAILCHIMP_GENERAL_LIST not in user.mailchimp_mailing_lists:
                 if not dry:
-                    subscribe_mailchimp(settings.MAILCHIMP_GENERAL_LIST, user._id)
+                    subscribe_mailchimp_async(settings.MAILCHIMP_GENERAL_LIST, user._id)
                     logger.info(f'User {user._id} has been subscribed to OSF general mailing list')
                 count += 1
 

tests/test_mailchimp.py

@@ -36,7 +36,7 @@ def test_subscribe_called(self, mock_get_mailchimp_api):
         mock_get_mailchimp_api.return_value = mock_client
         mock_client.lists.get.return_value = {'id': 1, 'list_name': list_name}
         list_id = mailchimp_utils.get_list_id_from_name(list_name)
-        mailchimp_utils.subscribe_mailchimp(list_name, user._id)
+        mailchimp_utils.subscribe_mailchimp_async(list_name, user._id)
         handlers.celery_teardown_request()
         mock_client.lists.members.create_or_update.assert_called()
 
@@ -48,10 +48,9 @@ def test_subscribe_fake_email_does_not_throw_validation_error(self, mock_get_mai
         mock_client = mock.MagicMock()
         mock_get_mailchimp_api.return_value = mock_client
         mock_client.lists.members.create_or_update.side_effect = MailChimpError
-        mailchimp_utils.subscribe_mailchimp(list_name, user._id)
-        handlers.celery_teardown_request()
+        mailchimp_utils.subscribe_mailchimp_async(list_name, user._id)
         user.reload()
-        assert not user.mailchimp_mailing_lists[list_name]
+        assert not user.mailchimp_mailing_lists
 
     @mock.patch('website.mailchimp_utils.get_mailchimp_api')
     def test_unsubscribe_called_with_correct_arguments(self, mock_get_mailchimp_api):

website/mailchimp_utils.py

@@ -118,4 +118,4 @@ def unsubscribe_mailchimp_async(list_name, user_id, username=None):
 def subscribe_on_confirm(user):
     # Subscribe user to general OSF mailing list upon account confirmation
     if settings.ENABLE_EMAIL_SUBSCRIPTIONS:
-        subscribe_mailchimp(settings.MAILCHIMP_GENERAL_LIST, user._id)
+        subscribe_mailchimp_async(settings.MAILCHIMP_GENERAL_LIST, user._id)

website/profile/views.py

@@ -519,7 +519,7 @@ def update_mailchimp_subscription(user, list_name, subscription):
     :param boolean subscription: true if user is subscribed
     """
     if subscription:
-        mailchimp_utils.subscribe_mailchimp(list_name, user._id)
+        mailchimp_utils.subscribe_mailchimp_async(list_name, user._id)
     else:
         try:
             mailchimp_utils.unsubscribe_mailchimp_async(list_name, user._id, username=user.username)