Merge pull request #7552 from Automattic/fix/highlight-not-removed-tour

Fix highlight not removed after closing tour
Automattic · Mar 20, 2024 · e8cf694 · e8cf694
2 parents f813af2 + 106c6a7
commit e8cf694
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/assets/admin/tour/components/sensei-tour-kit/index.js b/assets/admin/tour/components/sensei-tour-kit/index.js
@@ -66,7 +66,10 @@ function SenseiTourKit( {
 
 	const config = {
 		steps,
-		closeHandler: () => setTourShowStatus( false, true, tourName ),
+		closeHandler: () => {
+			removeHighlightClasses();
+			setTourShowStatus( false, true, tourName );
+		},
 		options: {
 			effects: {
 				spotlight: null,

diff --git a/assets/admin/tour/components/sensei-tour-kit/index.test.js b/assets/admin/tour/components/sensei-tour-kit/index.test.js
@@ -3,6 +3,7 @@
  */
 import SenseiTourKit from './index';
 import getTourSteps from '../../course-tour/steps';
+import { removeHighlightClasses } from '../../helper';
 /**
  * External dependencies
  */
@@ -26,6 +27,8 @@ jest.mock( '@wordpress/data', () => ( {
 	useSelect: jest.fn().mockImplementation( () => ( {} ) ),
 } ) );
 
+jest.mock( '../../helper' );
+
 const mockFunction = jest.fn();
 
 describe( 'SenseiTourKit', () => {
@@ -105,6 +108,9 @@ describe( 'SenseiTourKit', () => {
 
 	test( 'should close the tour when closeHandler is called', () => {
 		const setTourShowStatus = jest.fn();
+		const removeHighlight = jest.fn();
+
+		removeHighlightClasses.mockImplementation( removeHighlight );
 
 		useDispatch.mockReturnValue( { setTourShowStatus } );
 
@@ -119,6 +125,7 @@ describe( 'SenseiTourKit', () => {
 			true,
 			'test-tour'
 		);
+		expect( removeHighlight ).toHaveBeenCalled();
 	} );
 
 	test( 'should call the event log function when step is viewed', () => {