feat(onboarding): Add API to support onboarding support request (#5331)

gagantrivedi · web-flow · commit 651ce590f6df · 2025-04-16T15:39:44.000+05:30
diff --git a/api/api/urls/v1.py b/api/api/urls/v1.py
@@ -56,6 +56,7 @@
         feature_health_webhook,
         name="feature-health-webhook",
     ),
+    re_path(r"^onboarding/", include("onboarding.urls", namespace="onboarding")),
     # Client SDK urls
     re_path(r"^flags/$", SDKFeatureStates.as_view(), name="flags"),
     re_path(r"^identities/$", SDKIdentities.as_view(), name="sdk-identities"),
diff --git a/api/app/settings/common.py b/api/app/settings/common.py
@@ -123,6 +123,7 @@
     "projects.tags",
     "api_keys",
     "webhooks",
+    "onboarding",
     # 2FA
     "custom_auth.mfa.trench",
     # health check plugins
@@ -732,6 +733,18 @@
     "USER_THROTTLE_CACHE_OPTIONS", default={}
 )
 
+ONBOARDING_REQUEST_THROTTLE_CACHE_NAME = "onboarding-request-throttle"
+ONBOARDING_REQUEST_THROTTLE_CACHE_BACKEND = env.str(
+    "ONBOARDING_REQUEST_THROTTLE_CACHE_BACKEND",
+    "django.core.cache.backends.db.DatabaseCache",
+)
+ONBOARDING_REQUEST_THROTTLE_CACHE_LOCATION = env.str(
+    "ONBOARDING_REQUEST_THROTTLE_CACHE_LOCATION", "onboarding-request-throttle"
+)
+ONBOARDING_REQUEST_THROTTLE_CACHE_OPTIONS: dict[str, str] = env.dict(
+    "ONBOARDING_REQUEST_THROTTLE_CACHE_OPTIONS", default={}
+)
+
 # Using Redis for cache
 # To use Redis for caching, set the cache backend to `django_redis.cache.RedisCache`.
 # and set the cache location to the redis url
@@ -807,6 +820,14 @@
         "LOCATION": USER_THROTTLE_CACHE_LOCATION,
         "OPTIONS": USER_THROTTLE_CACHE_OPTIONS,
     },
+    ONBOARDING_REQUEST_THROTTLE_CACHE_NAME: {
+        "BACKEND": ONBOARDING_REQUEST_THROTTLE_CACHE_BACKEND,
+        "LOCATION": ONBOARDING_REQUEST_THROTTLE_CACHE_LOCATION,
+        "OPTIONS": ONBOARDING_REQUEST_THROTTLE_CACHE_OPTIONS,
+        "TIMEOUT": None,
+        "MAX_ENTRIES": 10000,
+        "KEY_PREFIX": "onboarding-req",
+    },
 }
 
 TRENCH_AUTH = {
diff --git a/api/core/helpers.py b/api/core/helpers.py
@@ -1,4 +1,5 @@
 import re
+from typing import Any
 
 from django.conf import settings
 from django.contrib.sites import models as sites_models
@@ -34,7 +35,7 @@ def get_current_site_url(request: HttpRequest | Request | None = None) -> str:
     return f"{scheme}://{domain}"
 
 
-def get_ip_address_from_request(request):  # type: ignore[no-untyped-def]
+def get_ip_address_from_request(request: Request) -> Any | None:
     x_forwarded_for = request.META.get("HTTP_X_FORWARDED_FOR")
     return (
         x_forwarded_for.split(",")[0]
diff --git a/api/core/middleware/admin.py b/api/core/middleware/admin.py
@@ -14,7 +14,7 @@ def __init__(self, get_response):  # type: ignore[no-untyped-def]
 
     def __call__(self, request):  # type: ignore[no-untyped-def]
         if request.path.startswith("/admin"):
-            ip = get_ip_address_from_request(request)  # type: ignore[no-untyped-call]
+            ip = get_ip_address_from_request(request)
             if (
                 settings.ALLOWED_ADMIN_IP_ADDRESSES
                 and ip not in settings.ALLOWED_ADMIN_IP_ADDRESSES
diff --git a/api/integrations/lead_tracking/hubspot/client.py b/api/integrations/lead_tracking/hubspot/client.py
@@ -15,6 +15,7 @@
 )
 
 from integrations.lead_tracking.hubspot.constants import (
+    HUBSPOT_API_LEAD_SOURCE_SELF_HOSTED,
     HUBSPOT_FORM_ID,
     HUBSPOT_PORTAL_ID,
     HUBSPOT_ROOT_FORM_URL,
@@ -111,7 +112,11 @@ def create_contact(
             "lastname": user.last_name,
             "hs_marketable_status": user.marketing_consent_given,
         }
+        return self._create_contact(properties, hubspot_company_id)
 
+    def _create_contact(
+        self, properties: dict[str, Any], hubspot_company_id: str
+    ) -> dict[str, str]:
         response = self.client.crm.contacts.basic_api.create(
             simple_public_object_input_for_create=SimplePublicObjectInputForCreate(
                 properties=properties,
@@ -130,6 +135,17 @@ def create_contact(
         )
         return response.to_dict()  # type: ignore[no-any-return]
 
+    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,
+        }
+        self._create_contact(properties, hubspot_company_id)
+
     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
diff --git a/api/integrations/lead_tracking/hubspot/constants.py b/api/integrations/lead_tracking/hubspot/constants.py
@@ -2,3 +2,5 @@
 HUBSPOT_PORTAL_ID = "143451822"
 HUBSPOT_FORM_ID = "562ee023-fb3f-4645-a217-4d8c9b4e45be"
 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"
diff --git a/api/integrations/lead_tracking/hubspot/services.py b/api/integrations/lead_tracking/hubspot/services.py
@@ -2,7 +2,11 @@
 
 from rest_framework.request import Request
 
-from integrations.lead_tracking.hubspot.constants import HUBSPOT_COOKIE_NAME
+from integrations.lead_tracking.hubspot.client import HubspotClient
+from integrations.lead_tracking.hubspot.constants import (
+    HUBSPOT_ACTIVE_SUBSCRIPTION_SELF_HOSTED,
+    HUBSPOT_COOKIE_NAME,
+)
 from users.models import HubspotTracker
 
 logger = logging.getLogger(__name__)
@@ -35,3 +39,21 @@ def register_hubspot_tracker(request: Request) -> None:
     logger.info(
         f"Created HubspotTracker instance for user {request.user.id} with cookie {hubspot_cookie}"
     )
+
+
+def create_self_hosted_onboarding_lead(
+    email: str, first_name: str, last_name: str, organisation_name: 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"]
+
+    hubspot_client.create_self_hosted_contact(email, first_name, last_name, company_id)
diff --git a/api/integrations/lead_tracking/hubspot/tasks.py b/api/integrations/lead_tracking/hubspot/tasks.py
@@ -62,3 +62,20 @@ def track_hubspot_lead_without_organisation(user_id: int) -> None:
         return
 
     track_hubspot_lead(user.id)
+
+
+@register_task_handler()
+def create_self_hosted_onboarding_lead_task(
+    email: str, first_name: str, last_name: str, organisation_name: str
+) -> None:
+    # Avoid circular imports.
+    from integrations.lead_tracking.hubspot.services import (
+        create_self_hosted_onboarding_lead,
+    )
+
+    create_self_hosted_onboarding_lead(
+        first_name=first_name,
+        last_name=last_name,
+        email=email,
+        organisation_name=organisation_name,
+    )
diff --git a/api/onboarding/__init__.py b/api/onboarding/__init__.py
diff --git a/api/onboarding/apps.py b/api/onboarding/apps.py
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class OnboardingConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "onboarding"
diff --git a/api/onboarding/serializers.py b/api/onboarding/serializers.py
@@ -0,0 +1,8 @@
+from rest_framework import serializers
+
+
+class SelfHostedOnboardingSupportSerializer(serializers.Serializer):  # type: ignore[type-arg]
+    organisation_name = serializers.CharField()
+    first_name = serializers.CharField()
+    last_name = serializers.CharField()
+    email = serializers.EmailField()
diff --git a/api/onboarding/tasks.py b/api/onboarding/tasks.py
@@ -0,0 +1,20 @@
+import requests
+from task_processor.decorators import register_task_handler
+
+SEND_SUPPORT_REQUEST_URL = (
+    "https://api.flagsmith.com/api/v1/onboarding/request/receive/"
+)
+
+
+@register_task_handler()
+def send_onboarding_request_to_saas_flagsmith_task(
+    first_name: str, last_name: str, email: str, organisation_name: str
+) -> None:
+    data = {
+        "first_name": first_name,
+        "last_name": last_name,
+        "email": email,
+        "organisation_name": organisation_name,
+    }
+    response = requests.post(SEND_SUPPORT_REQUEST_URL, data=data, timeout=30)
+    response.raise_for_status()
diff --git a/api/onboarding/throttling.py b/api/onboarding/throttling.py
@@ -0,0 +1,29 @@
+import hashlib
+
+from django.conf import settings
+from django.core.cache import caches
+from django.views import View
+from rest_framework.request import Request
+from rest_framework.throttling import BaseThrottle
+
+from core.helpers import get_ip_address_from_request
+
+
+class OnboardingRequestThrottle(BaseThrottle):
+    cache = caches[settings.ONBOARDING_REQUEST_THROTTLE_CACHE_NAME]
+
+    def get_cache_key(self, request: Request) -> str:
+        return self.get_ip_hash(request)
+
+    def get_ip_hash(self, request: Request) -> str:
+        ip = get_ip_address_from_request(request)
+        return hashlib.sha256(ip.encode()).hexdigest()  # type: ignore[union-attr]
+
+    def allow_request(self, request: Request, view: View) -> bool:
+        cache_key = self.get_cache_key(request)
+        if self.cache.get(cache_key):
+            return False
+
+        self.cache.set(cache_key, 1)
+
+        return True
diff --git a/api/onboarding/urls.py b/api/onboarding/urls.py
@@ -0,0 +1,27 @@
+from common.core.utils import is_oss, is_saas
+from django.urls import path
+
+from onboarding.views import (
+    ReceiveSupportRequestFromSelfHosted,
+    send_onboarding_request_to_saas_flagsmith_view,
+)
+
+app_name = "onboarding"
+urlpatterns = []
+if is_saas():
+    urlpatterns.append(
+        path(
+            "request/receive/",
+            ReceiveSupportRequestFromSelfHosted.as_view(),
+            name="receive-onboarding-request",
+        )
+    )
+
+if is_oss():
+    urlpatterns.append(
+        path(
+            "request/send/",
+            send_onboarding_request_to_saas_flagsmith_view,
+            name="send-onboarding-request",
+        ),
+    )
diff --git a/api/onboarding/views.py b/api/onboarding/views.py
@@ -0,0 +1,71 @@
+import logging
+
+from django.conf import settings
+from drf_yasg.utils import no_body, 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
+from rest_framework.permissions import IsAdminUser
+from rest_framework.request import Request
+from rest_framework.response import Response
+
+from api.serializers import ErrorSerializer
+from integrations.lead_tracking.hubspot.tasks import (
+    create_self_hosted_onboarding_lead_task,
+)
+from onboarding.serializers import SelfHostedOnboardingSupportSerializer
+from onboarding.tasks import send_onboarding_request_to_saas_flagsmith_task
+from onboarding.throttling import OnboardingRequestThrottle
+from users.models import FFAdminUser
+
+logger = logging.getLogger(__name__)
+
+
+@swagger_auto_schema(
+    method="post",
+    request_body=no_body,
+    responses={204: "No Content", 400: ErrorSerializer()},
+)  # type: ignore[misc]
+@api_view(["POST"])
+@permission_classes([IsAdminUser])
+def send_onboarding_request_to_saas_flagsmith_view(request: Request) -> Response:
+    admin_user: FFAdminUser = request.user  # type: ignore[assignment]
+    organisation = admin_user.organisations.first()
+
+    if not organisation:
+        return Response(
+            {"message": "Please create an organisation before requesting support"},
+            status=status.HTTP_400_BAD_REQUEST,
+        )
+    send_onboarding_request_to_saas_flagsmith_task.delay(
+        kwargs={
+            "first_name": admin_user.first_name,
+            "last_name": admin_user.last_name,
+            "email": admin_user.email,
+            "organisation_name": organisation.name,
+        }
+    )
+    return Response(status=status.HTTP_204_NO_CONTENT)
+
+
+class ReceiveSupportRequestFromSelfHosted(GenericAPIView):  # type: ignore[type-arg]
+    serializer_class = SelfHostedOnboardingSupportSerializer
+    authentication_classes = ()
+    permission_classes = ()
+    throttle_classes = [OnboardingRequestThrottle]
+
+    @swagger_auto_schema(
+        request_body=SelfHostedOnboardingSupportSerializer,
+        responses={204: "No Content", 400: ErrorSerializer()},
+    )  # type: ignore[misc]
+    def post(self, request: Request) -> Response:
+        if not settings.HUBSPOT_ACCESS_TOKEN:
+            return Response(
+                {"message": "HubSpot access token not configured"},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+        serializer = self.get_serializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        create_self_hosted_onboarding_lead_task.delay(kwargs=serializer.data)
+        return Response(status=status.HTTP_204_NO_CONTENT)
diff --git a/api/telemetry/serializers.py b/api/telemetry/serializers.py
@@ -20,7 +20,7 @@ def save(self, instance=None):  # type: ignore[no-untyped-def,override]
             influxdb = InfluxDBWrapper("self_hosted_telemetry")  # type: ignore[no-untyped-call]
             tags = {
                 **self.validated_data,
-                "ip_address": get_ip_address_from_request(self.context["request"]),  # type: ignore[no-untyped-call]
+                "ip_address": get_ip_address_from_request(self.context["request"]),
             }
             influxdb.add_data_point("heartbeat", 1, tags=tags)
             influxdb.write()
diff --git a/api/tests/unit/integrations/lead_tracking/hubspot/test_services.py b/api/tests/unit/integrations/lead_tracking/hubspot/test_services.py
diff --git a/api/tests/unit/integrations/lead_tracking/hubspot/test_unit_hubspot_client.py b/api/tests/unit/integrations/lead_tracking/hubspot/test_unit_hubspot_client.py
diff --git a/api/tests/unit/onboarding/conftest.py b/api/tests/unit/onboarding/conftest.py
diff --git a/api/tests/unit/onboarding/test_views.py b/api/tests/unit/onboarding/test_views.py
