Switch backend from cTms to Braze

basket/admin.py

@@ -11,32 +11,22 @@
 import sentry_sdk
 
 from basket.base.forms import EmailForm, EmailListForm
-from basket.news.backends.braze import braze
-from basket.news.backends.ctms import (
-    CTMSNotFoundByEmailError,
-    CTMSNotFoundByEmailIDError,
-    ctms,
-)
-from basket.news.newsletters import newsletter_obj
+from basket.news.backends.braze import BrazeUserNotFoundByEmailError, braze
+from basket.news.backends.ctms import CTMSNotFoundByEmailError, CTMSNotFoundByEmailIDError, ctms, from_vendor
+from basket.news.newsletters import slug_to_vendor_id
 
 log = logging.getLogger(__name__)
 
 
-def get_newsletter_names(ctms_contact):
+def get_newsletter_names(contact):
     names = []
-    newsletters = ctms_contact["newsletters"]
-    for nl in newsletters:
-        if not nl["subscribed"]:
-            continue
-
-        nl_slug = nl["name"]
-        nl_obj = newsletter_obj(nl_slug)
-        if nl_obj:
-            nl_name = nl_obj.title
-        else:
-            nl_name = ""
-        names.append(f"{nl_name} (id: {nl_slug})")
-
+    newsletters = contact["newsletters"]
+    for newsletter_slug in newsletters:
+        try:
+            newsletter_id = slug_to_vendor_id(newsletter_slug)
+            names.append(f"{newsletter_slug} (id: {newsletter_id})")
+        except KeyError:
+            pass
     return names
 
 
@@ -104,27 +94,55 @@ def get_app_list(self, request, app_label=None):
     def dsar_info_view(self, request):
         form = EmailForm()
         context = {
-            "title": "DSAR: Fetch CTMS User Info by Email Address",
+            "title": "DSAR: Fetch User Info by Email Address",
         }
         if request.method == "POST":
             form = EmailForm(request.POST)
             if form.is_valid():
                 email = form.cleaned_data["email"]
-                try:
-                    contact = ctms.interface.get_by_alternate_id(primary_email=email)
-                except CTMSNotFoundByEmailError:
-                    contact = None
-                else:
-                    # response could be 200 with an empty list
-                    if contact:
-                        contact = contact[0]
-                        context["dsar_contact_pretty"] = json.dumps(contact, indent=2, sort_keys=True)
-                        context["newsletter_names"] = get_newsletter_names(contact)
-                    else:
+
+                def handler(email, use_braze_backend=False, fallback_to_ctms=False):
+                    context["vendor"] = "Braze" if use_braze_backend else "CTMS"
+                    try:
+                        if use_braze_backend:
+                            contact = braze.get(email=email)
+                            if not contact and fallback_to_ctms:
+                                context["vendor"] = "CTMS"
+                                contact = ctms.interface.get_by_alternate_id(primary_email=email)
+                        else:
+                            contact = ctms.interface.get_by_alternate_id(primary_email=email)
+                    except CTMSNotFoundByEmailError:
                         contact = None
+                    else:
+                        # response could be 200 with an empty list
+                        if contact:
+                            if context["vendor"] == "Braze":
+                                context["dsar_contact_pretty"] = json.dumps(contact, indent=2, sort_keys=True)
+                            else:
+                                raw_contact = contact[0]
+                                contact = from_vendor(raw_contact)
+                                context["dsar_contact_pretty"] = json.dumps(raw_contact, indent=2, sort_keys=True)
 
-                context["dsar_contact"] = contact
-                context["dsar_submitted"] = True
+                            context["newsletter_names"] = get_newsletter_names(contact)
+                        else:
+                            contact = None
+
+                    if not contact and fallback_to_ctms:
+                        context["vendor"] = "CTMS or Braze"
+
+                    context["dsar_contact"] = contact
+                    context["dsar_submitted"] = True
+
+                if settings.BRAZE_READ_WITH_FALLBACK_ENABLE:
+                    try:
+                        handler(email, use_braze_backend=True, fallback_to_ctms=True)
+                    except Exception as e:
+                        sentry_sdk.capture_exception(e)
+                        handler(email, use_braze_backend=False)
+                elif settings.BRAZE_ONLY_READ_ENABLE:
+                    handler(email, use_braze_backend=True)
+                else:
+                    handler(email, use_braze_backend=False)
 
         context["dsar_form"] = form
         # adds default django admin context so sidebar shows etc.
@@ -152,28 +170,47 @@ def dsar_unsub_view(self, request):
                     "waitlists": "UNSUBSCRIBE",
                 }
 
-                # Process the emails.
-                for email in emails:
-                    contact = ctms.get(email=email)
-                    if contact:
-                        email_id = contact["email_id"]
-                        try:
-                            ctms.interface.patch_by_email_id(email_id, update_data)
-                        except CTMSNotFoundByEmailIDError:
-                            # should never reach here, but best to catch it anyway
-                            output.append(f"{email} not found in CTMS")
+                def handler(emails, use_braze_backend=False):
+                    # Process the emails.
+                    for email in emails:
+                        if use_braze_backend:
+                            contact = braze.get(email=email)
                         else:
-                            output.append(f"UNSUBSCRIBED {email} (ctms id: {email_id}).")
-                    else:
-                        output.append(f"{email} not found in CTMS")
+                            contact = ctms.get(email=email)
+                        if contact:
+                            email_id = contact["email_id"]
+                            try:
+                                if use_braze_backend:
+                                    braze.update(contact, {"optout": True})
+                                else:
+                                    ctms.interface.patch_by_email_id(email_id, update_data)
+                            except CTMSNotFoundByEmailIDError:
+                                # should never reach here, but best to catch it anyway
+                                output.append(f"{email} not found in CTMS")
+                            else:
+                                output.append(f"UNSUBSCRIBED {email} ({'Braze external id:' if use_braze_backend else 'ctms id:'} {email_id}).")
+                        else:
+                            output.append(f"{email} not found in {'Braze' if use_braze_backend else 'CTMS'}")
+
+                if settings.BRAZE_PARALLEL_WRITE_ENABLE:
+                    try:
+                        handler(emails, use_braze_backend=True)
+                    except Exception as e:
+                        sentry_sdk.capture_exception(e)
+
+                    handler(emails, use_braze_backend=False)
+                elif settings.BRAZE_ONLY_WRITE_ENABLE:
+                    handler(emails, use_braze_backend=True)
+                else:
+                    handler(emails, use_braze_backend=False)
 
                 output = "\n".join(output)
 
                 # Reset the form
                 form = EmailListForm()
 
         context = {
-            "title": "DSAR: Unsubscribe CTMS Users by Email Address",
+            "title": "DSAR: Unsubscribe Users by Email Address",
             "dsar_form": form,
             "dsar_output": output,
         }
@@ -192,43 +229,50 @@ def dsar_delete_view(self, request):
                 emails = form.cleaned_data["emails"]
                 output = []
 
-                # Process the emails.
-                for email in emails:
-                    try:
-                        data = ctms.delete(email)
-                    except CTMSNotFoundByEmailError:
-                        output.append(f"{email} not found in CTMS")
-                    else:
-                        for contact in data:
-                            email_id = contact["email_id"]
-                            msg = f"DELETED {email} (ctms id: {email_id})."
-                            if contact["fxa_id"]:
-                                msg += " fxa: YES."
-                            if contact["mofo_contact_id"]:
-                                msg += " mofo: YES."
-                            output.append(msg)
-
-                    if settings.BRAZE_DELETE_USER_ENABLE:
+                def handler(emails, use_braze_backend=False):
+                    # Process the emails.
+                    for email in emails:
                         try:
-                            # Fetch braze_ids instead of external_ids so we also delete
-                            # alias-only profiles.
-                            response = braze.export_users(email, ["braze_id"])
-                            if response and response.get("users"):
-                                braze_ids = [user["braze_id"] for user in response["users"]]
-                                braze.delete_users(braze_ids)
-                                msg = f"DELETED {email} (braze ids: {', '.join(braze_ids)})."
+                            if use_braze_backend:
+                                data = braze.delete(email)
+                            else:
+                                data = ctms.delete(email)
+                        except CTMSNotFoundByEmailError:
+                            output.append(f"{email} not found in CTMS")
+                        except BrazeUserNotFoundByEmailError:
+                            output.append(f"{email} not found in Braze")
+                        else:
+                            for contact in data:
+                                email_id = contact["email_id"]
+                                if use_braze_backend:
+                                    msg = f"DELETED {email} from Braze (external_id: {email_id})."
+                                else:
+                                    msg = f"DELETED {email} from CTMS (ctms id: {email_id})."
+                                if contact.get("fxa_id"):
+                                    msg += " fxa: YES."
+                                if contact.get("mofo_contact_id"):
+                                    msg += " mofo: YES."
                                 output.append(msg)
-                        except Exception as e:
-                            sentry_sdk.capture_exception()
-                            log.error(f"Braze user deletion error: {e}")
+
+                if settings.BRAZE_PARALLEL_WRITE_ENABLE:
+                    try:
+                        handler(emails, use_braze_backend=True)
+                    except Exception as e:
+                        sentry_sdk.capture_exception(e)
+
+                    handler(emails, use_braze_backend=False)
+                elif settings.BRAZE_ONLY_WRITE_ENABLE:
+                    handler(emails, use_braze_backend=True)
+                else:
+                    handler(emails, use_braze_backend=False)
 
                 output = "\n".join(output)
 
                 # Reset the form
                 form = EmailListForm()
 
         context = {
-            "title": "DSAR: Delete CTMS Data by Email Address",
+            "title": "DSAR: Delete Data by Email Address",
             "dsar_form": form,
             "dsar_output": output,
         }

basket/base/templates/admin/dsar-info.html

@@ -69,53 +69,53 @@ <h2>{{ dsar_form.email.label_tag }}</h2>
 
     <div class="output-container">
       {% if dsar_contact %}
-        <h2>User Info:</h2>
+        <h2>User Info (from {{ vendor }}):</h2>
         <table>
             <tr>
                 <th>Primary Email</th>
-                <td>{{ dsar_contact.email.primary_email }}</td>
+                <td>{{ dsar_contact.email }}</td>
             </tr>
             <tr>
                 <th>Basket Token</th>
-                <td><a href="{{ settings.FXA_EMAIL_PREFS_URL }}/{{ dsar_contact.email.basket_token }}/" target="_blank" title="Open the user's Email Preferences">{{ dsar_contact.email.basket_token }}</a></td>
+                <td><a href="{{ settings.FXA_EMAIL_PREFS_URL }}/{{ dsar_contact.token }}/" target="_blank" title="Open the user's Email Preferences">{{ dsar_contact.token }}</a></td>
             </tr>
-            {% if dsar_contact.email.first_name %}
+            {% if dsar_contact.first_name or dsar_contact.last_name %}
             <tr>
                 <th>Name</th>
-                <td>{{ dsar_contact.email.first_name }} {{ dsar_contact.email.last_name }}</td>
+                <td>{% if dsar_contact.first_name %}{{ dsar_contact.first_name }}{% endif %}{% if dsar_contact.last_name %} {{ dsar_contact.last_name }}{% endif %}</td>
             </tr>
             {% endif %}
             <tr>
                 <th>Language</th>
-                <td>{{ dsar_contact.email.email_lang }}</td>
+                <td>{{ dsar_contact.lang }}</td>
             </tr>
-            {% if dsar_contact.email.mailing_country %}
+            {% if dsar_contact.country %}
             <tr>
                 <th>Country</th>
-                <td>{{ dsar_contact.email.mailing_country }}</td>
+                <td>{{ dsar_contact.country }}</td>
             </tr>
             {% endif %}
             <tr>
                 <th>FxA ID</th>
-                <td>{{ dsar_contact.fxa.fxa_id }}</td>
+                <td>{{ dsar_contact.fxa_id }}</td>
             </tr>
-            {% if dsar_contact.fxa.primary_email %}
+            {% if dsar_contact.fxa_primary_email %}
             <tr>
                 <th>FxA Primary Email</th>
-                <td>{{ dsar_contact.fxa.primary_email }}</td>
+                <td>{{ dsar_contact.fxa_primary_email }}</td>
             </tr>
             {% endif %}
             <tr>
                 <th>MoFo Relevant?</th>
-                <td>{{ dsar_contact.mofo.mofo_relevant|yesno }}</td>
+                <td>{{ dsar_contact.mofo_relevant|yesno }}</td>
             </tr>
             <tr>
                 <th>Double Opt In?</th>
-                <td>{{ dsar_contact.email.double_opt_in|yesno }}</td>
+                <td>{{ dsar_contact.optin|yesno }}</td>
             </tr>
             <tr>
                 <th>Opt Out of All Email?</th>
-                <td>{{ dsar_contact.email.has_opted_out_of_email|yesno }}</td>
+                <td>{{ dsar_contact.optout|yesno }}</td>
             </tr>
             <tr>
                 <th>Subscriptions</th>
@@ -141,7 +141,7 @@ <h2>Raw Data:</h2>
         <pre id="text-content" class="output-text">{{ dsar_contact_pretty }}</pre>
       {% elif dsar_submitted %}
         <h2>Not Found:</h2>
-        <pre id="text-content" class="output-text">User not found in CTMS</pre>
+        <pre id="text-content" class="output-text">User not found in {{ vendor }}</pre>
       {% endif %}
     </div>
   </div>

basket/base/tests/test_rq_utils.py

@@ -1,4 +1,5 @@
 from unittest.mock import patch
+from urllib.parse import urlparse
 
 from django.conf import settings
 from django.test.utils import override_settings
@@ -19,6 +20,8 @@
 from basket.news.models import FailedTask
 from basket.news.utils import NewsletterException
 
+default_rq_url = settings.RQ_URL
+
 
 @pytest.mark.django_db
 class TestRQUtils:
@@ -46,7 +49,7 @@ def test_rq_exponential_backoff_with_debug(self):
         """
         assert rq_exponential_backoff() == [5, 5, 5, 5, 5, 5, 5, 5, 5, 5]
 
-    @override_settings(RQ_URL="redis://redis:6379/2")
+    @override_settings(RQ_URL=default_rq_url)
     def test_get_redis_connection(self):
         """
         Test that the get_redis_connection function returns a Redis connection with params we expect.
@@ -58,7 +61,12 @@ def test_get_redis_connection(self):
         # Test with no URL argument, but with RQ_URL in the settings.
         # Note: The RQ_URL being used also sets this back to the "default" for tests that follow.
         connection = get_redis_connection(force=True)
-        assert connection.connection_pool.connection_kwargs == {"host": "redis", "port": 6379, "db": 2}
+        parsed_default_rq_url = urlparse(default_rq_url)
+        assert connection.connection_pool.connection_kwargs == {
+            "host": parsed_default_rq_url.hostname,
+            "port": parsed_default_rq_url.port,
+            "db": 2,
+        }
 
     @override_settings(REDIS_URL=None, RQ_URL=None)
     def test_get_redis_connection_none(self):
@@ -69,7 +77,7 @@ def test_get_redis_connection_none(self):
             get_redis_connection(force=True)
 
         # Set back to the "default" for tests that follow since the connection is cached in the module.
-        get_redis_connection("redis://redis:6379/2", force=True)
+        get_redis_connection(default_rq_url, force=True)
 
     @override_settings(RQ_DEFAULT_QUEUE="")
     def test_get_queue(self):