feat: use-create-lead-form-for-self-hosted (#6117)

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

Author: Zaimwa9

api/integrations/lead_tracking/hubspot/client.py

@@ -16,8 +16,7 @@
 )
 
 from integrations.lead_tracking.hubspot.constants import (
-    HUBSPOT_API_LEAD_SOURCE_SELF_HOSTED,
-    HUBSPOT_FORM_ID,
+    HUBSPOT_FORM_ID_SAAS,
     HUBSPOT_PORTAL_ID,
     HUBSPOT_ROOT_FORM_URL,
 )
@@ -61,6 +60,7 @@ def create_lead_form(
         user: "FFAdminUser",
         hubspot_cookie: str | None = None,
         utm_data: dict[str, str] | None = None,
+        form_id: str = HUBSPOT_FORM_ID_SAAS,
     ) -> dict[str, Any]:
         utm_data = utm_data or {}
         logger.info(
@@ -105,7 +105,7 @@ def create_lead_form(
         headers = {
             "Content-Type": "application/json",
         }
-        url = f"{HUBSPOT_ROOT_FORM_URL}/{HUBSPOT_PORTAL_ID}/{HUBSPOT_FORM_ID}"
+        url = f"{HUBSPOT_ROOT_FORM_URL}/{HUBSPOT_PORTAL_ID}/{form_id}"
 
         response = requests.post(url, headers=headers, data=json.dumps(payload))
 
@@ -131,38 +131,6 @@ def associate_contact_to_company(self, contact_id: str, company_id: str) -> None
             association_spec=association_spec,
         )
 
-    def create_self_hosted_contact(
-        self, email: str, first_name: str, last_name: str, hubspot_company_id: str
-    ) -> None:
-        properties = {
-            "email": email,
-            "firstname": first_name,
-            "lastname": last_name,
-            "api_lead_source": HUBSPOT_API_LEAD_SOURCE_SELF_HOSTED,
-        }
-
-        create_params = {
-            "simple_public_object_input_for_create": SimplePublicObjectInputForCreate(
-                properties=properties,
-            )
-        }
-
-        if hubspot_company_id:
-            create_params["simple_public_object_input_for_create"].associations = [
-                {
-                    "types": [
-                        {
-                            "associationCategory": "HUBSPOT_DEFINED",
-                            "associationTypeId": 1,
-                        }
-                    ],
-                    "to": {"id": hubspot_company_id},
-                }
-            ]
-
-        response = self.client.crm.contacts.basic_api.create(**create_params)
-        return response.to_dict()  # type: ignore[no-any-return]
-
     def get_company_by_domain(self, domain: str) -> dict[str, Any] | None:
         """
         Domain should be unique in Hubspot by design, so we should only ever have

api/integrations/lead_tracking/hubspot/constants.py

@@ -1,6 +1,7 @@
 HUBSPOT_COOKIE_NAME = "hubspotutk"
 HUBSPOT_PORTAL_ID = "143451822"
-HUBSPOT_FORM_ID = "562ee023-fb3f-4645-a217-4d8c9b4e45be"
+HUBSPOT_FORM_ID_SAAS = "562ee023-fb3f-4645-a217-4d8c9b4e45be"
+HUBSPOT_FORM_ID_SELF_HOSTED = "e79b8eca-a727-4188-a5ed-8f71c707ac50"
 HUBSPOT_ROOT_FORM_URL = "https://api.hsforms.com/submissions/v3/integration/submit"
 HUBSPOT_API_LEAD_SOURCE_SELF_HOSTED = "self-hosted"
 HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED = "free-opensource"

api/integrations/lead_tracking/hubspot/lead_tracker.py

@@ -13,6 +13,7 @@
 from users.models import FFAdminUser, HubspotLead, HubspotTracker
 
 from .client import HubspotClient
+from .constants import HUBSPOT_FORM_ID_SAAS
 
 logger = logging.getLogger(__name__)
 
@@ -67,7 +68,10 @@ def update_company_active_subscription(
 
     def create_user_hubspot_contact(self, user: FFAdminUser) -> str | None:
         tracker = HubspotTracker.objects.filter(user=user).first()
-        create_lead_form_kwargs: dict[str, Any] = {"user": user}
+        create_lead_form_kwargs: dict[str, Any] = {
+            "user": user,
+            "form_id": HUBSPOT_FORM_ID_SAAS,
+        }
         if tracker:
             create_lead_form_kwargs.update(
                 hubspot_cookie=tracker.hubspot_cookie,

api/integrations/lead_tracking/hubspot/services.py

@@ -1,12 +1,13 @@
 import logging
+from typing import Any
 
 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,
+    HUBSPOT_FORM_ID_SELF_HOSTED,
 )
 from integrations.lead_tracking.hubspot.tasks import (
     create_hubspot_contact_for_user,
@@ -67,18 +68,18 @@ def register_hubspot_tracker(
 
 
 def create_self_hosted_onboarding_lead(
-    email: str, first_name: str, last_name: str, organisation_name: str
+    email: str,
+    first_name: str,
+    last_name: str,
+    hubspot_cookie: str = "",
 ) -> None:
-    email_domain = email.split("@")[1]
     hubspot_client = HubspotClient()
-    company = hubspot_client.get_company_by_domain(email_domain)
-    if not company:
-        company = hubspot_client.create_company(
-            name=organisation_name,
-            domain=email_domain,
-            active_subscription=HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED,
-        )
-
-    company_id = company["id"]
+    user = FFAdminUser(email=email, first_name=first_name, last_name=last_name)
+    create_lead_form_kwargs: dict[str, Any] = {
+        "user": user,
+        "form_id": HUBSPOT_FORM_ID_SELF_HOSTED,
+    }
+    if hubspot_cookie:
+        create_lead_form_kwargs.update(hubspot_cookie=hubspot_cookie)
 
-    hubspot_client.create_self_hosted_contact(email, first_name, last_name, company_id)
+    hubspot_client.create_lead_form(**create_lead_form_kwargs)

api/integrations/lead_tracking/hubspot/tasks.py

@@ -66,7 +66,7 @@ def update_hubspot_active_subscription(subscription_id: int) -> None:
 
 @register_task_handler()
 def create_self_hosted_onboarding_lead_task(
-    email: str, first_name: str, last_name: str, organisation_name: str
+    email: str, first_name: str, last_name: str, hubspot_cookie: str = ""
 ) -> None:
     # Avoid circular imports.
     from integrations.lead_tracking.hubspot.services import (
@@ -77,5 +77,5 @@ def create_self_hosted_onboarding_lead_task(
         first_name=first_name,
         last_name=last_name,
         email=email,
-        organisation_name=organisation_name,
+        hubspot_cookie=hubspot_cookie,
     )

api/onboarding/serializers.py

@@ -1,8 +1,12 @@
 from rest_framework import serializers
 
 
-class SelfHostedOnboardingSupportSerializer(serializers.Serializer):  # type: ignore[type-arg]
-    organisation_name = serializers.CharField()
+class SelfHostedOnboardingSupportSendRequestSerializer(serializers.Serializer):  # type: ignore[type-arg]
+    hubspotutk = serializers.CharField(required=False, allow_blank=True)
+
+
+class SelfHostedOnboardingReceiveSupportSerializer(serializers.Serializer):  # type: ignore[type-arg]
     first_name = serializers.CharField()
     last_name = serializers.CharField()
     email = serializers.EmailField()
+    hubspot_cookie = serializers.CharField(required=False, allow_blank=True)

api/onboarding/tasks.py

@@ -8,13 +8,13 @@
 
 @register_task_handler()
 def send_onboarding_request_to_saas_flagsmith_task(
-    first_name: str, last_name: str, email: str, organisation_name: str
+    first_name: str, last_name: str, email: str, hubspot_cookie: str
 ) -> None:
     data = {
         "first_name": first_name,
         "last_name": last_name,
         "email": email,
-        "organisation_name": organisation_name,
+        "hubspot_cookie": hubspot_cookie,
     }
     response = requests.post(SEND_SUPPORT_REQUEST_URL, data=data, timeout=30)
     response.raise_for_status()

api/onboarding/views.py

@@ -1,7 +1,7 @@
 import logging
 
 from django.conf import settings
-from drf_yasg.utils import no_body, swagger_auto_schema  # type: ignore[import-untyped]
+from drf_yasg.utils import swagger_auto_schema  # type: ignore[import-untyped]
 from rest_framework import status
 from rest_framework.decorators import api_view, permission_classes
 from rest_framework.generics import GenericAPIView
@@ -13,7 +13,10 @@
 from integrations.lead_tracking.hubspot.tasks import (
     create_self_hosted_onboarding_lead_task,
 )
-from onboarding.serializers import SelfHostedOnboardingSupportSerializer
+from onboarding.serializers import (
+    SelfHostedOnboardingReceiveSupportSerializer,
+    SelfHostedOnboardingSupportSendRequestSerializer,
+)
 from onboarding.tasks import send_onboarding_request_to_saas_flagsmith_task
 from onboarding.throttling import OnboardingRequestThrottle
 from users.models import FFAdminUser
@@ -23,7 +26,7 @@
 
 @swagger_auto_schema(
     method="post",
-    request_body=no_body,
+    request_body=SelfHostedOnboardingSupportSendRequestSerializer,
     responses={204: "No Content", 400: ErrorSerializer()},
 )  # type: ignore[misc]
 @api_view(["POST"])
@@ -42,20 +45,20 @@ def send_onboarding_request_to_saas_flagsmith_view(request: Request) -> Response
             "first_name": admin_user.first_name,
             "last_name": admin_user.last_name,
             "email": admin_user.email,
-            "organisation_name": organisation.name,
+            "hubspot_cookie": request.data.get("hubspotutk"),
         }
     )
     return Response(status=status.HTTP_204_NO_CONTENT)
 
 
 class ReceiveSupportRequestFromSelfHosted(GenericAPIView):  # type: ignore[type-arg]
-    serializer_class = SelfHostedOnboardingSupportSerializer
+    serializer_class = SelfHostedOnboardingReceiveSupportSerializer
     authentication_classes = ()
     permission_classes = ()
     throttle_classes = [OnboardingRequestThrottle]
 
     @swagger_auto_schema(
-        request_body=SelfHostedOnboardingSupportSerializer,
+        request_body=SelfHostedOnboardingReceiveSupportSerializer,
         responses={204: "No Content", 400: ErrorSerializer()},
     )  # type: ignore[misc]
     def post(self, request: Request) -> Response:

api/tests/unit/integrations/lead_tracking/hubspot/test_services.py

@@ -1,77 +1,42 @@
+import pytest
 from pytest_mock import MockerFixture
 
 from integrations.lead_tracking.hubspot.constants import (
-    HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED,
+    HUBSPOT_FORM_ID_SELF_HOSTED,
 )
 from integrations.lead_tracking.hubspot.services import (
     create_self_hosted_onboarding_lead,
 )
 
 
+@pytest.mark.parametrize(
+    "hubspot_cookie, expected_hubspot_cookie", [("", False), ("test_cookie", True)]
+)
 def test_create_self_hosted_onboarding_lead_with_existing_company(
     mocker: MockerFixture,
+    hubspot_cookie: str,
+    expected_hubspot_cookie: bool,
 ) -> None:
     # Given
     mocked_hubspot_client = mocker.patch(
         "integrations.lead_tracking.hubspot.services.HubspotClient", autospec=True
     )
     email = "user@flagsmith.com"
-    organisation_name = "Flagsmith"
     first_name = "user"
     last_name = "test"
 
-    company_domain = "flagsmith.com"
-    company_id = "111"
-
-    mocked_hubspot_client().get_company_by_domain.return_value = {"id": company_id}
-
     # When
-    create_self_hosted_onboarding_lead(email, first_name, last_name, organisation_name)
+    create_self_hosted_onboarding_lead(email, first_name, last_name, hubspot_cookie)
 
     # Then
-    mocked_hubspot_client().get_company_by_domain.assert_called_once_with(
-        company_domain
-    )
-
-    mocked_hubspot_client().create_company.assert_not_called()
-
-    mocked_hubspot_client().create_self_hosted_contact.assert_called_once_with(
-        email, first_name, last_name, company_id
-    )
+    mocked_hubspot_client().create_lead_form.assert_called_once()
 
+    call_args = mocked_hubspot_client().create_lead_form.call_args
+    user = call_args.kwargs["user"]
+    form_id = call_args.kwargs["form_id"]
 
-def test_create_self_hosted_onboarding_lead_with_new_company(
-    mocker: MockerFixture,
-) -> None:
-    # Given
-    mocked_hubspot_client = mocker.patch(
-        "integrations.lead_tracking.hubspot.services.HubspotClient", autospec=True
-    )
-    email = "user@flagsmith.com"
-    organisation_name = "Flagsmith"
-    first_name = "user"
-    last_name = "test"
-
-    company_domain = "flagsmith.com"
-    company_id = "111"
-
-    mocked_hubspot_client().get_company_by_domain.return_value = None
-    mocked_hubspot_client().create_company.return_value = {"id": company_id}
-
-    # When
-    create_self_hosted_onboarding_lead(email, first_name, last_name, organisation_name)
-
-    # Then
-    mocked_hubspot_client().get_company_by_domain.assert_called_once_with(
-        company_domain
-    )
-
-    mocked_hubspot_client().create_company.assert_called_once_with(
-        name=organisation_name,
-        domain=company_domain,
-        active_subscription=HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED,
-    )
-
-    mocked_hubspot_client().create_self_hosted_contact.assert_called_once_with(
-        email, first_name, last_name, company_id
-    )
+    assert user.email == email
+    assert user.first_name == first_name
+    assert user.last_name == last_name
+    assert form_id == HUBSPOT_FORM_ID_SELF_HOSTED
+    assert ("hubspot_cookie" in call_args.kwargs) is expected_hubspot_cookie