Merge pull request #1851 from warrickct/simplify-onboarding

Combining registration steps.
This commit is contained in:
Audric Ackermann 2021-08-19 13:45:49 +10:00 committed by GitHub
commit eed48094fe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 81 additions and 96 deletions

View file

@ -340,7 +340,7 @@
"createAccount": "Create account", "createAccount": "Create account",
"signIn": "Sign In", "signIn": "Sign In",
"yourUniqueSessionID": "Say hello to your Session ID", "yourUniqueSessionID": "Say hello to your Session ID",
"allUsersAreRandomly...": "Your Session ID is the unique address people can use to contact you on Session. With no connection to your real identity, your Session ID is totally anonymous and private by design.", "signupSessionIDBlurb": "Your Session ID is the unique address people can use to contact you on Session. With no connection to your real identity, your Session ID is totally anonymous and private by design.",
"getStarted": "Get started", "getStarted": "Get started",
"createSessionID": "Create Session ID", "createSessionID": "Create Session ID",
"recoveryPhrase": "Recovery Phrase", "recoveryPhrase": "Recovery Phrase",

View file

@ -149,7 +149,7 @@
color: themed('textColor'); color: themed('textColor');
} }
font-weight: bold; font-weight: bold;
padding: 12px; padding: 20px;
} }
&__welcome-session { &__welcome-session {
@ -278,7 +278,7 @@
&-description-long, &-description-long,
&-signin-device-pairing-header { &-signin-device-pairing-header {
padding-top: 10px; padding-top: 0;
padding-bottom: 20px; padding-bottom: 20px;
@include themify($themes) { @include themify($themes) {
@include session-color-subtle(themed('textColor')); @include session-color-subtle(themed('textColor'));

View file

@ -9,7 +9,7 @@ import { SessionButton, SessionButtonColor, SessionButtonType } from '../session
import { SessionIconButton, SessionIconSize, SessionIconType } from '../session/icon'; import { SessionIconButton, SessionIconSize, SessionIconType } from '../session/icon';
import { PillDivider } from '../session/PillDivider'; import { PillDivider } from '../session/PillDivider';
import { SyncUtils, ToastUtils, UserUtils } from '../../session/utils'; import { SyncUtils, ToastUtils, UserUtils } from '../../session/utils';
import { MAX_USERNAME_LENGTH } from '../session/registration/RegistrationTabs'; import { MAX_USERNAME_LENGTH } from '../session/registration/RegistrationStages';
import { SessionSpinner } from '../session/SessionSpinner'; import { SessionSpinner } from '../session/SessionSpinner';
import { ConversationModel, ConversationTypeEnum } from '../../models/conversation'; import { ConversationModel, ConversationTypeEnum } from '../../models/conversation';

View file

@ -1,7 +1,7 @@
import React, { useEffect } from 'react'; import React, { useEffect } from 'react';
import { AccentText } from './AccentText'; import { AccentText } from './AccentText';
import { RegistrationTabs } from './registration/RegistrationTabs'; import { RegistrationStages } from './registration/RegistrationStages';
import { SessionIconButton, SessionIconSize, SessionIconType } from './icon'; import { SessionIconButton, SessionIconSize, SessionIconType } from './icon';
import { SessionToastContainer } from './SessionToastContainer'; import { SessionToastContainer } from './SessionToastContainer';
import { lightTheme, SessionTheme } from '../../state/ducks/SessionTheme'; import { lightTheme, SessionTheme } from '../../state/ducks/SessionTheme';
@ -36,7 +36,7 @@ export const SessionRegistrationView = () => {
<AccentText /> <AccentText />
</div> </div>
<div className="session-content-registration"> <div className="session-content-registration">
<RegistrationTabs theme={lightTheme} /> <RegistrationStages />
</div> </div>
</div> </div>
</div> </div>

View file

@ -1,11 +1,9 @@
import React from 'react'; import React, { createContext, useEffect, useState } from 'react';
import { PromiseUtils, StringUtils, ToastUtils, UserUtils } from '../../../session/utils'; import { PromiseUtils, StringUtils, ToastUtils, UserUtils } from '../../../session/utils';
import { getConversationController } from '../../../session/conversations'; import { getConversationController } from '../../../session/conversations';
import { createOrUpdateItem, removeAll } from '../../../data/data'; import { createOrUpdateItem, removeAll } from '../../../data/data';
import { SignUpTab } from './SignUpTab'; import { SignUpTab } from './SignUpTab';
import { SignInTab } from './SignInTab'; import { SignInTab } from './SignInTab';
import { TabLabel, TabType } from './TabLabel';
import { trigger } from '../../../shims/events'; import { trigger } from '../../../shims/events';
import { import {
generateMnemonic, generateMnemonic,
@ -21,12 +19,6 @@ import { getSwarmPollingInstance } from '../../../session/snode_api/swarmPolling
export const MAX_USERNAME_LENGTH = 20; export const MAX_USERNAME_LENGTH = 20;
// tslint:disable: use-simple-attributes // tslint:disable: use-simple-attributes
interface State {
selectedTab: TabType;
generatedRecoveryPhrase: string;
hexGeneratedPubKey: string;
}
export async function resetRegistration() { export async function resetRegistration() {
await removeAll(); await removeAll();
await window.storage.reset(); await window.storage.reset();
@ -158,45 +150,39 @@ export async function signInWithLinking(signInDetails: { userRecoveryPhrase: str
window?.log?.warn('exception during registration:', e); window?.log?.warn('exception during registration:', e);
} }
} }
export class RegistrationTabs extends React.Component<any, State> {
constructor(props: any) { export enum RegistrationPhase {
super(props); Start,
this.state = { SignIn,
selectedTab: TabType.SignUp, SignUp,
}
interface RegistrationPhaseContext {
registrationPhase: RegistrationPhase;
setRegistrationPhase: (phase: RegistrationPhase) => void;
generatedRecoveryPhrase: string;
hexGeneratedPubKey: string;
}
export const RegistrationContext = createContext<RegistrationPhaseContext>({
registrationPhase: RegistrationPhase.Start,
setRegistrationPhase: () => undefined,
generatedRecoveryPhrase: '', generatedRecoveryPhrase: '',
hexGeneratedPubKey: '', hexGeneratedPubKey: '',
}; });
}
public componentDidMount() { export const RegistrationStages = () => {
void this.generateMnemonicAndKeyPair(); const [generatedRecoveryPhrase, setGeneratedRecoveryPhrase] = useState('');
const [hexGeneratedPubKey, setHexGeneratedPubKey] = useState('');
const [registrationPhase, setRegistrationPhase] = useState(RegistrationPhase.Start);
useEffect(() => {
void generateMnemonicAndKeyPair();
void resetRegistration(); void resetRegistration();
} }, []);
public render() { const generateMnemonicAndKeyPair = async () => {
const { selectedTab } = this.state; if (generatedRecoveryPhrase === '') {
return (
<div className="session-registration-container">
<div className="session-registration__tab-container">
<TabLabel
type={TabType.SignUp}
isSelected={selectedTab === TabType.SignUp}
onSelect={this.handleTabSelect}
/>
<TabLabel
type={TabType.SignIn}
isSelected={selectedTab === TabType.SignIn}
onSelect={this.handleTabSelect}
/>
</div>
{this.renderSections()}
</div>
);
}
private async generateMnemonicAndKeyPair() {
if (this.state.generatedRecoveryPhrase === '') {
const mnemonic = await generateMnemonic(); const mnemonic = await generateMnemonic();
let seedHex = mn_decode(mnemonic); let seedHex = mn_decode(mnemonic);
@ -208,32 +194,28 @@ export class RegistrationTabs extends React.Component<any, State> {
} }
const seed = fromHex(seedHex); const seed = fromHex(seedHex);
const keyPair = await sessionGenerateKeyPair(seed); const keyPair = await sessionGenerateKeyPair(seed);
const hexGeneratedPubKey = StringUtils.decode(keyPair.pubKey, 'hex'); const newHexPubKey = StringUtils.decode(keyPair.pubKey, 'hex');
this.setState({ setGeneratedRecoveryPhrase(mnemonic);
generatedRecoveryPhrase: mnemonic, setHexGeneratedPubKey(newHexPubKey); // our 'frontend' sessionID
hexGeneratedPubKey, // our 'frontend' sessionID
});
} }
}
private readonly handleTabSelect = (tabType: TabType): void => {
this.setState({
selectedTab: tabType,
});
}; };
private renderSections() {
const { selectedTab, generatedRecoveryPhrase, hexGeneratedPubKey } = this.state;
if (selectedTab === TabType.SignUp) {
return ( return (
<SignUpTab <div className="session-registration-container">
generatedRecoveryPhrase={generatedRecoveryPhrase} <RegistrationContext.Provider
hexGeneratedPubKey={hexGeneratedPubKey} value={{
/> registrationPhase,
setRegistrationPhase,
generatedRecoveryPhrase,
hexGeneratedPubKey,
}}
>
{(registrationPhase === RegistrationPhase.Start ||
registrationPhase === RegistrationPhase.SignUp) && <SignUpTab />}
{(registrationPhase === RegistrationPhase.Start ||
registrationPhase === RegistrationPhase.SignIn) && <SignInTab />}
</RegistrationContext.Provider>
</div>
); );
} };
return <SignInTab />;
}
}

View file

@ -2,7 +2,7 @@ import classNames from 'classnames';
import React from 'react'; import React from 'react';
import { lightTheme } from '../../../state/ducks/SessionTheme'; import { lightTheme } from '../../../state/ducks/SessionTheme';
import { SessionInput } from '../SessionInput'; import { SessionInput } from '../SessionInput';
import { MAX_USERNAME_LENGTH } from './RegistrationTabs'; import { MAX_USERNAME_LENGTH } from './RegistrationStages';
const DisplayNameInput = (props: { const DisplayNameInput = (props: {
stealAutoFocus?: boolean; stealAutoFocus?: boolean;

View file

@ -1,9 +1,14 @@
import React, { useState } from 'react'; import React, { useContext, useState } from 'react';
import { Flex } from '../../basic/Flex'; import { Flex } from '../../basic/Flex';
import { SpacerLG } from '../../basic/Text'; import { SpacerLG } from '../../basic/Text';
import { SessionButton, SessionButtonColor, SessionButtonType } from '../SessionButton'; import { SessionButton, SessionButtonColor, SessionButtonType } from '../SessionButton';
import { SessionSpinner } from '../SessionSpinner'; import { SessionSpinner } from '../SessionSpinner';
import { signInWithLinking, signInWithRecovery } from './RegistrationTabs'; import {
RegistrationContext,
RegistrationPhase,
signInWithLinking,
signInWithRecovery,
} from './RegistrationStages';
import { RegistrationUserDetails } from './RegistrationUserDetails'; import { RegistrationUserDetails } from './RegistrationUserDetails';
import { TermsAndConditions } from './TermsAndConditions'; import { TermsAndConditions } from './TermsAndConditions';
@ -80,14 +85,14 @@ const SignInButtons = (props: {
<div> <div>
<RestoreUsingRecoveryPhraseButton onRecoveryButtonClicked={props.onRecoveryButtonClicked} /> <RestoreUsingRecoveryPhraseButton onRecoveryButtonClicked={props.onRecoveryButtonClicked} />
<SpacerLG /> <SpacerLG />
<div className="or">{window.i18n('or')}</div>
<SpacerLG />
<LinkDeviceButton onLinkDeviceButtonClicked={props.onLinkDeviceButtonClicked} /> <LinkDeviceButton onLinkDeviceButtonClicked={props.onLinkDeviceButtonClicked} />
</div> </div>
); );
}; };
export const SignInTab = () => { export const SignInTab = () => {
const { setRegistrationPhase } = useContext(RegistrationContext);
const [signInMode, setSignInMode] = useState(SignInMode.Default); const [signInMode, setSignInMode] = useState(SignInMode.Default);
const [recoveryPhrase, setRecoveryPhrase] = useState(''); const [recoveryPhrase, setRecoveryPhrase] = useState('');
const [recoveryPhraseError, setRecoveryPhraseError] = useState(undefined as string | undefined); const [recoveryPhraseError, setRecoveryPhraseError] = useState(undefined as string | undefined);
@ -153,12 +158,14 @@ export const SignInTab = () => {
<SignInButtons <SignInButtons
signInMode={signInMode} signInMode={signInMode}
onRecoveryButtonClicked={() => { onRecoveryButtonClicked={() => {
setRegistrationPhase(RegistrationPhase.SignIn);
setSignInMode(SignInMode.UsingRecoveryPhrase); setSignInMode(SignInMode.UsingRecoveryPhrase);
setRecoveryPhrase(''); setRecoveryPhrase('');
setDisplayName(''); setDisplayName('');
setIsLoading(false); setIsLoading(false);
}} }}
onLinkDeviceButtonClicked={() => { onLinkDeviceButtonClicked={() => {
setRegistrationPhase(RegistrationPhase.SignIn);
setSignInMode(SignInMode.LinkDevice); setSignInMode(SignInMode.LinkDevice);
setRecoveryPhrase(''); setRecoveryPhrase('');
setDisplayName(''); setDisplayName('');

View file

@ -1,7 +1,7 @@
import React, { useEffect, useState } from 'react'; import React, { useContext, useEffect, useState } from 'react';
import { SessionButton, SessionButtonColor, SessionButtonType } from '../SessionButton'; import { SessionButton, SessionButtonColor, SessionButtonType } from '../SessionButton';
import { SessionIdEditable } from '../SessionIdEditable'; import { SessionIdEditable } from '../SessionIdEditable';
import { signUp } from './RegistrationTabs'; import { RegistrationContext, RegistrationPhase, signUp } from './RegistrationStages';
import { RegistrationUserDetails } from './RegistrationUserDetails'; import { RegistrationUserDetails } from './RegistrationUserDetails';
import { TermsAndConditions } from './TermsAndConditions'; import { TermsAndConditions } from './TermsAndConditions';
@ -11,12 +11,6 @@ export enum SignUpMode {
EnterDetails, EnterDetails,
} }
export interface Props {
// tslint:disable: react-unused-props-and-state
generatedRecoveryPhrase: string;
hexGeneratedPubKey: string;
}
const CreateSessionIdButton = ({ createSessionID }: { createSessionID: any }) => { const CreateSessionIdButton = ({ createSessionID }: { createSessionID: any }) => {
return ( return (
<SessionButton <SessionButton
@ -40,10 +34,8 @@ const ContinueSignUpButton = ({ continueSignUp }: { continueSignUp: any }) => {
}; };
const SignUpDefault = (props: { createSessionID: () => void }) => { const SignUpDefault = (props: { createSessionID: () => void }) => {
const allUsersAreRandomly = window.i18n('allUsersAreRandomly...');
return ( return (
<div className="session-registration__content"> <div className="session-registration__content">
<div className="session-description-long">{allUsersAreRandomly}</div>
<CreateSessionIdButton createSessionID={props.createSessionID} /> <CreateSessionIdButton createSessionID={props.createSessionID} />
</div> </div>
); );
@ -55,23 +47,26 @@ const SignUpSessionIDShown = (props: { continueSignUp: () => void }) => {
<div className="session-registration__unique-session-id"> <div className="session-registration__unique-session-id">
{window.i18n('yourUniqueSessionID')} {window.i18n('yourUniqueSessionID')}
</div> </div>
<SessionIdEditable editable={false} placeholder={undefined} /> <SessionIdEditable editable={false} placeholder={undefined} />
<div className="session-description-long">{window.i18n('signupSessionIDBlurb')}</div>
<ContinueSignUpButton continueSignUp={props.continueSignUp} /> <ContinueSignUpButton continueSignUp={props.continueSignUp} />
<TermsAndConditions /> <TermsAndConditions />
</div> </div>
); );
}; };
export const SignUpTab = (props: Props) => { export const SignUpTab = () => {
const [signUpMode, setSignUpMode] = useState(SignUpMode.Default); const { setRegistrationPhase, generatedRecoveryPhrase, hexGeneratedPubKey } = useContext(
RegistrationContext
);
const [signUpMode, setSignUpMode] = useState(SignUpMode.Default);
const [displayName, setDisplayName] = useState(''); const [displayName, setDisplayName] = useState('');
const [displayNameError, setDisplayNameError] = useState(''); const [displayNameError, setDisplayNameError] = useState('');
useEffect(() => { useEffect(() => {
if (signUpMode === SignUpMode.SessionIDShown) { if (signUpMode === SignUpMode.SessionIDShown) {
window.Session.setNewSessionID(props.hexGeneratedPubKey); window.Session.setNewSessionID(hexGeneratedPubKey);
} }
}, [signUpMode]); }, [signUpMode]);
@ -80,6 +75,7 @@ export const SignUpTab = (props: Props) => {
<SignUpDefault <SignUpDefault
createSessionID={() => { createSessionID={() => {
setSignUpMode(SignUpMode.SessionIDShown); setSignUpMode(SignUpMode.SessionIDShown);
setRegistrationPhase(RegistrationPhase.SignUp);
}} }}
/> />
); );
@ -104,7 +100,7 @@ export const SignUpTab = (props: Props) => {
const signUpWithDetails = async () => { const signUpWithDetails = async () => {
await signUp({ await signUp({
displayName, displayName,
generatedRecoveryPhrase: props.generatedRecoveryPhrase, generatedRecoveryPhrase: generatedRecoveryPhrase,
}); });
}; };