woocommerce/plugins/woocommerce-admin/client/tasks/test/tasks.test.tsx

226 lines
5.8 KiB
TypeScript
Raw Normal View History

/**
* External dependencies
*/
import { render, act, cleanup, waitFor } from '@testing-library/react';
import { useDispatch, useSelect } from '@wordpress/data';
import { recordEvent } from '@woocommerce/tracks';
import userEvent from '@testing-library/user-event';
/**
* Internal dependencies
*/
import { Tasks } from '../tasks';
2022-04-20 08:48:53 +00:00
import { TaskProps } from '../task';
import { TaskListProps } from '../task-list';
import { TaskListProps as TwoColumnTaskListProps } from '../../two-column-tasks/task-list';
2022-03-21 10:32:40 +00:00
jest.mock( '@wordpress/data', () => {
// Require the original module to not be mocked...
const originalModule = jest.requireActual( '@wordpress/data' );
return {
__esModule: true, // Use it when dealing with esModules
...originalModule,
useDispatch: jest.fn().mockReturnValue( {} ),
useSelect: jest.fn().mockReturnValue( {} ),
};
} );
jest.mock( '@woocommerce/explat' );
jest.mock( '@woocommerce/tracks' );
2022-04-04 19:43:15 +00:00
jest.mock( '../task-list', () => ( {
2022-04-20 08:48:53 +00:00
TaskList: ( { id }: TaskListProps ) => <div>task-list:{ id }</div>,
2022-04-04 19:43:15 +00:00
} ) );
jest.mock( '../../two-column-tasks/task-list', () => ( {
2022-04-20 08:48:53 +00:00
TaskList: ( { id }: TwoColumnTaskListProps ) => (
<div>two-column-list:{ id }</div>
),
2022-04-04 19:43:15 +00:00
} ) );
jest.mock( '../task', () => ( {
2022-04-20 08:48:53 +00:00
Task: ( { query }: TaskProps ) => <div>task:{ query.task }</div>,
} ) );
jest.mock( '../placeholder', () => ( {
TasksPlaceholder: () => <div>task-placeholder</div>,
} ) );
jest.mock( '~/activity-panel/display-options', () => ( {
2022-04-20 08:48:53 +00:00
DisplayOption: ( { children }: { children: React.ReactNode } ) => (
<div>{ children } </div>
),
} ) );
describe( 'Task', () => {
const hideTaskList = jest.fn();
const updateOptions = jest.fn();
beforeEach( () => {
jest.clearAllMocks();
( useDispatch as jest.Mock ).mockImplementation( () => ( {
hideTaskList,
updateOptions,
} ) );
( useSelect as jest.Mock ).mockImplementation( () => ( {
isResolving: false,
taskLists: [
{
id: 'main',
eventPrefix: 'main_tasklist_',
isVisible: true,
tasks: [ { id: 'main-task-1' }, { id: 'main-task-2' } ],
},
{ id: 'extended', isVisible: true, tasks: [] },
],
} ) );
} );
afterEach( () => {
cleanup();
} );
it( 'should render if no current task and finished resolving', () => {
const { queryByText } = render(
<div>
<Tasks query={ {} } />
</div>
);
waitFor( () => {
expect( queryByText( 'task-list:main' ) ).toBeInTheDocument();
expect( queryByText( 'task-list:extended' ) ).toBeInTheDocument();
expect(
queryByText( 'two-column-list:setup' )
).not.toBeInTheDocument();
} );
} );
it( 'should render the task component if query has an existing task', () => {
const { queryByText } = render(
<div>
<Tasks query={ { task: 'main-task-1' } } />
</div>
);
expect( queryByText( 'task:main-task-1' ) ).toBeInTheDocument();
} );
it( 'should not render anything if query has task, but task does not exist', () => {
const { queryByText } = render(
<div>
<Tasks query={ { task: 'main-task-random' } } />
</div>
);
expect(
queryByText( 'task:main-task-random' )
).not.toBeInTheDocument();
expect( queryByText( 'task-list:main' ) ).not.toBeInTheDocument();
} );
it( 'should render the placeholder if isResolving is true', () => {
( useSelect as jest.Mock ).mockImplementation( () => ( {
isResolving: true,
} ) );
const { queryByText } = render(
<div>
<Tasks query={ {} } />
</div>
);
expect( queryByText( 'task-placeholder' ) ).toBeInTheDocument();
} );
it( 'should show a menu item with Show things to do next if task list has isToggleable set to true', () => {
( useSelect as jest.Mock ).mockImplementation( () => ( {
isResolving: false,
taskLists: [
{
id: 'main',
eventPrefix: 'main_tasklist_',
isVisible: true,
isToggleable: true,
isHidden: false,
tasks: [ { id: 'main-task-1' }, { id: 'main-task-2' } ],
},
],
} ) );
const { queryByText } = render(
<div>
<Tasks query={ {} } />
</div>
);
expect( queryByText( 'Show things to do next' ) ).toBeInTheDocument();
} );
it( 'should class updateOptions with default data on render', () => {
render(
<div>
<Tasks query={ {} } />
</div>
);
waitFor( () => {
expect( updateOptions ).toHaveBeenCalledWith( {
woocommerce_task_list_prompt_shown: true,
} );
} );
} );
describe( 'toggle list', () => {
it( 'should trigger hide track when clicking Show things to do next button', () => {
( useSelect as jest.Mock ).mockImplementation( () => ( {
isResolving: false,
taskLists: [
{
id: 'main',
eventPrefix: 'main_tasklist_',
isVisible: true,
isToggleable: true,
isHidden: false,
tasks: [ { id: 'main-task-1' }, { id: 'main-task-2' } ],
},
],
} ) );
const { getByText } = render(
<div>
<Tasks query={ {} } />
</div>
);
act( () => {
userEvent.click( getByText( 'Show things to do next' ) );
} );
expect( recordEvent ).toHaveBeenCalledWith(
'main_tasklist_hide',
{}
);
expect( hideTaskList ).toHaveBeenCalledWith( 'main' );
} );
it( 'should trigger show track when toggling task list when isHidden was true', () => {
( useSelect as jest.Mock ).mockImplementation( () => ( {
isResolving: false,
taskLists: [
{
id: 'main',
eventPrefix: 'main_tasklist_',
isVisible: true,
isToggleable: true,
isHidden: true,
tasks: [ { id: 'main-task-1' }, { id: 'main-task-2' } ],
},
],
} ) );
const { getByText } = render(
<div>
<Tasks query={ {} } />
</div>
);
act( () => {
userEvent.click( getByText( 'Show things to do next' ) );
} );
expect( recordEvent ).toHaveBeenCalledWith(
'main_tasklist_show',
{}
);
expect( hideTaskList ).toHaveBeenCalledWith( 'main' );
} );
} );
} );