Add Web Worker Offloading module

.eslintignore

@@ -0,0 +1,5 @@
+**/*.min.js
+**/node_modules/**
+**/vendor/**
+build/*
+modules/js-and-css/partytown-web-worker/assets/js/partytown/*

.github/CODEOWNERS

@@ -48,6 +48,8 @@
 /modules/js-and-css/audit-enqueued-assets                                   @manuelRod
 /tests/modules/js-and-css/audit-enqueued-assets                             @manuelRod
 /tests/testdata/modules/js-and-css/audit-enqueued-assets                    @manuelRod
+/modules/js-and-css/partytown-web-worker                                    @thelovekesh
+/tests/modules/js-and-css/partytown-web-worker                              @thelovekesh
 
 # Module: Dominant Color Images
 /modules/images/dominant-color-images                                       @pbearne @spacedmonkey

.github/workflows/deploy-dotorg.yml

@@ -12,12 +12,28 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3.5.0
+        with:
+          node-version-file: ".nvmrc"
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+        env:
+          CI: true
+
+      - name: Build Plugin
+        run: npm run build
+
       - name: WordPress plugin deploy
         uses: 10up/action-wordpress-plugin-deploy@stable
         env:
           SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }}
           SVN_USERNAME: ${{ secrets.SVN_USERNAME }}
           SLUG: performance-lab
+
       - name: Upload release assets
         uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/')

.github/workflows/php-test-standalone-plugins.yml

@@ -68,6 +68,8 @@ jobs:
           cache: npm
       - name: npm install
         run: npm ci
+      - name: Build plugin assets
+        run: npm run build
       - name: General debug information
         run: |
           npm --version

.github/workflows/php-test.yml

@@ -65,6 +65,8 @@ jobs:
           cache: npm
       - name: npm install
         run: npm ci
+      - name: Build plugin assets
+        run: npm run build
       - name: Install WordPress
         run: npm run wp-env start
         # Note that `composer update` is required instead of `composer install`

.gitignore

@@ -16,6 +16,7 @@ local.properties
 .cproject
 .buildpath
 nbproject/
+.vscode
 
 ############
 ## Build
@@ -33,6 +34,7 @@ build-cs/composer.lock
 node_modules/
 vendor/
 
+modules/js-and-css/partytown-web-worker/assets/js/partytown
 ############
 ## OSes
 ############

module-i18n.php

@@ -9,6 +9,8 @@
 	_x( 'Creates WebP versions for new JPEG image uploads if supported by the server.', 'module description', 'performance-lab' ),
 	_x( 'Enqueued Assets Health Check', 'module name', 'performance-lab' ),
 	_x( 'Adds a CSS and JS resource check in Site Health status.', 'module description', 'performance-lab' ),
+	_x( 'Partytown Web Worker', 'module name', 'performance-lab' ),
+	_x( 'Add support for running JavaScript in a separate Web Worker with the help of the Partytown library.', 'module description', 'performance-lab' ),
 	_x( 'Autoloaded Options Health Check', 'module name', 'performance-lab' ),
 	_x( 'Adds a check for autoloaded options in Site Health status.', 'module description', 'performance-lab' ),
 );

modules/js-and-css/partytown-web-worker/can-load.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * Can load function to determine if Partytown Web Worker module can be loaded.
+ *
+ * @since   n.e.x.t
+ * @package partytown-web-worker
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+return static function () {
+	$errors = new WP_Error();
+
+	// Check for Partytown JavaScript library.
+	if ( ! file_exists( __DIR__ . '/assets/js/partytown/partytown.js' ) ) {
+		$errors->add(
+			'partytown_web_worker_library_missing',
+			sprintf(
+				/* translators: %s: npm commands. */
+				__( 'Partytown library is missing from the plugin. Please do "%s" to install it.', 'performance-lab' ),
+				'npm install && npm run build'
+			)
+		);
+	}
+
+	// Check for HTTPS.
+	if (
+		! is_ssl()
+		&&
+		'localhost' !== wp_parse_url( home_url(), PHP_URL_HOST )
+	) {
+		$errors->add(
+			'partytown_web_worker_ssl_error',
+			__( 'Partytown Web Worker Module requires a secure HTTPS connection to be enabled.', 'performance-lab' )
+		);
+	}
+
+	return $errors->has_errors() ? $errors : true;
+};

modules/js-and-css/partytown-web-worker/load.php

@@ -0,0 +1,139 @@
+<?php
+/**
+ * Module Name: Partytown Web Worker
+ * Description: Add support for running JavaScript in a separate Web Worker with the help of the Partytown library.
+ * Experimental: Yes
+ *
+ * @since   n.e.x.t
+ * @package performance-lab
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly.
+}
+
+/**
+ * PartyTown Configuration
+ *
+ * @since n.e.x.t
+ * @see https://partytown.builder.io/configuration
+ * @return array
+ */
+function perflab_partytown_web_worker_configuration() {
+	$plugin_dir           = plugin_dir_path( __FILE__ );
+	$content_dir_basename = basename( WP_CONTENT_DIR );
+
+	$config = array(
+		'lib'     => substr( $plugin_dir, strpos( $plugin_dir, $content_dir_basename ) - 1 ) . 'assets/js/partytown/',
+		'forward' => array(),
+	);
+
+	/**
+	 * Add configuration for PartyTown.
+	 *
+	 * @since n.e.x.t
+	 * @see <https://partytown.builder.io/configuration>.
+	 * @param array $config Configuration for PartyTown.
+	 * @return array
+	 */
+	return apply_filters( 'perflab_partytown_configuration', $config );
+}
+
+/**
+ * Initialize PartyTown
+ *
+ * @since n.e.x.t
+ * @return void
+ */
+function perflab_partytown_web_worker_init() {
+	$partytown_js = file_get_contents( __DIR__ . '/assets/js/partytown/partytown.js' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- It's a local filesystem path not a remote request.
+
+	wp_register_script(
+		'partytown',
+		'',
+		array(),
+		PERFLAB_VERSION,
+		array( 'in_footer' => false )
+	);
+
+	wp_add_inline_script(
+		'partytown',
+		sprintf(
+			'window.partytown = %s;',
+			wp_json_encode( perflab_partytown_web_worker_configuration() )
+		),
+		'before'
+	);
+
+	wp_add_inline_script(
+		'partytown',
+		$partytown_js,
+		'after'
+	);
+}
+add_action( 'wp_enqueue_scripts', 'perflab_partytown_web_worker_init' );
+
+/**
+ * Helper function to get all scripts tags which has `partytown` dependency.
+ *
+ * @since n.e.x.t
+ *
+ * @return array Array of script handles with `partytown` dependency.
+ */
+function perflab_get_partytown_handles() {
+	global $wp_scripts;
+
+	$partytown_handles = array();
+	foreach ( $wp_scripts->registered as $handle => $script ) {
+		if ( ! empty( $script->deps ) && in_array( 'partytown', $script->deps, true ) ) {
+			$partytown_handles[] = $handle;
+		}
+	}
+
+	return $partytown_handles;
+}
+
+/**
+ * Update script type for handles having `partytown` as dependency.
+ *
+ * @since n.e.x.t
+ *
+ * @param string $tag Script tag.
+ * @param string $handle Script handle.
+ * @param string $src Script source.
+ *
+ * @return string $tag Script tag with type="text/partytown".
+ */
+function perflab_partytown_web_worker_update_script_type( $tag, $handle, $src ) {
+	global $wp_scripts;
+
+	$partytown_handles = perflab_get_partytown_handles();
+
+	if ( in_array( $handle, $partytown_handles, true ) ) {
+		$before_script = $wp_scripts->get_inline_script_data( $handle, 'before' );
+		$after_script  = $wp_scripts->get_inline_script_data( $handle, 'after' );
+
+		if ( ! empty( $before_script ) || ! empty( $after_script ) ) {
+			_doing_it_wrong(
+				'wp_add_inline_script',
+				sprintf(
+					/* translators: %s: script handle */
+					esc_html__( 'Cannot add inline script "%s" to scripts with a "partytown" dependency. Script will continue to load in the main thread.', 'performance-lab' ),
+					'<a href="https://developer.wordpress.org/reference/functions/wp_add_inline_script/">wp_add_inline_script()</a>'
+				),
+				esc_html( PERFLAB_VERSION )
+			);
+		} else {
+			$tag = wp_get_script_tag(
+				array(
+					'type'   => 'text/partytown',
+					'src'    => $src,
+					'handle' => $handle . '-js',
+				)
+			);
+		}
+	}
+
+	return $tag;
+}
+add_filter( 'script_loader_tag', 'perflab_partytown_web_worker_update_script_type', 10, 3 );