Fixed issues after refactoring Faust Integration. e2e and code quality caught the issues.

Author: colinmurphy

plugins/hwp-previews/src/Integration/Faust_Integration.php

@@ -1,6 +1,6 @@
 <?php
 
-declare( strict_types=1 );
+declare(strict_types=1);
 
 namespace HWP\Previews\Integration;
 
@@ -16,6 +16,11 @@ class Faust_Integration {
 	 */
 	public const FAUST_NOTICE_KEY = 'hwp_previews_faust_notice';
 
+	/**
+	 * Whether Faust is enabled.
+	 */
+	public bool $faust_enabled = false;
+
 	/**
 	 * The instance of the Faust integration.
 	 *
@@ -24,11 +29,10 @@ class Faust_Integration {
 	protected static ?Faust_Integration $instance = null;
 
 	/**
-	 * Whether Faust is enabled.
+	 * Faust_Integration constructor.
+	 *
+	 * Initializes the Faust integration if Faust is enabled.
 	 */
-	public bool $faust_enabled = false;
-
-
 	public function __construct() {
 		$this->faust_enabled = $this->is_faust_enabled();
 
@@ -39,6 +43,17 @@ public function __construct() {
 		$this->configure_faust();
 	}
 
+	/**
+	 * Initialize the hooks for the preview functionality.
+	 */
+	public static function init(): Faust_Integration {
+		if ( ! isset( self::$instance ) || ! ( is_a( self::$instance, self::class ) ) ) {
+			self::$instance = new self();
+		}
+
+		return self::$instance;
+	}
+
 	/**
 	 * Checks if Faust is enabled.
 	 */
@@ -57,29 +72,6 @@ public function get_faust_enabled(): bool {
 		return $this->faust_enabled;
 	}
 
-	/**
-	 * Initialize the hooks for the preview functionality.
-	 */
-	public static function init(): Faust_Integration {
-		if ( ! isset( self::$instance ) || ! ( is_a( self::$instance, self::class ) ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Configure Faust settings and remove conflicting filters.
-	 */
-	protected function configure_faust(): void {
-		$this->set_default_faust_settings();
-
-		// Remove FaustWP post preview link filter to avoid conflicts with our custom preview link generation.
-		remove_filter( 'preview_post_link', 'WPE\FaustWP\Replacement\post_preview_link', 1000 );
-
-		$this->display_faust_admin_notice();
-	}
-
 	/**
 	 * Returns the Faust frontend URL from settings or a default value.
 	 */
@@ -134,18 +126,11 @@ public function set_default_faust_settings(): void {
 		update_option( HWP_PREVIEWS_SETTINGS_KEY, $default_settings );
 	}
 
-	/**
-	 * Dismiss the Faust admin notice.
-	 */
-	public function dismiss_faust_admin_notice(): void {
-		update_user_meta( get_current_user_id(), self::FAUST_NOTICE_KEY, 1 );
-	}
-
 	/**
 	 * Register admin notice to inform users about Faust integration.
 	 */
 	public function register_faust_admin_notice(): void {
-		add_action( 'admin_notices', function (): void {
+		add_action( 'admin_notices', static function (): void {
 			$screen = get_current_screen();
 
 			// Exit if not this plugin's settings page.
@@ -181,6 +166,25 @@ public function register_faust_admin_notice(): void {
 		}, 10, 0 );
 	}
 
+	/**
+	 * Dismiss the Faust admin notice.
+	 */
+	public static function dismiss_faust_admin_notice(): void {
+		update_user_meta( get_current_user_id(), self::FAUST_NOTICE_KEY, 1 );
+	}
+
+	/**
+	 * Configure Faust settings and remove conflicting filters.
+	 */
+	protected function configure_faust(): void {
+		$this->set_default_faust_settings();
+
+		// Remove FaustWP post preview link filter to avoid conflicts with our custom preview link generation.
+		remove_filter( 'preview_post_link', 'WPE\FaustWP\Replacement\post_preview_link', 1000 );
+
+		$this->display_faust_admin_notice();
+	}
+
 	/**
 	 * If Faust is enabled, show an admin notice about the migration on the settings page.
 	 */
@@ -195,7 +199,7 @@ protected function display_faust_admin_notice(): void {
 		self::register_faust_admin_notice();
 
 		// Register the AJAX action for dismissing the notice.
-		add_action( 'wp_ajax_' . self::FAUST_NOTICE_KEY, function (): void {
+		add_action( 'wp_ajax_' . self::FAUST_NOTICE_KEY, static function (): void {
 			// Exit if the action is not set or does not match the expected key.
 			if ( ! isset( $_POST['action'] ) || esc_attr( self::FAUST_NOTICE_KEY ) !== $_POST['action'] ) {
 				return;

plugins/hwp-previews/src/Templates/admin.php

@@ -4,10 +4,11 @@
 
 use HWP\Previews\Integration\Faust_Integration;
 
-$hwp_previews_tabs_config = (array) get_query_var( 'hwp_previews_main_page_config' );
-$hwp_previews_current_tab = (string) ( $hwp_previews_tabs_config['current_tab'] ?? '' );
-$hwp_previews_tabs        = (array) ( $hwp_previews_tabs_config['tabs'] ?? [] );
-$hwp_previews_params      = (array) ( $hwp_previews_tabs_config['params'] ?? [] );
+$hwp_previews_tabs_config       = (array) get_query_var( 'hwp_previews_main_page_config' );
+$hwp_previews_current_tab       = (string) ( $hwp_previews_tabs_config['current_tab'] ?? '' );
+$hwp_previews_tabs              = (array) ( $hwp_previews_tabs_config['tabs'] ?? [] );
+$hwp_previews_params            = (array) ( $hwp_previews_tabs_config['params'] ?? [] );
+$hwp_previews_faust_integration = Faust_Integration::init();
 
 ?>
 
@@ -61,11 +62,11 @@
 						<div class="postbox">
 							<h2><?php esc_html_e( 'Get Started With HWP Previews', 'hwp-previews' ); ?></h2>
 							<div class="inside hwp-previews-docs">
-			
+
 								<ul>
 									<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#getting-started" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Getting Started', 'hwp-previews' ); ?></a></li>
 									<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#front-end-integration" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Front-End Integration', 'hwp-previews' ); ?></a></li>
-									<?php if ( Faust_Integration::$faust_enabled ) : ?>
+									<?php if ( $hwp_previews_faust_integration->get_faust_enabled() ) : ?>
 										<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#using-with-faustjs" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Using With Faust.js', 'hwp-previews' ); ?></a></li>
 									<?php endif; ?>
 									<li><a href="https://github.com/wpengine/hwptoolkit/tree/main/plugins/hwp-previews#extending-the-functionality" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Extending the Functionality', 'hwp-previews' ); ?></a></li>