Repository navigation
feat(experimentation): decide the rollout when completing an experiment #9018
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
ca43040
8593aab
9769c92
0a76979
e73fb0a
f098bfc
5dbdd46
48f525e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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", | ||
| ), | ||
| ), | ||
| ] |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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,96 @@ 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.rollout_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.rollout_variant_id, | ||
| ) | ||
| ) | ||
|
|
||
| experiment.save() | ||
| create_experiment_audit_log(experiment, user, action=target_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, | ||
| 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, | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Carry the rollout's control value into the environment default on The rollout override stores its own control value from the request ( Before deleting the override, read its control value and write that value to the environment default. Alternatively, reject completion when the two values differ. Either way, identities in the control arm must keep the value they received during the experiment. |
||
| "variants": [ | ||
| { | ||
| "id": option_id, | ||
| "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 | ||
| ) | ||
| ], | ||
| } | ||
| ) | ||
| 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: | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2:
on_delete=SET_NULLclearsrollout_variantwhen the variant is deleted, butrollout_decisionstaysvariant. A completed experiment then reports avariantdecision with no variant, so the record no longer shows which variant won. Decide whether this is intended; if not, clearrollout_decisionwhen the variant is removed, or block variant deletion while a completed experiment references it.Prompt for AI agents