Allow filtered timeout to be null and warn when invalid value provided

Author: westonruter

src/wp-includes/ai-client/class-wp-ai-client-prompt-builder.php

@@ -197,14 +197,24 @@ public function __construct( ProviderRegistry $registry, $prompt = null ) {
 		 *
 		 * @since 7.0.0
 		 *
-		 * @param float $default_timeout The default timeout in seconds. Must be greater than or equal to zero.
+		 * @param float|null $default_timeout The default timeout in seconds, or null to disable the timeout.
+		 *                                    If not null, must be greater than or equal to zero.
 		 */
 		$timeout = apply_filters( 'wp_ai_client_default_request_timeout', $default_timeout );
-		if ( is_numeric( $timeout ) ) {
-			$timeout = (float) $timeout;
-			if ( $timeout >= 0.0 ) {
-				$default_timeout = $timeout;
-			}
+		if ( is_numeric( $timeout ) && (float) $timeout >= 0.0 ) {
+			$default_timeout = (float) $timeout;
+		} elseif ( null === $timeout ) {
+			$default_timeout = null;
+		} else {
+			_doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					/* translators: %s: wp_ai_client_default_request_timeout */
+					__( 'The %s filter must return a non-negative number or null.' ),
+					'<code>wp_ai_client_default_request_timeout</code>'
+				),
+				'7.0.0'
+			);
 		}
 
 		$this->builder->usingRequestOptions(

tests/phpunit/tests/ai-client/wpAiClientPromptBuilder.php

@@ -192,11 +192,11 @@ public function test_constructor_sets_default_request_timeout() {
 	}
 
 	/**
-	 * Test that the constructor allows overriding the default request timeout.
+	 * Test that the constructor allows overriding the default request timeout with a higher value.
 	 *
 	 * @ticket 64591
 	 */
-	public function test_constructor_allows_overriding_request_timeout() {
+	public function test_constructor_allows_overriding_request_timeout_with_higher_value() {
 		add_filter(
 			'wp_ai_client_default_request_timeout',
 			static function () {
@@ -213,6 +213,66 @@ static function () {
 		$this->assertEquals( 45, $request_options->getTimeout() );
 	}
 
+	/**
+	 * Test that the constructor allows overriding the default request timeout with null.
+	 *
+	 * @ticket 65094
+	 */
+	public function test_constructor_allows_overriding_request_timeout_with_null() {
+		add_filter( 'wp_ai_client_default_request_timeout', '__return_null' );
+
+		$builder = new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry() );
+
+		/** @var RequestOptions $request_options */
+		$request_options = $this->get_wrapped_prompt_builder_property_value( $builder, 'requestOptions' );
+
+		$this->assertInstanceOf( RequestOptions::class, $request_options );
+		$this->assertNull( $request_options->getTimeout() );
+	}
+
+	/**
+	 * Test that the constructor disallows overriding the default request timeout with a invalid value.
+	 *
+	 * @ticket 65094
+	 *
+	 * @expectedIncorrectUsage WP_AI_Client_Prompt_Builder::__construct
+	 */
+	public function test_constructor_disallows_overriding_with_negative_request_timeout() {
+		add_filter(
+			'wp_ai_client_default_request_timeout',
+			static function () {
+				return -1;
+			}
+		);
+
+		$builder = new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry() );
+
+		/** @var RequestOptions $request_options */
+		$request_options = $this->get_wrapped_prompt_builder_property_value( $builder, 'requestOptions' );
+
+		$this->assertInstanceOf( RequestOptions::class, $request_options );
+		$this->assertEquals( 30, $request_options->getTimeout() );
+	}
+
+	/**
+	 * Test that the constructor disallows overriding the default request timeout with a invalid value.
+	 *
+	 * @ticket 65094
+	 *
+	 * @expectedIncorrectUsage WP_AI_Client_Prompt_Builder::__construct
+	 */
+	public function test_constructor_disallows_overriding_with_bad_request_timeout_type() {
+		add_filter( 'wp_ai_client_default_request_timeout', '__return_empty_array' );
+
+		$builder = new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry() );
+
+		/** @var RequestOptions $request_options */
+		$request_options = $this->get_wrapped_prompt_builder_property_value( $builder, 'requestOptions' );
+
+		$this->assertInstanceOf( RequestOptions::class, $request_options );
+		$this->assertEquals( 30, $request_options->getTimeout() );
+	}
+
 	/**
 	 * Test method chaining with fluent methods.
 	 *