Skip to content

Commit

Permalink
feat: for signup set make organization name optional and set a defaul…
Browse files Browse the repository at this point in the history
…t one (#21083)

* Set a default org name if they don't enter one

* Add default org name tests

* Name org input optional

* Remove .only that the posthog-bot added

* Don't show optional for organization name input

* Update UI snapshots for `chromium` (2)

* Update UI snapshots for `chromium` (2)

* Clean up first / last name inputs on sign up / settings

* Update UI snapshots for `chromium` (1)

* Update cypress signup tests

* Update python tests for signup

* Update UI snapshots for `chromium` (1)

* Update signup.cy.ts

* Update signupLogic.ts

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
  • Loading branch information
zlwaterfield and github-actions[bot] authored Mar 27, 2024
1 parent 06fdcb2 commit 804bcbb
Show file tree
Hide file tree
Showing 9 changed files with 78 additions and 20 deletions.
43 changes: 39 additions & 4 deletions cypress/e2e/signup.cy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ describe('Signup', () => {
cy.get('[data-attr=signup-email]').type('[email protected]').should('have.value', '[email protected]')
cy.get('[data-attr=password]').type('12345678').should('have.value', '12345678')
cy.get('[data-attr=signup-start]').click()
cy.get('[data-attr=signup-first-name]').type('Jane').should('have.value', 'Jane')
cy.get('[data-attr=signup-name]').type('Jane Doe').should('have.value', 'Jane Doe')
cy.get('[data-attr=signup-organization-name]').type('Hogflix Movies').should('have.value', 'Hogflix Movies')
cy.get('[data-attr=signup-role-at-organization]').click()
cy.get('.Popover li:first-child').click()
Expand All @@ -39,18 +39,53 @@ describe('Signup', () => {
cy.get('.text-danger').should('not.contain', 'Password must be at least 8 characters') // Validation error removed on keystroke
})

it('Can create user account', () => {
it('Can create user account with first name, last name and organization name', () => {
cy.intercept('POST', '/api/signup/').as('signupRequest')

const email = `new_user+${Math.floor(Math.random() * 10000)}@posthog.com`
cy.get('[data-attr=signup-email]').type(email).should('have.value', email)
cy.get('[data-attr=password]').type('12345678').should('have.value', '12345678')
cy.get('[data-attr=signup-start]').click()
cy.get('[data-attr=signup-first-name]').type('Alice').should('have.value', 'Alice')
cy.get('[data-attr=signup-name]').type('Alice Bob').should('have.value', 'Alice Bob')
cy.get('[data-attr=signup-organization-name]').type('Hogflix SpinOff').should('have.value', 'Hogflix SpinOff')
cy.get('[data-attr=signup-role-at-organization]').click()
cy.get('.Popover li:first-child').click()
cy.get('[data-attr=signup-role-at-organization]').contains('Engineering')
cy.get('[data-attr=signup-submit]').click()

cy.wait('@signupRequest').then((interception) => {
expect(interception.request.body).to.have.property('first_name')
expect(interception.request.body.first_name).to.equal('Alice')
expect(interception.request.body).to.have.property('last_name')
expect(interception.request.body.last_name).to.equal('Bob')
expect(interception.request.body).to.have.property('organization_name')
expect(interception.request.body.organization_name).to.equal('Hogflix SpinOff')
})

// lazy regex for a guid
cy.location('pathname').should('match', /\/verify_email\/[a-zA-Z0-9_.-]*/)
})

it('Can create user account with just a first name', () => {
cy.intercept('POST', '/api/signup/').as('signupRequest')

const email = `new_user+${Math.floor(Math.random() * 10000)}@posthog.com`
cy.get('[data-attr=signup-email]').type(email).should('have.value', email)
cy.get('[data-attr=password]').type('12345678').should('have.value', '12345678')
cy.get('[data-attr=signup-start]').click()
cy.get('[data-attr=signup-name]').type('Alice').should('have.value', 'Alice')
cy.get('[data-attr=signup-role-at-organization]').click()
cy.get('.Popover li:first-child').click()
cy.get('[data-attr=signup-role-at-organization]').contains('Engineering')
cy.get('[data-attr=signup-submit]').click()

cy.wait('@signupRequest').then((interception) => {
expect(interception.request.body).to.have.property('first_name')
expect(interception.request.body.first_name).to.equal('Alice')
expect(interception.request.body).to.not.have.property('last_name')
expect(interception.request.body).to.not.have.property('organization_name')
})

// lazy regex for a guid
cy.location('pathname').should('match', /\/verify_email\/[a-zA-Z0-9_.-]*/)
})
Expand All @@ -74,7 +109,7 @@ describe('Signup', () => {
cy.get('.Toastify [data-attr="error-toast"]').contains('Inactive social login session.')
})

it.only('Shows redirect notice if redirecting for maintenance', () => {
it('Shows redirect notice if redirecting for maintenance', () => {
cy.intercept('**/decide/*', (req) =>
req.reply(
decideResponse({
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ export function SignupPanel2(): JSX.Element | null {
return (
<div className="space-y-4 Signup__panel__2">
<Form logic={signupLogic} formKey="signupPanel2" className="space-y-4" enableFormOnSubmit>
<LemonField name="first_name" label="Your name">
<LemonField name="name" label="Your name">
<LemonInput
className="ph-ignore-input"
data-attr="signup-first-name"
data-attr="signup-name"
placeholder="Jane Doe"
disabled={isSignupPanel2Submitting}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { urlToAction } from 'kea-router'
import api from 'lib/api'
import { CLOUD_HOSTNAMES, FEATURE_FLAGS } from 'lib/constants'
import { featureFlagLogic } from 'lib/logic/featureFlagLogic'
import posthog from 'posthog-js'
import { preflightLogic } from 'scenes/PreflightCheck/preflightLogic'
import { urls } from 'scenes/urls'

Expand All @@ -22,7 +23,7 @@ export interface AccountResponse {
export interface SignupForm {
email: string
password: string
first_name: string
name: string
organization_name: string
role_at_organization: string
referral_source: string
Expand Down Expand Up @@ -78,19 +79,27 @@ export const signupLogic = kea<signupLogicType>([
alwaysShowErrors: true,
showErrorsOnTouch: true,
defaults: {
first_name: '',
name: '',
organization_name: '',
role_at_organization: '',
referral_source: '',
} as SignupForm,
errors: ({ first_name, organization_name }) => ({
first_name: !first_name ? 'Please enter your name' : undefined,
organization_name: !organization_name ? 'Please enter your organization name' : undefined,
errors: ({ name }) => ({
name: !name ? 'Please enter your name' : undefined,
}),
submit: async (payload, breakpoint) => {
breakpoint()
try {
const res = await api.create('api/signup/', { ...values.signupPanel1, ...payload })
const res = await api.create('api/signup/', {
...values.signupPanel1,
...payload,
first_name: payload.name.split(' ')[0],
last_name: payload.name.split(' ')[1] || undefined,
organization_name: payload.organization_name || undefined,
})
if (!payload.organization_name) {
posthog.capture('sign up organization name not provided')
}
location.href = res.redirect_url || '/'
} catch (e) {
actions.setSignupPanel2ManualErrors({
Expand Down Expand Up @@ -142,7 +151,7 @@ export const signupLogic = kea<signupLogicType>([
email,
})
actions.setSignupPanel2Values({
first_name: 'X',
name: 'X',
organization_name: 'Y',
})
actions.submitSignupPanel2()
Expand Down
15 changes: 12 additions & 3 deletions frontend/src/scenes/settings/user/UserDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,25 @@ export function UserDetails(): JSX.Element {
maxWidth: '28rem',
}}
>
<LemonField name="first_name" label="Your name">
<LemonField name="first_name" label="First name">
<LemonInput
className="ph-ignore-input"
data-attr="settings-update-first-name"
placeholder="Jane Doe"
placeholder="Jane"
disabled={userLoading}
/>
</LemonField>

<LemonField name="email" label="Your email">
<LemonField name="last_name" label="Last name">
<LemonInput
className="ph-ignore-input"
data-attr="settings-update-last-name"
placeholder="Doe"
disabled={userLoading}
/>
</LemonField>

<LemonField name="email" label="Email">
<LemonInput
className="ph-ignore-input"
data-attr="settings-update-email"
Expand Down
4 changes: 3 additions & 1 deletion frontend/src/scenes/userLogic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export const userLogic = kea<userLogicType>([
: null,
email: !email
? 'You need to have an email.'
: first_name.length > 254
: email.length > 254
? 'This email is too long. Please keep it under 255 characters.'
: null,
}),
Expand Down Expand Up @@ -98,10 +98,12 @@ export const userLogic = kea<userLogicType>([
{
loadUserSuccess: (_, { user }) => ({
first_name: user?.first_name || '',
last_name: user?.last_name || '',
email: user?.email || '',
}),
updateUserSuccess: (_, { user }) => ({
first_name: user?.first_name || '',
last_name: user?.last_name || '',
email: user?.email || '',
}),
},
Expand Down
3 changes: 2 additions & 1 deletion posthog/api/signup.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ def get_redirect_url(uuid: str, is_email_verified: bool) -> str:

class SignupSerializer(serializers.Serializer):
first_name: serializers.Field = serializers.CharField(max_length=128)
last_name: serializers.Field = serializers.CharField(max_length=128, required=False, allow_blank=True)
email: serializers.Field = serializers.EmailField()
password: serializers.Field = serializers.CharField(allow_null=True, required=True)
organization_name: serializers.Field = serializers.CharField(max_length=128, required=False, allow_blank=True)
Expand Down Expand Up @@ -92,7 +93,7 @@ def create(self, validated_data, **kwargs):

is_instance_first_user: bool = not User.objects.exists()

organization_name = validated_data.pop("organization_name", validated_data["first_name"])
organization_name = validated_data.pop("organization_name", f"{validated_data['first_name']}'s Organization")
role_at_organization = validated_data.pop("role_at_organization", "")
referral_source = validated_data.pop("referral_source", "")

Expand Down
6 changes: 4 additions & 2 deletions posthog/api/test/test_signup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ def test_api_sign_up(self, mock_capture):
"/api/signup/",
{
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"password": "notsecure",
"organization_name": "Hedgehogs United, LLC",
Expand All @@ -62,8 +63,8 @@ def test_api_sign_up(self, mock_capture):
"id": user.pk,
"uuid": str(user.uuid),
"distinct_id": user.distinct_id,
"last_name": "",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"redirect_url": "/",
"is_email_verified": False,
Expand All @@ -72,6 +73,7 @@ def test_api_sign_up(self, mock_capture):

# Assert that the user was properly created
self.assertEqual(user.first_name, "John")
self.assertEqual(user.last_name, "Doe")
self.assertEqual(user.email, "[email protected]")
self.assertFalse(user.email_opt_in)
self.assertTrue(user.is_staff) # True because this is the first user in the instance
Expand Down Expand Up @@ -223,7 +225,7 @@ def test_signup_minimum_attrs(self, mock_capture):
self.assertEqual(user.first_name, "Jane")
self.assertEqual(user.email, "[email protected]")
self.assertTrue(user.email_opt_in) # Defaults to True
self.assertEqual(organization.name, "Jane")
self.assertEqual(organization.name, f"{user.first_name}'s Organization")
self.assertTrue(user.is_staff) # True because this is the first user in the instance

# Assert that the sign up event & identify calls were sent to PostHog analytics
Expand Down

0 comments on commit 804bcbb

Please sign in to comment.