Merge pull request #100 from dkotter/add/require-credentials

Disable Experiments when no valid AI credentials are found

Co-authored-by: dkotter <dkotter@git.wordpress.org>
Co-authored-by: felixarntz <flixos90@git.wordpress.org>

Author: 3 people

includes/Abstracts/Abstract_Experiment.php

@@ -11,6 +11,9 @@
 
 use WordPress\AI\Contracts\Experiment;
 use WordPress\AI\Exception\Invalid_Experiment_Metadata_Exception;
+use WordPress\AI\Settings\Settings_Registration;
+
+use function WordPress\AI\has_valid_ai_credentials;
 
 /**
  * Base implementation for experiments.
@@ -148,7 +151,7 @@ final public function is_enabled(): bool {
 		}
 
 		// Check global experiments toggle first.
-		$global_enabled = (bool) get_option( 'ai_experiments_enabled', false );
+		$global_enabled = (bool) get_option( Settings_Registration::GLOBAL_OPTION, false );
 		if ( ! $global_enabled ) {
 			$this->enabled_cache = false;
 			return false;
@@ -168,6 +171,11 @@ final public function is_enabled(): bool {
 		 */
 		$is_enabled = (bool) apply_filters( "ai_experiment_{$this->id}_enabled", $experiment_enabled );
 
+		// Check if we have valid AI credentials.
+		if ( ! has_valid_ai_credentials() ) {
+			$is_enabled = false;
+		}
+
 		// Cache the result.
 		$this->enabled_cache = $is_enabled;
 

includes/Settings/Settings_Page.php

@@ -14,6 +14,9 @@
 use WordPress\AI\Asset_Loader;
 use WordPress\AI\Experiment_Registry;
 
+use function WordPress\AI\has_ai_credentials;
+use function WordPress\AI\has_valid_ai_credentials;
+
 /**
  * Manages the admin settings page for AI experiments.
  *
@@ -125,6 +128,30 @@ public function render_page(): void {
 		<div class="wrap">
 			<h1><?php echo esc_html( get_admin_page_title() ); ?></h1>
 
+			<?php
+			// If we don't have proper credentials, show an error message and return early.
+			if ( ! has_valid_ai_credentials() ) {
+				if ( ! has_ai_credentials() ) {
+					$error_message = sprintf(
+						/* translators: 1: Link to the AI credentials settings page. */
+						__( 'Before you can enable experiments, you need to ensure you have one or more AI credentials set <a href="%s">here</a>', 'ai' ),
+						admin_url( 'options-general.php?page=wp-ai-client' )
+					);
+				} else {
+					$error_message = sprintf(
+						/* translators: 1: Link to the AI credentials settings page. */
+						__( 'Before you can enable experiments, you need to ensure you have set valid AI credentials <a href="%s">here</a>', 'ai' ),
+						admin_url( 'options-general.php?page=wp-ai-client' )
+					);
+				}
+
+				wp_admin_notice( $error_message, array( 'type' => 'error' ) );
+				return;
+			}
+			?>
+
+			<?php settings_errors(); ?>
+
 			<form method="post" action="options.php">
 				<?php
 				settings_fields( Settings_Registration::OPTION_GROUP );

includes/bootstrap.php

@@ -178,6 +178,9 @@ function load(): void {
  */
 function initialize_experiments(): void {
 	try {
+		// Initialize the WP AI Client.
+		AI_Client::init();
+
 		$registry = new Experiment_Registry();
 		$loader   = new Experiment_Loader( $registry );
 		$loader->register_default_experiments();
@@ -193,9 +196,6 @@ function initialize_experiments(): void {
 			$settings_page->init();
 		}
 
-		// Initialize the WP AI Client.
-		AI_Client::init();
-
 		// Register our post-related WordPress Abilities.
 		$post_abilities = new Posts();
 		$post_abilities->register();

includes/helpers.php

@@ -9,6 +9,9 @@
 
 namespace WordPress\AI;
 
+use Throwable;
+use WordPress\AI_Client\AI_Client;
+
 /**
  * Normalizes the content by cleaning it and removing unwanted HTML tags.
  *
@@ -155,3 +158,66 @@ function get_preferred_models(): array {
 	 */
 	return (array) apply_filters( 'ai_preferred_models', $preferred_models );
 }
+
+/**
+ * Checks if we have AI credentials set.
+ *
+ * @since 0.1.0
+ *
+ * @return bool True if we have AI credentials, false otherwise.
+ */
+function has_ai_credentials(): bool {
+	$credentials = get_option( 'wp_ai_client_provider_credentials', array() );
+
+	// If there are no credentials, return false.
+	if ( ! is_array( $credentials ) || empty( $credentials ) ) {
+		return false;
+	}
+
+	// If all of the AI keys are empty, return false; otherwise, return true.
+	return ! empty(
+		array_filter(
+			$credentials,
+			static function ( $api_key ): bool {
+				return is_string( $api_key ) && '' !== $api_key;
+			}
+		)
+	);
+}
+
+/**
+ * Checks if we have valid AI credentials.
+ *
+ * @since 0.1.0
+ *
+ * @return bool True if we have valid AI credentials, false otherwise.
+ */
+function has_valid_ai_credentials(): bool {
+	// If we have no AI credentials, return false.
+	if ( ! has_ai_credentials() ) {
+		return false;
+	}
+
+	/**
+	 * Filters whether valid AI credentials are available.
+	 *
+	 * Allows overriding the credentials check, useful for testing.
+	 *
+	 * @since 0.1.0
+	 * @hook ai_pre_has_valid_credentials_check
+	 *
+	 * @param bool|null $has_valid_credentials Whether valid credentials are available. Return null to use default check.
+	 * @return bool|null True if valid credentials are available, false otherwise, or null to use default check.
+	 */
+	$valid = apply_filters( 'ai_pre_has_valid_credentials_check', null );
+	if ( null !== $valid ) {
+		return (bool) $valid;
+	}
+
+	// See if we have credentials that give us access to generate text.
+	try {
+		return AI_Client::prompt( 'Test' )->is_supported_for_text_generation();
+	} catch ( Throwable $t ) {
+		return false;
+	}
+}

tests/Integration/Includes/Abstracts/Abstract_AbilityTest.php

@@ -138,6 +138,32 @@ public function register(): void {
  */
 class Abstract_AbilityTest extends WP_UnitTestCase {
 
+	/**
+	 * Set up test case.
+	 *
+	 * @since 0.1.0
+	 */
+	public function setUp(): void {
+		parent::setUp();
+
+		// Set up mock AI credentials so has_ai_credentials() returns true.
+		update_option( 'wp_ai_client_provider_credentials', array( 'openai' => 'test-api-key' ) );
+
+		// Mock has_valid_ai_credentials to return true for tests.
+		add_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+	}
+
+	/**
+	 * Tear down test case.
+	 *
+	 * @since 0.1.0
+	 */
+	public function tearDown(): void {
+		delete_option( 'wp_ai_client_provider_credentials' );
+		remove_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+		parent::tearDown();
+	}
+
 	/**
 	 * Test that constructor properly sets up the ability.
 	 *

tests/Integration/Includes/Experiment_LoaderTest.php

@@ -77,10 +77,28 @@ class Experiment_LoaderTest extends WP_UnitTestCase {
 	 */
 	public function setUp(): void {
 		parent::setUp();
+
+		// Set up mock AI credentials so has_ai_credentials() returns true.
+		update_option( 'wp_ai_client_provider_credentials', array( 'openai' => 'test-api-key' ) );
+
+		// Mock has_valid_ai_credentials to return true for tests.
+		add_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+
 		$this->registry = new Experiment_Registry();
 		$this->loader   = new Experiment_Loader( $this->registry );
 	}
 
+	/**
+	 * Tear down test case.
+	 *
+	 * @since 0.1.0
+	 */
+	public function tearDown(): void {
+		delete_option( 'wp_ai_client_provider_credentials' );
+		remove_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+		parent::tearDown();
+	}
+
 	/**
 	 * Test register_default_experiments registers default experiments.
 	 *

tests/Integration/Includes/Experiment_RegistryTest.php

@@ -63,9 +63,27 @@ class Experiment_Registry_Test extends WP_UnitTestCase {
 	 */
 	public function setUp(): void {
 		parent::setUp();
+
+		// Set up mock AI credentials so has_ai_credentials() returns true.
+		update_option( 'wp_ai_client_provider_credentials', array( 'openai' => 'test-api-key' ) );
+
+		// Mock has_valid_ai_credentials to return true for tests.
+		add_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+
 		$this->registry = new Experiment_Registry();
 	}
 
+	/**
+	 * Tear down test case.
+	 *
+	 * @since 0.1.0
+	 */
+	public function tearDown(): void {
+		delete_option( 'wp_ai_client_provider_credentials' );
+		remove_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+		parent::tearDown();
+	}
+
 	/**
 	 * Test registering an experiment.
 	 *

tests/Integration/Includes/Experiments/Example_Experiment/Example_ExperimentTest.php

@@ -26,6 +26,12 @@ class Example_ExperimentTest extends WP_UnitTestCase {
 	public function setUp(): void {
 		parent::setUp();
 
+		// Set up mock AI credentials so has_ai_credentials() returns true.
+		update_option( 'wp_ai_client_provider_credentials', array( 'openai' => 'test-api-key' ) );
+
+		// Mock has_valid_ai_credentials to return true for tests.
+		add_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+
 		// Enable experiments globally and individually.
 		update_option( 'ai_experiments_enabled', true );
 		update_option( 'ai_experiment_example-experiment_enabled', true );
@@ -48,6 +54,8 @@ public function tearDown(): void {
 		wp_set_current_user( 0 );
 		delete_option( 'ai_experiments_enabled' );
 		delete_option( 'ai_experiment_example-experiment_enabled' );
+		delete_option( 'wp_ai_client_provider_credentials' );
+		remove_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
 		parent::tearDown();
 	}
 

tests/Integration/Includes/Experiments/Title_Generation/Title_GenerationTest.php

@@ -26,6 +26,12 @@ class Title_GenerationTest extends WP_UnitTestCase {
 	public function setUp(): void {
 		parent::setUp();
 
+		// Set up mock AI credentials so has_ai_credentials() returns true.
+		update_option( 'wp_ai_client_provider_credentials', array( 'openai' => 'test-api-key' ) );
+
+		// Mock has_valid_ai_credentials to return true for tests.
+		add_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
+
 		// Enable experiments globally and individually.
 		update_option( 'ai_experiments_enabled', true );
 		update_option( 'ai_experiment_title-generation_enabled', true );
@@ -47,6 +53,8 @@ public function tearDown(): void {
 		wp_set_current_user( 0 );
 		delete_option( 'ai_experiments_enabled' );
 		delete_option( 'ai_experiment_title-generation_enabled' );
+		delete_option( 'wp_ai_client_provider_credentials' );
+		remove_filter( 'ai_pre_has_valid_credentials_check', '__return_true' );
 		parent::tearDown();
 	}