8854429551

Committed 26 Apr 2024 09:20PM UTC coverage: 31.974% (+0.003%) from 31.971%

Build # 8854429551

Build Type

Pull #9190

github

Committed by

Stvad

Commit Message

Generalize OnboardingFlow and introduce BasicOnboardingFlow for non-EA forums #to-upstream

Pull Request Pull Request #9190: Generalize OnboardingFlow and introduce BasicOnboardingFlow for non-EA forums #to-upstream

Run Details

4709 of 38479 branches covered (12.24%)

Branch coverage included in aggregate %.

17 of 32 new or added lines in 5 files covered. (53.13%)

1 existing line in 1 file now uncovered.

27509 of 62285 relevant lines covered (44.17%)

180.02 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

24.14

/packages/lesswrong/components/onboarding/OnboardingFlow.tsx

import React, {ReactNode, useCallback, useEffect, useState} from 'react'
import {Components, registerComponent} from '../../lib/vulcan-lib'
import {useCurrentUser} from '../common/withUser'
import {EAOnboardingContextProvider} from '../ea-forum/onboarding/useEAOnboarding'

const styles = (_theme: ThemeType) => ({
  root: {
    padding: 0,
  },
})

const OnboardingFlow = ({stages, viewAsAdmin, classes}: {
  stages: Record<string, ReactNode>,
  // if viewAsAdmin is true, this is an admin testing out the flow, so don't update their account
  viewAsAdmin?: boolean,
  classes: ClassesType<typeof styles>,
}) => {
  const currentUser = useCurrentUser()

  // If `usernameUnset` is true, then we need to show the onboarding flow.
  // We cache the value in a `useState` as it gets set to false in the very
  // first stage (which is the only compulsary stage) - without caching the
  // value this would close the popup.
  const [isOnboarding, setIsOnboarding] = useState(currentUser?.usernameUnset || viewAsAdmin)

  useEffect(() => {
    // Set `isOnboarding` to true after a new user signs up.
    setIsOnboarding((currentValue) => currentValue || currentUser?.usernameUnset)
  }, [currentUser?.usernameUnset])

  const onOnboardingComplete = useCallback(() => {
    setIsOnboarding(false)
  }, [])

  if (!isOnboarding) {
    return null
  }

  const {BlurredBackgroundModal} = Components
  return (
    <BlurredBackgroundModal open className={classes.root}>
      <EAOnboardingContextProvider stages={stages} onOnboardingComplete={onOnboardingComplete} viewAsAdmin={viewAsAdmin}/>
    </BlurredBackgroundModal>
  )
}

const OnboardingFlowComponent = registerComponent(
  'OnboardingFlow',
  OnboardingFlow,
  {styles},
)

declare global {
  interface ComponentTypes {
    OnboardingFlow: typeof OnboardingFlowComponent
  }
}

1	import React, {ReactNode, useCallback, useEffect, useState} from 'react'	1✔
2	import {Components, registerComponent} from '../../lib/vulcan-lib'	1✔
3	import {useCurrentUser} from '../common/withUser'	1✔
4	import {EAOnboardingContextProvider} from '../ea-forum/onboarding/useEAOnboarding'	1✔
5
6	const styles = (_theme: ThemeType) => ({	1✔
7	root: {
8	padding: 0,
9	},
10	})
11
12	const OnboardingFlow = ({stages, viewAsAdmin, classes}: {	1✔
13	stages: Record<string, ReactNode>,
14	// if viewAsAdmin is true, this is an admin testing out the flow, so don't update their account
15	viewAsAdmin?: boolean,
16	classes: ClassesType<typeof styles>,
17	}) => {
NEW 18	const currentUser = useCurrentUser()	×
19
20	// If `usernameUnset` is true, then we need to show the onboarding flow.
21	// We cache the value in a `useState` as it gets set to false in the very
22	// first stage (which is the only compulsary stage) - without caching the
23	// value this would close the popup.
NEW 24	const [isOnboarding, setIsOnboarding] = useState(currentUser?.usernameUnset \|\| viewAsAdmin)	×
25
NEW 26	useEffect(() => {	×
27	// Set `isOnboarding` to true after a new user signs up.
NEW 28	setIsOnboarding((currentValue) => currentValue \|\| currentUser?.usernameUnset)	×
29	}, [currentUser?.usernameUnset])	×
30
NEW 31	const onOnboardingComplete = useCallback(() => {	×
NEW 32	setIsOnboarding(false)	×
33	}, [])
34
NEW 35	if (!isOnboarding) {	×
NEW 36	return null	×
37	}
38
NEW 39	const {BlurredBackgroundModal} = Components	×
NEW 40	return (	×
41	<BlurredBackgroundModal open className={classes.root}>
42	<EAOnboardingContextProvider stages={stages} onOnboardingComplete={onOnboardingComplete} viewAsAdmin={viewAsAdmin}/>
43	</BlurredBackgroundModal>
44	)
45	}
46
47	const OnboardingFlowComponent = registerComponent(	1✔
48	'OnboardingFlow',
49	OnboardingFlow,
50	{styles},
51	)
52
53	declare global {
54	interface ComponentTypes {
55	OnboardingFlow: typeof OnboardingFlowComponent
56	}
57	}

ForumMagnum / ForumMagnum / 8854429551

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous