Improve Test Coverage for Web Worker Offloading Plugin

plugins/web-worker-offloading/helper.php

@@ -29,7 +29,7 @@ function plwwo_get_configuration(): array {
 	);
 
 	if ( WP_DEBUG && SCRIPT_DEBUG ) {
-		$config['debug'] = true;
+		$config['debug'] = true;// @codeCoverageIgnore
 	}
 
 	/**
@@ -72,3 +72,129 @@ function plwwo_get_configuration(): array {
 	 */
 	return (array) apply_filters( 'plwwo_configuration', $config );
 }
+
+/**
+ * Registers defaults scripts for Web Worker Offloading.
+ *
+ * @since 0.1.0
+ * @access private
+ *
+ * @param WP_Scripts $scripts WP_Scripts instance.
+ */
+function plwwo_register_default_scripts( WP_Scripts $scripts ): void {
+	// The source code for partytown.js is built from <https://github.com/BuilderIO/partytown/blob/b292a14047a0c12ca05ba97df1833935d42fdb66/src/lib/main/snippet.ts>.
+	// See webpack config in the WordPress/performance repo: <https://github.com/WordPress/performance/blob/282a068f3eb2575d37aeb9034e894e7140fcddca/webpack.config.js#L84-L130>.
+	if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
+		$partytown_js_path = '/build/debug/partytown.js';// @codeCoverageIgnore
+	} else {
+		$partytown_js_path = '/build/partytown.js';
+	}
+
+	$partytown_js = file_get_contents( __DIR__ . $partytown_js_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+	if ( false === $partytown_js ) {
+		return;// @codeCoverageIgnore
+	}
+
+	$scripts->add(
+		'web-worker-offloading',
+		'',
+		array(),
+		WEB_WORKER_OFFLOADING_VERSION,
+		array( 'in_footer' => false )
+	);
+
+	$scripts->add_inline_script(
+		'web-worker-offloading',
+		sprintf(
+			'window.partytown = {...(window.partytown || {}), ...%s};',
+			wp_json_encode( plwwo_get_configuration() )
+		),
+		'before'
+	);
+
+	$scripts->add_inline_script( 'web-worker-offloading', $partytown_js );
+}
+
+/**
+ * Prepends web-worker-offloading to the list of scripts to print if one of the queued scripts is offloaded to a worker.
+ *
+ * @since 0.1.0
+ * @access private
+ *
+ * @param string[]|mixed $script_handles An array of enqueued script dependency handles.
+ * @return string[] Script handles.
+ */
+function plwwo_filter_print_scripts_array( $script_handles ): array {
+	$scripts = wp_scripts();
+	foreach ( (array) $script_handles as $handle ) {
+		if ( true === (bool) $scripts->get_data( $handle, 'worker' ) ) {
+			$scripts->set_group( 'web-worker-offloading', false, 0 ); // Try to print in the head.
+			array_unshift( $script_handles, 'web-worker-offloading' );
+			break;
+		}
+	}
+	return $script_handles;
+}
+
+/**
+ * Updates script type for handles having `web-worker-offloading` as dependency.
+ *
+ * @since 0.1.0
+ * @access private
+ *
+ * @param string|mixed $tag    Script tag.
+ * @param string       $handle Script handle.
+ * @return string|mixed Script tag with type="text/partytown" for eligible scripts.
+ */
+function plwwo_update_script_type( $tag, string $handle ) {
+	if (
+		is_string( $tag )
+		&&
+		(bool) wp_scripts()->get_data( $handle, 'worker' )
+	) {
+		$html_processor = new WP_HTML_Tag_Processor( $tag );
+		while ( $html_processor->next_tag( array( 'tag_name' => 'SCRIPT' ) ) ) {
+			if ( $html_processor->get_attribute( 'id' ) === "{$handle}-js" ) {
+				$html_processor->set_attribute( 'type', 'text/partytown' );
+				$tag = $html_processor->get_updated_html();
+				break;
+			}
+		}
+	}
+	return $tag;
+}
+
+/**
+ * Filters inline script attributes to offload to a worker if the script has been opted-in.
+ *
+ * @since 0.1.0
+ * @access private
+ *
+ * @param array<string, mixed>|mixed $attributes Attributes.
+ * @return array<string, mixed> Attributes.
+ */
+function plwwo_filter_inline_script_attributes( $attributes ): array {
+	$attributes = (array) $attributes;
+	if (
+		isset( $attributes['id'] )
+		&&
+		1 === preg_match( '/^(?P<handle>.+)-js-(?:before|after)$/', $attributes['id'], $matches )
+		&&
+		(bool) wp_scripts()->get_data( $matches['handle'], 'worker' )
+	) {
+		$attributes['type'] = 'text/partytown';
+	}
+	return $attributes;
+}
+
+/**
+ * Displays the HTML generator meta tag for the Web Worker Offloading plugin.
+ *
+ * See {@see 'wp_head'}.
+ *
+ * @since 0.1.1
+ */
+function plwwo_render_generator_meta_tag(): void {
+	// Use the plugin slug as it is immutable.
+	echo '<meta name="generator" content="web-worker-offloading ' . esc_attr( WEB_WORKER_OFFLOADING_VERSION ) . '">' . "\n";
+}

plugins/web-worker-offloading/hooks.php

@@ -10,135 +10,9 @@
 if ( ! defined( 'ABSPATH' ) ) {
 	exit; // Exit if accessed directly.
 }
-// @codeCoverageIgnoreEnd
-
-/**
- * Registers defaults scripts for Web Worker Offloading.
- *
- * @since 0.1.0
- * @access private
- *
- * @param WP_Scripts $scripts WP_Scripts instance.
- */
-function plwwo_register_default_scripts( WP_Scripts $scripts ): void {
-	// The source code for partytown.js is built from <https://github.com/BuilderIO/partytown/blob/b292a14047a0c12ca05ba97df1833935d42fdb66/src/lib/main/snippet.ts>.
-	// See webpack config in the WordPress/performance repo: <https://github.com/WordPress/performance/blob/282a068f3eb2575d37aeb9034e894e7140fcddca/webpack.config.js#L84-L130>.
-	if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
-		$partytown_js_path = '/build/debug/partytown.js';
-	} else {
-		$partytown_js_path = '/build/partytown.js';
-	}
-
-	$partytown_js = file_get_contents( __DIR__ . $partytown_js_path ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
-	if ( false === $partytown_js ) {
-		return;
-	}
-
-	$scripts->add(
-		'web-worker-offloading',
-		'',
-		array(),
-		WEB_WORKER_OFFLOADING_VERSION,
-		array( 'in_footer' => false )
-	);
-
-	$scripts->add_inline_script(
-		'web-worker-offloading',
-		sprintf(
-			'window.partytown = {...(window.partytown || {}), ...%s};',
-			wp_json_encode( plwwo_get_configuration() )
-		),
-		'before'
-	);
-
-	$scripts->add_inline_script( 'web-worker-offloading', $partytown_js );
-}
 add_action( 'wp_default_scripts', 'plwwo_register_default_scripts' );
-
-/**
- * Prepends web-worker-offloading to the list of scripts to print if one of the queued scripts is offloaded to a worker.
- *
- * @since 0.1.0
- * @access private
- *
- * @param string[]|mixed $script_handles An array of enqueued script dependency handles.
- * @return string[] Script handles.
- */
-function plwwo_filter_print_scripts_array( $script_handles ): array {
-	$scripts = wp_scripts();
-	foreach ( (array) $script_handles as $handle ) {
-		if ( true === (bool) $scripts->get_data( $handle, 'worker' ) ) {
-			$scripts->set_group( 'web-worker-offloading', false, 0 ); // Try to print in the head.
-			array_unshift( $script_handles, 'web-worker-offloading' );
-			break;
-		}
-	}
-	return $script_handles;
-}
 add_filter( 'print_scripts_array', 'plwwo_filter_print_scripts_array', PHP_INT_MAX );
-
-/**
- * Updates script type for handles having `web-worker-offloading` as dependency.
- *
- * @since 0.1.0
- * @access private
- *
- * @param string|mixed $tag    Script tag.
- * @param string       $handle Script handle.
- * @return string|mixed Script tag with type="text/partytown" for eligible scripts.
- */
-function plwwo_update_script_type( $tag, string $handle ) {
-	if (
-		is_string( $tag )
-		&&
-		(bool) wp_scripts()->get_data( $handle, 'worker' )
-	) {
-		$html_processor = new WP_HTML_Tag_Processor( $tag );
-		while ( $html_processor->next_tag( array( 'tag_name' => 'SCRIPT' ) ) ) {
-			if ( $html_processor->get_attribute( 'id' ) === "{$handle}-js" ) {
-				$html_processor->set_attribute( 'type', 'text/partytown' );
-				$tag = $html_processor->get_updated_html();
-				break;
-			}
-		}
-	}
-	return $tag;
-}
 add_filter( 'script_loader_tag', 'plwwo_update_script_type', 10, 2 );
-
-/**
- * Filters inline script attributes to offload to a worker if the script has been opted-in.
- *
- * @since 0.1.0
- * @access private
- *
- * @param array<string, mixed>|mixed $attributes Attributes.
- * @return array<string, mixed> Attributes.
- */
-function plwwo_filter_inline_script_attributes( $attributes ): array {
-	$attributes = (array) $attributes;
-	if (
-		isset( $attributes['id'] )
-		&&
-		1 === preg_match( '/^(?P<handle>.+)-js-(?:before|after)$/', $attributes['id'], $matches )
-		&&
-		(bool) wp_scripts()->get_data( $matches['handle'], 'worker' )
-	) {
-		$attributes['type'] = 'text/partytown';
-	}
-	return $attributes;
-}
 add_filter( 'wp_inline_script_attributes', 'plwwo_filter_inline_script_attributes' );
-
-/**
- * Displays the HTML generator meta tag for the Web Worker Offloading plugin.
- *
- * See {@see 'wp_head'}.
- *
- * @since 0.1.1
- */
-function plwwo_render_generator_meta_tag(): void {
-	// Use the plugin slug as it is immutable.
-	echo '<meta name="generator" content="web-worker-offloading ' . esc_attr( WEB_WORKER_OFFLOADING_VERSION ) . '">' . "\n";
-}
 add_action( 'wp_head', 'plwwo_render_generator_meta_tag' );
+// @codeCoverageIgnoreEnd

plugins/web-worker-offloading/load.php

@@ -19,7 +19,6 @@
 if ( ! defined( 'ABSPATH' ) ) {
 	exit; // Exit if accessed directly.
 }
-// @codeCoverageIgnoreEnd
 
 // Define the constant.
 if ( defined( 'WEB_WORKER_OFFLOADING_VERSION' ) ) {
@@ -49,3 +48,4 @@
 require_once __DIR__ . '/helper.php';
 require_once __DIR__ . '/hooks.php';
 require_once __DIR__ . '/third-party.php';
+// @codeCoverageIgnoreEnd

plugins/web-worker-offloading/tests/test-web-worker-offloading.php

@@ -190,7 +190,7 @@ public static function data_update_script_types(): array {
 	 *
 	 * @covers ::plwwo_update_script_type
 	 * @covers ::plwwo_filter_print_scripts_array
-	 * @cogers ::plwwo_filter_inline_script_attributes
+	 * @covers ::plwwo_filter_inline_script_attributes
 	 *
 	 * @dataProvider data_update_script_types
 	 *
@@ -324,4 +324,38 @@ public function test_plwwo_render_generator_meta_tag(): void {
 	private function reset_wp_dependencies(): void {
 		$GLOBALS['wp_scripts'] = null;
 	}
+
+	/**
+	 * Test the function that marks scripts for offloading.
+	 *
+	 * @covers ::plwwo_mark_scripts_for_offloading
+	 */
+	public function test_plwwo_mark_scripts_for_offloading(): void {
+		// Enqueue a script.
+		wp_enqueue_script( 'test-script', 'https://example.com/test-script.js', array(), '1.0.0', true );
+		plwwo_mark_scripts_for_offloading( array( 'test-script' ) );
+
+		$html = get_echo( array( wp_scripts(), 'do_items' ) );
+
+		// Check that the 'worker' data has been added to the script.
+		$this->assertTrue( wp_scripts()->get_data( 'test-script', 'worker' ) );
+
+		$this->assertStringContainsString( 'Partytown', $html );
+	}
+
+	/**
+	 * Test the function that loads third party plugin integrations.
+	 *
+	 * @covers ::plwwo_load_third_party_integrations
+	 */
+	public function test_plwwo_load_third_party_integrations(): void {
+		plwwo_load_third_party_integrations();
+
+		// Note: Calling the above function won't actually impact these since none of the plugins are active.
+		// In order to test these being true it would depend on either actually loading those plugins,
+		// or defining constants/classes in separate processes.
+		$this->assertFalse( function_exists( 'plwwo_google_site_kit_configure' ) );
+		$this->assertFalse( function_exists( 'plwwo_rank_math_configure' ) );
+		$this->assertFalse( function_exists( 'plwwo_woocommerce_configure' ) );
+	}
 }

plugins/web-worker-offloading/tests/third-party/test-google-site-kit.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Test cases for google-site-kit.php in Web Worker Offloading.
+ *
+ * @package web-worker-offloading
+ */
+class Test_Google_Site_Kit extends WP_UnitTestCase {
+	/**
+	 * Runs the routine before each test is executed.
+	 */
+	public function set_up(): void {
+		parent::set_up();
+		require_once __DIR__ . '/../../third-party/google-site-kit.php';
+	}
+
+	/**
+	 * Test the function that configures WWO for Google Site Kit.
+	 *
+	 * @covers ::plwwo_google_site_kit_configure
+	 */
+	public function test_plwwo_google_site_kit_configure(): void {
+		$configuration          = array();
+		$expected_configuration = array(
+			'globalFns'           => array( 'gtag', 'wp_has_consent' ),
+			'forward'             => array( 'dataLayer.push', 'gtag' ),
+			'mainWindowAccessors' => array(
+				'_googlesitekitConsentCategoryMap',
+				'_googlesitekitConsents',
+				'wp_consent_type',
+				'wp_fallback_consent_type',
+				'wp_has_consent',
+				'waitfor_consent_hook',
+			),
+		);
+
+		$result = plwwo_google_site_kit_configure( $configuration );
+
+		$this->assertEquals( $expected_configuration, $result );
+	}
+
+	/**
+	 * Test the function that filters inline script attributes.
+	 *
+	 * @covers ::plwwo_google_site_kit_filter_inline_script_attributes
+	 */
+	public function test_plwwo_google_site_kit_filter_inline_script_attributes(): void {
+		$attributes          = array( 'id' => 'google_gtagjs-js-consent-mode-data-layer' );
+		$expected_attributes = array(
+			'id'   => 'google_gtagjs-js-consent-mode-data-layer',
+			'type' => 'text/partytown',
+		);
+
+		$result = plwwo_google_site_kit_filter_inline_script_attributes( $attributes );
+
+		$this->assertEquals( $expected_attributes, $result );
+	}
+}