:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
feat(workflows): report every committed workflow creation (#127193)
Michael Reichenbach1903bd37388a
diff --git a/products/workflows/backend/models/hog_flow/hog_flow.py b/products/workflows/backend/models/hog_flow/hog_flow.pyindex f2ad18f4afb5..36a6eec7823d 100644--- a/products/workflows/backend/models/hog_flow/hog_flow.py+++ b/products/workflows/backend/models/hog_flow/hog_flow.py@@ -353,8 +353,35 @@ def _reload_batch_on_workers(team_id: int, hog_flow_ids: list[str]) -> None:capture_exception(e)+def _enqueue_workflow_created_report(+ team_id: int, workflow_id: str, created_at: str, origin_product: str | None, actions_count: int+) -> None:+ from products.workflows.backend.tasks.hog_flows import report_workflow_created # noqa: PLC0415++ try:+ report_workflow_created.delay(+ team_id=team_id,+ hog_flow_id=workflow_id,+ created_at=created_at,+ origin_product=origin_product,+ actions_count=actions_count,+ )+ except Exception:+ logger.exception("Failed to report workflow creation", team_id=team_id, workflow_id=workflow_id)++@receiver(post_save, sender=HogFlow)-def hog_flow_saved(sender, instance: HogFlow, created, update_fields=None, **kwargs):+def hog_flow_saved(sender, instance: HogFlow, created, update_fields=None, using="default", **kwargs):+ if created:+ team_id = instance.team_id+ workflow_id = str(instance.id)+ created_at = instance.created_at.isoformat()+ origin_product = instance.origin_product+ actions_count = len(instance.actions or [])+ transaction.on_commit(+ lambda: _enqueue_workflow_created_report(team_id, workflow_id, created_at, origin_product, actions_count),+ using=using,+ )# Draft columns don't affect live execution, so workers don't need a config reload for them.if update_fields and set(update_fields) <= {"draft", "draft_updated_at"}:returndiff --git a/products/workflows/backend/tasks/hog_flows.py b/products/workflows/backend/tasks/hog_flows.pyindex c0ba6fedf5ad..26404602fd92 100644--- a/products/workflows/backend/tasks/hog_flows.py+++ b/products/workflows/backend/tasks/hog_flows.py@@ -1,4 +1,5 @@from typing import Optional+from uuid import UUID, uuid5from django.utils import timezone@@ -6,9 +7,13 @@ import requestsfrom celery import shared_taskfrom structlog import get_logger+from posthog.event_usage import groups+from posthog.models.team.team import Team+from posthog.ph_client import ph_scoped_capturefrom posthog.plugins.plugin_server_api import reload_hog_flows_on_workers, reschedule_hog_flow_parked_jobsfrom posthog.scoping_audit import skip_team_scope_auditfrom posthog.tasks.utils import CeleryQueue+from posthog.utils import get_instance_regionfrom products.actions.backend.models.action import Actionfrom products.workflows.backend.models.hog_flow.hog_flow import HogFlow@@ -19,6 +24,8 @@ logger = get_logger(__name__)# beyond any real parked backlog.MAX_RESCHEDULE_SLICES = 500+WORKFLOW_CREATED_EVENT = "workflows workflow created"+@shared_task(ignore_result=True, queue=CeleryQueue.DEFAULT.value)@skip_team_scope_audit@@ -59,6 +66,36 @@ def refresh_affected_hog_flows(team_id: Optional[int] = None, action_id: Optionareturn updates+@shared_task(+ ignore_result=True,+ queue=CeleryQueue.DEFAULT.value,+ autoretry_for=(Exception,),+ dont_autoretry_for=(Team.DoesNotExist,),+ max_retries=5,+ retry_backoff=60,+ retry_backoff_max=600,+ retry_jitter=True,+)+@skip_team_scope_audit+def report_workflow_created(+ team_id: int, hog_flow_id: str, created_at: str, origin_product: str | None, actions_count: int+) -> None:+ team = Team.objects.only("uuid", "organization_id").get(id=team_id)+ with ph_scoped_capture(event_region=get_instance_region(), raise_on_error=True) as capture:+ capture(+ distinct_id=str(team.uuid),+ event=WORKFLOW_CREATED_EVENT,+ timestamp=created_at,+ uuid=str(uuid5(UUID(hog_flow_id), WORKFLOW_CREATED_EVENT)),+ properties={+ "workflow_id": hog_flow_id,+ "origin_product": origin_product,+ "actions_count": actions_count,+ },+ groups=groups(team=team),+ )++@shared_task(ignore_result=True,queue=CeleryQueue.DEFAULT.value,diff --git a/products/workflows/backend/test/test_hog_flow.py b/products/workflows/backend/test/test_hog_flow.pyindex a3f6e1066da7..e8baadb776a8 100644--- a/products/workflows/backend/test/test_hog_flow.py+++ b/products/workflows/backend/test/test_hog_flow.py@@ -1,6 +1,7 @@-from unittest.mock import patch+from unittest.mock import MagicMock, patchfrom django.core.management import call_command+from django.db import transactionfrom django.test import TestCasefrom django.utils import timezone@@ -9,6 +10,9 @@ from posthog.models.user import Userfrom products.actions.backend.models.action import Actionfrom products.workflows.backend.models.hog_flow.hog_flow import HogFlow+REPORT_CREATED = "products.workflows.backend.tasks.hog_flows.report_workflow_created.delay"+LOGGER = "products.workflows.backend.models.hog_flow.hog_flow.logger"+class TestHogFlow(TestCase):def setUp(self):@@ -18,6 +22,54 @@ class TestHogFlow(TestCase):self.user = userself.org = org+ @patch("posthog.ph_client.get_client")+ @patch(REPORT_CREATED)+ def test_creation_enqueues_one_report_after_commit(self, report_created: MagicMock, get_client: MagicMock) -> None:+ with self.captureOnCommitCallbacks(execute=True):+ flow = HogFlow.objects.create(+ name="Welcome",+ team=self.team,+ created_by=self.user,+ origin_product="broadcasts",+ actions=[{"type": "trigger"}],+ )+ flow.name = "Renamed"+ flow.origin_product = "loops"+ flow.actions = []+ flow.save()+ report_created.assert_not_called()++ report_created.assert_called_once_with(+ team_id=self.team.id,+ hog_flow_id=str(flow.id),+ created_at=flow.created_at.isoformat(),+ origin_product="broadcasts",+ actions_count=1,+ )+ get_client.assert_not_called()++ @patch(REPORT_CREATED, side_effect=RuntimeError("Broker unavailable"))+ def test_failed_enqueue_is_logged_and_does_not_fail_creation(self, report_created: MagicMock) -> None:+ with patch(LOGGER) as logger, self.captureOnCommitCallbacks(execute=True):+ flow = HogFlow.objects.create(name="Welcome", team=self.team)++ report_created.assert_called_once()+ logger.exception.assert_called_once_with(+ "Failed to report workflow creation", team_id=self.team.id, workflow_id=str(flow.id)+ )+ assert HogFlow.objects.filter(id=flow.id, team=self.team).exists()++ @patch(REPORT_CREATED)+ def test_rolled_back_creation_does_not_report(self, report_created: MagicMock) -> None:+ with self.captureOnCommitCallbacks(execute=True):+ try:+ with transaction.atomic():+ HogFlow.objects.create(name="Rolled back", team=self.team)+ raise ValueError("Abort")+ except ValueError:+ pass+ report_created.assert_not_called()+@patch("products.workflows.backend.models.hog_flow.hog_flow.reload_hog_flows_on_workers")def test_hog_flow_saved_receiver(self, mock_reload):hog_flow = HogFlow.objects.create(name="Test Flow", team=self.team)diff --git a/products/workflows/backend/test/test_report_workflow_created.py b/products/workflows/backend/test/test_report_workflow_created.pynew file mode 100644index 000000000000..eaaac1702016--- /dev/null+++ b/products/workflows/backend/test/test_report_workflow_created.py@@ -0,0 +1,140 @@+from unittest.mock import MagicMock, patch++from django.test import TestCase, override_settings++from celery.result import EagerResult++from posthog.models.team.team import Team+from posthog.models.user import User++from products.workflows.backend.tasks.hog_flows import report_workflow_created++SCOPED_CAPTURE = "products.workflows.backend.tasks.hog_flows.ph_scoped_capture"+HOG_FLOW_ID = "01a19c26-7912-0000-a2ac-711701f9164a"+CREATED_AT = "2026-10-31T23:59:58.123456+00:00"+++def captured_events(scoped_capture: MagicMock) -> list[dict]:+ capture = scoped_capture.return_value.__enter__.return_value+ return [call.kwargs for call in capture.call_args_list]+++class TestReportWorkflowCreated(TestCase):+ def setUp(self):+ super().setUp()+ self.org, self.team, _ = User.objects.bootstrap("Test org", "[email protected]", None)++ @override_settings(CLOUD_DEPLOYMENT="EU")+ @patch(SCOPED_CAPTURE)+ def test_sends_the_event_through_the_scoped_client(self, scoped_capture: MagicMock) -> None:+ report_workflow_created(+ team_id=self.team.id,+ hog_flow_id=HOG_FLOW_ID,+ created_at=CREATED_AT,+ origin_product="broadcasts",+ actions_count=1,+ )++ assert scoped_capture.call_args.kwargs == {"event_region": "EU", "raise_on_error": True}+ events = captured_events(scoped_capture)+ assert len(events) == 1+ assert events[0]["event"] == "workflows workflow created"+ assert events[0]["distinct_id"] == str(self.team.uuid)+ assert events[0]["timestamp"] == CREATED_AT+ assert events[0]["groups"]["project"] == str(self.team.uuid)+ assert events[0]["groups"]["organization"] == str(self.org.id)+ assert events[0]["properties"] == {+ "workflow_id": HOG_FLOW_ID,+ "origin_product": "broadcasts",+ "actions_count": 1,+ }++ @patch(SCOPED_CAPTURE)+ def test_a_replayed_task_sends_the_same_event_uuid(self, scoped_capture: MagicMock) -> None:+ for _ in range(2):+ report_workflow_created(+ team_id=self.team.id,+ hog_flow_id=HOG_FLOW_ID,+ created_at=CREATED_AT,+ origin_product=None,+ actions_count=0,+ )+ other_flow_id = "01a19c26-7b55-0000-0121-b3a3ea7d482f"+ report_workflow_created(+ team_id=self.team.id, hog_flow_id=other_flow_id, created_at=CREATED_AT, origin_product=None, actions_count=0+ )++ first, replay, other = (event["uuid"] for event in captured_events(scoped_capture))+ assert first == replay+ assert first != other++ def report_kwargs(self, team_id: int | None = None) -> dict:+ return {+ "team_id": self.team.id if team_id is None else team_id,+ "hog_flow_id": HOG_FLOW_ID,+ "created_at": CREATED_AT,+ "origin_product": None,+ "actions_count": 0,+ }++ def run_with_eager_retries(self, team_id: int | None = None) -> EagerResult:+ conf = report_workflow_created.app.conf+ propagates = conf.task_eager_propagates+ conf.task_eager_propagates = False+ try:+ return report_workflow_created.apply(kwargs=self.report_kwargs(team_id=team_id))+ finally:+ conf.task_eager_propagates = propagates++ @patch("posthog.ph_client.is_cloud", return_value=True)+ @patch("posthog.ph_client.get_client")+ def test_failed_upload_is_retried_and_delivers_the_same_event(+ self, get_client: MagicMock, _is_cloud: MagicMock+ ) -> None:+ clients: list[MagicMock] = []++ def client_whose_first_upload_fails(region: str, on_error=None, **kwargs) -> MagicMock:+ client = MagicMock(super_properties={})+ if on_error is not None and not clients:+ client.shutdown.side_effect = lambda: on_error(RuntimeError("Upload failed"), [])+ clients.append(client)+ return client++ get_client.side_effect = client_whose_first_upload_fails++ result = self.run_with_eager_retries()++ assert result.state == "SUCCESS"+ assert len(clients) == 2+ first, retry = (client.capture.call_args.kwargs for client in clients)+ assert retry["uuid"] == first["uuid"]+ assert retry["timestamp"] == CREATED_AT++ @patch("posthog.ph_client.is_cloud", return_value=True)+ @patch("posthog.ph_client.get_client")+ def test_upload_that_keeps_failing_stops_after_five_retries(+ self, get_client: MagicMock, _is_cloud: MagicMock+ ) -> None:+ def client_whose_upload_fails(region: str, on_error=None, **kwargs) -> MagicMock:+ client = MagicMock(super_properties={})+ if on_error is not None:+ client.shutdown.side_effect = lambda: on_error(RuntimeError("Upload failed"), [])+ return client++ get_client.side_effect = client_whose_upload_fails++ result = self.run_with_eager_retries()++ assert result.state == "FAILURE"+ assert str(result.result) == "Upload failed"+ assert get_client.call_count == 6++ @patch(SCOPED_CAPTURE)+ def test_missing_team_fails_without_a_retry(self, scoped_capture: MagicMock) -> None:+ with patch.object(Team.objects, "only", wraps=Team.objects.only) as team_lookup:+ result = self.run_with_eager_retries(team_id=-1)++ assert result.state == "FAILURE"+ assert isinstance(result.result, Team.DoesNotExist)+ assert team_lookup.call_count == 1+ scoped_capture.assert_not_called()