Ensure e2e tests configure Optimized Checkout correctly (#4627)

* Refactor optimized checkout setup to ensure correct starting point for e2e tests
* Changelog

Author: daledupreez

changelog.txt

@@ -29,6 +29,7 @@
 * Fix - Display only Apple Pay and Google Pay buttons in the Customize page preview
 * Update - Add nightly task and WooCommerce tool to remove stale entries from our database cache
 * Dev - Make 'Add to cart' more robust in e2e tests
+* Dev - Ensure e2e tests enable or disable Optimized Checkout during setup
 
 = 9.8.1 - 2025-08-15 =
 * Fix - Remove connection type requirement from PMC sync migration attempt

readme.txt

@@ -139,5 +139,6 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Fix - Display only Apple Pay and Google Pay buttons in the Customize page preview
 * Update - Add nightly task and WooCommerce tool to remove stale entries from our database cache
 * Dev - Make 'Add to cart' more robust in e2e tests
+* Dev - Ensure e2e tests enable or disable Optimized Checkout during setup
 
 [See changelog for full details across versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/e2e/tests/default.setup.js

@@ -24,4 +24,6 @@ setup( 'Configure store for default tests', async ( { browser } ) => {
 	await expect( page.getByLabel( 'Link by Stripe' ) ).toBeChecked();
 
 	await adminContext.close();
+
+	await admin.initializeOptimizedCheckout( browser, false );
 } );

tests/e2e/tests/optimized-checkout.setup.js

@@ -1,37 +1,9 @@
-import { test as setup, expect } from '@playwright/test';
+import { test as setup } from '@playwright/test';
+import { initializeOptimizedCheckout } from '../utils/admin';
 
 setup(
 	'Configure store for Optimized Checkout tests',
 	async ( { browser } ) => {
-		const adminContext = await browser.newContext( {
-			storageState: process.env.ADMINSTATE,
-		} );
-
-		const page = await adminContext.newPage();
-
-		// Enable SPE in the admin.
-		await page.goto(
-			'/wp-admin/admin.php?page=wc-settings&tab=checkout&section=stripe&panel=settings'
-		);
-
-		const checkbox = page.getByTestId(
-			'optimized-checkout-element-checkbox'
-		);
-		const isChecked = await checkbox.isChecked();
-
-		if ( ! isChecked ) {
-			await checkbox.click();
-			await page.click( 'text=Save changes' );
-			await expect(
-				page.locator(
-					'.components-snackbar__content:has-text("Settings saved.")'
-				)
-			).toBeVisible();
-			await expect(
-				page.getByTestId( 'optimized-checkout-element-checkbox' )
-			).toBeChecked();
-		}
-
-		await adminContext.close();
+		await initializeOptimizedCheckout( browser, true );
 	}
 );

tests/e2e/utils/admin.js

@@ -80,3 +80,52 @@ export const updateStoreCurrency = async ( browser, currency ) => {
 		await context.close();
 	}
 };
+
+/**
+ * Enable or disable the Optimized Checkout feature in Stripe settings.
+ *
+ * @param {Browser} browser      Playwright browser fixture.
+ * @param {boolean} shouldEnable Whether to enable or disable the Optimized Checkout element.
+ */
+export const initializeOptimizedCheckout = async (
+	browser,
+	shouldEnable = true
+) => {
+	const adminContext = await browser.newContext( {
+		storageState: process.env.ADMINSTATE,
+	} );
+
+	const page = await adminContext.newPage();
+
+	await page.goto(
+		'/wp-admin/admin.php?page=wc-settings&tab=checkout&section=stripe&panel=settings'
+	);
+
+	const checkbox = page.getByTestId( 'optimized-checkout-element-checkbox' );
+	const isChecked = await checkbox.isChecked();
+
+	const updateNeeded =
+		( shouldEnable && ! isChecked ) || ( ! shouldEnable && isChecked );
+
+	if ( updateNeeded ) {
+		await checkbox.click();
+		await page.click( 'text=Save changes' );
+		await expect(
+			page.locator(
+				'.components-snackbar__content:has-text("Settings saved.")'
+			)
+		).toBeVisible();
+
+		if ( shouldEnable ) {
+			await expect(
+				page.getByTestId( 'optimized-checkout-element-checkbox' )
+			).toBeChecked();
+		} else {
+			await expect(
+				page.getByTestId( 'optimized-checkout-element-checkbox' )
+			).not.toBeChecked();
+		}
+	}
+
+	await adminContext.close();
+};