From ca4304005661bac1fe831e7f2d62618d5d7ea044 Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 15:29:08 +0100 Subject: [PATCH 1/8] feat(experimentation): decide the rollout when completing an experiment --- api/experimentation/dataclasses.py | 6 + .../0020_add_experiment_rollout_decision.py | 39 ++++++ api/experimentation/models.py | 19 +++ api/experimentation/serializers.py | 37 ++++++ api/experimentation/services.py | 75 ++++++++++- api/experimentation/views.py | 46 ++++++- .../experimentation/test_experiment_views.py | 84 +++++++++++- .../unit/experimentation/test_services.py | 121 +++++++++++++++++- .../observability/_events-catalogue.md | 30 +++-- 9 files changed, 436 insertions(+), 21 deletions(-) create mode 100644 api/experimentation/migrations/0020_add_experiment_rollout_decision.py diff --git a/api/experimentation/dataclasses.py b/api/experimentation/dataclasses.py index c05b31686541..f4f755d7b8f3 100644 --- a/api/experimentation/dataclasses.py +++ b/api/experimentation/dataclasses.py @@ -25,6 +25,12 @@ class RolloutSpec: audience: AudienceSpec | None = None +@dataclass(frozen=True) +class RolloutDecisionSpec: + decision: str + variant_id: int | None = None + + @dataclass(frozen=True) class WarehouseEventStats: total_events_received: int diff --git a/api/experimentation/migrations/0020_add_experiment_rollout_decision.py b/api/experimentation/migrations/0020_add_experiment_rollout_decision.py new file mode 100644 index 000000000000..404ed3d7dfc5 --- /dev/null +++ b/api/experimentation/migrations/0020_add_experiment_rollout_decision.py @@ -0,0 +1,39 @@ +# Generated by Django 5.2.18 on 2026-11-19 11:45 + +import django.db.models.deletion +from django.db import migrations, models + + +class Migration(migrations.Migration): + dependencies = [ + ("experimentation", "0019_add_sdk_experimentation_event"), + ("multivariate", "0009_add_multivariate_feature_option_key"), + ] + + operations = [ + migrations.AddField( + model_name="experiment", + name="rollout_decision", + field=models.CharField( + blank=True, + choices=[ + ("control", "Control"), + ("variant", "Variant"), + ("disable", "Disable"), + ], + max_length=50, + null=True, + ), + ), + migrations.AddField( + model_name="experiment", + name="rollout_variant", + field=models.ForeignKey( + blank=True, + null=True, + on_delete=django.db.models.deletion.SET_NULL, + related_name="+", + to="multivariate.multivariatefeatureoption", + ), + ), + ] diff --git a/api/experimentation/models.py b/api/experimentation/models.py index bcfed3b18b37..030f3dab5171 100644 --- a/api/experimentation/models.py +++ b/api/experimentation/models.py @@ -140,6 +140,12 @@ class ExperimentStatus(models.TextChoices): COMPLETED = "completed", "Completed" +class RolloutDecision(models.TextChoices): + CONTROL = "control", "Control" + VARIANT = "variant", "Variant" + DISABLE = "disable", "Disable" + + class AudienceMatch(models.TextChoices): ANY = "any", "Any" ALL = "all", "All" @@ -175,6 +181,19 @@ class Experiment(LifecycleModelMixin, SoftDeleteExportableModel): # type: ignor updated_at = models.DateTimeField(auto_now=True) started_at = models.DateTimeField(null=True, blank=True) ended_at = models.DateTimeField(null=True, blank=True) + rollout_decision = models.CharField( + max_length=50, + choices=RolloutDecision.choices, + null=True, + blank=True, + ) + rollout_variant = models.ForeignKey( + "multivariate.MultivariateFeatureOption", + on_delete=models.SET_NULL, + related_name="+", + null=True, + blank=True, + ) rollout_segment = models.OneToOneField( "segments.Segment", on_delete=models.SET_NULL, diff --git a/api/experimentation/serializers.py b/api/experimentation/serializers.py index 147cb6ffdb64..625cf2075033 100644 --- a/api/experimentation/serializers.py +++ b/api/experimentation/serializers.py @@ -13,6 +13,7 @@ ) from experimentation.dataclasses import ( AudienceSpec, + RolloutDecisionSpec, RolloutSpec, WarehouseEventStats, ) @@ -27,6 +28,7 @@ ExperimentStatus, Metric, MetricDirection, + RolloutDecision, WarehouseConnection, WarehouseConnectionStatus, WarehouseType, @@ -313,6 +315,37 @@ def to_spec(data: dict[str, Any], request: Any) -> RolloutSpec: ) +class ExperimentRolloutDecisionSerializer(serializers.Serializer): # type: ignore[type-arg] + rollout_decision = serializers.ChoiceField(choices=RolloutDecision.choices) + variant_id = serializers.IntegerField(required=False) + + def validate(self, attrs: dict[str, Any]) -> dict[str, Any]: + experiment: Experiment = self.context["experiment"] + variant_id: int | None = attrs.get("variant_id") + if attrs["rollout_decision"] != RolloutDecision.VARIANT: + if variant_id is not None: + raise serializers.ValidationError( + {"variant_id": "Only allowed when rolling out a variant."} + ) + return attrs + if variant_id is None: + raise serializers.ValidationError( + {"variant_id": "Required when rolling out a variant."} + ) + if not experiment.feature.multivariate_options.filter(id=variant_id).exists(): + raise serializers.ValidationError( + {"variant_id": "Variant not found for the experiment's feature."} + ) + return attrs + + @staticmethod + def to_spec(data: dict[str, Any]) -> RolloutDecisionSpec: + return RolloutDecisionSpec( + decision=data["rollout_decision"], + variant_id=data.get("variant_id"), + ) + + class ExperimentSerializer(serializers.ModelSerializer): # type: ignore[type-arg] # Annotated with the common base type so ExperimentListSerializer can # override the field with a read-only representation. @@ -339,6 +372,8 @@ class Meta: "updated_at", "started_at", "ended_at", + "rollout_decision", + "rollout_variant", ) read_only_fields = ( "id", @@ -347,6 +382,8 @@ class Meta: "updated_at", "started_at", "ended_at", + "rollout_decision", + "rollout_variant", ) def validate_feature(self, feature: Any) -> Any: diff --git a/api/experimentation/services.py b/api/experimentation/services.py index 9434e0885f93..5d316881aafc 100644 --- a/api/experimentation/services.py +++ b/api/experimentation/services.py @@ -42,6 +42,7 @@ MetricSpec, ResultsAggregates, ResultsSummary, + RolloutDecisionSpec, RolloutSpec, WarehouseEventNames, WarehouseEventStats, @@ -58,6 +59,7 @@ ExperimentStatus, MetricAggregation, MetricDirection, + RolloutDecision, SDKExperimentationEvent, WarehouseConnection, WarehouseConnectionStatus, @@ -78,7 +80,7 @@ from features.feature_segments.services import get_next_segment_override_priority from features.feature_states.models import API_VALUE_TYPES from features.future.services import delete_segment_override, update_flag -from features.future.types import SegmentOverrideRequest +from features.future.types import EnvironmentDefaultRequest, SegmentOverrideRequest from features.models import FeatureState from features.value_types import BOOLEAN, STRING from features.versioning.versioning_service import get_environment_flags_list @@ -606,6 +608,8 @@ def transition_experiment_status( experiment: Experiment, target_status: str, user: FFAdminUser, + *, + rollout_decision: RolloutDecisionSpec | None = None, ) -> Experiment: with transaction.atomic(): experiment.refresh_from_db(from_queryset=Experiment.objects.select_for_update()) @@ -622,13 +626,82 @@ def transition_experiment_status( experiment, AuthorData.from_user(user) ) elif target_status == ExperimentStatus.COMPLETED: + if rollout_decision is None: + raise ValueError( + "Cannot complete an experiment without a rollout decision." + ) experiment.ended_at = timezone.now() + experiment.rollout_decision = rollout_decision.decision + experiment.rollout_variant_id = rollout_decision.variant_id + _apply_rollout_decision( + experiment, rollout_decision, AuthorData.from_user(user) + ) + transaction.on_commit( + lambda: experimentation_logger.info( + "experiment.completed", + experiment__id=experiment.id, + environment__id=experiment.environment_id, + feature__id=experiment.feature_id, + rollout__decision=rollout_decision.decision, + variant__id=rollout_decision.variant_id, + ) + ) experiment.save() create_experiment_audit_log(experiment, user, action=target_status) return experiment +def _apply_rollout_decision( + experiment: Experiment, + rollout_decision: RolloutDecisionSpec, + author: AuthorData, +) -> None: + """Serve the decided outcome from the environment default and remove the + rollout override. The rollout segment is kept: it records the audience.""" + environment_default: EnvironmentDefaultRequest = ( + {"enabled": False} + if rollout_decision.decision == RolloutDecision.DISABLE + else { + "enabled": True, + "variants": [ + { + "id": option_id, + "weight": 100 if option_id == rollout_decision.variant_id else 0, + } + for option_id in experiment.feature.multivariate_options.values_list( + "id", flat=True + ) + ], + } + ) + update_flag( + environment=experiment.environment, + feature=experiment.feature, + changes={"environment_default": environment_default}, + replace=False, + author=author, + overwrite_system_segment_overrides=True, + ) + delete_experiment_rollout_override(experiment, author) + + +def delete_experiment_rollout_override( + experiment: Experiment, author: AuthorData +) -> None: + if ( + segment_id := experiment.rollout_segment_id + ) is None or not _get_live_rollout_override(experiment): + return + delete_segment_override( + environment=experiment.environment, + feature=experiment.feature, + segment_id=segment_id, + author=author, + overwrite_system_segment_overrides=True, + ) + + def _remove_superseded_experiment_rollouts( experiment: Experiment, author: AuthorData ) -> None: diff --git a/api/experimentation/views.py b/api/experimentation/views.py index f99fee32fa85..1d5d4eed45c3 100644 --- a/api/experimentation/views.py +++ b/api/experimentation/views.py @@ -39,6 +39,7 @@ EXPOSURES_REFRESH_MIN_INTERVAL, RESULTS_REFRESH_MIN_INTERVAL, ) +from experimentation.dataclasses import RolloutDecisionSpec from experimentation.models import ( Experiment, ExperimentComputation, @@ -63,6 +64,7 @@ ExperimentMetricSerializer, ExperimentQueryParamSerializer, ExperimentResultsSerializer, + ExperimentRolloutDecisionSerializer, ExperimentRolloutSerializer, ExperimentSerializer, MetricSerializer, @@ -75,6 +77,7 @@ create_experiment_audit_log, create_metric_audit_log, create_warehouse_audit_log, + delete_experiment_rollout_override, enable_experiment_rollout, get_warehouse_event_names, mark_warehouse_pending_connection, @@ -481,10 +484,14 @@ def perform_destroy(self, instance: Experiment) -> None: ) } ) - create_experiment_audit_log( - instance, self._get_user(self.request), action="deleted" - ) - instance.delete() + with transaction.atomic(): + delete_experiment_rollout_override( + instance, AuthorData.from_request(self.request) + ) + create_experiment_audit_log( + instance, self._get_user(self.request), action="deleted" + ) + instance.delete() @action(detail=True, methods=["post"]) def start(self, request: Request, **kwargs: object) -> Response: @@ -500,9 +507,27 @@ def start(self, request: Request, **kwargs: object) -> Response: def pause(self, request: Request, **kwargs: object) -> Response: return self._transition_status(ExperimentStatus.PAUSED) + @extend_schema( + description=( + "Completes an experiment and decides what its feature serves " + "afterwards: control, one variant, or the flag disabled. The " + "rollout override is removed." + ), + request=ExperimentRolloutDecisionSerializer, + responses={200: ExperimentListSerializer}, + ) @action(detail=True, methods=["post"]) def complete(self, request: Request, **kwargs: object) -> Response: - return self._transition_status(ExperimentStatus.COMPLETED) + serializer = ExperimentRolloutDecisionSerializer( + data=request.data, context={"experiment": self.get_object()} + ) + serializer.is_valid(raise_exception=True) + return self._transition_status( + ExperimentStatus.COMPLETED, + rollout_decision=ExperimentRolloutDecisionSerializer.to_spec( + serializer.validated_data + ), + ) # Deliberately not tagged for MCP: the sibling mutating actions (start, # pause, complete) are not agent-exposed either, and this one re-targets a @@ -621,11 +646,18 @@ def _validate_refresh_request( detail="A refresh was requested recently. Try again later.", ) - def _transition_status(self, target_status: str) -> Response: + def _transition_status( + self, + target_status: str, + rollout_decision: RolloutDecisionSpec | None = None, + ) -> Response: experiment: Experiment = self.get_object() try: experiment = transition_experiment_status( - experiment, target_status, self._get_user(self.request) + experiment, + target_status, + self._get_user(self.request), + rollout_decision=rollout_decision, ) except ValueError: logger.warning( diff --git a/api/tests/unit/experimentation/test_experiment_views.py b/api/tests/unit/experimentation/test_experiment_views.py index db1502747073..89ce0259a124 100644 --- a/api/tests/unit/experimentation/test_experiment_views.py +++ b/api/tests/unit/experimentation/test_experiment_views.py @@ -597,7 +597,11 @@ def test_action__status_transition__returns_expected( experiment.save() # When - response = admin_client_new.post(_action_url(environment, experiment, action_name)) + response = admin_client_new.post( + _action_url(environment, experiment, action_name), + data={"rollout_decision": "control"}, + format="json", + ) # Then assert response.status_code == expected_status_code @@ -712,21 +716,72 @@ def test_action__start_rollout_enable_fails__rolls_back_transition( assert experiment.started_at is None -def test_action__complete__sets_ended_at( +def test_action__complete__returns_ended_at_and_rollout_decision( admin_client_new: APIClient, environment: Environment, experiment: Experiment, + multivariate_options: list[MultivariateFeatureOption], ) -> None: # Given experiment.status = ExperimentStatus.RUNNING experiment.save() + variant_id = multivariate_options[0].id # When - response = admin_client_new.post(_action_url(environment, experiment, "complete")) + response = admin_client_new.post( + _action_url(environment, experiment, "complete"), + data={"rollout_decision": "variant", "variant_id": variant_id}, + format="json", + ) # Then assert response.status_code == status.HTTP_200_OK assert response.json()["ended_at"] is not None + assert response.json()["rollout_decision"] == "variant" + assert response.json()["rollout_variant"] == variant_id + + +@pytest.mark.parametrize( + "rollout_decision, variant_owner", + [ + pytest.param("variant", None, id="variant-without-id"), + pytest.param("control", "own", id="control-with-variant-id"), + pytest.param("variant", "other", id="variant-of-other-feature"), + ], +) +def test_action__complete_invalid_rollout_decision__returns_400( + admin_client_new: APIClient, + environment: Environment, + experiment: Experiment, + multivariate_options: list[MultivariateFeatureOption], + feature: Feature, + rollout_decision: str, + variant_owner: str | None, +) -> None: + # Given + experiment.status = ExperimentStatus.RUNNING + experiment.save() + variant_ids = { + None: None, + "own": multivariate_options[0].id, + "other": MultivariateFeatureOption.objects.create( + feature=feature, type="unicode", string_value="other" + ).id, + } + data: dict[str, object] = {"rollout_decision": rollout_decision} + if variant_id := variant_ids[variant_owner]: + data["variant_id"] = variant_id + + # When + response = admin_client_new.post( + _action_url(environment, experiment, "complete"), + data=data, + format="json", + ) + + # Then + assert response.status_code == status.HTTP_400_BAD_REQUEST + assert list(response.json()) == ["variant_id"] def test_exposures__computed_row__returns_row( @@ -1027,6 +1082,29 @@ def test_delete__exists__returns_204_and_soft_deletes( assert Experiment.objects.all_with_deleted().filter(id=experiment.id).exists() +def test_delete__live_rollout_override__removes_override_and_keeps_segment( + admin_client_new: APIClient, + environment: Environment, + experiment_with_rollout: Experiment, +) -> None: + # Given + rollout_segment_id = experiment_with_rollout.rollout_segment_id + + # When + response = admin_client_new.delete( + _detail_url(environment, experiment_with_rollout) + ) + + # Then + assert response.status_code == status.HTTP_204_NO_CONTENT + assert not FeatureState.objects.get_live_feature_states( + environment=environment, + additional_filters=Q(feature_segment__segment_id=rollout_segment_id), + feature_id=experiment_with_rollout.feature_id, + ).exists() + assert Segment.objects.filter(id=rollout_segment_id).exists() + + def test_post__valid_create__creates_audit_log( admin_client_new: APIClient, environment: Environment, diff --git a/api/tests/unit/experimentation/test_services.py b/api/tests/unit/experimentation/test_services.py index 9b75dee2422c..296b4f9cf867 100644 --- a/api/tests/unit/experimentation/test_services.py +++ b/api/tests/unit/experimentation/test_services.py @@ -37,6 +37,7 @@ ExposuresTimeseriesPoint, MetricSpec, ResultsAggregates, + RolloutDecisionSpec, RolloutSpec, WarehouseEventNames, WarehouseEventStats, @@ -49,6 +50,7 @@ Metric, MetricAggregation, MetricDirection, + RolloutDecision, WarehouseConnection, WarehouseConnectionStatus, WarehouseDeliveryStatus, @@ -66,7 +68,7 @@ from experimentation.warehouses.exceptions import UnsupportedWarehouseOperation from features.feature_segments.services import get_next_segment_override_priority from features.feature_types import MULTIVARIATE -from features.future.services import update_flag +from features.future.services import get_flag, update_flag from features.models import Feature, FeatureState from features.multivariate.models import MultivariateFeatureOption from features.value_types import STRING @@ -3749,6 +3751,123 @@ def test_transition_experiment_status__first_start__removes_superseded_rollouts( ] +@pytest.mark.parametrize( + "environment_fixture_name", + ["environment", "environment_v2_versioning"], +) +@pytest.mark.parametrize( + "decision, variant_index, expected_enabled, expected_weights", + [ + pytest.param(RolloutDecision.CONTROL, None, True, [0, 0, 0], id="control"), + pytest.param(RolloutDecision.VARIANT, 1, True, [0, 100, 0], id="variant"), + pytest.param(RolloutDecision.DISABLE, None, False, [30, 0, 0], id="disable"), + ], +) +def test_transition_experiment_status__complete__serves_decision_and_removes_rollout_override( # type: ignore[no-untyped-def] + environment_fixture_name: str, + decision: str, + variant_index: int | None, + expected_enabled: bool, + expected_weights: list[float], + multivariate_feature: Feature, + multivariate_options: list[MultivariateFeatureOption], + admin_user: FFAdminUser, + rollout_spec: RolloutSpecFactory, + log: StructuredLogCapture, + request: pytest.FixtureRequest, + django_capture_on_commit_callbacks, +) -> None: + # Given + environment: Environment = request.getfixturevalue(environment_fixture_name) + experiment = _experiment_with_rollout( + environment, + multivariate_feature, + rollout_spec, + status=ExperimentStatus.RUNNING, + ) + rollout_segment_id = experiment.rollout_segment_id + update_flag( + environment=environment, + feature=multivariate_feature, + changes={ + "environment_default": { + "enabled": not expected_enabled, + "variants": [ + {"id": option.id, "weight": 30 if index == 0 else 0} + for index, option in enumerate(multivariate_options) + ], + } + }, + replace=False, + author=AuthorData(user=admin_user), + overwrite_system_segment_overrides=False, + ) + variant_id = ( + multivariate_options[variant_index].id if variant_index is not None else None + ) + + # When + with django_capture_on_commit_callbacks(execute=True): + services.transition_experiment_status( + experiment, + ExperimentStatus.COMPLETED, + admin_user, + rollout_decision=RolloutDecisionSpec( + decision=decision, variant_id=variant_id + ), + ) + + # Then + environment_default = get_flag( + environment=environment, feature=multivariate_feature + )["environment_default"] + assert environment_default["enabled"] is expected_enabled + assert { + variant["id"]: variant["weight"] for variant in environment_default["variants"] + } == { + option.id: weight + for option, weight in zip(multivariate_options, expected_weights) + } + assert _live_override_segment_ids(environment, multivariate_feature) == set() + experiment.refresh_from_db() + assert experiment.rollout_decision == decision + assert experiment.rollout_variant_id == variant_id + assert experiment.rollout_segment_id == rollout_segment_id + assert Segment.objects.filter(id=rollout_segment_id).exists() + assert [ + event for event in log.events if event["event"] == "experiment.completed" + ] == [ + { + "level": "info", + "event": "experiment.completed", + "experiment__id": experiment.id, + "environment__id": environment.id, + "feature__id": multivariate_feature.id, + "rollout__decision": decision, + "variant__id": variant_id, + } + ] + + +def test_transition_experiment_status__complete_without_rollout_decision__raises( + experiment: Experiment, + admin_user: FFAdminUser, +) -> None: + # Given + experiment.status = ExperimentStatus.RUNNING + experiment.save() + + # When + with pytest.raises(ValueError): + services.transition_experiment_status( + experiment, ExperimentStatus.COMPLETED, admin_user + ) + + # Then + experiment.refresh_from_db() + assert experiment.status == ExperimentStatus.RUNNING + + def test_get_experiment_rollout__audience__returns_segment_details( multi_segment_audiences: None, experiment: Experiment, diff --git a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md index e40b24429464..7a337f3d00ad 100644 --- a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md +++ b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md @@ -192,6 +192,18 @@ Logged at `warning` from: Attributes: - `exc_info` +### `experimentation.experiment.completed` + +Logged at `info` from: + - `api/experimentation/services.py:640` + +Attributes: + - `environment.id` + - `experiment.id` + - `feature.id` + - `rollout.decision` + - `variant.id` + ### `experimentation.exposures.compute_failed` Logged at `error` from: @@ -240,7 +252,7 @@ Attributes: ### `experimentation.rollout.applied` Logged at `info` from: - - `api/experimentation/services.py:1081` + - `api/experimentation/services.py:1154` Attributes: - `audience.match` @@ -256,7 +268,7 @@ Attributes: ### `experimentation.rollout.superseded` Logged at `info` from: - - `api/experimentation/services.py:672` + - `api/experimentation/services.py:745` Attributes: - `environment.id` @@ -267,7 +279,7 @@ Attributes: ### `experimentation.sdk_events.rejected` Logged at `warning` from: - - `api/experimentation/services.py:222` + - `api/experimentation/services.py:224` Attributes: - `environment.id` @@ -933,7 +945,7 @@ Attributes: ### `warehouse.connection.connected` Logged at `info` from: - - `api/experimentation/services.py:1257` + - `api/experimentation/services.py:1330` Attributes: - `environment.id` @@ -964,7 +976,7 @@ Attributes: ### `warehouse.connection.test_event_sent` Logged at `info` from: - - `api/experimentation/services.py:1200` + - `api/experimentation/services.py:1273` Attributes: - `environment.id` @@ -973,7 +985,7 @@ Attributes: ### `warehouse.connection.verification_failed` Logged at `warning` from: - - `api/experimentation/services.py:1232` + - `api/experimentation/services.py:1305` Attributes: - `environment.id` @@ -983,7 +995,7 @@ Attributes: ### `warehouse.connection.verification_succeeded` Logged at `info` from: - - `api/experimentation/services.py:1242` + - `api/experimentation/services.py:1315` Attributes: - `environment.id` @@ -992,7 +1004,7 @@ Attributes: ### `warehouse.srm.overallocated` Logged at `error` from: - - `api/experimentation/services.py:461` + - `api/experimentation/services.py:463` Attributes: - `environment.id` @@ -1002,7 +1014,7 @@ Attributes: ### `warehouse.srm.unkeyed_variant` Logged at `error` from: - - `api/experimentation/services.py:447` + - `api/experimentation/services.py:449` Attributes: - `environment.id` From 8593aab0a5ec95e6daec8af343df72e58f36f8c0 Mon Sep 17 00:00:00 2001 From: "flagsmith-engineering[bot]" Date: Thu, 19 Nov 2026 14:30:26 +0000 Subject: [PATCH 2/8] chore: Update documentation artefacts --- mcp/src/flagsmith_mcp/openapi.json | 63 ++++++++++++++++++++++++++++ openapi.yaml | 67 ++++++++++++++++++++++++++++-- 2 files changed, 126 insertions(+), 4 deletions(-) diff --git a/mcp/src/flagsmith_mcp/openapi.json b/mcp/src/flagsmith_mcp/openapi.json index 418e0dedf5d2..38506c708215 100644 --- a/mcp/src/flagsmith_mcp/openapi.json +++ b/mcp/src/flagsmith_mcp/openapi.json @@ -4591,6 +4591,24 @@ ], "format": "date-time", "readOnly": true + }, + "rollout_decision": { + "oneOf": [ + { + "$ref": "#/components/schemas/RolloutDecisionEnum" + }, + { + "$ref": "#/components/schemas/NullEnum" + } + ], + "readOnly": true + }, + "rollout_variant": { + "type": [ + "integer", + "null" + ], + "readOnly": true } }, "required": [ @@ -4691,6 +4709,24 @@ ], "format": "date-time", "readOnly": true + }, + "rollout_decision": { + "oneOf": [ + { + "$ref": "#/components/schemas/RolloutDecisionEnum" + }, + { + "$ref": "#/components/schemas/NullEnum" + } + ], + "readOnly": true + }, + "rollout_variant": { + "type": [ + "integer", + "null" + ], + "readOnly": true } }, "required": [ @@ -4803,6 +4839,24 @@ ], "format": "date-time", "readOnly": true + }, + "rollout_decision": { + "oneOf": [ + { + "$ref": "#/components/schemas/RolloutDecisionEnum" + }, + { + "$ref": "#/components/schemas/NullEnum" + } + ], + "readOnly": true + }, + "rollout_variant": { + "type": [ + "integer", + "null" + ], + "readOnly": true } }, "required": [ @@ -7277,6 +7331,15 @@ "USER" ] }, + "RolloutDecisionEnum": { + "description": "* `control` - Control\n* `variant` - Variant\n* `disable` - Disable", + "type": "string", + "enum": [ + "control", + "variant", + "disable" + ] + }, "Segment": { "description": "Functionality for serializers that need to handle metadata", "type": "object", diff --git a/openapi.yaml b/openapi.yaml index 82298c729991..f4907e60dafc 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -3721,7 +3721,7 @@ paths: '/api/v1/environments/{environment_api_key}/experiments/{experiment_id}/complete/': post: operationId: api_v1_environments_experiments_complete_create - description: Manage experiments for an environment. + description: 'Completes an experiment and decides what its feature serves afterwards: control, one variant, or the flag disabled. The rollout override is removed.' parameters: - name: environment_api_key in: path @@ -3739,13 +3739,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExperimentList' + $ref: '#/components/schemas/ExperimentRolloutDecision' application/x-www-form-urlencoded: schema: - $ref: '#/components/schemas/ExperimentList' + $ref: '#/components/schemas/ExperimentRolloutDecision' multipart/form-data: schema: - $ref: '#/components/schemas/ExperimentList' + $ref: '#/components/schemas/ExperimentRolloutDecision' responses: '200': description: '' @@ -21831,6 +21831,16 @@ components: - 'null' format: date-time readOnly: true + rollout_decision: + oneOf: + - $ref: '#/components/schemas/RolloutDecisionEnum' + - $ref: '#/components/schemas/NullEnum' + readOnly: true + rollout_variant: + type: + - integer + - 'null' + readOnly: true required: - feature - hypothesis @@ -21899,6 +21909,16 @@ components: - 'null' format: date-time readOnly: true + rollout_decision: + oneOf: + - $ref: '#/components/schemas/RolloutDecisionEnum' + - $ref: '#/components/schemas/NullEnum' + readOnly: true + rollout_variant: + type: + - integer + - 'null' + readOnly: true required: - hypothesis - name @@ -21974,6 +21994,16 @@ components: - 'null' format: date-time readOnly: true + rollout_decision: + oneOf: + - $ref: '#/components/schemas/RolloutDecisionEnum' + - $ref: '#/components/schemas/NullEnum' + readOnly: true + rollout_variant: + type: + - integer + - 'null' + readOnly: true required: - hypothesis - name @@ -22053,6 +22083,15 @@ components: - feature_state_value - multivariate_feature_state_values - rollout_percentage + ExperimentRolloutDecision: + type: object + properties: + rollout_decision: + $ref: '#/components/schemas/RolloutDecisionEnum' + variant_id: + type: integer + required: + - rollout_decision ExperimentStatistics: description: Serializer for statistical analysis results. type: object @@ -25736,6 +25775,16 @@ components: - 'null' format: date-time readOnly: true + rollout_decision: + oneOf: + - $ref: '#/components/schemas/RolloutDecisionEnum' + - $ref: '#/components/schemas/NullEnum' + readOnly: true + rollout_variant: + type: + - integer + - 'null' + readOnly: true PatchedExperimentMetric: type: object properties: @@ -28191,6 +28240,16 @@ components: required: - permissions - project + RolloutDecisionEnum: + description: |- + * `control` - Control + * `variant` - Variant + * `disable` - Disable + type: string + enum: + - control + - variant + - disable RudderstackConfiguration: type: object properties: From 9769c922b9cc3815ffd6578bb0af6a18e8f10697 Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 16:05:23 +0100 Subject: [PATCH 3/8] fix(experimentation): lock the experiment before deleting it and type the rollout decision --- api/experimentation/dataclasses.py | 4 ++-- api/experimentation/services.py | 3 +-- api/experimentation/types.py | 2 ++ api/experimentation/views.py | 21 ++++++++++++--------- 4 files changed, 17 insertions(+), 13 deletions(-) diff --git a/api/experimentation/dataclasses.py b/api/experimentation/dataclasses.py index f4f755d7b8f3..8e08a1a8237c 100644 --- a/api/experimentation/dataclasses.py +++ b/api/experimentation/dataclasses.py @@ -3,7 +3,7 @@ from core.dataclasses import AuthorData from experimentation.stats import Inference, VariantStats -from experimentation.types import ExposureGranularity +from experimentation.types import ExposureGranularity, RolloutDecisionType from features.feature_states.models import FeatureValueType from features.future.types import Variant @@ -27,7 +27,7 @@ class RolloutSpec: @dataclass(frozen=True) class RolloutDecisionSpec: - decision: str + decision: RolloutDecisionType variant_id: int | None = None diff --git a/api/experimentation/services.py b/api/experimentation/services.py index 5d316881aafc..fba8aff0b21a 100644 --- a/api/experimentation/services.py +++ b/api/experimentation/services.py @@ -59,7 +59,6 @@ ExperimentStatus, MetricAggregation, MetricDirection, - RolloutDecision, SDKExperimentationEvent, WarehouseConnection, WarehouseConnectionStatus, @@ -661,7 +660,7 @@ def _apply_rollout_decision( rollout override. The rollout segment is kept: it records the audience.""" environment_default: EnvironmentDefaultRequest = ( {"enabled": False} - if rollout_decision.decision == RolloutDecision.DISABLE + if rollout_decision.decision == "disable" else { "enabled": True, "variants": [ diff --git a/api/experimentation/types.py b/api/experimentation/types.py index a36079199b29..6d596405d672 100644 --- a/api/experimentation/types.py +++ b/api/experimentation/types.py @@ -4,6 +4,8 @@ ExposureGranularity = Literal["hour", "day"] +RolloutDecisionType = Literal["control", "variant", "disable"] + class MetricDefinitionV1(TypedDict): """The recipe a metric is computed from. diff --git a/api/experimentation/views.py b/api/experimentation/views.py index 1d5d4eed45c3..732192bc9ae9 100644 --- a/api/experimentation/views.py +++ b/api/experimentation/views.py @@ -475,16 +475,19 @@ def perform_update(self, serializer: BaseSerializer[Experiment]) -> None: ) def perform_destroy(self, instance: Experiment) -> None: - if instance.status == ExperimentStatus.RUNNING: - raise serializers.ValidationError( - { - "detail": ( - "Cannot delete a running experiment. " - "Pause or complete it first." - ) - } - ) with transaction.atomic(): + instance.refresh_from_db( + from_queryset=Experiment.objects.select_for_update() + ) + if instance.status == ExperimentStatus.RUNNING: + raise serializers.ValidationError( + { + "detail": ( + "Cannot delete a running experiment. " + "Pause or complete it first." + ) + } + ) delete_experiment_rollout_override( instance, AuthorData.from_request(self.request) ) From 0a769797a1122fee6eac6f6859d785f968d47616 Mon Sep 17 00:00:00 2001 From: "flagsmith-engineering[bot]" Date: Thu, 19 Nov 2026 15:06:36 +0000 Subject: [PATCH 4/8] chore: Update documentation artefacts --- .../observability/_events-catalogue.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md index 7a337f3d00ad..aa51e8f0e2ea 100644 --- a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md +++ b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md @@ -195,7 +195,7 @@ Attributes: ### `experimentation.experiment.completed` Logged at `info` from: - - `api/experimentation/services.py:640` + - `api/experimentation/services.py:639` Attributes: - `environment.id` @@ -252,7 +252,7 @@ Attributes: ### `experimentation.rollout.applied` Logged at `info` from: - - `api/experimentation/services.py:1154` + - `api/experimentation/services.py:1153` Attributes: - `audience.match` @@ -268,7 +268,7 @@ Attributes: ### `experimentation.rollout.superseded` Logged at `info` from: - - `api/experimentation/services.py:745` + - `api/experimentation/services.py:744` Attributes: - `environment.id` @@ -279,7 +279,7 @@ Attributes: ### `experimentation.sdk_events.rejected` Logged at `warning` from: - - `api/experimentation/services.py:224` + - `api/experimentation/services.py:223` Attributes: - `environment.id` @@ -945,7 +945,7 @@ Attributes: ### `warehouse.connection.connected` Logged at `info` from: - - `api/experimentation/services.py:1330` + - `api/experimentation/services.py:1329` Attributes: - `environment.id` @@ -976,7 +976,7 @@ Attributes: ### `warehouse.connection.test_event_sent` Logged at `info` from: - - `api/experimentation/services.py:1273` + - `api/experimentation/services.py:1272` Attributes: - `environment.id` @@ -985,7 +985,7 @@ Attributes: ### `warehouse.connection.verification_failed` Logged at `warning` from: - - `api/experimentation/services.py:1305` + - `api/experimentation/services.py:1304` Attributes: - `environment.id` @@ -995,7 +995,7 @@ Attributes: ### `warehouse.connection.verification_succeeded` Logged at `info` from: - - `api/experimentation/services.py:1315` + - `api/experimentation/services.py:1314` Attributes: - `environment.id` @@ -1004,7 +1004,7 @@ Attributes: ### `warehouse.srm.overallocated` Logged at `error` from: - - `api/experimentation/services.py:463` + - `api/experimentation/services.py:462` Attributes: - `environment.id` @@ -1014,7 +1014,7 @@ Attributes: ### `warehouse.srm.unkeyed_variant` Logged at `error` from: - - `api/experimentation/services.py:449` + - `api/experimentation/services.py:448` Attributes: - `environment.id` From e73fb0ac1509fb50eb83a6f96c46d2099a20833e Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 16:15:59 +0100 Subject: [PATCH 5/8] fix(experimentation): type the rollout decision in the completion test --- api/tests/unit/experimentation/test_services.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/api/tests/unit/experimentation/test_services.py b/api/tests/unit/experimentation/test_services.py index 296b4f9cf867..9855b8e0a2a7 100644 --- a/api/tests/unit/experimentation/test_services.py +++ b/api/tests/unit/experimentation/test_services.py @@ -62,6 +62,7 @@ verify_warehouse_connection, ) from experimentation.stats import VariantStats +from experimentation.types import RolloutDecisionType from experimentation.warehouses import flagsmith from experimentation.warehouses.constants import VERIFY_TIMEOUT_SECONDS from experimentation.warehouses.dialect import CLICKHOUSE_DIALECT @@ -3765,7 +3766,7 @@ def test_transition_experiment_status__first_start__removes_superseded_rollouts( ) def test_transition_experiment_status__complete__serves_decision_and_removes_rollout_override( # type: ignore[no-untyped-def] environment_fixture_name: str, - decision: str, + decision: RolloutDecisionType, variant_index: int | None, expected_enabled: bool, expected_weights: list[float], From f098bfc27d6c06ea7ef038103713e99e1a88ecd7 Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 16:16:01 +0100 Subject: [PATCH 6/8] fix(experimentation): return 404 when an experiment is deleted concurrently --- api/experimentation/views.py | 11 ++++-- .../experimentation/test_experiment_views.py | 37 +++++++++++++++++++ 2 files changed, 45 insertions(+), 3 deletions(-) diff --git a/api/experimentation/views.py b/api/experimentation/views.py index 732192bc9ae9..529b0636dbef 100644 --- a/api/experimentation/views.py +++ b/api/experimentation/views.py @@ -476,9 +476,12 @@ def perform_update(self, serializer: BaseSerializer[Experiment]) -> None: def perform_destroy(self, instance: Experiment) -> None: with transaction.atomic(): - instance.refresh_from_db( - from_queryset=Experiment.objects.select_for_update() - ) + try: + instance.refresh_from_db( + from_queryset=Experiment.objects.select_for_update() + ) + except Experiment.DoesNotExist as exc: + raise NotFound from exc if instance.status == ExperimentStatus.RUNNING: raise serializers.ValidationError( { @@ -662,6 +665,8 @@ def _transition_status( self._get_user(self.request), rollout_decision=rollout_decision, ) + except Experiment.DoesNotExist as exc: + raise NotFound from exc except ValueError: logger.warning( "Invalid experiment status transition for " diff --git a/api/tests/unit/experimentation/test_experiment_views.py b/api/tests/unit/experimentation/test_experiment_views.py index 89ce0259a124..e28fac821af5 100644 --- a/api/tests/unit/experimentation/test_experiment_views.py +++ b/api/tests/unit/experimentation/test_experiment_views.py @@ -1263,6 +1263,43 @@ def test_delete__running_experiment__returns_400( assert Experiment.objects.filter(id=experiment.id).exists() +@pytest.mark.parametrize( + "method, action, data", + [ + pytest.param("delete", None, None, id="delete"), + pytest.param( + "post", "complete", {"rollout_decision": "control"}, id="complete" + ), + ], +) +def test_experiment__deleted_concurrently__returns_404( + admin_client_new: APIClient, + environment: Environment, + experiment: Experiment, + mocker: MockerFixture, + method: str, + action: str | None, + data: dict[str, str] | None, +) -> None: + # Given + experiment.status = ExperimentStatus.PAUSED + experiment.save() + mocker.patch.object( + Experiment, "refresh_from_db", side_effect=Experiment.DoesNotExist + ) + url = ( + _action_url(environment, experiment, action) + if action + else _detail_url(environment, experiment) + ) + + # When + response = getattr(admin_client_new, method)(url, data=data, format="json") + + # Then + assert response.status_code == status.HTTP_404_NOT_FOUND + + def test_patch__no_change__skips_audit_log( admin_client_new: APIClient, environment: Environment, From 5dbdd467b23779d6bc83e73f7a79a8782f6ca81f Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 17:06:15 +0100 Subject: [PATCH 7/8] refactor(experimentation): move experiment deletion to a service and name the variant rollout_variant --- api/experimentation/dataclasses.py | 10 ++++-- api/experimentation/serializers.py | 20 ++++++------ api/experimentation/services.py | 27 ++++++++++++---- api/experimentation/types.py | 2 -- api/experimentation/views.py | 31 +++++-------------- .../experimentation/test_experiment_views.py | 6 ++-- .../unit/experimentation/test_services.py | 5 ++- 7 files changed, 51 insertions(+), 50 deletions(-) diff --git a/api/experimentation/dataclasses.py b/api/experimentation/dataclasses.py index 8e08a1a8237c..99732e42695a 100644 --- a/api/experimentation/dataclasses.py +++ b/api/experimentation/dataclasses.py @@ -1,12 +1,16 @@ from dataclasses import dataclass from datetime import datetime +from typing import TYPE_CHECKING from core.dataclasses import AuthorData from experimentation.stats import Inference, VariantStats -from experimentation.types import ExposureGranularity, RolloutDecisionType +from experimentation.types import ExposureGranularity from features.feature_states.models import FeatureValueType from features.future.types import Variant +if TYPE_CHECKING: + from experimentation.models import RolloutDecision + @dataclass(frozen=True) class AudienceSpec: @@ -27,8 +31,8 @@ class RolloutSpec: @dataclass(frozen=True) class RolloutDecisionSpec: - decision: RolloutDecisionType - variant_id: int | None = None + decision: "RolloutDecision" + rollout_variant_id: int | None = None @dataclass(frozen=True) diff --git a/api/experimentation/serializers.py b/api/experimentation/serializers.py index 625cf2075033..3d5f259c21dc 100644 --- a/api/experimentation/serializers.py +++ b/api/experimentation/serializers.py @@ -317,24 +317,26 @@ def to_spec(data: dict[str, Any], request: Any) -> RolloutSpec: class ExperimentRolloutDecisionSerializer(serializers.Serializer): # type: ignore[type-arg] rollout_decision = serializers.ChoiceField(choices=RolloutDecision.choices) - variant_id = serializers.IntegerField(required=False) + rollout_variant = serializers.IntegerField(required=False) def validate(self, attrs: dict[str, Any]) -> dict[str, Any]: experiment: Experiment = self.context["experiment"] - variant_id: int | None = attrs.get("variant_id") + rollout_variant: int | None = attrs.get("rollout_variant") if attrs["rollout_decision"] != RolloutDecision.VARIANT: - if variant_id is not None: + if rollout_variant is not None: raise serializers.ValidationError( - {"variant_id": "Only allowed when rolling out a variant."} + {"rollout_variant": "Only allowed when rolling out a variant."} ) return attrs - if variant_id is None: + if rollout_variant is None: raise serializers.ValidationError( - {"variant_id": "Required when rolling out a variant."} + {"rollout_variant": "Required when rolling out a variant."} ) - if not experiment.feature.multivariate_options.filter(id=variant_id).exists(): + if not experiment.feature.multivariate_options.filter( + id=rollout_variant + ).exists(): raise serializers.ValidationError( - {"variant_id": "Variant not found for the experiment's feature."} + {"rollout_variant": "Variant not found for the experiment's feature."} ) return attrs @@ -342,7 +344,7 @@ def validate(self, attrs: dict[str, Any]) -> dict[str, Any]: def to_spec(data: dict[str, Any]) -> RolloutDecisionSpec: return RolloutDecisionSpec( decision=data["rollout_decision"], - variant_id=data.get("variant_id"), + rollout_variant_id=data.get("rollout_variant"), ) diff --git a/api/experimentation/services.py b/api/experimentation/services.py index fba8aff0b21a..573216631340 100644 --- a/api/experimentation/services.py +++ b/api/experimentation/services.py @@ -59,6 +59,7 @@ ExperimentStatus, MetricAggregation, MetricDirection, + RolloutDecision, SDKExperimentationEvent, WarehouseConnection, WarehouseConnectionStatus, @@ -631,7 +632,7 @@ def transition_experiment_status( ) experiment.ended_at = timezone.now() experiment.rollout_decision = rollout_decision.decision - experiment.rollout_variant_id = rollout_decision.variant_id + experiment.rollout_variant_id = rollout_decision.rollout_variant_id _apply_rollout_decision( experiment, rollout_decision, AuthorData.from_user(user) ) @@ -642,7 +643,7 @@ def transition_experiment_status( environment__id=experiment.environment_id, feature__id=experiment.feature_id, rollout__decision=rollout_decision.decision, - variant__id=rollout_decision.variant_id, + variant__id=rollout_decision.rollout_variant_id, ) ) @@ -651,6 +652,18 @@ def transition_experiment_status( return experiment +def delete_experiment(experiment: Experiment, user: FFAdminUser) -> None: + with transaction.atomic(): + experiment.refresh_from_db(from_queryset=Experiment.objects.select_for_update()) + if experiment.status == ExperimentStatus.RUNNING: + raise ValueError( + "Cannot delete a running experiment. Pause or complete it first." + ) + _delete_experiment_rollout_override(experiment, AuthorData.from_user(user)) + create_experiment_audit_log(experiment, user, action="deleted") + experiment.delete() + + def _apply_rollout_decision( experiment: Experiment, rollout_decision: RolloutDecisionSpec, @@ -660,13 +673,15 @@ def _apply_rollout_decision( rollout override. The rollout segment is kept: it records the audience.""" environment_default: EnvironmentDefaultRequest = ( {"enabled": False} - if rollout_decision.decision == "disable" + if rollout_decision.decision == RolloutDecision.DISABLE else { "enabled": True, "variants": [ { "id": option_id, - "weight": 100 if option_id == rollout_decision.variant_id else 0, + "weight": ( + 100 if option_id == rollout_decision.rollout_variant_id else 0 + ), } for option_id in experiment.feature.multivariate_options.values_list( "id", flat=True @@ -682,10 +697,10 @@ def _apply_rollout_decision( author=author, overwrite_system_segment_overrides=True, ) - delete_experiment_rollout_override(experiment, author) + _delete_experiment_rollout_override(experiment, author) -def delete_experiment_rollout_override( +def _delete_experiment_rollout_override( experiment: Experiment, author: AuthorData ) -> None: if ( diff --git a/api/experimentation/types.py b/api/experimentation/types.py index 6d596405d672..a36079199b29 100644 --- a/api/experimentation/types.py +++ b/api/experimentation/types.py @@ -4,8 +4,6 @@ ExposureGranularity = Literal["hour", "day"] -RolloutDecisionType = Literal["control", "variant", "disable"] - class MetricDefinitionV1(TypedDict): """The recipe a metric is computed from. diff --git a/api/experimentation/views.py b/api/experimentation/views.py index 529b0636dbef..282927905ac7 100644 --- a/api/experimentation/views.py +++ b/api/experimentation/views.py @@ -77,7 +77,7 @@ create_experiment_audit_log, create_metric_audit_log, create_warehouse_audit_log, - delete_experiment_rollout_override, + delete_experiment, enable_experiment_rollout, get_warehouse_event_names, mark_warehouse_pending_connection, @@ -475,29 +475,12 @@ def perform_update(self, serializer: BaseSerializer[Experiment]) -> None: ) def perform_destroy(self, instance: Experiment) -> None: - with transaction.atomic(): - try: - instance.refresh_from_db( - from_queryset=Experiment.objects.select_for_update() - ) - except Experiment.DoesNotExist as exc: - raise NotFound from exc - if instance.status == ExperimentStatus.RUNNING: - raise serializers.ValidationError( - { - "detail": ( - "Cannot delete a running experiment. " - "Pause or complete it first." - ) - } - ) - delete_experiment_rollout_override( - instance, AuthorData.from_request(self.request) - ) - create_experiment_audit_log( - instance, self._get_user(self.request), action="deleted" - ) - instance.delete() + try: + delete_experiment(instance, self._get_user(self.request)) + except Experiment.DoesNotExist as exc: + raise NotFound from exc + except ValueError as exc: + raise serializers.ValidationError({"detail": str(exc)}) from exc @action(detail=True, methods=["post"]) def start(self, request: Request, **kwargs: object) -> Response: diff --git a/api/tests/unit/experimentation/test_experiment_views.py b/api/tests/unit/experimentation/test_experiment_views.py index e28fac821af5..3b824b43fb7c 100644 --- a/api/tests/unit/experimentation/test_experiment_views.py +++ b/api/tests/unit/experimentation/test_experiment_views.py @@ -730,7 +730,7 @@ def test_action__complete__returns_ended_at_and_rollout_decision( # When response = admin_client_new.post( _action_url(environment, experiment, "complete"), - data={"rollout_decision": "variant", "variant_id": variant_id}, + data={"rollout_decision": "variant", "rollout_variant": variant_id}, format="json", ) @@ -770,7 +770,7 @@ def test_action__complete_invalid_rollout_decision__returns_400( } data: dict[str, object] = {"rollout_decision": rollout_decision} if variant_id := variant_ids[variant_owner]: - data["variant_id"] = variant_id + data["rollout_variant"] = variant_id # When response = admin_client_new.post( @@ -781,7 +781,7 @@ def test_action__complete_invalid_rollout_decision__returns_400( # Then assert response.status_code == status.HTTP_400_BAD_REQUEST - assert list(response.json()) == ["variant_id"] + assert list(response.json()) == ["rollout_variant"] def test_exposures__computed_row__returns_row( diff --git a/api/tests/unit/experimentation/test_services.py b/api/tests/unit/experimentation/test_services.py index 9855b8e0a2a7..042e230ca0c9 100644 --- a/api/tests/unit/experimentation/test_services.py +++ b/api/tests/unit/experimentation/test_services.py @@ -62,7 +62,6 @@ verify_warehouse_connection, ) from experimentation.stats import VariantStats -from experimentation.types import RolloutDecisionType from experimentation.warehouses import flagsmith from experimentation.warehouses.constants import VERIFY_TIMEOUT_SECONDS from experimentation.warehouses.dialect import CLICKHOUSE_DIALECT @@ -3766,7 +3765,7 @@ def test_transition_experiment_status__first_start__removes_superseded_rollouts( ) def test_transition_experiment_status__complete__serves_decision_and_removes_rollout_override( # type: ignore[no-untyped-def] environment_fixture_name: str, - decision: RolloutDecisionType, + decision: RolloutDecision, variant_index: int | None, expected_enabled: bool, expected_weights: list[float], @@ -3814,7 +3813,7 @@ def test_transition_experiment_status__complete__serves_decision_and_removes_rol ExperimentStatus.COMPLETED, admin_user, rollout_decision=RolloutDecisionSpec( - decision=decision, variant_id=variant_id + decision=decision, rollout_variant_id=variant_id ), ) From 48f525e1c67f38f7a10a012163ef6f662324f1a9 Mon Sep 17 00:00:00 2001 From: "flagsmith-engineering[bot]" Date: Thu, 19 Nov 2026 16:08:18 +0000 Subject: [PATCH 8/8] chore: Update documentation artefacts --- .../observability/_events-catalogue.md | 20 +++++++++---------- openapi.yaml | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md index aa51e8f0e2ea..61b1c689eee5 100644 --- a/docs/docs/deployment-self-hosting/observability/_events-catalogue.md +++ b/docs/docs/deployment-self-hosting/observability/_events-catalogue.md @@ -195,7 +195,7 @@ Attributes: ### `experimentation.experiment.completed` Logged at `info` from: - - `api/experimentation/services.py:639` + - `api/experimentation/services.py:640` Attributes: - `environment.id` @@ -252,7 +252,7 @@ Attributes: ### `experimentation.rollout.applied` Logged at `info` from: - - `api/experimentation/services.py:1153` + - `api/experimentation/services.py:1168` Attributes: - `audience.match` @@ -268,7 +268,7 @@ Attributes: ### `experimentation.rollout.superseded` Logged at `info` from: - - `api/experimentation/services.py:744` + - `api/experimentation/services.py:759` Attributes: - `environment.id` @@ -279,7 +279,7 @@ Attributes: ### `experimentation.sdk_events.rejected` Logged at `warning` from: - - `api/experimentation/services.py:223` + - `api/experimentation/services.py:224` Attributes: - `environment.id` @@ -945,7 +945,7 @@ Attributes: ### `warehouse.connection.connected` Logged at `info` from: - - `api/experimentation/services.py:1329` + - `api/experimentation/services.py:1344` Attributes: - `environment.id` @@ -976,7 +976,7 @@ Attributes: ### `warehouse.connection.test_event_sent` Logged at `info` from: - - `api/experimentation/services.py:1272` + - `api/experimentation/services.py:1287` Attributes: - `environment.id` @@ -985,7 +985,7 @@ Attributes: ### `warehouse.connection.verification_failed` Logged at `warning` from: - - `api/experimentation/services.py:1304` + - `api/experimentation/services.py:1319` Attributes: - `environment.id` @@ -995,7 +995,7 @@ Attributes: ### `warehouse.connection.verification_succeeded` Logged at `info` from: - - `api/experimentation/services.py:1314` + - `api/experimentation/services.py:1329` Attributes: - `environment.id` @@ -1004,7 +1004,7 @@ Attributes: ### `warehouse.srm.overallocated` Logged at `error` from: - - `api/experimentation/services.py:462` + - `api/experimentation/services.py:463` Attributes: - `environment.id` @@ -1014,7 +1014,7 @@ Attributes: ### `warehouse.srm.unkeyed_variant` Logged at `error` from: - - `api/experimentation/services.py:448` + - `api/experimentation/services.py:449` Attributes: - `environment.id` diff --git a/openapi.yaml b/openapi.yaml index f4907e60dafc..7c79efb32a87 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -22088,7 +22088,7 @@ components: properties: rollout_decision: $ref: '#/components/schemas/RolloutDecisionEnum' - variant_id: + rollout_variant: type: integer required: - rollout_decision