woocommerce/plugins/woocommerce-admin/client/task-list/index.js

/**
 * External dependencies
 */
import { __ } from '@wordpress/i18n';
import { MenuGroup, MenuItem } from '@wordpress/components';
import { check } from '@wordpress/icons';
import { useState, useEffect } from '@wordpress/element';
import { useDispatch, useSelect } from '@wordpress/data';
import {
	ONBOARDING_STORE_NAME,
	OPTIONS_STORE_NAME,
	PLUGINS_STORE_NAME,
	SETTINGS_STORE_NAME,
} from '@woocommerce/data';
import { useExperiment } from '@woocommerce/explat';
import { recordEvent } from '@woocommerce/tracks';
import { ScrollTo } from '@woocommerce/components';

/**
 * Internal dependencies
 */
import './style.scss';
import CartModal from '../dashboard/components/cart-modal';
import { getAllTasks, taskSort } from './tasks';
import { getCountryCode } from '../dashboard/utils';
import TaskList from './task-list';
import { DisplayOption } from '../header/activity-panel/display-options';
import { TaskStep } from './task-step';
import TaskListPlaceholder from './placeholder';

const taskDashboardSelect = ( select ) => {
	const { getProfileItems, getTasksStatus } = select( ONBOARDING_STORE_NAME );
	const { getSettings } = select( SETTINGS_STORE_NAME );
	const { getOption } = select( OPTIONS_STORE_NAME );
	const {
		getActivePlugins,
		getInstalledPlugins,
		isJetpackConnected,
	} = select( PLUGINS_STORE_NAME );
	const profileItems = getProfileItems();

	const trackedCompletedTasks =
		getOption( 'woocommerce_task_list_tracked_completed_tasks' ) || [];

	const { general: generalSettings = {} } = getSettings( 'general' );
	const countryCode = getCountryCode(
		generalSettings.woocommerce_default_country
	);
	const {
		woocommerce_store_address: storeAddress,
		woocommerce_default_country: defaultCountry,
		woocommerce_store_postcode: storePostCode,
	} = generalSettings;
	const hasCompleteAddress = Boolean(
		storeAddress && defaultCountry && storePostCode
	);

	const activePlugins = getActivePlugins();
	const installedPlugins = getInstalledPlugins();
	const onboardingStatus = getTasksStatus();

	return {
		activePlugins,
		countryCode,
		dismissedTasks: getOption( 'woocommerce_task_list_dismissed_tasks' ),
		remindMeLaterTasks: getOption(
			'woocommerce_task_list_remind_me_later_tasks'
		),
		isExtendedTaskListComplete:
			getOption( 'woocommerce_extended_task_list_complete' ) === 'yes',
		isExtendedTaskListHidden:
			getOption( 'woocommerce_extended_task_list_hidden' ) === 'yes',
		isJetpackConnected: isJetpackConnected(),
		isSetupTaskListHidden:
			getOption( 'woocommerce_task_list_hidden' ) === 'yes',
		isTaskListComplete:
			getOption( 'woocommerce_task_list_complete' ) === 'yes',
		installedPlugins,
		onboardingStatus,
		profileItems,
		trackedCompletedTasks,
		hasCompleteAddress,
	};
};

const TaskDashboard = ( { userPreferences, query } ) => {
	const { createNotice } = useDispatch( 'core/notices' );
	const { updateOptions } = useDispatch( OPTIONS_STORE_NAME );
	const { installAndActivatePlugins } = useDispatch( PLUGINS_STORE_NAME );
	const {
		trackedCompletedTasks,
		activePlugins,
		countryCode,
		installedPlugins,
		isJetpackConnected,
		onboardingStatus,
		profileItems,
		isSetupTaskListHidden,
		dismissedTasks,
		remindMeLaterTasks,
		isTaskListComplete,
		isExtendedTaskListHidden,
		isExtendedTaskListComplete,
		hasCompleteAddress,
	} = useSelect( taskDashboardSelect );

	const [ isCartModalOpen, setIsCartModalOpen ] = useState( false );
	const [ isLoadingExperiment, experimentAssignment ] = useExperiment(
		'woocommerce_tasklist_progression'
	);

	useEffect( () => {
		document.body.classList.add( 'woocommerce-onboarding' );
		document.body.classList.add( 'woocommerce-task-dashboard__body' );
	}, [] );

	const getTaskStartedCount = ( taskName ) => {
		const trackedStartedTasks =
			userPreferences.task_list_tracked_started_tasks;
		if ( ! trackedStartedTasks || ! trackedStartedTasks[ taskName ] ) {
			return 0;
		}
		return trackedStartedTasks[ taskName ];
	};

	const updateTrackStartedCount = ( taskName, newCount ) => {
		const trackedStartedTasks =
			userPreferences.task_list_tracked_started_tasks || {};
		userPreferences.updateUserPreferences( {
			task_list_tracked_started_tasks: {
				...( trackedStartedTasks || {} ),
				[ taskName ]: newCount,
			},
		} );
	};

	const isTaskCompleted = ( taskName ) => {
		if ( ! trackedCompletedTasks ) {
			return false;
		}
		return trackedCompletedTasks.includes( taskName );
	};

	const onTaskSelect = ( taskName ) => {
		const trackStartedCount = getTaskStartedCount( taskName );
		recordEvent( 'tasklist_click', {
			task_name: taskName,
		} );
		if ( ! isTaskCompleted( taskName ) ) {
			updateTrackStartedCount( taskName, trackStartedCount + 1 );
		}
	};

	const toggleExtensionTaskList = () => {
		const newValue = ! isExtendedTaskListHidden;

		recordEvent(
			newValue ? 'extended_tasklist_hide' : 'extended_tasklist_show'
		);
		updateOptions( {
			woocommerce_extended_task_list_hidden: newValue ? 'yes' : 'no',
		} );
	};

	const toggleCartModal = () => {
		if ( ! isCartModalOpen ) {
			recordEvent( 'tasklist_purchase_extensions' );
		}

		setIsCartModalOpen( ! isCartModalOpen );
	};

	const getCurrentTask = ( tasks ) => {
		const { task } = query;
		const currentTask = tasks.find( ( s ) => s.key === task );

		if ( ! currentTask ) {
			return null;
		}

		return currentTask;
	};

	const getExtendedTaskList = ( extensionTasks ) => {
		return (
			<TaskList
				name="extended_task_list"
				eventName="extended_tasklist"
				collapsible
				dismissedTasks={ dismissedTasks || [] }
				remindMeLaterTasks={ remindMeLaterTasks || [] }
				isComplete={ isExtendedTaskListComplete }
				query={ query }
				tasks={ extensionTasks }
				title={ __( 'Things to do next', 'woocommerce-admin' ) }
				trackedCompletedTasks={ trackedCompletedTasks || [] }
			/>
		);
	};

	const allTasks = getAllTasks( {
		activePlugins,
		countryCode,
		createNotice,
		installAndActivatePlugins,
		installedPlugins,
		isJetpackConnected,
		onboardingStatus,
		profileItems,
		query,
		toggleCartModal,
		onTaskSelect,
		hasCompleteAddress,
	} );

	const { extension, setup: setupTasks } = allTasks;
	const { task } = query;

	const extensionTasks =
		Array.isArray( extension ) && extension.sort( taskSort );

	const currentTask = getCurrentTask( [
		...( extensionTasks || [] ),
		...( setupTasks || [] ),
	] );

	if ( task && ! currentTask ) {
		return null;
	}
	if ( currentTask ) {
		return (
			<TaskStep taskContainer={ currentTask.container } query={ query } />
		);
	}

	const scrollToExtendedList =
		window.location.hash.substr( 1 ) === 'extended_task_list';

	return (
		<>
			{ setupTasks &&
				( ! isSetupTaskListHidden || task ) &&
				( isLoadingExperiment ? (
					<TaskListPlaceholder />
				) : (
					<TaskList
						name="task_list"
						eventName="tasklist"
						expandingItems={
							experimentAssignment?.variationName === 'treatment'
						}
						dismissedTasks={ dismissedTasks || [] }
						remindMeLaterTasks={ remindMeLaterTasks || [] }
						isComplete={ isTaskListComplete }
						query={ query }
						tasks={ setupTasks }
						title={ __(
							'Get ready to start selling',
							'woocommerce-admin'
						) }
						trackedCompletedTasks={ trackedCompletedTasks || [] }
						onComplete={ () =>
							updateOptions( {
								woocommerce_default_homepage_layout:
									'two_columns',
							} )
						}
						onHide={ () =>
							updateOptions( {
								woocommerce_task_list_prompt_shown: true,
								woocommerce_default_homepage_layout:
									'two_columns',
							} )
						}
					/>
				) ) }
			{ extensionTasks && (
				<DisplayOption>
					<MenuGroup
						className="woocommerce-layout__homescreen-display-options"
						label={ __( 'Display', 'woocommerce-admin' ) }
					>
						<MenuItem
							className="woocommerce-layout__homescreen-extension-tasklist-toggle"
							icon={ ! isExtendedTaskListHidden && check }
							isSelected={ ! isExtendedTaskListHidden }
							role="menuitemcheckbox"
							onClick={ toggleExtensionTaskList }
						>
							{ __(
								'Show things to do next',
								'woocommerce-admin'
							) }
						</MenuItem>
					</MenuGroup>
				</DisplayOption>
			) }
			{ extensionTasks &&
				! isExtendedTaskListHidden &&
				( scrollToExtendedList ? (
					<ScrollTo offset="-20">
						{ getExtendedTaskList( extensionTasks ) }
					</ScrollTo>
				) : (
					getExtendedTaskList( extensionTasks )
				) ) }
			{ isCartModalOpen && (
				<CartModal
					onClose={ () => toggleCartModal() }
					onClickPurchaseLater={ () => toggleCartModal() }
				/>
			) }
		</>
	);
};

export default TaskDashboard;