Merge pull request #489 from ProgressPlanner/filip/v15/tour-fix

Remove tour steps for Settings popover

Author: aristath

assets/js/tour.js

@@ -37,18 +37,10 @@ const prplDriverObj = prplDriver( {
 		popover, // eslint-disable-line no-unused-vars
 		{ config, state } // eslint-disable-line no-unused-vars
 	) => {
-		const settingsPopover = document.getElementById(
-			'prpl-popover-settings'
-		);
 		const monthlyBadgesPopover = document.getElementById(
 			'prpl-popover-monthly-badges'
 		);
-
-		if ( state.activeIndex === 4 ) {
-			prplTourShowPopover( settingsPopover );
-		}
-
-		if ( state.activeIndex === 7 ) {
+		if ( state.activeIndex === 5 ) {
 			prplTourShowPopover( monthlyBadgesPopover );
 		}
 
@@ -85,25 +77,16 @@ function prplMakePopoverBackdropTransparent( popover ) {
 
 // eslint-disable-next-line no-unused-vars -- This is called on a few buttons.
 function prplStartTour() {
-	const settingsPopover = document.getElementById( 'prpl-popover-settings' );
 	const monthlyBadgesPopover = document.getElementById(
 		'prpl-popover-monthly-badges'
 	);
 	const progressPlannerTourSteps = progressPlannerTour.steps;
-	progressPlannerTourSteps[ 3 ].popover.onNextClick = function () {
-		prplTourShowPopover( settingsPopover );
-		prplDriverObj.moveNext();
-	};
-	progressPlannerTourSteps[ 4 ].popover.onNextClick = function () {
-		prplTourHidePopover( settingsPopover );
-		prplDriverObj.moveNext();
-	};
 
-	progressPlannerTourSteps[ 6 ].popover.onNextClick = function () {
+	progressPlannerTourSteps[ 4 ].popover.onNextClick = function () {
 		prplTourShowPopover( monthlyBadgesPopover );
 		prplDriverObj.moveNext();
 	};
-	progressPlannerTourSteps[ 7 ].popover.onNextClick = function () {
+	progressPlannerTourSteps[ 5 ].popover.onNextClick = function () {
 		prplTourHidePopover( monthlyBadgesPopover );
 		prplDriverObj.moveNext();
 	};

classes/admin/class-tour.php

@@ -53,24 +53,6 @@ public function get_steps() {
 					'align'       => 'center',
 				],
 			],
-			[
-				'element' => '#prpl-popover-settings-trigger',
-				'popover' => [
-					'title'       => \esc_html__( 'Settings', 'progress-planner' ),
-					'description' => \esc_html__( 'With this button you can open the settings. Here you can determine which post types you want to include in your activity score.', 'progress-planner' ),
-					'side'        => 'top',
-					'align'       => 'center',
-				],
-			],
-			[
-				'element' => '#prpl-popover-settings',
-				'popover' => [
-					'title'       => \esc_html__( 'Post types', 'progress-planner' ),
-					'description' => \esc_html__( 'Simply select the post types you want to include in your activity score and hit save.', 'progress-planner' ),
-					'side'        => 'top',
-					'align'       => 'center',
-				],
-			],
 			[
 				'element' => '.prpl-widget-wrapper.prpl-todo',
 				'popover' => [

tests/e2e/auth.setup.js

@@ -12,10 +12,16 @@ async function cleanup() {
 	}
 }
 
+// Handle async cleanup properly
+async function handleCleanup() {
+	await cleanup();
+	process.exit( 0 );
+}
+
 // Register cleanup on process exit
-// process.on( 'exit', cleanup ); // it gets triggered between sequential & parallel tests
-process.on( 'SIGINT', cleanup );
-process.on( 'SIGTERM', cleanup );
+process.on( 'exit', () => cleanup() ); // exit event doesn't support async, it gets triggered between sequential & parallel tests
+process.on( 'SIGINT', () => handleCleanup() );
+process.on( 'SIGTERM', () => handleCleanup() );
 
 async function globalSetup() {
 	const authFile = path.join( process.cwd(), 'auth.json' );

tests/e2e/tour.spec.js

@@ -13,7 +13,34 @@ test.describe( 'PRPL Tour', () => {
 		await tourButton.click();
 
 		// Wait for and verify the tour popover is visible
-		const tourPopover = page.locator( '.driver-popover' );
+		let tourPopover = page.locator( '.driver-popover' );
 		await expect( tourPopover ).toBeVisible();
+
+		// Get the number of steps from the window object
+		const numberOfSteps = await page.evaluate(
+			() => window.progressPlannerTour.steps.length
+		);
+
+		for ( let i = 0; i < numberOfSteps - 1; i++ ) {
+			tourPopover = page.locator( '.driver-popover' );
+
+			// Wait for the popover to be visible before interacting
+			await expect( tourPopover ).toBeVisible();
+
+			// Click the "Next" button if it's not the last step
+			if ( i < numberOfSteps - 1 ) {
+				const nextButton = page.locator( '.driver-popover-next-btn' );
+				await nextButton.click();
+			}
+		}
+
+		const nextButton = page.locator( '.driver-popover-next-btn' );
+
+		// Verify the button text changes to "Finish" on the last step
+		await expect( nextButton ).toHaveText( 'Finish' );
+
+		// Click the finish button and verify the tour popover closes
+		await nextButton.click();
+		await expect( tourPopover ).not.toBeVisible();
 	} );
 } );