openreplay/frontend/app/components/UsabilityTesting/TestOverview.tsx
2024-05-10 16:38:27 +02:00

516 lines
17 KiB
TypeScript

import { durationFormatted } from 'App/date';
import { numberWithCommas } from 'App/utils';
import { getPdf2 } from 'Components/AssistStats/pdfGenerator';
import { useModal } from 'Components/Modal';
import LiveTestsModal from 'Components/UsabilityTesting/LiveTestsModal';
import React from 'react';
import { Button, Typography, Select, Space, Popover, Dropdown } from 'antd';
import { withSiteId, usabilityTesting, usabilityTestingEdit } from 'App/routes';
import { useParams, useHistory } from 'react-router-dom';
import Breadcrumb from 'Shared/Breadcrumb';
import { observer } from 'mobx-react-lite';
import { useStore } from 'App/mstore';
import {
EditOutlined,
ShareAltOutlined,
ArrowRightOutlined,
MoreOutlined,
UserOutlined,
UserDeleteOutlined,
CheckCircleOutlined,
FastForwardOutlined,
// FilePdfOutlined,
DeleteOutlined,
ClockCircleOutlined
} from '@ant-design/icons';
import SessionItem from 'Shared/SessionItem';
import { CopyButton, Icon, Loader, NoContent, Pagination } from 'UI';
import { Stage, EmptyStage } from 'Components/Funnels/FunnelWidget/FunnelWidget';
import { confirm } from 'UI';
import ResponsesOverview from './ResponsesOverview';
import ParticipantOverviewItem from 'Components/UsabilityTesting/ParticipantOverview';
import { toast } from 'react-toastify';
const StatusItem = ({ iconName, color, text, size = "16" }: {
iconName: string;
color: string;
size: string;
text: string;
}) => (
<div className='flex items-center'>
<Icon name={iconName} color={color} size={size} />
<Typography.Text className='ml-2'>
{text}
</Typography.Text>
</div>
);
const statusItems = [
{
value: 'in-progress',
label: <StatusItem iconName='record-circle-fill' color='green' text='On Going' />
},
{
value: 'paused',
label: <StatusItem iconName='pause-circle-fill' color='orange-dark' text='Hold' />
},
{
value: 'closed',
label: <StatusItem iconName='check-circle-fill' color='gray-medium' text='Close' />
}
];
const colors = {
'in-progress': '#52c41a',
closed: '#bfbfbf',
paused: '#fa8c16',
preview: '#2f54eb'
};
const menuItems = [
// {
// key: '1',
// label: 'Download Results',
// icon: <FilePdfOutlined rev={undefined} />,
// },
{
key: '2',
label: 'Edit',
icon: <EditOutlined rev={undefined} />
},
{
key: '3',
label: 'Delete',
icon: <DeleteOutlined rev={undefined} />
}
];
function TestOverview() {
// @ts-ignore
const { siteId, testId } = useParams();
const { showModal, hideModal } = useModal();
const history = useHistory();
const { uxtestingStore } = useStore();
React.useEffect(() => {
const getData = async () => {
try {
await uxtestingStore.getTest(testId);
} catch {
history.push(withSiteId(usabilityTesting(), siteId));
}
};
void getData();
}, [testId, siteId]);
if (!uxtestingStore.instance) {
return <Loader loading={uxtestingStore.isLoading}>No data.</Loader>;
} else {
document.title = `Usability Tests | ${uxtestingStore.instance.title}`;
}
const onPageChange = (page: number) => {
uxtestingStore.setSessionsPage(page);
};
return (
<div className='w-full mx-auto' style={{ maxWidth: '1360px' }} id={'pdf-anchor'}>
<Breadcrumb
items={[
{
label: 'Usability Testing',
to: withSiteId(usabilityTesting(), siteId)
},
{
label: uxtestingStore.instance.title
}
]}
/>
<div className={'rounded border bg-white'}>
<Title testId={testId} siteId={siteId} />
{uxtestingStore.instance.liveCount ? (
<div className={'p-4 flex items-center gap-2'}>
<div className={'relative h-4 w-4'}>
<div className={'absolute w-4 h-4 animate-ping bg-green rounded-full opacity-75'} />
<div className={'absolute w-4 h-4 bg-green rounded-full'} />
</div>
<Typography.Text>
{uxtestingStore.instance.liveCount} participants are engaged in this usability test at
the moment.
</Typography.Text>
<Button
type={'primary'}
ghost
onClick={() => {
showModal(<LiveTestsModal closeModal={hideModal} testId={testId} />, {
right: true,
width: 900
});
}}
>
<Space align={'center'}>
Moderate Real-Time
<ArrowRightOutlined rev={undefined} />
</Space>
</Button>
</div>
) : null}
</div>
<ParticipantOverview />
<TaskSummary />
<div className={'mt-2 rounded border p-4 bg-white flex gap-2 items-center'}>
<Typography.Title style={{ marginBottom: 0 }} level={5}>
Open-ended task responses
</Typography.Title>
{uxtestingStore.instance.responsesCount ? (
<Button
type={'primary'}
ghost
disabled={uxtestingStore.instance.responsesCount === 0}
onClick={() => showModal(<ResponsesOverview />, { right: true, width: 900 })}
>
<Space align={'center'}>
Review All {uxtestingStore.instance.responsesCount} Responses
<ArrowRightOutlined rev={undefined} />
</Space>
</Button>
) : (
<Typography.Text>0 at the moment.</Typography.Text>
)}
</div>
<div className={'mt-2 rounded border p-4 bg-white flex gap-1 items-start flex-col'}>
<Typography.Title style={{ marginBottom: 0 }} level={5}>
Sessions
</Typography.Title>
{/*<Typography.Text>in your selection</Typography.Text>*/}
{/*<div className={'flex gap-1 link'}>clear selection</div>*/}
<div className={'flex flex-col w-full'}>
<Loader loading={uxtestingStore.isLoading}>
<NoContent show={uxtestingStore.testSessions.list.length == 0} title='No data'>
{uxtestingStore.testSessions.list.map((session) => (
// @ts-ignore
<SessionItem session={session} query={'?uxt=true'} />
))}
<div className={'flex items-center justify-between'}>
<div>
Showing{' '}
<span className='font-medium'>
{(uxtestingStore.testSessions.page - 1) * 10 + 1}
</span>{' '}
to{' '}
<span className='font-medium'>
{(uxtestingStore.page - 1) * 10 + uxtestingStore.testSessions.list.length}
</span>{' '}
of{' '}
<span className='font-medium'>
{numberWithCommas(uxtestingStore.testSessions.total)}
</span>{' '}
tests.
</div>
<Pagination
page={uxtestingStore.testSessions.page}
total={uxtestingStore.testSessions.total}
onPageChange={onPageChange}
limit={10}
debounceRequest={200}
/>
</div>
</NoContent>
</Loader>
</div>
</div>
</div>
);
}
const ParticipantOverview = observer(() => {
const { uxtestingStore } = useStore();
return (
<div className={'p-4 rounded border bg-white mt-2'}>
<Typography.Title level={5}>Participant Overview</Typography.Title>
{uxtestingStore.testStats ? (
<div className={'flex gap-4'}>
<ParticipantOverviewItem
titleRow={
<>
<UserOutlined style={{ fontSize: 18, color: '#394EFF' }} rev={undefined} />
<Typography.Text className='font-medium'>Total Participants</Typography.Text>
</>
}
firstNum={uxtestingStore.testStats.tests_attempts?.toString()}
/>
<ParticipantOverviewItem
titleRow={
<>
<CheckCircleOutlined style={{ fontSize: 18, color: '#389E0D' }} rev={undefined} />
<Typography.Text className='font-medium'>Completed all tasks</Typography.Text>
</>
}
firstNum={
uxtestingStore.testStats.tests_attempts > 0
? `${Math.round(
(uxtestingStore.testStats.completed_all_tasks /
uxtestingStore.testStats.tests_attempts) *
100
)}%`
: undefined
}
addedNum={uxtestingStore.testStats.completed_all_tasks.toString()}
/>
<ParticipantOverviewItem
titleRow={
<>
<FastForwardOutlined style={{ fontSize: 18, color: '#874D00' }} rev={undefined} />
<Typography.Text className='font-medium'>Skipped tasks</Typography.Text>
</>
}
firstNum={
uxtestingStore.testStats.tests_attempts > 0
? `${Math.round(
(uxtestingStore.testStats.tasks_skipped /
uxtestingStore.testStats.tests_attempts) *
100
)}%`
: undefined
}
addedNum={uxtestingStore.testStats.tasks_skipped.toString()}
/>
<ParticipantOverviewItem
titleRow={
<>
<UserDeleteOutlined style={{ fontSize: 18, color: '#CC0000' }} rev={undefined} />
<Typography.Text className='font-medium'>Aborted the test</Typography.Text>
</>
}
firstNum={
uxtestingStore.testStats.tests_attempts > 0
? `${Math.round(
(uxtestingStore.testStats.tests_skipped /
uxtestingStore.testStats.tests_attempts) *
100
)}%`
: undefined
}
addedNum={uxtestingStore.testStats.tests_skipped.toString()}
/>
</div>
) : null}
</div>
);
});
const TaskSummary = observer(() => {
const { uxtestingStore } = useStore();
const [showAll, setShowAll] = React.useState(false);
const totalAttempts = uxtestingStore.testStats?.tests_attempts ?? 0;
const shouldHide = uxtestingStore.taskStats.length > 5;
const shownTasks = shouldHide
? showAll
? uxtestingStore.taskStats
: uxtestingStore.taskStats.slice(0, 5)
: uxtestingStore.taskStats;
return (
<div className={'mt-2 rounded border p-4 bg-white'}>
<div className={'flex justify-between items-center mb-2'}>
<Typography.Title level={5}>Task Summary</Typography.Title>
{uxtestingStore.taskStats.length ? (
<div className={'p-2 rounded bg-teal-light flex items-center gap-1'}>
<Typography.Text>Average completion time of all tasks:</Typography.Text>
<Typography.Text strong>
{uxtestingStore.taskStats
? durationFormatted(
uxtestingStore.taskStats.reduce(
(stats, task) => stats + task.avgCompletionTime,
0
) / uxtestingStore.taskStats.length
)
: null}
</Typography.Text>
<ClockCircleOutlined rev={undefined} />
</div>
) : null}
</div>
{!uxtestingStore.taskStats.length ? <NoContent show title={'No data'} /> : null}
{shownTasks.map((tst, index) => (
<Stage
stage={{ ...tst, isActive: true, skipped: tst.skipped || totalAttempts - tst.completed }}
uxt
index={index + 1}
/>
))}
{shouldHide && !showAll ? (
<div className={'cursor-pointer'} onClick={() => setShowAll(true)}>
<EmptyStage total={uxtestingStore.taskStats.length - 5} />
</div>
) : null}
</div>
);
});
const Title = observer(({ testId, siteId }: any) => {
const [truncate, setTruncate] = React.useState(true);
const { uxtestingStore } = useStore();
const history = useHistory();
const handleChange = (value: string) => {
uxtestingStore.updateTestStatus(value);
switch (value) {
case 'in-progress':
toast.success('The usability test is now live and accessible to participants.');
break;
case 'paused':
toast.success(
'Usability test is on \'Hold\'—participant activity paused. Switch it to “ongoing” to resume activity.'
);
break;
case 'closed':
toast.success(
'The usability test has been marked as completed. All participant interactions are now finalized.'
);
break;
}
};
const onMenuClick = async ({ key }: any) => {
if (key === '1') {
void getPdf2();
}
if (key === '2') {
await redirectToEdit();
}
if (key === '3') {
if (
await confirm({
confirmation:
'Are you sure you want to delete this usability test? This action cannot be undone.'
})
) {
uxtestingStore.deleteTest(testId).then(() => {
history.push(withSiteId(usabilityTesting(), siteId));
});
}
}
};
if (!uxtestingStore.instance) {
return null;
}
const truncatedDescr = uxtestingStore.instance?.description &&
uxtestingStore.instance.description.length > 250 && truncate
? uxtestingStore.instance?.description.substring(0, 250) + '...'
: uxtestingStore.instance?.description;
const redirectToEdit = async () => {
const confirmationTitle =
uxtestingStore.instance!.status === 'in-progress'
? 'Editing Active Usability Test'
: 'Editing Test on Hold';
const confirmationStr =
uxtestingStore.instance!.status === 'in-progress'
? 'You\'re editing a test that\'s currently active. Please be aware that you can only modify the test title and objective. Editing test steps is not permitted to avoid confusion with existing responses. Proceed with caution! 🚧'
: 'This usability test is on hold. You can only update the title and descriptions. Task editing is not allowed to avoid confusion with existing responses.';
if (
await confirm({
header: confirmationTitle,
confirmation: confirmationStr,
confirmButton: 'Edit'
})
) {
history.push(withSiteId(usabilityTestingEdit(testId), siteId));
}
};
// @ts-ignore
const getColor = (status) => colors[status];
const isActive = ['in-progress', 'preview'].includes(uxtestingStore.instance!.status);
return (
<div className={'p-4 border-b'}>
<div className={'flex items-center gap-2'}>
<Typography.Title level={4}>{uxtestingStore.instance!.title}</Typography.Title>
<div className={'ml-auto'} />
<Select
value={uxtestingStore.instance!.status}
style={{ width: 150 }}
onChange={handleChange}
options={statusItems}
optionRender={(item) => (
<Space align={'center'}>
{item.label}
</Space>
)}
/>
<Button
disabled={uxtestingStore.instance!.status === 'closed'}
type={'primary'}
onClick={redirectToEdit}
>
<Space align={'center'}>
{uxtestingStore.instance!.tasks.length} Tasks <EditOutlined rev={undefined} />{' '}
</Space>
</Button>
{isActive ?
<Popover
trigger={'click'}
title={'Participants Link'}
content={
<div style={{ width: '220px' }}>
<div className={'text-disabled-text text-sm'}>
Distribute following link via email or other methods to share the survey with test
participants.
</div>
<div
style={{ background: '#E4F6F6' }}
className={'p-2 rounded border shadow break-all my-2'}
>
{`${uxtestingStore.instance!.startingPath}?oruxt=${
uxtestingStore.instance!.testId
}`}
</div>
<CopyButton
variant={'outline'}
content={`${uxtestingStore.instance!.startingPath}?oruxt=${
uxtestingStore.instance!.testId
}`}
/>
</div>
}
>
<Button type={'primary'} ghost>
<Space align={'center'}>
Distribute
<ShareAltOutlined rev={undefined} />
</Space>
</Button>
</Popover>
: null}
<Dropdown
menu={{
items:
uxtestingStore.instance!.status === 'closed'
? menuItems.filter((i) => i.label !== 'Edit')
: menuItems,
onClick: onMenuClick
}}
>
<Button icon={<MoreOutlined rev={undefined} />}></Button>
</Dropdown>
</div>
<div className={'whitespace-pre-wrap mt-2'}>{truncatedDescr}</div>
{uxtestingStore.instance?.description && uxtestingStore.instance.description.length > 250 ? (
<div className={'link'} onClick={() => setTruncate(!truncate)}>
{truncate ? 'Show more' : 'Show less'}
</div>
) : null}
</div>
);
});
export default observer(TestOverview);