chore: send survey partial responses event #1788

lucasheriques · 2025-03-05T05:48:10Z

Changes

sends events after every survey question - logic to dedupe them will be done on posthog/posthog side

related issue: PostHog/posthog#19300

todo:

add tests

Checklist

Tests for new code (see advice on the tests we use)
Accounted for the impact of any changes across different browsers
Accounted for backwards compatibility of any changes (no breaking changes in posthog-js!)

vercel · 2025-03-05T05:48:14Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
posthog-js	✅ Ready (Inspect)	Visit Preview	Mar 19, 2025 5:15am

github-actions · 2025-03-05T05:52:59Z

Size Change: +10.3 kB (+0.29%)

Total Size: 3.59 MB

Filename	Size	Change
`dist/all-external-dependencies.js`	223 kB	+2.84 kB (+1.29%)
`dist/array.full.es5.js`	276 kB	+351 B (+0.13%)
`dist/array.full.js`	379 kB	+327 B (+0.09%)
`dist/array.full.no-external.js`	377 kB	+327 B (+0.09%)
`dist/array.js`	186 kB	+22 B (+0.01%)
`dist/array.no-external.js`	184 kB	+22 B (+0.01%)
`dist/main.js`	186 kB	+22 B (+0.01%)
`dist/module.full.js`	379 kB	+327 B (+0.09%)
`dist/module.full.no-external.js`	377 kB	+327 B (+0.09%)
`dist/module.js`	186 kB	+22 B (+0.01%)
`dist/module.no-external.js`	184 kB	+22 B (+0.01%)
`dist/surveys-preview.js`	74.2 kB	+2.84 kB (+3.99%)
`dist/surveys.js`	79.5 kB	+2.84 kB (+3.7%)

ℹ️ View Unchanged

Filename	Size
`dist/customizations.full.js`	14 kB
`dist/dead-clicks-autocapture.js`	14.5 kB
`dist/exception-autocapture.js`	9.94 kB
`dist/external-scripts-loader.js`	2.75 kB
`dist/posthog-recorder.js`	211 kB
`dist/recorder-v2.js`	115 kB
`dist/recorder.js`	115 kB
`dist/tracing-headers.js`	1.76 kB
`dist/web-vitals.js`	10.4 kB

_{compressed-size-action}

src/extensions/surveys/surveys-utils.tsx

src/extensions/surveys.tsx

posthog-bot · 2025-03-14T09:33:15Z

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.

greptile-apps

PR Summary

This PR adds support for sending partial survey responses by tracking individual question responses before survey completion, with a new enable_partial_response flag controlling this behavior.

Added enable_partial_response flag to Survey interface to control partial response behavior
Implemented surveyResponseId using uuidv7() to track responses across questions consistently
Modified sendSurveyEvent to conditionally send events based on enable_partial_response and surveyCompleted flags
Added logging for survey response payloads to aid debugging
Deduplication logic will be handled server-side in posthog/posthog

_{3 file(s) reviewed, 2 comment(s)}
_{Edit PR Review Bot Settings | Greptile}

greptile-apps · 2025-03-19T01:54:21Z

src/extensions/surveys.tsx


        const nextStep = getNextSurveyStep(survey, displayQuestionIndex, res)
        if (nextStep === SurveyQuestionBranchingType.End) {
-            sendSurveyEvent({ ...questionsResponses, [responseKey]: res }, survey, posthog)
+            sendSurveyEvent({
+                responses: { ...questionsResponses, [responseKey]: res },
+                survey,
+                posthog,
+                surveyCompleted: nextStep === SurveyQuestionBranchingType.End,
+                surveyResponseId,
+            })
            onPopupSurveySent()


logic: Sending partial responses here but not in the else branch creates inconsistent behavior. Should also send partial responses when moving to next question.

greptile-apps · 2025-03-19T01:54:21Z

src/extensions/surveys.tsx

+                onPopupSurveySent()
+            },
+            surveyResponseId: uuidv7(),
+        }),


logic: surveyResponseId is regenerated on every render due to useMemo dependencies. Should be stored in state or ref to maintain consistency.

Suggested change

}),

surveyResponseId: useRef(uuidv7()).current,

}),

logic: surveyResponseId is regenerated on every render due to useMemo dependencies. Should be stored in state or ref to maintain consistency.

No idea if this stands but this would mean a new uuid on every render right?

this is not correct, as uuidv7() is a stable function (outside of preact component lifecycle)

it would only change when SurveyPopup is unmounted then rendered again, as expected

could it be that the user answers 1 question, refresh the page, generates another uuid, and answers the 2nd question?

or rather, how do we keep track of the current state of responses if the user refresh the page, comes back later, etc? is that gonna be an issue? (eg, even if starting from zero, having multiple answers for the same question, with a different uuid)

we'd have to do a more complex logic to handle a bigger user session that might involve refreshing. because, right now, if they answer one question, at this point the survey is marked as responded, so once it's gone, no longer it'll show up

this seems like we should address then, because previously, the user had a chance to answer the full survey, even if from the very beginning (annoying but possible).
now if the user just goes to another page (that is not a match anymore and survey is closed), or refreshes the page, the user cant answer anything anymore, leading to maybe an even poorer experience than before, with lots of surveys half answered

revisiting this discussion, so we're talking about the case:

survey is opened because it matches filters

user sends a couple of answers

but then he refreshes / goes to another page filters don't match (thus survey will not be shown anymore)

while it is not ideal, i'm not sure if we should optimize for this case specifically. we can though, might involve however keeping the surveyResponseId on the session data until it's fully answered.

however, it'll also require a lot of logic changes on other parts, like showing a survey that was already in progress, which is not exactly trivial.

I'd instead release this as is, get a few people to early access it, and see if this feedback will happen again. what do you think? we have plenty of customers who'd like partial responses so we can find customers to iterate on it with them

than the survey will not be shown, as after one question is answered, it's marked as if it is responded

I think this is the key change here. I'm okay if they are shown the survey again until they respond to the whole thing. In the edge cases listed above, they will have to go through all the questions again which is okay for me. I think it's preferable to show the survey two or more times until it's fully completed rather than not showing it again just because they accidentally refreshed

we discussed offline

marandaneto · 2025-03-19T07:23:39Z

src/extensions/surveys/surveys-utils.tsx

@@ -16,7 +16,7 @@ const window = _window as Window & typeof globalThis
 const document = _document as Document
 const SurveySeenPrefix = 'seenSurvey_'

-const logger = createLogger('[Surveys]')
+const logger = createLogger('[Surveys Utils]')


Suggested change

const logger = createLogger('[Surveys Utils]')

const logger = createLogger('[Surveys]')

any reason to change it? its easier to filter logs by [Surveys] rather than many other options

those logs are just not working, i was just testing it out to make sure.

the only logs who are working are from posthog-surveys

quickfix? :)

not that quick (really confused why it's not working) but I do wanna take a look

marandaneto · 2025-03-19T07:24:47Z

src/extensions/surveys/surveys-utils.tsx

    localStorage.setItem(getSurveySeenKey(survey), 'true')

+    logger.info('[PostHog Surveys] survey partial response payload', {


Suggested change

logger.info('[PostHog Surveys] survey partial response payload', {

logger.info('survey partial response payload', {

createLogger already has a prefix

marandaneto · 2025-03-19T07:25:40Z

i think some tests around the new props would be good.
also, if an event is captured per answer or the whole survey, including if partial response is enabled or not

ioannisj · 2025-03-19T08:09:29Z

src/extensions/surveys.tsx

+                onPopupSurveySent()
+            },
+            surveyResponseId: uuidv7(),
+        }),


logic: surveyResponseId is regenerated on every render due to useMemo dependencies. Should be stored in state or ref to maintain consistency.

No idea if this stands but this would mean a new uuid on every render right?

ioannisj · 2025-03-19T08:13:09Z

src/extensions/surveys/surveys-utils.tsx

    if (!posthog) {
        logger.error('[survey sent] event not captured, PostHog instance not found.')
        return
    }
+    if (!isSurveyCompleted && !survey.enable_partial_responses) {


I think this bit of logic here should be on the calling side

Yeah we also check for survey complete on the callsite to fire the survey sent popup callback, so better to avoid dupe checks and keep in a single place

posthog-bot · 2025-04-03T09:34:23Z

This PR hasn't seen activity in a week! Should it be merged, closed, or further worked on? If you want to keep it open, post a comment or remove the stale label – otherwise this will be closed in another week.

lucasheriques · 2025-04-10T13:21:27Z

closing in favor of #1888 (not ready for review yet)

too many files changed since I opened this PR, since the lines changes were few, decided to create a new one instead of handling the merge conflicts

wip

1d66679

lucasheriques added bump patch Bump patch version when this PR gets merged feature/surveys labels Mar 5, 2025

lucasheriques self-assigned this Mar 5, 2025

vercel bot deployed to Preview March 5, 2025 05:50 View deployment

lucasheriques mentioned this pull request Mar 6, 2025

feat: survey partial responses PostHog/posthog#29621

Closed

marandaneto reviewed Mar 7, 2025

View reviewed changes

src/extensions/surveys/surveys-utils.tsx Outdated Show resolved Hide resolved

marandaneto reviewed Mar 7, 2025

View reviewed changes

src/extensions/surveys.tsx Outdated Show resolved Hide resolved

marandaneto reviewed Mar 7, 2025

View reviewed changes

src/extensions/surveys.tsx Outdated Show resolved Hide resolved

posthog-bot added the stale label Mar 14, 2025

lucasheriques removed the stale label Mar 18, 2025

lucasheriques added 3 commits March 18, 2025 16:58

merge main

aa72a8b

use individual survey config instead

056b7c6

some type changes

99e4c51

vercel bot deployed to Preview March 19, 2025 01:20 View deployment

lucasheriques marked this pull request as ready for review March 19, 2025 01:53

lucasheriques requested a review from a team as a code owner March 19, 2025 01:53

greptile-apps bot reviewed Mar 19, 2025

View reviewed changes

some logic fixes

26c9dda

vercel bot deployed to Preview March 19, 2025 05:15 View deployment

marandaneto approved these changes Mar 19, 2025

View reviewed changes

marandaneto requested a review from ioannisj March 19, 2025 07:22

marandaneto reviewed Mar 19, 2025

View reviewed changes

ioannisj reviewed Mar 19, 2025

View reviewed changes

lucasheriques mentioned this pull request Mar 19, 2025

Sprint March 24 - April 4 PostHog/posthog#30139

Closed

lucasheriques mentioned this pull request Apr 2, 2025

Sprint April 7 to April 18 PostHog/posthog#30623

Closed

posthog-bot added the stale label Apr 3, 2025

lucasheriques closed this Apr 10, 2025

	const logger = createLogger('[Surveys Utils]')
	const logger = createLogger('[Surveys]')

		localStorage.setItem(getSurveySeenKey(survey), 'true')

		logger.info('[PostHog Surveys] survey partial response payload', {

	logger.info('[PostHog Surveys] survey partial response payload', {
	logger.info('survey partial response payload', {

chore: send survey partial responses event #1788

chore: send survey partial responses event #1788

Uh oh!

Conversation

lucasheriques commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Checklist

Uh oh!

vercel bot commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

posthog-bot commented Mar 14, 2025

Uh oh!

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

greptile-apps bot Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

greptile-apps bot Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

ioannisj Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marandaneto commented Mar 19, 2025

Uh oh!

ioannisj Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

posthog-bot commented Apr 3, 2025

Uh oh!

lucasheriques commented Apr 10, 2025

Uh oh!

Uh oh!

lucasheriques commented Mar 5, 2025 •

edited

Loading

vercel bot commented Mar 5, 2025 •

edited

Loading

github-actions bot commented Mar 5, 2025 •

edited

Loading

ioannisj Mar 19, 2025 •

edited

Loading

ioannisj Mar 19, 2025 •

edited

Loading