From ba6d07b167e518194e2778a00778d2483d100a07 Mon Sep 17 00:00:00 2001 From: wadii Date: Thu, 19 Nov 2026 17:16:00 +0100 Subject: [PATCH 1/3] feat(experimentation): choose the rollout when completing an experiment --- .../useFeatureExperimentFreeze.test.ts | 2 + frontend/common/services/useExperiment.ts | 5 +- frontend/common/types/requests.ts | 11 ++ frontend/common/types/responses.ts | 4 + .../base/SelectableCard/SelectableCard.scss | 26 ++- .../base/SelectableCard/SelectableCard.tsx | 64 +++--- .../CompleteExperimentModal.tsx | 146 ++++++++++++++ .../RolloutDecisionPicker.tsx | 105 ++++++++++ .../VariantChoiceRow.tsx | 22 +++ .../__tests__/utils.test.ts | 183 ++++++++++++++++++ .../CompleteExperimentModal/index.ts | 1 + .../CompleteExperimentModal/utils.ts | 98 ++++++++++ .../ExperimentActionDropdown.tsx | 32 +-- .../results/ExperimentDetailHeader.tsx | 32 +-- .../results/ExperimentRolloutCard.tsx | 27 ++- .../results/__tests__/derive.test.ts | 38 ++++ .../components/experiments/results/derive.ts | 30 +++ .../warehouse-tab/WarehouseSetupSkeleton.tsx | 12 +- 18 files changed, 748 insertions(+), 90 deletions(-) create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/CompleteExperimentModal.tsx create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/RolloutDecisionPicker.tsx create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/VariantChoiceRow.tsx create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/__tests__/utils.test.ts create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/index.ts create mode 100644 frontend/web/components/experiments/CompleteExperimentModal/utils.ts diff --git a/frontend/common/hooks/__tests__/useFeatureExperimentFreeze.test.ts b/frontend/common/hooks/__tests__/useFeatureExperimentFreeze.test.ts index 6c1ddf421446..1707eb92d1f0 100644 --- a/frontend/common/hooks/__tests__/useFeatureExperimentFreeze.test.ts +++ b/frontend/common/hooks/__tests__/useFeatureExperimentFreeze.test.ts @@ -39,6 +39,8 @@ const makeExperiment = ( id: 1, metrics: [], name: 'Test Experiment', + rollout_decision: null, + rollout_variant: null, started_at: null, status: overrides.status ?? 'running', updated_at: '', diff --git a/frontend/common/services/useExperiment.ts b/frontend/common/services/useExperiment.ts index adc4e83eb3aa..19c39c8af7cc 100644 --- a/frontend/common/services/useExperiment.ts +++ b/frontend/common/services/useExperiment.ts @@ -12,13 +12,14 @@ export const experimentService = service endpoints: (builder) => ({ completeExperiment: builder.mutation< Res['experiment'], - Req['experimentAction'] + Req['completeExperiment'] >({ invalidatesTags: (_res, _err, { experimentId }) => [ { id: experimentId, type: 'Experiment' }, { id: 'LIST', type: 'Experiment' }, ], - query: ({ environmentId, experimentId }) => ({ + query: ({ body, environmentId, experimentId }) => ({ + body, method: 'POST', url: `environments/${environmentId}/experiments/${experimentId}/complete/`, }), diff --git a/frontend/common/types/requests.ts b/frontend/common/types/requests.ts index 860e21713e29..70ef745c1e9b 100644 --- a/frontend/common/types/requests.ts +++ b/frontend/common/types/requests.ts @@ -27,6 +27,7 @@ import { ChangeRequest, ExpectedDirection, ExperimentAudienceMatch, + ExperimentRolloutDecision, ExperimentStatus, MetricAggregation, MetricDirection, @@ -180,6 +181,11 @@ export type ExperimentRolloutBody = { audience?: ExperimentAudienceBody } +export type CompleteExperimentBody = { + rollout_decision: ExperimentRolloutDecision + rollout_variant?: number +} + export type UsageGroupBy = 'project' | 'environment' export type Req = { @@ -1213,6 +1219,11 @@ export type Req = { } } experimentAction: { environmentId: string; experimentId: number } + completeExperiment: { + environmentId: string + experimentId: number + body: CompleteExperimentBody + } updateExperiment: { environmentId: string experimentId: number diff --git a/frontend/common/types/responses.ts b/frontend/common/types/responses.ts index f8dee3a87451..d6d5f3ae2030 100644 --- a/frontend/common/types/responses.ts +++ b/frontend/common/types/responses.ts @@ -695,6 +695,8 @@ export type FeatureType = 'STANDARD' | 'MULTIVARIATE' export type ExperimentStatus = 'created' | 'running' | 'paused' | 'completed' +export type ExperimentRolloutDecision = 'control' | 'variant' | 'disable' + export type ExperimentStatusCounts = Record export type MetricAggregation = 'count' | 'sum' | 'mean' | 'occurrence' @@ -744,6 +746,8 @@ export type Experiment = { started_at: string | null ended_at: string | null experiment_rollout?: ExperimentRollout + rollout_decision: ExperimentRolloutDecision | null + rollout_variant: number | null } export type ExperimentAudienceMatch = 'any' | 'all' diff --git a/frontend/web/components/base/SelectableCard/SelectableCard.scss b/frontend/web/components/base/SelectableCard/SelectableCard.scss index 72eae4590544..977487848513 100644 --- a/frontend/web/components/base/SelectableCard/SelectableCard.scss +++ b/frontend/web/components/base/SelectableCard/SelectableCard.scss @@ -1,15 +1,11 @@ .selectable-card { display: flex; - align-items: flex-start; - justify-content: space-between; + flex-direction: column; height: 100%; - padding: 16px; border-radius: var(--radius-xl); border: 2px solid transparent; box-shadow: inset 0 0 0 1px var(--color-border-default); background: transparent; - cursor: pointer; - text-align: left; width: 100%; transition: border-color var(--duration-fast) var(--easing-standard), @@ -20,6 +16,11 @@ box-shadow: inset 0 0 0 1px var(--color-border-strong); } + &:has(.selectable-card__body:focus-visible) { + outline: 2px solid var(--color-border-action); + outline-offset: 2px; + } + &--selected { border-color: var(--color-border-action); box-shadow: none; @@ -28,10 +29,23 @@ &--disabled { opacity: 0.5; - cursor: default; pointer-events: none; } + &__body { + display: flex; + flex: 1; + align-items: flex-start; + justify-content: space-between; + width: 100%; + padding: 16px; + text-align: left; + + &:focus-visible { + outline: none; + } + } + &__content { display: flex; flex-direction: column; diff --git a/frontend/web/components/base/SelectableCard/SelectableCard.tsx b/frontend/web/components/base/SelectableCard/SelectableCard.tsx index a88d42577312..c15eb55e3fc9 100644 --- a/frontend/web/components/base/SelectableCard/SelectableCard.tsx +++ b/frontend/web/components/base/SelectableCard/SelectableCard.tsx @@ -11,14 +11,16 @@ type SelectableCardProps = { selected?: boolean onClick: () => void icon?: ReactNode - title: string - description: string + title: ReactNode + description: ReactNode badge?: { label: string; variant: BadgeVariant } tags?: string[] disabled?: boolean className?: string // Extra content below the description (e.g. an illustrative preview). children?: ReactNode + // Content inside the card but outside its button (e.g. a form control). + footer?: ReactNode } const SelectableCard: FC = ({ @@ -27,6 +29,7 @@ const SelectableCard: FC = ({ className, description, disabled, + footer, icon, onClick, selected, @@ -34,7 +37,7 @@ const SelectableCard: FC = ({ title, }) => { return ( - = ({ }, className, )} - onClick={onClick} - disabled={disabled} > -
- {icon &&
{icon}
} - {title} - {description} - {!!tags?.length && ( -
- {tags.map((tag) => ( - - {tag} - - ))} + +
+ {icon &&
{icon}
} + {title} + {description} + {!!tags?.length && ( +
+ {tags.map((tag) => ( + + {tag} + + ))} +
+ )} + {children} +
+ {badge && ( +
+ + {badge.label} +
)} - {children} -
- {badge && ( -
- - {badge.label} - -
- )} - + + {footer &&
{footer}
} +
) } diff --git a/frontend/web/components/experiments/CompleteExperimentModal/CompleteExperimentModal.tsx b/frontend/web/components/experiments/CompleteExperimentModal/CompleteExperimentModal.tsx new file mode 100644 index 000000000000..49ab63f4ce7f --- /dev/null +++ b/frontend/web/components/experiments/CompleteExperimentModal/CompleteExperimentModal.tsx @@ -0,0 +1,146 @@ +import { FC, useMemo, useState } from 'react' +import { + useCompleteExperimentMutation, + useGetExperimentBayesianResultsQuery, + useGetExperimentQuery, +} from 'common/services/useExperiment' +import { useGetEnvironmentQuery } from 'common/services/useEnvironment' +import Banner from 'components/base/Banner' +import Button from 'components/base/forms/Button' +import ModalHR from 'components/modals/ModalHR' +import { getVariantIdentities } from 'components/experiments/results/derive' +import RolloutDecisionPicker from './RolloutDecisionPicker' +import { + RolloutSelection, + buildCompleteExperimentBody, + getControlSelectedMessage, + getDefaultSelection, + getServedVariant, + getVariantChoices, +} from './utils' + +type CompleteExperimentModalProps = { + environmentId: string + experimentId: number +} + +const CompleteExperimentModal: FC = ({ + environmentId, + experimentId, +}) => { + const params = { environmentId, experimentId } + const { data: experiment, isError } = useGetExperimentQuery(params) + const { data: bayesianResults, isLoading: isLoadingResults } = + useGetExperimentBayesianResultsQuery(params) + const { data: environment } = useGetEnvironmentQuery({ id: environmentId }) + const [completeExperiment, { isLoading: isCompleting }] = + useCompleteExperimentMutation() + const [selection, setSelection] = useState() + + const results = bayesianResults?.payload ?? undefined + const choices = useMemo( + () => (experiment ? getVariantChoices(experiment, results) : []), + [experiment, results], + ) + const defaultSelection = useMemo( + () => + experiment ? getDefaultSelection(experiment, choices, results) : null, + [experiment, choices, results], + ) + + if (isError) { + return ( +
+
+ We couldn't load this experiment. +
+
+ ) + } + + if (!experiment || !environment || !defaultSelection || isLoadingResults) { + return ( +
+ +
+ ) + } + + const activeSelection = selection ?? defaultSelection + const control = getVariantIdentities(experiment.feature)[0] + const servedVariant = getServedVariant(activeSelection, control, choices) + const hasAudience = !!experiment.experiment_rollout?.audience?.segments.length + + const handleComplete = async () => { + try { + await completeExperiment({ + ...params, + body: buildCompleteExperimentBody(activeSelection), + }).unwrap() + toast('Experiment completed') + closeModal() + } catch { + toast('Failed to complete experiment', 'danger') + } + } + + return ( + <> +
+

+ Choose what {experiment.feature.name} serves in{' '} + {environment.name} after {experiment.name} ends. Results + stay available; this can't be undone. +

+ {defaultSelection.decision === 'control' && + activeSelection.decision === 'control' && ( + {getControlSelectedMessage(experiment, results)} + )} + +
+ The experiment's rollout override is removed and{' '} + {servedVariant ? ( + <> + 100% of users get {servedVariant.name}. + + ) : ( + <> + {experiment.feature.name} is turned off for everyone. + + )} + {hasAudience && ( + <> + {' '} + This applies to everyone in {environment.name}, not only + the experiment's audience. + + )} +
+
+ +
+ + +
+ + ) +} + +export default CompleteExperimentModal diff --git a/frontend/web/components/experiments/CompleteExperimentModal/RolloutDecisionPicker.tsx b/frontend/web/components/experiments/CompleteExperimentModal/RolloutDecisionPicker.tsx new file mode 100644 index 000000000000..d20b68cd824c --- /dev/null +++ b/frontend/web/components/experiments/CompleteExperimentModal/RolloutDecisionPicker.tsx @@ -0,0 +1,105 @@ +import { FC } from 'react' +import SelectableCard from 'components/base/SelectableCard' +import ColorSwatch from 'components/ColorSwatch' +import { VariantIdentity } from 'components/experiments/results/derive' +import VariantChoiceRow from './VariantChoiceRow' +import { RolloutSelection, VariantChoice } from './utils' + +type VariantOption = { + label: string + value: number + choice: VariantChoice +} + +type RolloutDecisionPickerProps = { + choices: VariantChoice[] + control: VariantIdentity + environmentName: string + featureName: string + selection: RolloutSelection + onChange: (selection: RolloutSelection) => void +} + +const RolloutDecisionPicker: FC = ({ + choices, + control, + environmentName, + featureName, + onChange, + selection, +}) => { + const hasSingleChoice = choices.length === 1 + const variantOptions: VariantOption[] = choices.map((choice) => ({ + choice, + label: choice.name, + value: choice.optionId, + })) + + return ( +
+ onChange({ ...selection, decision: 'control' })} + title={ + + + Roll out control + + } + description={ + <> + Everyone gets {control.value}. + + } + /> + {!!choices.length && ( + onChange({ ...selection, decision: 'variant' })} + title='Roll out a variant' + description={ + hasSingleChoice + ? 'Everyone gets the variant below.' + : 'Everyone gets the chosen variant.' + } + footer={ + selection.decision === 'variant' && + !hasSingleChoice && ( +