wp-calypso/packages/command-palette/test/use-command-palette.tsx

/**
 * @jest-environment jsdom
 */
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { renderHook } from '@testing-library/react';
import React from 'react';
import { CommandPaletteContext, CommandPaletteContextProvider } from '../src/context';
import { useCommandPalette } from '../src/use-command-palette';

const callback = () => {};

const defaultCommands = [
	{
		callback,
		name: 'getHelp',
		label: 'Get help',
	},
	{
		callback,
		name: 'clearCache',
		label: 'Clear cache',
	},
	{
		callback,
		name: 'enableEdgeCache',
		label: 'Enable edge cache',
	},
];

const commandsWithViewMySite = [
	{
		callback,
		name: 'getHelp',
		label: 'Get help',
	},
	{
		callback,
		name: 'clearCache',
		label: 'Clear cache',
	},
	{
		callback,
		name: 'viewMySites',
		label: 'View my sites',
	},
	{
		callback,
		name: 'enableEdgeCache',
		label: 'Enable edge cache',
	},
];

const commandsWithViewMySiteResult = [
	{
		name: 'viewMySites',
		label: 'View my sites',
	},
	{
		name: 'getHelp',
		label: 'Get help',
	},
	{
		name: 'clearCache',
		label: 'Clear cache',
	},
	{
		name: 'enableEdgeCache',
		label: 'Enable edge cache',
	},
];

const commandsWithContext = [
	{
		callback,
		name: 'getHelp',
		label: 'Get help',
		context: [ '/sites' ],
	},
	{
		callback,
		name: 'clearCache',
		label: 'Clear cache',
		context: [ '/sites' ],
	},
	{
		callback,
		name: 'enableEdgeCache',
		label: 'Enable edge cache',
		context: [ '/settings' ],
	},
];

const commandsWithContextResult = [
	{
		name: 'enableEdgeCache',
		label: 'Enable edge cache',
		context: [ '/settings' ],
	},
	{
		name: 'getHelp',
		label: 'Get help',
		context: [ '/sites' ],
	},
	{
		name: 'clearCache',
		label: 'Clear cache',
		context: [ '/sites' ],
	},
];

jest.mock( 'cmdk', () => ( {
	useCommandState: jest.fn(),
} ) );

describe( 'useCommandPalette', () => {
	const queryClient = new QueryClient();

	const renderUseCommandPalette = ( {
		currentRoute = null,
		commands,
	}: {
		currentRoute?: CommandPaletteContext[ 'currentRoute' ];
		commands: ReturnType< CommandPaletteContext[ 'useCommands' ] >;
	} ) =>
		renderHook( () => useCommandPalette(), {
			wrapper: ( { children } ) => (
				<QueryClientProvider client={ queryClient }>
					<CommandPaletteContextProvider
						currentRoute={ currentRoute }
						currentSiteId={ 1 }
						navigate={ () => {} }
						useCommands={ () => commands }
						userCapabilities={ {} }
						useSites={ () => [] }
						emptyListNotice=""
						placeHolderOverride=""
						search=""
						selectedCommandName=""
						setEmptyListNotice={ () => {} }
						setFooterMessage={ () => {} }
						setSelectedCommandName={ () => {} }
						close={ () => {} }
						setSearch={ () => {} }
						setPlaceholderOverride={ () => {} }
					>
						{ children }
					</CommandPaletteContextProvider>
				</QueryClientProvider>
			),
		} );
	it( 'should return the commands in the order that they are added to the commands array with no change', () => {
		const { result } = renderUseCommandPalette( { commands: defaultCommands } );
		expect(
			result.current.commands.map( ( { name, label } ) => ( { callback, name, label } ) )
		).toEqual( defaultCommands );
	} );

	it( 'should return the View My Sites command first before other commands from commandsWithViewMySite array when no context is specified', () => {
		const { result } = renderUseCommandPalette( { commands: commandsWithViewMySite } );

		expect( result.current.commands.map( ( { name, label } ) => ( { name, label } ) ) ).toEqual(
			commandsWithViewMySiteResult
		);
	} );

	it( 'should return Enable Edge Cache command first as it matches the context; all other commands should follow in the order they are added to commandsWithContext array', () => {
		const { result } = renderUseCommandPalette( {
			currentRoute: '/settings',
			commands: commandsWithContext,
		} );
		expect(
			result.current.commands.map( ( { name, label, context } ) => ( { name, label, context } ) )
		).toEqual( commandsWithContextResult );
	} );
} );