fix: trigger create hubspot user post tracker (#5711)

Co-authored-by: Matthew Elwell <matthew.elwell@flagsmith.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: 3 people

api/custom_auth/oauth/serializers.py

@@ -7,8 +7,12 @@
 from rest_framework import serializers
 from rest_framework.authtoken.models import Token
 
+from integrations.lead_tracking.hubspot.services import (
+    register_hubspot_tracker_and_track_user,
+)
 from users.auth_type import AuthType
-from users.models import SignUpType
+from users.models import FFAdminUser, SignUpType
+from users.serializers import UTMDataSerializer
 
 from ..serializers import InviteLinkValidationMixin
 from .github import GithubUser
@@ -31,7 +35,11 @@ class OAuthLoginSerializer(InviteLinkValidationMixin, serializers.Serializer):
         help_text="Provide information about how the user signed up (i.e. via invite or not)",
         write_only=True,
     )
-
+    hubspot_cookie = serializers.CharField(
+        required=False, allow_null=True, allow_blank=True
+    )
+    marketing_consent_given = serializers.BooleanField(required=False, allow_null=True)
+    utm_data = UTMDataSerializer(required=False, allow_null=True)
     auth_type: AuthType | None = None
     user_model_id_attribute: str = "id"
 
@@ -87,9 +95,16 @@ def _get_user(self, user_data: dict):  # type: ignore[type-arg,no-untyped-def]
                 email=email, sign_up_type=self.validated_data.get("sign_up_type")
             )
 
-            return UserModel.objects.create(
+            user = FFAdminUser.objects.create(
                 **user_data, email=email.lower(), sign_up_type=sign_up_type
             )
+
+            # On first OAuth signup, we register the hubspot cookies and utms before creating the hubspot contact
+            if request := self.context.get("request"):
+                register_hubspot_tracker_and_track_user(request, user)
+
+            return user
+
         elif existing_user.auth_type != self.get_auth_type().value:
             # In this scenario, we're seeing a user that had previously
             # authenticated with another authentication method and is now

api/custom_auth/oauth/views.py

@@ -27,7 +27,7 @@
 @swagger_auto_schema(
     method="post",
     request_body=GoogleLoginSerializer,
-    responses={200: CustomTokenSerializer(), 502: ErrorSerializer()},
+    responses={200: CustomTokenSerializer, 502: ErrorSerializer},
 )
 @api_view(["POST"])
 @permission_classes([AllowAny])
@@ -52,7 +52,7 @@ def login_with_google(request):  # type: ignore[no-untyped-def]
 @swagger_auto_schema(
     method="post",
     request_body=GithubLoginSerializer,
-    responses={200: CustomTokenSerializer(), 502: ErrorSerializer()},
+    responses={200: CustomTokenSerializer, 502: ErrorSerializer},
 )
 @api_view(["POST"])
 @permission_classes([AllowAny])

api/custom_auth/views.py

@@ -30,7 +30,7 @@
 from custom_auth.mfa.trench.utils import user_token_generator
 from custom_auth.serializers import CustomUserDelete
 from integrations.lead_tracking.hubspot.services import (
-    register_hubspot_tracker,
+    register_hubspot_tracker_and_track_user,
 )
 from users.constants import DEFAULT_DELETE_ORPHAN_ORGANISATIONS_VALUE
 from users.models import FFAdminUser
@@ -128,7 +128,8 @@ def get_throttles(self):  # type: ignore[no-untyped-def]
 
     def create(self, request: Request, *args: Any, **kwargs: Any) -> Response:
         response = super().create(request, *args, **kwargs)
-        register_hubspot_tracker(request, user=self.user)
+        register_hubspot_tracker_and_track_user(request, user=self.user)
+
         if settings.COOKIE_AUTH_ENABLED:
             authorise_response(self.user, response)
         return response  # type: ignore[no-any-return]

api/integrations/lead_tracking/hubspot/lead_tracker.py

@@ -70,10 +70,8 @@ def create_user_hubspot_contact(self, user: FFAdminUser) -> str | None:
         create_lead_form_kwargs: dict[str, Any] = {"user": user}
         if tracker:
             create_lead_form_kwargs.update(
-                {
-                    "hubspot_cookie": tracker.hubspot_cookie,
-                    "utm_data": tracker.utm_data,
-                }
+                hubspot_cookie=tracker.hubspot_cookie,
+                utm_data=tracker.utm_data,
             )
         self.client.create_lead_form(**create_lead_form_kwargs)
 

api/integrations/lead_tracking/hubspot/services.py

@@ -1,18 +1,32 @@
 import logging
 
+from django.conf import settings
 from rest_framework.request import Request
 
 from integrations.lead_tracking.hubspot.client import HubspotClient
 from integrations.lead_tracking.hubspot.constants import (
     HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED,
     HUBSPOT_COOKIE_NAME,
 )
+from integrations.lead_tracking.hubspot.tasks import (
+    create_hubspot_contact_for_user,
+)
 from users.models import FFAdminUser, HubspotTracker
 from users.serializers import UTMDataSerializer
 
 logger = logging.getLogger(__name__)
 
 
+def register_hubspot_tracker_and_track_user(
+    request: Request,
+    user: FFAdminUser | None = None,
+) -> None:
+    user_id = user.id if user else request.user.id
+    register_hubspot_tracker(request, user)
+    if settings.ENABLE_HUBSPOT_LEAD_TRACKING:
+        create_hubspot_contact_for_user.delay(args=(user_id,))
+
+
 def register_hubspot_tracker(
     request: Request,
     user: FFAdminUser | None = None,

api/organisations/invites/views.py

@@ -14,9 +14,6 @@
 from rest_framework.throttling import ScopedRateThrottle
 from rest_framework.viewsets import GenericViewSet
 
-from integrations.lead_tracking.hubspot.services import (
-    register_hubspot_tracker,
-)
 from organisations.invites.exceptions import InviteExpiredError
 from organisations.invites.models import Invite, InviteLink
 from organisations.invites.serializers import (
@@ -47,8 +44,6 @@ def join_organisation_from_email(request, hash):  # type: ignore[no-untyped-def]
         error_data = {"detail": str(e)}
         return Response(data=error_data, status=status.HTTP_400_BAD_REQUEST)
 
-    register_hubspot_tracker(request)
-
     return Response(
         OrganisationSerializerFull(
             invite.organisation, context={"request": request}
@@ -67,8 +62,6 @@ def join_organisation_from_link(request, hash):  # type: ignore[no-untyped-def]
     if invite.is_expired:
         raise InviteExpiredError()
 
-    register_hubspot_tracker(request)
-
     request.user.join_organisation_from_invite_link(invite)
 
     return Response(

api/organisations/models.py

@@ -1,5 +1,6 @@
 from __future__ import unicode_literals
 
+from datetime import timedelta
 from typing import TYPE_CHECKING, Any
 
 from common.core.utils import is_enterprise, is_saas
@@ -224,7 +225,8 @@ def register_hubspot_lead_tracking(self):  # type: ignore[no-untyped-def]
                 args=(
                     self.user.id,
                     self.organisation.id,
-                )
+                ),
+                delay_until=timezone.now() + timedelta(minutes=3),
             )
 
 

api/organisations/views.py

@@ -22,9 +22,6 @@
     get_multiple_event_list_for_organisation,
 )
 from core.helpers import get_current_site_url
-from integrations.lead_tracking.hubspot.services import (
-    register_hubspot_tracker,
-)
 from organisations.chargebee import webhook_event_types, webhook_handlers
 from organisations.exceptions import OrganisationHasNoPaidSubscription
 from organisations.models import (
@@ -114,7 +111,6 @@ def create(self, request, **kwargs):  # type: ignore[no-untyped-def]
         Override create method to add new organisation to authenticated user
         """
 
-        register_hubspot_tracker(request)
         user = request.user
         serializer = OrganisationSerializerFull(data=request.data)
         if serializer.is_valid():

api/tests/unit/custom_auth/oauth/test_unit_oauth_serializers.py

@@ -1,32 +1,54 @@
 from typing import Type
 from unittest import mock
+from unittest.mock import MagicMock
 
 import pytest
 from django.test import RequestFactory
 from django.utils import timezone
 from pytest_django.fixtures import SettingsWrapper
 from pytest_mock import MockerFixture
 from rest_framework.authtoken.models import Token
+from rest_framework.parsers import JSONParser
+from rest_framework.request import Request
+from rest_framework.test import APIRequestFactory
 
 from custom_auth.oauth.serializers import (
     GithubLoginSerializer,
     GoogleLoginSerializer,
     OAuthLoginSerializer,
 )
 from organisations.invites.models import InviteLink
-from users.models import FFAdminUser, SignUpType
+from users.models import FFAdminUser, HubspotTracker, SignUpType
 
 
+@pytest.mark.parametrize(
+    "enable_hubspot_lead_tracking",
+    (
+        True,
+        False,
+    ),
+)
 @mock.patch("custom_auth.oauth.serializers.get_user_info")
 def test_create_oauth_login_serializer(
-    mock_get_user_info: mock.MagicMock, db: None
+    mock_get_user_info: mock.MagicMock,
+    db: None,
+    settings: SettingsWrapper,
+    mocker: MagicMock,
+    enable_hubspot_lead_tracking: bool,
 ) -> None:
     # Given
+    settings.ENABLE_HUBSPOT_LEAD_TRACKING = enable_hubspot_lead_tracking
     access_token = "access-token"
     sign_up_type = "NO_INVITE"
-    data = {"access_token": access_token, "sign_up_type": sign_up_type}
-    rf = RequestFactory()
-    request = rf.post("/api/v1/auth/oauth/google/")
+    data = {
+        "access_token": access_token,
+        "sign_up_type": sign_up_type,
+        "hubspotutk": "test-hubspot-utk",
+        "utm_data": {"utm_source": "test-utm-data"},
+    }
+    rf = APIRequestFactory()
+    django_request = rf.post("/api/v1/auth/oauth/google/", data=data, format="json")
+    request = Request(django_request, parsers=[JSONParser()])
     email = "testytester@example.com"
     first_name = "testy"
     last_name = "tester"
@@ -39,7 +61,9 @@ def test_create_oauth_login_serializer(
         "google_user_id": google_user_id,
     }
     serializer = OAuthLoginSerializer(data=data, context={"request": request})  # type: ignore[abstract]
-
+    mock_create_hubspot_contact_for_user = mocker.patch(
+        "integrations.lead_tracking.hubspot.services.create_hubspot_contact_for_user"
+    )
     # monkey patch the get_user_info method to return the mock user data
     serializer.get_user_info = lambda: mock_user_data  # type: ignore[method-assign]
 
@@ -48,7 +72,17 @@ def test_create_oauth_login_serializer(
     response = serializer.save()
 
     # Then
-    assert FFAdminUser.objects.filter(email=email, sign_up_type=sign_up_type).exists()
+    user = FFAdminUser.objects.filter(email=email, sign_up_type=sign_up_type).first()
+    assert user is not None
+    hubspot_tracker = HubspotTracker.objects.get(user=user)
+    assert hubspot_tracker.utm_data == {"utm_source": "test-utm-data"}
+    assert hubspot_tracker.hubspot_cookie == "test-hubspot-utk"
+    if enable_hubspot_lead_tracking:
+        mock_create_hubspot_contact_for_user.delay.assert_called_once_with(
+            args=(user.id,)
+        )
+    else:
+        mock_create_hubspot_contact_for_user.delay.assert_not_called()
     assert isinstance(response, Token)
     assert (timezone.now() - response.user.last_login).seconds < 5
     assert response.user.email == email
@@ -103,16 +137,18 @@ def test_OAuthLoginSerializer_calls_is_authentication_method_valid_correctly_if_
 ):
     # Given
     settings.AUTH_CONTROLLER_INSTALLED = True
-
-    request = rf.post("/some-login/url")
+    rf = APIRequestFactory()
+    data = {"access_token": "some_token"}
+    django_request = rf.post("/some-login/url", data=data, format="json")
+    request = Request(django_request, parsers=[JSONParser()])
     user_email = "test_user@test.com"
     mocked_auth_controller = mocker.MagicMock()
     mocker.patch.dict(
         "sys.modules", {"auth_controller.controller": mocked_auth_controller}
     )
 
     serializer = OAuthLoginSerializer(  # type: ignore[abstract]
-        data={"access_token": "some_token"}, context={"request": request}
+        data=data, context={"request": request}
     )
     # monkey patch the get_user_info method to return the mock user data
     serializer.get_user_info = lambda: {"email": user_email}  # type: ignore[method-assign]
@@ -139,16 +175,22 @@ def test_OAuthLoginSerializer_allows_registration_if_sign_up_type_is_invite_link
 ):
     # Given
     settings.ALLOW_REGISTRATION_WITHOUT_INVITE = False
-
-    request = rf.post("/api/v1/auth/users/")
+    data = {
+        "access_token": "some_token",
+        "sign_up_type": SignUpType.INVITE_LINK.value,
+        "invite_hash": invite_link.hash,
+    }
+    rf = APIRequestFactory()
+    django_request = rf.post(
+        "/api/v1/auth/oauth/google/",
+        data=data,
+        format="json",
+    )
+    request = Request(django_request, parsers=[JSONParser()])
     user_email = "test_user@test.com"
 
     serializer = OAuthLoginSerializer(  # type: ignore[abstract]
-        data={
-            "access_token": "some_token",
-            "sign_up_type": SignUpType.INVITE_LINK.value,
-            "invite_hash": invite_link.hash,
-        },
+        data=data,
         context={"request": request},
     )
     # monkey patch the get_user_info method to return the mock user data