-
Notifications
You must be signed in to change notification settings - Fork 48
feat(surveys): auto-submit rating and single-choice selections #769
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
Open
lucasheriques
wants to merge
2
commits into
main
Choose a base branch
from
lucas/surveys-auto-submit
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| "posthog": minor | ||
| "posthog-android": patch | ||
| "posthog-android-surveys-compose": minor | ||
| --- | ||
|
|
||
| Support skipSubmitButton for survey rating and single-choice questions. The Compose renderer submits eligible selections immediately and hides the submit button; multiple-choice questions and single-choice questions with an open option retain explicit submission. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
...ose/src/test/java/com/posthog/android/surveys/compose/internal/ui/SurveyAutoSubmitTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package com.posthog.android.surveys.compose.internal.ui | ||
|
|
||
| import com.posthog.surveys.PostHogDisplayChoiceQuestion | ||
| import com.posthog.surveys.PostHogDisplaySurveyTextContentType | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.junit.runners.Parameterized | ||
| import kotlin.test.assertEquals | ||
|
|
||
| @RunWith(Parameterized::class) | ||
| internal class SurveyAutoSubmitTest( | ||
| private val enabled: Boolean, | ||
| private val multiple: Boolean, | ||
| private val openChoice: Boolean, | ||
| private val expected: Boolean, | ||
| ) { | ||
| @Test | ||
| fun `only single choice without an open option auto-submits`() { | ||
| val question = | ||
| PostHogDisplayChoiceQuestion( | ||
| id = "question", question = "Choose", questionDescription = null, | ||
| questionDescriptionContentType = PostHogDisplaySurveyTextContentType.TEXT, | ||
| isOptional = false, buttonText = null, choices = listOf("First", "Other"), | ||
| hasOpenChoice = openChoice, shuffleOptions = false, isMultipleChoice = multiple, | ||
| skipSubmitButton = enabled, | ||
| ) | ||
| assertEquals(expected, question.shouldAutoSubmit) | ||
| } | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| @Parameterized.Parameters(name = "enabled={0}, multiple={1}, open={2}") | ||
| fun cases(): List<Array<Boolean>> = | ||
| listOf( | ||
| arrayOf(true, false, false, true), | ||
| arrayOf(true, false, true, false), | ||
| arrayOf(true, true, false, false), | ||
| arrayOf(true, true, true, false), | ||
| arrayOf(false, false, false, false), | ||
| arrayOf(false, false, true, false), | ||
| arrayOf(false, true, false, false), | ||
| arrayOf(false, true, true, false), | ||
| ) | ||
| } | ||
| } | ||
163 changes: 163 additions & 0 deletions
163
...g/java/com/posthog/android/surveys/compose/internal/ui/SurveyAutoSubmitInteractionTest.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package com.posthog.android.surveys.compose.internal.ui | ||
|
|
||
| import androidx.compose.material3.MaterialTheme | ||
| import androidx.compose.ui.semantics.SemanticsProperties | ||
| import androidx.compose.ui.test.SemanticsMatcher | ||
| import androidx.compose.ui.test.assertCountEquals | ||
| import androidx.compose.ui.test.assertIsDisplayed | ||
| import androidx.compose.ui.test.assertIsEnabled | ||
| import androidx.compose.ui.test.assertIsNotEnabled | ||
| import androidx.compose.ui.test.hasClickAction | ||
| import androidx.compose.ui.test.hasSetTextAction | ||
| import androidx.compose.ui.test.junit4.createComposeRule | ||
| import androidx.compose.ui.test.onNodeWithText | ||
| import androidx.compose.ui.test.performClick | ||
| import androidx.compose.ui.test.performTextInput | ||
| import com.posthog.surveys.PostHogDisplayChoiceQuestion | ||
| import com.posthog.surveys.PostHogDisplayRatingQuestion | ||
| import com.posthog.surveys.PostHogDisplaySurvey | ||
| import com.posthog.surveys.PostHogDisplaySurveyAppearance | ||
| import com.posthog.surveys.PostHogDisplaySurveyQuestion | ||
| import com.posthog.surveys.PostHogDisplaySurveyRatingType | ||
| import com.posthog.surveys.PostHogDisplaySurveyTextContentType | ||
| import com.posthog.surveys.PostHogNextSurveyQuestion | ||
| import com.posthog.surveys.PostHogSurveyResponse | ||
| import org.junit.Rule | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.robolectric.ParameterizedRobolectricTestRunner | ||
| import org.robolectric.annotation.Config | ||
| import kotlin.test.assertEquals | ||
|
|
||
| @RunWith(ParameterizedRobolectricTestRunner::class) | ||
| @Config(sdk = [28]) | ||
| internal class SurveyAutoSubmitInteractionTest( | ||
| private val kind: String, | ||
| private val enabled: Boolean, | ||
| ) { | ||
| @get:Rule | ||
| val compose = createComposeRule() | ||
|
|
||
| @Test | ||
| fun `selection submits once and follows branching without carrying selection to the next question`() { | ||
| val responses = mutableListOf<Pair<Int, PostHogSurveyResponse>>() | ||
| var closes = 0 | ||
| val survey = | ||
| PostHogDisplaySurvey( | ||
| id = "interaction-survey", | ||
| name = "Interaction survey", | ||
| questions = | ||
| listOf( | ||
| question("First question", enabled), | ||
| question("Skipped question", false), | ||
| question("Last question", false), | ||
| ), | ||
| appearance = PostHogDisplaySurveyAppearance(displayThankYouMessage = false), | ||
| ) | ||
| compose.setContent { | ||
| MaterialTheme { | ||
| SurveySheet( | ||
| survey = survey, | ||
| onSurveyShown = {}, | ||
| onSubmit = { index, response -> | ||
| responses.add(index to response) | ||
| PostHogNextSurveyQuestion(2, index == 2) | ||
| }, | ||
| onClose = { closes++ }, | ||
| ) | ||
| } | ||
| } | ||
| compose.onNodeWithText("First question").assertIsDisplayed() | ||
| val autoSubmit = enabled && kind in listOf("number", "emoji", "single") | ||
| if (autoSubmit) { | ||
| compose.onNodeWithText("Submit").assertDoesNotExist() | ||
| } else { | ||
| compose.onNodeWithText("Submit").assertIsNotEnabled() | ||
| } | ||
|
|
||
| selectAnswer() | ||
| if (!autoSubmit) { | ||
| compose.runOnIdle { assertEquals(emptyList(), responses) } | ||
| compose.onNodeWithText("Submit").assertIsEnabled().performClick() | ||
| } | ||
|
|
||
| compose.onNodeWithText("Last question").assertIsDisplayed() | ||
| compose.onNodeWithText("Skipped question").assertDoesNotExist() | ||
| compose.onNodeWithText("Submit").assertIsNotEnabled() | ||
| compose.runOnIdle { | ||
| assertEquals(listOf(0 to expectedResponse()), responses) | ||
| assertEquals(0, closes) | ||
| } | ||
|
|
||
| // Selecting the same value again must select it on the new question, not deselect stale state. | ||
| selectAnswer() | ||
| compose.onNodeWithText("Submit").assertIsEnabled().performClick() | ||
| compose.runOnIdle { | ||
| assertEquals(listOf(0 to expectedResponse(), 2 to expectedResponse()), responses) | ||
| assertEquals(1, closes) | ||
| } | ||
| } | ||
|
|
||
| private fun selectAnswer() { | ||
| when (kind) { | ||
| "number" -> compose.onNodeWithText("3").performClick() | ||
| "emoji" -> { | ||
| // Emoji choices are canvases without text; other sheet actions have accessible labels. | ||
| val choices = | ||
| compose.onAllNodes( | ||
| hasClickAction() and | ||
| SemanticsMatcher.keyNotDefined(SemanticsProperties.Text) and | ||
| SemanticsMatcher.keyNotDefined(SemanticsProperties.ContentDescription), | ||
| ) | ||
| choices.assertCountEquals(5) | ||
| choices[2].performClick() | ||
| } | ||
| "open" -> { | ||
| compose.onNodeWithText("Other:").performClick() | ||
| compose.onNode(hasSetTextAction()).performTextInput("Free form") | ||
| } | ||
| else -> compose.onNodeWithText("First").performClick() | ||
| } | ||
| } | ||
|
|
||
| private fun expectedResponse(): PostHogSurveyResponse = | ||
| when (kind) { | ||
| "number", "emoji" -> PostHogSurveyResponse.Rating(3) | ||
| "multiple" -> PostHogSurveyResponse.MultipleChoice(listOf("First")) | ||
| "open" -> PostHogSurveyResponse.SingleChoice("Free form") | ||
| else -> PostHogSurveyResponse.SingleChoice("First") | ||
| } | ||
|
|
||
| private fun question( | ||
| title: String, | ||
| autoSubmit: Boolean, | ||
| ): PostHogDisplaySurveyQuestion = | ||
| when (kind) { | ||
| "number", "emoji" -> | ||
| PostHogDisplayRatingQuestion( | ||
| id = title, question = title, questionDescription = null, | ||
| questionDescriptionContentType = PostHogDisplaySurveyTextContentType.TEXT, | ||
| isOptional = false, buttonText = "Submit", | ||
| ratingType = if (kind == "number") PostHogDisplaySurveyRatingType.NUMBER else PostHogDisplaySurveyRatingType.EMOJI, | ||
| scaleLowerBound = 1, scaleUpperBound = 5, lowerBoundLabel = "", upperBoundLabel = "", | ||
| skipSubmitButton = autoSubmit, | ||
| ) | ||
| else -> | ||
| PostHogDisplayChoiceQuestion( | ||
| id = title, question = title, questionDescription = null, | ||
| questionDescriptionContentType = PostHogDisplaySurveyTextContentType.TEXT, | ||
| isOptional = false, buttonText = "Submit", choices = listOf("First", "Other"), | ||
| hasOpenChoice = kind == "open", shuffleOptions = false, isMultipleChoice = kind == "multiple", | ||
| skipSubmitButton = autoSubmit, | ||
| ) | ||
| } | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| @ParameterizedRobolectricTestRunner.Parameters(name = "kind={0}, enabled={1}") | ||
| fun cases(): List<Array<Any>> = | ||
| listOf("number", "emoji", "single", "open", "multiple").flatMap { kind -> | ||
| listOf(true, false).map { enabled -> arrayOf(kind, enabled) } | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.