mirror of
https://github.com/PostHog/posthog.git
synced 2024-11-21 21:49:51 +01:00
feat(surveys): Allow user to edit survey response adaptive limits (#26223)
feat(surveys): Allow user to edit survey response adaptive limits Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Daniel Bachhuber <daniel.b@posthog.com>
This commit is contained in:
Phani Raj
GitHub
parent
593019f609
commit
d8776382b6
@ -269,6 +269,7 @@ describe('Surveys', () => {
|
||||
|
||||
// Set responses limit
|
||||
cy.get('.LemonCollapsePanel').contains('Completion conditions').click()
|
||||
cy.get('[data-attr=survey-collection-until-limit]').first().click()
|
||||
cy.get('[data-attr=survey-responses-limit-input]').focus().type('228').click()
|
||||
|
||||
// Save the survey
|
||||
@ -276,7 +277,7 @@ describe('Surveys', () => {
|
||||
cy.get('button[data-attr="launch-survey"]').should('have.text', 'Launch')
|
||||
|
||||
cy.reload()
|
||||
cy.contains('The survey will be stopped once 228 responses are received.').should('be.visible')
|
||||
cy.contains('The survey will be stopped once 100228 responses are received.').should('be.visible')
|
||||
})
|
||||
|
||||
it('creates a new survey with branching logic', () => {
|
||||
|
||||
@ -169,6 +169,7 @@ export const FEATURE_FLAGS = {
|
||||
SURVEYS_EVENTS: 'surveys-events', // owner: #team-feature-success
|
||||
SURVEYS_ACTIONS: 'surveys-actions', // owner: #team-feature-success
|
||||
SURVEYS_RECURRING: 'surveys-recurring', // owner: #team-feature-success
|
||||
SURVEYS_ADAPTIVE_COLLECTION: 'surveys-recurring', // owner: #team-feature-success
|
||||
YEAR_IN_HOG: 'year-in-hog', // owner: #team-replay
|
||||
SESSION_REPLAY_EXPORT_MOBILE_DATA: 'session-replay-export-mobile-data', // owner: #team-replay
|
||||
DISCUSSIONS: 'discussions', // owner: #team-replay
|
||||
|
||||
@ -6,6 +6,7 @@ import { IconInfo } from '@posthog/icons'
|
||||
import { IconLock, IconPlus, IconTrash } from '@posthog/icons'
|
||||
import {
|
||||
LemonButton,
|
||||
LemonCalendarSelect,
|
||||
LemonCheckbox,
|
||||
LemonCollapse,
|
||||
LemonDialog,
|
||||
@ -15,17 +16,21 @@ import {
|
||||
LemonTag,
|
||||
LemonTextArea,
|
||||
Link,
|
||||
Popover,
|
||||
} from '@posthog/lemon-ui'
|
||||
import { BindLogic, useActions, useValues } from 'kea'
|
||||
import { EventSelect } from 'lib/components/EventSelect/EventSelect'
|
||||
import { FlagSelector } from 'lib/components/FlagSelector'
|
||||
import { TaxonomicFilterGroupType } from 'lib/components/TaxonomicFilter/types'
|
||||
import { FEATURE_FLAGS } from 'lib/constants'
|
||||
import { dayjs } from 'lib/dayjs'
|
||||
import { IconCancel } from 'lib/lemon-ui/icons'
|
||||
import { LemonField } from 'lib/lemon-ui/LemonField'
|
||||
import { LemonRadio } from 'lib/lemon-ui/LemonRadio'
|
||||
import { Tooltip } from 'lib/lemon-ui/Tooltip'
|
||||
import { featureFlagLogic as enabledFeaturesLogic } from 'lib/logic/featureFlagLogic'
|
||||
import { formatDate } from 'lib/utils'
|
||||
import { useMemo, useState } from 'react'
|
||||
import { featureFlagLogic } from 'scenes/feature-flags/featureFlagLogic'
|
||||
import { FeatureFlagReleaseConditions } from 'scenes/feature-flags/FeatureFlagReleaseConditions'
|
||||
|
||||
@ -62,15 +67,21 @@ export default function SurveyEdit(): JSX.Element {
|
||||
schedule,
|
||||
hasBranchingLogic,
|
||||
surveyRepeatedActivationAvailable,
|
||||
dataCollectionType,
|
||||
surveyUsesLimit,
|
||||
surveyUsesAdaptiveLimit,
|
||||
} = useValues(surveyLogic)
|
||||
const {
|
||||
setSurveyValue,
|
||||
resetTargeting,
|
||||
resetSurveyResponseLimits,
|
||||
resetSurveyAdaptiveSampling,
|
||||
setSelectedPageIndex,
|
||||
setSelectedSection,
|
||||
setFlagPropertyErrors,
|
||||
setSchedule,
|
||||
deleteBranchingLogic,
|
||||
setDataCollectionType,
|
||||
} = useActions(surveyLogic)
|
||||
const {
|
||||
surveysMultipleQuestionsAvailable,
|
||||
@ -79,11 +90,25 @@ export default function SurveyEdit(): JSX.Element {
|
||||
surveysActionsAvailable,
|
||||
} = useValues(surveysLogic)
|
||||
const { featureFlags } = useValues(enabledFeaturesLogic)
|
||||
const [visible, setVisible] = useState(false)
|
||||
const sortedItemIds = survey.questions.map((_, idx) => idx.toString())
|
||||
const { thankYouMessageDescriptionContentType = null } = survey.appearance ?? {}
|
||||
const surveysRecurringScheduleDisabledReason = surveysRecurringScheduleAvailable
|
||||
? undefined
|
||||
: 'Upgrade your plan to use repeating surveys'
|
||||
const surveysAdaptiveLimitsDisabledReason = surveysRecurringScheduleAvailable
|
||||
? undefined
|
||||
: 'Upgrade your plan to use an adaptive limit on survey responses'
|
||||
|
||||
useMemo(() => {
|
||||
if (surveyUsesLimit) {
|
||||
setDataCollectionType('until_limit')
|
||||
} else if (surveyUsesAdaptiveLimit) {
|
||||
setDataCollectionType('until_adaptive_limit')
|
||||
} else {
|
||||
setDataCollectionType('until_stopped')
|
||||
}
|
||||
}, [surveyUsesLimit, surveyUsesAdaptiveLimit, setDataCollectionType])
|
||||
|
||||
if (survey.iteration_count && survey.iteration_count > 0) {
|
||||
setSchedule('recurring')
|
||||
@ -852,44 +877,157 @@ export default function SurveyEdit(): JSX.Element {
|
||||
header: 'Completion conditions',
|
||||
content: (
|
||||
<>
|
||||
<LemonField name="responses_limit">
|
||||
{({ onChange, value }) => {
|
||||
return (
|
||||
<div className="flex flex-row gap-2 items-center">
|
||||
<LemonCheckbox
|
||||
checked={!!value}
|
||||
onChange={(checked) => {
|
||||
const newResponsesLimit = checked ? 100 : null
|
||||
onChange(newResponsesLimit)
|
||||
}}
|
||||
/>
|
||||
Stop the survey once
|
||||
<LemonInput
|
||||
type="number"
|
||||
data-attr="survey-responses-limit-input"
|
||||
size="small"
|
||||
min={1}
|
||||
value={value || NaN}
|
||||
onChange={(newValue) => {
|
||||
if (newValue && newValue > 0) {
|
||||
onChange(newValue)
|
||||
} else {
|
||||
onChange(null)
|
||||
}
|
||||
}}
|
||||
className="w-16"
|
||||
/>{' '}
|
||||
responses are received.
|
||||
<Tooltip title="This is a rough guideline, not an absolute one, so the survey might receive slightly more responses than the limit specifies.">
|
||||
<IconInfo />
|
||||
</Tooltip>
|
||||
</div>
|
||||
)
|
||||
}}
|
||||
</LemonField>
|
||||
<div className="mt-2">
|
||||
<h3> How long would you like to collect survey responses? </h3>
|
||||
<LemonField.Pure>
|
||||
<LemonRadio
|
||||
value={dataCollectionType}
|
||||
onChange={(
|
||||
newValue: 'until_stopped' | 'until_limit' | 'until_adaptive_limit'
|
||||
) => {
|
||||
if (newValue === 'until_limit') {
|
||||
resetSurveyAdaptiveSampling()
|
||||
setSurveyValue('responses_limit', survey.responses_limit || 100)
|
||||
} else if (newValue === 'until_adaptive_limit') {
|
||||
resetSurveyResponseLimits()
|
||||
setSurveyValue(
|
||||
'response_sampling_interval',
|
||||
survey.response_sampling_interval || 1
|
||||
)
|
||||
setSurveyValue(
|
||||
'response_sampling_interval_type',
|
||||
survey.response_sampling_interval_type || 'month'
|
||||
)
|
||||
setSurveyValue(
|
||||
'response_sampling_limit',
|
||||
survey.response_sampling_limit || 100
|
||||
)
|
||||
setSurveyValue(
|
||||
'response_sampling_start_date',
|
||||
survey.response_sampling_start_date || dayjs()
|
||||
)
|
||||
} else {
|
||||
resetSurveyResponseLimits()
|
||||
resetSurveyAdaptiveSampling()
|
||||
}
|
||||
setDataCollectionType(newValue)
|
||||
}}
|
||||
options={[
|
||||
{
|
||||
value: 'until_stopped',
|
||||
label: 'Keep collecting responses until the survey is stopped',
|
||||
'data-attr': 'survey-collection-until-stopped',
|
||||
},
|
||||
{
|
||||
value: 'until_limit',
|
||||
label: 'Stop displaying the survey after reaching a certain number of completed surveys',
|
||||
'data-attr': 'survey-collection-until-limit',
|
||||
},
|
||||
{
|
||||
value: 'until_adaptive_limit',
|
||||
label: 'Collect a certain number of surveys per day, week or month',
|
||||
'data-attr': 'survey-collection-until-adaptive-limit',
|
||||
disabledReason: surveysAdaptiveLimitsDisabledReason,
|
||||
},
|
||||
]}
|
||||
/>
|
||||
</LemonField.Pure>
|
||||
</div>
|
||||
{dataCollectionType == 'until_adaptive_limit' && (
|
||||
<LemonField.Pure className="mt-4">
|
||||
<div className="flex flex-row gap-2 items-center ml-5">
|
||||
Starting on{' '}
|
||||
<Popover
|
||||
actionable
|
||||
overlay={
|
||||
<LemonCalendarSelect
|
||||
value={dayjs(survey.response_sampling_start_date)}
|
||||
onChange={(value) => {
|
||||
setSurveyValue('response_sampling_start_date', value)
|
||||
setVisible(false)
|
||||
}}
|
||||
showTimeToggle={false}
|
||||
onClose={() => setVisible(false)}
|
||||
/>
|
||||
}
|
||||
visible={visible}
|
||||
onClickOutside={() => setVisible(false)}
|
||||
>
|
||||
<LemonButton type="secondary" onClick={() => setVisible(!visible)}>
|
||||
{formatDate(dayjs(survey.response_sampling_start_date || ''))}
|
||||
</LemonButton>
|
||||
</Popover>
|
||||
, capture up to
|
||||
<LemonInput
|
||||
type="number"
|
||||
size="small"
|
||||
min={1}
|
||||
onChange={(newValue) => {
|
||||
setSurveyValue('response_sampling_limit', newValue)
|
||||
}}
|
||||
value={survey.response_sampling_limit || 0}
|
||||
/>
|
||||
responses, every
|
||||
<LemonInput
|
||||
type="number"
|
||||
size="small"
|
||||
min={1}
|
||||
onChange={(newValue) => {
|
||||
setSurveyValue('response_sampling_interval', newValue)
|
||||
}}
|
||||
value={survey.response_sampling_interval || 0}
|
||||
/>
|
||||
<LemonSelect
|
||||
value={survey.response_sampling_interval_type}
|
||||
size="small"
|
||||
onChange={(newValue) => {
|
||||
setSurveyValue('response_sampling_interval_type', newValue)
|
||||
}}
|
||||
options={[
|
||||
{ value: 'day', label: 'Day(s)' },
|
||||
{ value: 'week', label: 'Week(s)' },
|
||||
{ value: 'month', label: 'Month(s)' },
|
||||
]}
|
||||
/>
|
||||
<Tooltip title="This is a rough guideline, not an absolute one, so the survey might receive slightly more responses than the limit specifies.">
|
||||
<IconInfo />
|
||||
</Tooltip>
|
||||
</div>
|
||||
</LemonField.Pure>
|
||||
)}
|
||||
{dataCollectionType == 'until_limit' && (
|
||||
<LemonField name="responses_limit" className="mt-4 ml-5">
|
||||
{({ onChange, value }) => {
|
||||
return (
|
||||
<div className="flex flex-row gap-2 items-center">
|
||||
Stop the survey once
|
||||
<LemonInput
|
||||
type="number"
|
||||
data-attr="survey-responses-limit-input"
|
||||
size="small"
|
||||
min={1}
|
||||
value={value || NaN}
|
||||
onChange={(newValue) => {
|
||||
if (newValue && newValue > 0) {
|
||||
onChange(newValue)
|
||||
} else {
|
||||
onChange(null)
|
||||
}
|
||||
}}
|
||||
className="w-16"
|
||||
/>{' '}
|
||||
responses are received.
|
||||
<Tooltip title="This is a rough guideline, not an absolute one, so the survey might receive slightly more responses than the limit specifies.">
|
||||
<IconInfo />
|
||||
</Tooltip>
|
||||
</div>
|
||||
)
|
||||
}}
|
||||
</LemonField>
|
||||
)}
|
||||
{featureFlags[FEATURE_FLAGS.SURVEYS_RECURRING] && (
|
||||
<div className="mt-2">
|
||||
<h4> How often should we show this survey? </h4>
|
||||
<div className="mt-4">
|
||||
<h3> How often should we show this survey? </h3>
|
||||
<LemonField.Pure>
|
||||
<LemonRadio
|
||||
value={schedule}
|
||||
|
||||
@ -47,6 +47,7 @@ export function SurveyView({ id }: { id: string }): JSX.Element {
|
||||
setSelectedPageIndex,
|
||||
duplicateSurvey,
|
||||
} = useActions(surveyLogic)
|
||||
const { surveyUsesLimit, surveyUsesAdaptiveLimit } = useValues(surveyLogic)
|
||||
const { deleteSurvey } = useActions(surveysLogic)
|
||||
|
||||
const [tabKey, setTabKey] = useState(survey.start_date ? 'results' : 'overview')
|
||||
@ -342,7 +343,7 @@ export function SurveyView({ id }: { id: string }): JSX.Element {
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
{survey.responses_limit && (
|
||||
{surveyUsesLimit && (
|
||||
<>
|
||||
<span className="card-secondary mt-4">Completion conditions</span>
|
||||
<span>
|
||||
@ -351,6 +352,17 @@ export function SurveyView({ id }: { id: string }): JSX.Element {
|
||||
</span>
|
||||
</>
|
||||
)}
|
||||
{surveyUsesAdaptiveLimit && (
|
||||
<>
|
||||
<span className="card-secondary mt-4">Completion conditions</span>
|
||||
<span>
|
||||
Survey response collection is limited to receive{' '}
|
||||
<b>{survey.response_sampling_limit}</b> responses every{' '}
|
||||
{survey.response_sampling_interval}{' '}
|
||||
{survey.response_sampling_interval_type}(s).
|
||||
</span>
|
||||
</>
|
||||
)}
|
||||
<LemonDivider />
|
||||
<SurveyDisplaySummary
|
||||
id={id}
|
||||
|
||||
@ -142,6 +142,10 @@ export interface NewSurvey
|
||||
| 'iteration_frequency_days'
|
||||
| 'iteration_start_dates'
|
||||
| 'current_iteration'
|
||||
| 'response_sampling_start_date'
|
||||
| 'response_sampling_interval_type'
|
||||
| 'response_sampling_interval'
|
||||
| 'response_sampling_limit'
|
||||
> {
|
||||
id: 'new'
|
||||
linked_flag_id: number | null
|
||||
|
||||
@ -105,6 +105,7 @@ export interface QuestionResultsReady {
|
||||
[key: string]: boolean
|
||||
}
|
||||
|
||||
export type DataCollectionType = 'until_stopped' | 'until_limit' | 'until_adaptive_limit'
|
||||
export type ScheduleType = 'once' | 'recurring'
|
||||
|
||||
const getResponseField = (i: number): string => (i === 0 ? '$survey_response' : `$survey_response_${i}`)
|
||||
@ -168,6 +169,9 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
nextStep,
|
||||
specificQuestionIndex,
|
||||
}),
|
||||
setDataCollectionType: (dataCollectionType: DataCollectionType) => ({
|
||||
dataCollectionType,
|
||||
}),
|
||||
resetBranchingForQuestion: (questionIndex) => ({ questionIndex }),
|
||||
deleteBranchingLogic: true,
|
||||
archiveSurvey: true,
|
||||
@ -178,6 +182,8 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
|
||||
setSchedule: (schedule: ScheduleType) => ({ schedule }),
|
||||
resetTargeting: true,
|
||||
resetSurveyAdaptiveSampling: true,
|
||||
resetSurveyResponseLimits: true,
|
||||
setFlagPropertyErrors: (errors: any) => ({ errors }),
|
||||
}),
|
||||
loaders(({ props, actions, values }) => ({
|
||||
@ -608,6 +614,19 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
loadSurveySuccess: () => {
|
||||
actions.loadSurveyUserStats()
|
||||
},
|
||||
resetSurveyResponseLimits: () => {
|
||||
actions.setSurveyValue('responses_limit', null)
|
||||
},
|
||||
|
||||
resetSurveyAdaptiveSampling: () => {
|
||||
actions.setSurveyValues({
|
||||
response_sampling_interval: null,
|
||||
response_sampling_interval_type: null,
|
||||
response_sampling_limit: null,
|
||||
response_sampling_start_date: null,
|
||||
response_sampling_daily_limits: null,
|
||||
})
|
||||
},
|
||||
resetTargeting: () => {
|
||||
actions.setSurveyValue('linked_flag_id', NEW_SURVEY.linked_flag_id)
|
||||
actions.setSurveyValue('targeting_flag_filters', NEW_SURVEY.targeting_flag_filters)
|
||||
@ -647,6 +666,12 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
setSurveyMissing: () => true,
|
||||
},
|
||||
],
|
||||
dataCollectionType: [
|
||||
'until_stopped' as DataCollectionType,
|
||||
{
|
||||
setDataCollectionType: (_, { dataCollectionType }) => dataCollectionType,
|
||||
},
|
||||
],
|
||||
|
||||
survey: [
|
||||
{ ...NEW_SURVEY } as NewSurvey | Survey,
|
||||
@ -877,6 +902,24 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
return !!(survey.start_date && !survey.end_date)
|
||||
},
|
||||
],
|
||||
surveyUsesLimit: [
|
||||
(s) => [s.survey],
|
||||
(survey: Survey): boolean => {
|
||||
return !!(survey.responses_limit && survey.responses_limit > 0)
|
||||
},
|
||||
],
|
||||
surveyUsesAdaptiveLimit: [
|
||||
(s) => [s.survey],
|
||||
(survey: Survey): boolean => {
|
||||
return !!(
|
||||
survey.response_sampling_interval &&
|
||||
survey.response_sampling_interval > 0 &&
|
||||
survey.response_sampling_interval_type !== '' &&
|
||||
survey.response_sampling_limit &&
|
||||
survey.response_sampling_limit > 0
|
||||
)
|
||||
},
|
||||
],
|
||||
surveyShufflingQuestionsAvailable: [
|
||||
(s) => [s.survey],
|
||||
(survey: Survey): boolean => {
|
||||
@ -1022,6 +1065,7 @@ export const surveyLogic = kea<surveyLogicType>([
|
||||
}
|
||||
},
|
||||
],
|
||||
|
||||
getBranchingDropdownValue: [
|
||||
(s) => [s.survey],
|
||||
(survey) => (questionIndex: number, question: RatingSurveyQuestion | MultipleSurveyQuestion) => {
|
||||
|
||||
@ -2767,6 +2767,11 @@ export interface Survey {
|
||||
iteration_start_dates?: string[]
|
||||
current_iteration?: number | null
|
||||
current_iteration_start_date?: string
|
||||
response_sampling_start_date?: string | null
|
||||
response_sampling_interval_type?: string | null
|
||||
response_sampling_interval?: number | null
|
||||
response_sampling_limit?: number | null
|
||||
response_sampling_daily_limits?: string[] | null
|
||||
}
|
||||
|
||||
export enum SurveyUrlMatchType {
|
||||
|
||||
@ -1,3 +1,4 @@
|
||||
import json
|
||||
from unittest.mock import patch, MagicMock
|
||||
from datetime import datetime
|
||||
from django.utils import timezone
|
||||
@ -39,6 +40,18 @@ class TestUpdateSurveyAdaptiveSampling(BaseTest):
|
||||
self.assertEqual(internal_response_sampling_flag.rollout_percentage, 20)
|
||||
mock_get_count.assert_called_once_with(self.survey.id)
|
||||
|
||||
@freeze_time("2024-12-21T12:00:00Z")
|
||||
@patch("posthog.tasks.update_survey_adaptive_sampling._get_survey_responses_count")
|
||||
def test_updates_rollout_after_interval_is_over(self, mock_get_count: MagicMock) -> None:
|
||||
mock_get_count.return_value = 50
|
||||
update_survey_adaptive_sampling()
|
||||
internal_response_sampling_flag = FeatureFlag.objects.get(id=self.internal_response_sampling_flag.id)
|
||||
self.assertEqual(internal_response_sampling_flag.rollout_percentage, 100)
|
||||
mock_get_count.assert_called_once_with(self.survey.id)
|
||||
survey = Survey.objects.get(id=self.survey.id)
|
||||
response_sampling_daily_limits = json.loads(survey.response_sampling_daily_limits)
|
||||
self.assertEqual(response_sampling_daily_limits[0].get("date"), "2024-12-22")
|
||||
|
||||
@freeze_time("2024-12-13T12:00:00Z")
|
||||
@patch("posthog.tasks.update_survey_adaptive_sampling._get_survey_responses_count")
|
||||
def test_no_update_when_limit_reached(self, mock_get_count: MagicMock) -> None:
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import json
|
||||
from datetime import datetime
|
||||
from datetime import datetime, timedelta
|
||||
from django.utils.timezone import now
|
||||
|
||||
from posthog.clickhouse.client import sync_execute
|
||||
@ -29,6 +29,12 @@ def _update_survey_adaptive_sampling(survey: Survey) -> None:
|
||||
internal_response_sampling_flag.rollout_percentage = today_entry["rollout_percentage"]
|
||||
internal_response_sampling_flag.save()
|
||||
|
||||
# this also doubles as a way to check that we're processing the final entry in the current sequence.
|
||||
if today_entry["rollout_percentage"] == 100:
|
||||
tomorrow = today_date + timedelta(days=1)
|
||||
survey.response_sampling_start_date = tomorrow
|
||||
survey.save(update_fields=["response_sampling_start_date", "response_sampling_daily_limits"])
|
||||
|
||||
|
||||
def _get_survey_responses_count(survey_id: int) -> int:
|
||||
data = sync_execute(
|
||||
|
||||
Loading…
Reference in New Issue
Block a user