Skip to content

: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.

refactor(experiments): drop metric_type from recalculation temporal payloads (#118599)

Anders2b40dfd8bd5b
diff --git a/products/experiments/backend/temporal/models.py b/products/experiments/backend/temporal/models.py
index f6a93520bc8b..9723faa894af 100644
--- a/products/experiments/backend/temporal/models.py
+++ b/products/experiments/backend/temporal/models.py
@@ -106,13 +106,6 @@ class ExperimentMetricsRecalculationWorkflowInputs:
activity_task_queue: str | None = None
-def _role_from_either_field(role: str, metric_type: str) -> str:
- resolved = role or metric_type
- if not resolved:
- raise ValueError("role is required")
- return resolved
-
-
@dataclasses.dataclass(frozen=False)
class ExperimentMetricToRecalculate:
"""A single metric to recalculate.
@@ -124,14 +117,7 @@ class ExperimentMetricToRecalculate:
experiment_id: int
metric_uuid: str
# "primary" or "secondary": the metric's role in the experiment, not its kind.
- role: str = ""
- # The old name of `role`. Workers and runs that started before `role` existed write and read only this
- # field, so __post_init__ keeps the two fields equal. Remove this field, and the default of `role`, when no
- # such worker or run is left.
- metric_type: str = ""
-
- def __post_init__(self) -> None:
- self.role = self.metric_type = _role_from_either_field(self.role, self.metric_type)
+ role: str
@dataclasses.dataclass
@@ -156,14 +142,7 @@ class MetricOutOfTimeFailure:
recalculation_id: str
experiment_id: int
metric_uuid: str
- role: str = "" # "primary" or "secondary"
- # The old name of `role`, kept for the same reason as ExperimentMetricToRecalculate.metric_type.
- metric_type: str = ""
-
- def __post_init__(self) -> None:
- role = _role_from_either_field(self.role, self.metric_type)
- object.__setattr__(self, "role", role)
- object.__setattr__(self, "metric_type", role)
+ role: str # "primary" or "secondary"
@dataclasses.dataclass
diff --git a/products/experiments/backend/temporal/test_recalculation_payloads.py b/products/experiments/backend/temporal/test_recalculation_payloads.py
deleted file mode 100644
index 70d50fa54e5a..000000000000
--- a/products/experiments/backend/temporal/test_recalculation_payloads.py
+++ /dev/null
@@ -1,44 +0,0 @@
-from typing import Any
-
-import pytest
-
-import temporalio.converter
-from temporalio.contrib.pydantic import pydantic_data_converter
-
-from products.experiments.backend.temporal.models import ExperimentMetricToRecalculate, MetricOutOfTimeFailure
-
-CONVERTERS = {
- "default": temporalio.converter.default().payload_converter,
- "pydantic": pydantic_data_converter.payload_converter,
-}
-
-PAYLOADS_WITHOUT_ROLE: list[tuple[type, dict[str, Any]]] = [
- (ExperimentMetricToRecalculate, {"experiment_id": 1, "metric_uuid": "m1", "metric_type": "secondary"}),
- (
- MetricOutOfTimeFailure,
- {"recalculation_id": "r1", "experiment_id": 1, "metric_uuid": "m1", "metric_type": "secondary"},
- ),
-]
-
-
[email protected]("converter_name", CONVERTERS)
[email protected]("payload_class,fields", PAYLOADS_WITHOUT_ROLE)
-def test_payload_without_role_decodes_with_role(converter_name: str, payload_class: type, fields: dict) -> None:
- converter = CONVERTERS[converter_name]
-
- decoded = converter.from_payloads(converter.to_payloads([fields]), [payload_class])[0]
-
- assert decoded.role == "secondary"
-
-
[email protected]("converter_name", CONVERTERS)
[email protected]("payload_class,fields", PAYLOADS_WITHOUT_ROLE)
-def test_payload_with_role_still_carries_metric_type(converter_name: str, payload_class: type, fields: dict) -> None:
- converter = CONVERTERS[converter_name]
- fields_without_metric_type = {name: value for name, value in fields.items() if name != "metric_type"}
- written = payload_class(**fields_without_metric_type, role="secondary")
-
- encoded = converter.from_payloads(converter.to_payloads([written]), [dict])[0]
-
- assert encoded["metric_type"] == "secondary"
- assert encoded["role"] == "secondary"