Small refactor of plugin class. Added integration tests for configuration helper.

Author: colinmurphy

plugins/wpgraphql-logging/src/Admin/Settings/ConfigurationHelper.php

@@ -165,7 +165,7 @@ public function get_option_value( string $option_key, mixed $default_value = nul
 	 * Hook into WordPress to clear cache when settings are updated.
 	 * This should be called during plugin initialization.
 	 */
-	public static function init_cache_hooks(): void {
+	public static function register_cache_hooks(): void {
 		$instance   = self::get_instance();
 		$option_key = $instance->get_option_key();
 

plugins/wpgraphql-logging/src/Admin/ViewLogsPage.php

@@ -92,14 +92,6 @@ public function register_settings_page(): void {
 			'dashicons-list-view',
 			25
 		);
-		add_submenu_page(
-			'graphiql-ide',
-			esc_html__( 'GraphQL Logs', 'wpgraphql-logging' ),
-			esc_html__( 'GraphQL Logs', 'wpgraphql-logging' ),
-			'manage_options',
-			self::ADMIN_PAGE_SLUG,
-			[ $this, 'render_admin_page' ]
-		);
 
 		// Updates the list table when filters are applied.
 		add_action( 'load-' . $this->page_hook, [ $this, 'process_page_actions_before_rendering' ], 10, 0 );

plugins/wpgraphql-logging/src/Plugin.php

@@ -54,14 +54,17 @@ public static function init(): self {
 	}
 
 	/**
-	 * Initialize the plugin admin, frontend & api functionality.
+	 * Initialize various components of the plugin.
 	 */
 	public function setup(): void {
-		ConfigurationHelper::init_cache_hooks();
-		SettingsPage::init();
-		ViewLogsPage::init();
-		QueryEventLifecycle::init();
-		DataDeletionScheduler::init();
+		QueryEventLifecycle::init(); // Event lifecycle for capturing logs.
+		DataDeletionScheduler::init(); // Data deletion scheduler.
+
+		if ( is_admin() ) {
+			ConfigurationHelper::register_cache_hooks(); // Register cache hooks.
+			SettingsPage::init(); // Settings page.
+			ViewLogsPage::init(); // View logs page.
+		}
 
 		do_action( 'wpgraphql_logging_plugin_setup', self::$instance );
 	}
@@ -122,7 +125,6 @@ public static function activate(): void {
 	 * @since 0.0.1
 	 */
 	public static function deactivate(): void {
-
 		DataDeletionScheduler::clear_scheduled_deletion();
 		$log_service = self::get_log_service();
 		$log_service->deactivate();

plugins/wpgraphql-logging/tests/wpunit/Admin/Settings/ConfigurationHelperTest.php

@@ -117,4 +117,23 @@ public function test_get_is_enabled(): void {
 		$this->assertFalse($instance->is_enabled('data_management', 'enabled'));
 	}
 
+	public function test_register_cache_hooks(): void {
+		$instance = ConfigurationHelper::get_instance();
+
+
+		// Set initial configuration
+		$configuration = ['enabled' => true];
+		update_option($instance->get_option_key(), $configuration);
+
+		// Register cache hooks.
+		ConfigurationHelper::register_cache_hooks();
+
+		$this->assertEquals(10, has_action("update_option_{$instance->get_option_key()}", [$instance, 'clear_cache']));
+		$this->assertEquals(10, has_action("add_option_{$instance->get_option_key()}", [$instance, 'clear_cache']));
+		$this->assertEquals(10, has_action("delete_option_{$instance->get_option_key()}", [$instance, 'clear_cache']));
+
+		// Test that the cache is cleared when the option is updated.
+		update_option($instance->get_option_key(), ['enabled' => false]);
+		$this->assertEquals(['enabled' => false], $instance->get_config());
+	}
 }