Skip to content
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.

Sign up for GitHub

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

chore(surveys): add basic survey e2e tests #948

Merged
merged 5 commits into from
Jan 8, 2024
Merged

chore(surveys): add basic survey e2e tests #948

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c766fc4
add basic survey e2e tests
liyiy Jan 4, 2024
1f2a0f0
fix
liyiy Jan 4, 2024
932c45b
add header display and capture tests
liyiy Jan 5, 2024
2760ea4
test multiple question survey response and optional questions
liyiy Jan 5, 2024
09487e5
remove unneeded feature flags in mock decide call
liyiy Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 198 additions & 0 deletions cypress/e2e/surveys.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
/// <reference types="cypress" />
import { getBase64EncodedPayload } from '../support/compression'

function onPageLoad() {
cy.posthogInit(given.options)
cy.wait('@decide')
cy.wait('@surveys')
}

describe('Surveys', () => {
given('options', () => ({}))
beforeEach(() => {
cy.intercept('POST', '**/decide/*', {
config: { enable_collect_everything: false },
editorParams: {},
featureFlags: ['session-recording-player'],
surveys: true,
isAuthenticated: false,
}).as('decide')
})
it('shows and submits a basic survey', () => {
cy.intercept('GET', '**/surveys/*', {
surveys: [
{
id: '123',
name: 'Test survey',
active: true,
type: 'popover',
start_date: '2021-01-01T00:00:00Z',
questions: [{ type: 'open', question: 'What is your role?', description: 'test description' }],
},
],
}).as('surveys')
cy.visit('./playground/cypress')
onPageLoad()
cy.wait(500)
const survey = cy.get('.PostHogSurvey123').shadow()
survey.find('.survey-123-form').should('be.visible')
cy.get('.PostHogSurvey123').shadow().find('.survey-question').should('have.text', 'What is your role?')
cy.get('.PostHogSurvey123').shadow().find('.description').should('have.text', 'test description')
survey.find('.question-textarea-wrapper').type('product engineer')
cy.get('.PostHogSurvey123').shadow().find('.form-submit').click()
cy.phCaptures().should('include', 'survey sent')
})

it('shows confirmation message after submitting', () => {
cy.intercept('GET', '**/surveys/*', {
surveys: [
{
id: '1234',
name: 'Test survey 2',
active: true,
type: 'popover',
start_date: '2021-01-01T00:00:00Z',
questions: [
{ type: 'rating', display: 'number', scale: 10, question: 'Would you recommend surveys?' },
],
appearance: {
displayThankYouMessage: true,
thankyouMessageHeader: 'Thanks!',
thankyouMessageBody: 'We appreciate your feedback.',
},
},
],
}).as('surveys')
cy.visit('./playground/cypress')
onPageLoad()
cy.get('.PostHogSurvey1234').shadow().find('.ratings-number').should('be.visible')
cy.get('.PostHogSurvey1234').shadow().find('.ratings-number').first().click()
cy.get('.PostHogSurvey1234').shadow().find('.form-submit').click()
expect(cy.get('.PostHogSurvey1234').shadow().find('.thank-you-message').should('be.visible'))
})

it('multiple question surveys', () => {
cy.intercept('GET', '**/surveys/*', {
surveys: [
{
id: '12345',
name: 'multiple question survey',
active: true,
type: 'popover',
start_date: '2021-01-01T00:00:00Z',
questions: [
{
question: 'Which types of content would you like to see more of?',
description: 'This is a question description',
type: 'multiple_choice',
choices: ['Tutorials', 'Product Updates', 'Events', 'Other'],
},
{ type: 'open', question: 'Why?' },
{
type: 'rating',
display: 'emoji',
scale: 5,
question: 'How does this survey make you feel?',
optional: true,
},
{
type: 'link',
question: 'Would you like to participate in a user study?',
link: 'https://posthog.com',
buttonText: 'Yes',
},
],
appearance: {
displayThankYouMessage: true,
thankyouMessageHeader: 'Thanks!',
thankyouMessageBody: 'We appreciate your feedback.',
},
},
],
}).as('surveys')
cy.intercept('POST', '**/e/*').as('capture-assertion')
cy.visit('./playground/cypress')
onPageLoad()
cy.wait(500)
cy.get('.PostHogSurvey12345').shadow().find('.survey-12345-form').should('be.visible')
cy.get('.PostHogSurvey12345').shadow().find('#surveyQuestion0Choice1').click()
cy.get('.PostHogSurvey12345').shadow().find('#surveyQuestion0Choice2').click()
cy.get('.PostHogSurvey12345').shadow().find('.form-submit').eq(0).click()
cy.get('.PostHogSurvey12345')
.shadow()
.find('.question-textarea-wrapper')
.first()
.type('Because I want to learn more about PostHog')
cy.get('.PostHogSurvey12345').shadow().find('.form-submit').eq(1).click()
cy.get('.PostHogSurvey12345').shadow().find('.form-submit').eq(2).click()
cy.get('.PostHogSurvey12345').shadow().find('.form-submit').eq(3).click()
cy.wait('@capture-assertion')
cy.wait('@capture-assertion').then(async ({ request }) => {
const captures = await getBase64EncodedPayload(request)
expect(captures.map(({ event }) => event)).to.deep.equal(['survey shown', 'survey sent'])
expect(captures[1].properties['$survey_response']).to.deep.equal(['Product Updates', 'Events'])
expect(captures[1].properties).to.contain({
$survey_id: '12345',
$survey_response_1: 'Because I want to learn more about PostHog',
$survey_response_2: null,
$survey_response_3: 'link clicked',
})
})
expect(cy.get('.PostHogSurvey12345').shadow().find('.thank-you-message').should('be.visible'))
})

describe('survey response capture', () => {
it('captures survey shown and survey dismissed events', () => {
cy.visit('./playground/cypress')
cy.intercept('GET', '**/surveys/*', {
surveys: [
{
id: '123',
name: 'Test survey',
description: 'description',
active: true,
type: 'popover',
start_date: '2021-01-01T00:00:00Z',
questions: [{ type: 'open', question: 'What is a survey event capture test?' }],
},
],
}).as('surveys')
cy.intercept('POST', '**/e/*').as('capture-assertion')
onPageLoad()
// first capture is $pageview
cy.wait('@capture-assertion')
cy.get('.PostHogSurvey123').shadow().find('.cancel-btn-wrapper').click()
cy.wait('@capture-assertion').then(async ({ request }) => {
const captures = await getBase64EncodedPayload(request)
expect(captures.map(({ event }) => event)).to.deep.equal(['survey shown', 'survey dismissed'])
})
})

it('captures survey sent event', () => {
cy.visit('./playground/cypress')
cy.intercept('GET', '**/surveys/*', {
surveys: [
{
id: '123',
name: 'Test survey',
description: 'description',
active: true,
type: 'popover',
start_date: '2021-01-01T00:00:00Z',
questions: [{ type: 'open', question: 'What is a survey event capture test?' }],
},
],
}).as('surveys')
cy.intercept('POST', '**/e/*').as('capture-assertion')
onPageLoad()
cy.get('.PostHogSurvey123').shadow().find('.question-textarea-wrapper').type('product engineer')
cy.get('.PostHogSurvey123').shadow().find('.form-submit').click()
cy.wait('@capture-assertion')
cy.wait('@capture-assertion').then(async ({ request }) => {
const captures = await getBase64EncodedPayload(request)
expect(captures.map(({ event }) => event)).to.deep.equal(['survey shown', 'survey sent'])
expect(captures[1].properties).to.contain({ $survey_id: '123', $survey_response: 'product engineer' })
})
})
})
})
5 changes: 5 additions & 0 deletions cypress/support/e2e.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ beforeEach(() => {
cy.intercept('POST', '**/decide/*').as('decide')
cy.intercept('POST', '**/e/*').as('capture')
cy.intercept('POST', '**/ses/*').as('session-recording')
cy.intercept('GET', '**/surveys/*').as('surveys')

cy.readFile('dist/array.full.js').then((body) => {
cy.intercept('**/static/array.full.js', { body })
Expand All @@ -45,4 +46,8 @@ beforeEach(() => {
cy.readFile('dist/recorder.js').then((body) => {
cy.intercept('**/static/recorder.js*', { body }).as('recorder')
})

cy.readFile('dist/surveys.js').then((body) => {
cy.intercept('**/static/surveys.js*', { body })
})
})
2 changes: 1 addition & 1 deletion playground/cypress-full/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<br />

<script>
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.full.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.full.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getSurveys getActiveMatchingSurveys".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
</script>
</body>
</html>
6 changes: 5 additions & 1 deletion playground/cypress/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
Test a feature flag
</button>

<button class="test-surveys" onclick="posthog.getActiveMatchingSurveys(surveys => console.log(surveys))">
Test surveys
</button>

<br />

<div data-cy-captures>
Expand All @@ -37,7 +41,7 @@
</button>

<script>
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getSurveys getActiveMatchingSurveys".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
</script>
</body>
</html>
Loading