✨(backend) allow to create a new user in a marketing system

We want to create a new user in a marketing system to create a dedicated
onboarding for each of them. The marketing service is implemented in the
django-lasuite library and it is possible to pick the backend we want
or implement a new one following the documentation on this library.

Author: lunika

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Added
+
+- ✨(backend) allow to create a new user in a marketing system
+
 ### Changed
 
 - ♿(frontend) improve accessibility:

src/backend/core/authentication/backends.py

@@ -6,6 +6,7 @@
 from django.conf import settings
 from django.core.exceptions import SuspiciousOperation
 
+from lasuite.marketing.tasks import create_or_update_contact
 from lasuite.oidc_login.backends import (
     OIDCAuthenticationBackend as LaSuiteOIDCAuthenticationBackend,
 )
@@ -57,3 +58,22 @@ def get_existing_user(self, sub, email):
             return self.UserModel.objects.get_user_by_sub_or_email(sub, email)
         except DuplicateEmailError as err:
             raise SuspiciousOperation(err.message) from err
+
+    def post_get_or_create_user(self, user, claims, is_new_user):
+        """
+        Post-processing after user creation or retrieval.
+
+        Args:
+          user (User): The user instance.
+          claims (dict): The claims dictionary.
+          is_new_user (bool): Indicates if the user was newly created.
+
+        Returns:
+        - None
+
+        """
+
+        if is_new_user and settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL:
+            create_or_update_contact.delay(
+                email=user.email, attributes={"DOCS_SOURCE": ["SIGNIN"]}
+            )

src/backend/core/tests/authentication/test_backends.py

@@ -2,17 +2,22 @@
 
 import random
 import re
+from unittest import mock
 
 from django.core.exceptions import SuspiciousOperation
 from django.test.utils import override_settings
 
 import pytest
 import responses
 from cryptography.fernet import Fernet
+from lasuite.marketing.backends import ContactData
 from lasuite.oidc_login.backends import get_oidc_refresh_token
 
 from core import models
-from core.authentication.backends import OIDCAuthenticationBackend
+from core.authentication.backends import (
+    OIDCAuthenticationBackend,
+    create_or_update_contact,
+)
 from core.factories import UserFactory
 
 pytestmark = pytest.mark.django_db
@@ -509,3 +514,79 @@ def verify_token_mocked(*args, **kwargs):
     assert user is not None
     assert request.session["oidc_access_token"] == "test-access-token"
     assert get_oidc_refresh_token(request.session) == "test-refresh-token"
+
+
+def test_authentication_post_get_or_create_user_new_user_to_marketing_email(settings):
+    """
+    New user and SIGNUP_NEW_USER_TO_MARKETING_EMAIL enabled should create a contact
+    in the marketing backend.
+    """
+
+    user = UserFactory()
+    settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL = True
+
+    klass = OIDCAuthenticationBackend()
+    with mock.patch.object(
+        create_or_update_contact, "delay"
+    ) as mock_create_or_update_contact:
+        klass.post_get_or_create_user(user, {}, True)
+        mock_create_or_update_contact.assert_called_once_with(
+            email=user.email, attributes={"DOCS_SOURCE": ["SIGNIN"]}
+        )
+
+
+def test_authentication_post_get_or_create_user_new_user_to_marketing_email_disabled(
+    settings,
+):
+    """
+    New user and SIGNUP_NEW_USER_TO_MARKETING_EMAIL disabled should not create a contact
+    in the marketing backend.
+    """
+
+    user = UserFactory()
+    settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL = False
+
+    klass = OIDCAuthenticationBackend()
+    with mock.patch.object(
+        create_or_update_contact, "delay"
+    ) as mock_create_or_update_contact:
+        klass.post_get_or_create_user(user, {}, True)
+        mock_create_or_update_contact.assert_not_called()
+
+
+def test_authentication_post_get_or_create_user_existing_user_to_marketing_email(
+    settings,
+):
+    """
+    Existing user and SIGNUP_NEW_USER_TO_MARKETING_EMAIL enabled should not create a contact
+    in the marketing backend.
+    """
+
+    user = UserFactory()
+    settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL = True
+
+    klass = OIDCAuthenticationBackend()
+    with mock.patch.object(
+        create_or_update_contact, "delay"
+    ) as mock_create_or_update_contact:
+        klass.post_get_or_create_user(user, {}, False)
+        mock_create_or_update_contact.assert_not_called()
+
+
+def test_authentication_post_get_or_create_user_existing_user_to_marketing_email_disabled(
+    settings,
+):
+    """
+    Existing user and SIGNUP_NEW_USER_TO_MARKETING_EMAIL disabled should not create a contact
+    in the marketing backend.
+    """
+
+    user = UserFactory()
+    settings.SIGNUP_NEW_USER_TO_MARKETING_EMAIL = False
+
+    klass = OIDCAuthenticationBackend()
+    with mock.patch.object(
+        create_or_update_contact, "delay"
+    ) as mock_create_or_update_contact:
+        klass.post_get_or_create_user(user, {}, False)
+        mock_create_or_update_contact.assert_not_called()

src/backend/impress/settings.py

@@ -328,6 +328,7 @@ class Base(Configuration):
         # OIDC third party
         "mozilla_django_oidc",
         "lasuite.malware_detection",
+        "lasuite.marketing",
         "csp",
     ]
 
@@ -808,6 +809,30 @@ class Base(Configuration):
         ),
     }
 
+    # Marketing and communication settings
+    SIGNUP_NEW_USER_TO_MARKETING_EMAIL = values.BooleanValue(
+        False,
+        environ_name="SIGNUP_NEW_USER_TO_MARKETING_EMAIL",
+        environ_prefix=None,
+        help_text=(
+            "When enabled, new users are automatically added to mailing list "
+            "for product updates, marketing communications, and customized emails. "
+        ),
+    )
+
+    LASUITE_MARKETING = {
+        "BACKEND": values.Value(
+            "lasuite.marketing.backends.dummy.DummyBackend",
+            environ_name="LASUITE_MARKETING_BACKEND",
+            environ_prefix=None,
+        ),
+        "PARAMETERS": values.DictValue(
+            default={},
+            environ_name="LASUITE_MARKETING_PARAMETERS",
+            environ_prefix=None,
+        ),
+    }
+
     # pylint: disable=invalid-name
     @property
     def ENVIRONMENT(self):