feat(surveys): allow to stop surveys once reached enough responses (#…

…21528)


Co-authored-by: Neil Kakkar <neilkakkar@gmail.com>

cypress/e2e/surveys.cy.ts

@@ -281,4 +281,23 @@ describe('Surveys', () => {
             .contains('DRAFT')
             .should('exist')
     })
+
+    it.only('can set responses limit', () => {
+        cy.get('h1').should('contain', 'Surveys')
+        cy.get('[data-attr=new-survey]').click()
+        cy.get('[data-attr=new-blank-survey]').click()
+
+        cy.get('[data-attr=survey-name]').focus().type(name)
+
+        // Set responses limit
+        cy.get('.LemonCollapsePanel').contains('Completion conditions').click()
+        cy.get('[data-attr=survey-responses-limit-input]').focus().type('228').click()
+
+        // Save the survey
+        cy.get('[data-attr=save-survey]').first().click()
+        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')
+    })
 })

frontend/src/scenes/surveys/SurveyEdit.tsx

@@ -2,6 +2,7 @@ import './EditSurvey.scss'
 
 import { DndContext } from '@dnd-kit/core'
 import { SortableContext, verticalListSortingStrategy } from '@dnd-kit/sortable'
+import { IconInfo } from '@posthog/icons'
 import { IconLock, IconPlus, IconTrash } from '@posthog/icons'
 import {
     LemonButton,
@@ -19,6 +20,7 @@ import { FlagSelector } from 'lib/components/FlagSelector'
 import { FEATURE_FLAGS } from 'lib/constants'
 import { IconCancel } from 'lib/lemon-ui/icons'
 import { LemonField } from 'lib/lemon-ui/LemonField'
+import { Tooltip } from 'lib/lemon-ui/Tooltip'
 import { featureFlagLogic as enabledFeaturesLogic } from 'lib/logic/featureFlagLogic'
 import { featureFlagLogic } from 'scenes/feature-flags/featureFlagLogic'
 import { FeatureFlagReleaseConditions } from 'scenes/feature-flags/FeatureFlagReleaseConditions'
@@ -516,13 +518,18 @@ export default function SurveyEdit(): JSX.Element {
                                                                     type="number"
                                                                     size="small"
                                                                     min={0}
-                                                                    value={value?.seenSurveyWaitPeriodInDays}
+                                                                    value={value?.seenSurveyWaitPeriodInDays || NaN}
                                                                     onChange={(val) => {
                                                                         if (val !== undefined && val > 0) {
                                                                             onChange({
                                                                                 ...value,
                                                                                 seenSurveyWaitPeriodInDays: val,
                                                                             })
+                                                                        } else {
+                                                                            onChange({
+                                                                                ...value,
+                                                                                seenSurveyWaitPeriodInDays: null,
+                                                                            })
                                                                         }
                                                                     }}
                                                                     className="w-16"
@@ -597,6 +604,47 @@ export default function SurveyEdit(): JSX.Element {
                                 </LemonField.Pure>
                             ),
                         },
+                        {
+                            key: SurveyEditSection.CompletionConditions,
+                            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>

frontend/src/scenes/surveys/SurveyView.tsx

@@ -217,6 +217,15 @@ export function SurveyView({ id }: { id: string }): JSX.Element {
                                                     </div>
                                                 )}
                                             </div>
+                                            {survey.responses_limit && (
+                                                <>
+                                                    <span className="card-secondary mt-4">Completion conditions</span>
+                                                    <span>
+                                                        The survey will be stopped once <b>{survey.responses_limit}</b>{' '}
+                                                        responses are received.
+                                                    </span>
+                                                </>
+                                            )}
                                             <LemonDivider />
                                             <SurveyReleaseSummary
                                                 id={id}

frontend/src/scenes/surveys/Surveys.stories.tsx

@@ -40,6 +40,7 @@ const MOCK_BASIC_SURVEY: Survey = {
     start_date: null,
     end_date: null,
     archived: false,
+    responses_limit: null,
 }
 
 const MOCK_SURVEY_WITH_RELEASE_CONS: Survey = {
@@ -110,6 +111,7 @@ const MOCK_SURVEY_WITH_RELEASE_CONS: Survey = {
     start_date: '2023-04-29T10:04:37.977401Z',
     end_date: null,
     archived: false,
+    responses_limit: null,
 }
 
 const MOCK_SURVEY_SHOWN = {

frontend/src/scenes/surveys/constants.tsx

@@ -118,6 +118,7 @@ export interface NewSurvey
         | 'archived'
         | 'appearance'
         | 'targeting_flag_filters'
+        | 'responses_limit'
     > {
     id: 'new'
     linked_flag_id: number | null
@@ -145,6 +146,7 @@ export const NEW_SURVEY: NewSurvey = {
     conditions: null,
     archived: false,
     appearance: defaultSurveyAppearance,
+    responses_limit: null,
 }
 
 export enum SurveyTemplateType {

frontend/src/scenes/surveys/surveyLogic.test.ts

@@ -48,6 +48,7 @@ const MULTIPLE_CHOICE_SURVEY: Survey = {
     end_date: null,
     archived: false,
     targeting_flag_filters: undefined,
+    responses_limit: null,
 }
 
 const SINGLE_CHOICE_SURVEY: Survey = {
@@ -93,6 +94,7 @@ const SINGLE_CHOICE_SURVEY: Survey = {
     end_date: null,
     archived: false,
     targeting_flag_filters: undefined,
+    responses_limit: null,
 }
 
 const MULTIPLE_CHOICE_SURVEY_WITH_OPEN_CHOICE: Survey = {
@@ -139,6 +141,7 @@ const MULTIPLE_CHOICE_SURVEY_WITH_OPEN_CHOICE: Survey = {
     end_date: null,
     archived: false,
     targeting_flag_filters: undefined,
+    responses_limit: null,
 }
 
 const SINGLE_CHOICE_SURVEY_WITH_OPEN_CHOICE: Survey = {
@@ -185,6 +188,7 @@ const SINGLE_CHOICE_SURVEY_WITH_OPEN_CHOICE: Survey = {
     end_date: null,
     archived: false,
     targeting_flag_filters: undefined,
+    responses_limit: null,
 }
 
 describe('multiple choice survey logic', () => {

frontend/src/scenes/surveys/surveyLogic.tsx

@@ -36,6 +36,7 @@ export enum SurveyEditSection {
     Appearance = 'appearance',
     Customization = 'customization',
     Targeting = 'targeting',
+    CompletionConditions = 'CompletionConditions',
 }
 export interface SurveyLogicProps {
     /** Either a UUID or 'new'. */
@@ -475,6 +476,7 @@ export const surveyLogic = kea<surveyLogicType>([
             actions.setSurveyValue('targeting_flag', NEW_SURVEY.targeting_flag)
             actions.setSurveyValue('conditions', NEW_SURVEY.conditions)
             actions.setSurveyValue('remove_targeting_flag', true)
+            actions.setSurveyValue('responses_limit', NEW_SURVEY.responses_limit)
         },
         submitSurveyFailure: async () => {
             // When errors occur, scroll to the error, but wait for errors to be set in the DOM first

frontend/src/types.ts

@@ -2434,6 +2434,7 @@ export interface Survey {
     end_date: string | null
     archived: boolean
     remove_targeting_flag?: boolean
+    responses_limit: number | null
 }
 
 export enum SurveyUrlMatchType {

latest_migrations.manifest

@@ -5,7 +5,7 @@ contenttypes: 0002_remove_content_type_name
 ee: 0016_rolemembership_organization_member
 otp_static: 0002_throttling
 otp_totp: 0002_auto_20190420_0723
-posthog: 0405_team_heatmaps_opt_in
+posthog: 0406_survey_responses_limit
 sessions: 0001_initial
 social_django: 0010_uid_db_index
 two_factor: 0007_auto_20201201_1019

posthog/api/survey.py

@@ -57,6 +57,7 @@ class Meta:
             "start_date",
             "end_date",
             "archived",
+            "responses_limit",
         ]
         read_only_fields = ["id", "created_at", "created_by"]
 
@@ -88,6 +89,7 @@ class Meta:
             "start_date",
             "end_date",
             "archived",
+            "responses_limit",
         ]
         read_only_fields = ["id", "linked_flag", "targeting_flag", "created_at"]
 

posthog/api/test/__snapshots__/test_organization_feature_flag.ambr

@@ -1536,7 +1536,8 @@
          "posthog_survey"."start_date",
          "posthog_survey"."end_date",
          "posthog_survey"."updated_at",
-         "posthog_survey"."archived"
+         "posthog_survey"."archived",
+         "posthog_survey"."responses_limit"
   FROM "posthog_survey"
   WHERE "posthog_survey"."linked_flag_id" = 2
   '''

posthog/api/test/__snapshots__/test_survey.ambr

@@ -181,6 +181,7 @@
          "posthog_survey"."end_date",
          "posthog_survey"."updated_at",
          "posthog_survey"."archived",
+         "posthog_survey"."responses_limit",
          "posthog_featureflag"."id",
          "posthog_featureflag"."key",
          "posthog_featureflag"."name",

posthog/api/test/test_survey.py

@@ -853,6 +853,7 @@ def test_can_list_surveys(self):
                     "archived": False,
                     "start_date": None,
                     "end_date": None,
+                    "responses_limit": None,
                 }
             ],
         }

posthog/migrations/0406_survey_responses_limit.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.1.13 on 2024-04-14 13:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("posthog", "0405_team_heatmaps_opt_in"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="survey",
+            name="responses_limit",
+            field=models.PositiveIntegerField(null=True),
+        ),
+    ]

posthog/models/feedback/survey.py

@@ -56,6 +56,8 @@ class Meta:
     end_date: models.DateTimeField = models.DateTimeField(null=True)
     updated_at: models.DateTimeField = models.DateTimeField(auto_now=True)
     archived: models.BooleanField = models.BooleanField(default=False)
+    # It's not a strict limit as it's enforced in a periodic task
+    responses_limit = models.PositiveIntegerField(null=True)
 
 
 @mutable_receiver([post_save, post_delete], sender=Survey)

posthog/tasks/scheduled.py

@@ -46,6 +46,7 @@
     update_event_partitions,
     update_quota_limiting,
     verify_persons_data_in_sync,
+    stop_surveys_reached_target,
 )
 from posthog.utils import get_crontab
 
@@ -238,6 +239,12 @@ def setup_periodic_tasks(sender: Celery, **kwargs: Any) -> None:
             name="clickhouse clear deleted person data",
         )
 
+    sender.add_periodic_task(
+        crontab(hour="*/12"),
+        stop_surveys_reached_target.s(),
+        name="stop surveys that reached responses limits",
+    )
+
     if settings.EE_AVAILABLE:
         # every interval seconds, we calculate N replay embeddings
         # the goal is to process _enough_ every 24 hours that

posthog/tasks/stop_surveys_reached_target.py

@@ -0,0 +1,71 @@
+from itertools import groupby
+from django.db.models import Q
+from django.utils import timezone
+from uuid import UUID
+from datetime import datetime
+
+from posthog.clickhouse.client.connection import Workload
+from posthog.client import sync_execute
+from posthog.models import Survey
+
+
+def _get_surveys_response_counts(
+    surveys_ids: list[UUID], team_id: int, earliest_survey_creation_date: datetime
+) -> dict[str, int]:
+    data = sync_execute(
+        """
+        SELECT JSONExtractString(properties, '$survey_id') as survey_id, count()
+        FROM events
+        WHERE event = 'survey sent'
+              AND team_id = %(team_id)s
+              AND timestamp >= %(earliest_survey_creation_date)s
+              AND survey_id in %(surveys_ids)s
+        GROUP BY survey_id
+    """,
+        {
+            "surveys_ids": surveys_ids,
+            "team_id": team_id,
+            "earliest_survey_creation_date": earliest_survey_creation_date,
+        },
+        workload=Workload.OFFLINE,
+    )
+
+    counts = {}
+    for survey_id, count in data:
+        counts[survey_id] = count
+    return counts
+
+
+def _stop_survey_if_reached_limit(survey: Survey, responses_count: int) -> None:
+    # Since the job might take a long time, the survey configuration could've been changed by the user
+    # after we've queried it.
+    survey.refresh_from_db()
+    if survey.responses_limit is None or survey.end_date is not None:
+        return
+
+    if responses_count < survey.responses_limit:
+        return
+
+    survey.end_date = timezone.now()
+    survey.responses_limit = None
+    survey.save(update_fields=["end_date", "responses_limit"])
+
+
+def stop_surveys_reached_target() -> None:
+    all_surveys = Survey.objects.exclude(Q(responses_limit__isnull=True) | Q(end_date__isnull=False)).only(
+        "id", "responses_limit", "team_id", "created_at"
+    )
+
+    all_surveys_sorted = sorted(all_surveys, key=lambda survey: survey.team_id)
+    for team_id, team_surveys in groupby(all_surveys_sorted, lambda survey: survey.team_id):
+        team_surveys_list = list(team_surveys)
+        surveys_ids = [survey.id for survey in team_surveys_list]
+        earliest_survey_creation_date = min([survey.created_at for survey in team_surveys_list])
+
+        response_counts = _get_surveys_response_counts(surveys_ids, team_id, earliest_survey_creation_date)
+        for survey in team_surveys_list:
+            survey_id = str(survey.id)
+            if survey_id not in response_counts:
+                continue
+
+            _stop_survey_if_reached_limit(survey, response_counts[survey_id])

posthog/tasks/tasks.py

@@ -631,6 +631,13 @@ def verify_persons_data_in_sync() -> None:
     verify()
 
 
+@shared_task(ignrore_result=True)
+def stop_surveys_reached_target() -> None:
+    from posthog.tasks.stop_surveys_reached_target import stop_surveys_reached_target
+
+    stop_surveys_reached_target()
+
+
 def recompute_materialized_columns_enabled() -> bool:
     from posthog.models.instance_setting import get_instance_setting