Changeset 62266

Timestamp:

04/26/2026 11:59:30 PM (5 months ago)

Author:

peterwilsoncc

Message:

AI: Validate filtered default request timeout in WP_AI_Client_Prompt_Builder.

This checks that the return value of the wp_ai_client_default_request_timeout filter is a non-negative number before passing it to RequestOptions. If the filtered value is invalid, it is discarded in favor of the original default of 30.0 and a _doing_it_wrong() notice is issued. Without this check, a fatal error would ensue from the exception thrown in \WordPress\AiClient\Providers\Http\DTO\RequestOptions::validateTimeout().

The following static analysis issues are addressed:

• Use float instead of int for the wp_ai_client_default_request_timeout filter parameter.
• Add missing PHP imports for Message and MessagePart in the PHPDoc for wp_ai_client_prompt().
• Add PHP return type hints for wp_ai_client_prompt() and WP_AI_Client_Cache::getMultiple().
• Use native property type hints in WP_AI_Client_HTTP_Client.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11596

Reviewed by peterwilsoncc.
Merges r62255 to the 7.0 branch.

Props westonruter, justlevine, flixos90, khushdoms, darshitrajyaguru97, adrmf25, jarodortegaaraya, tusharaddweb, gaurangsondagar.
Fixes #65094.

Location:

branches/7.0

Files:

• . (modified) (1 prop)
• src/wp-includes/ai-client.php (modified) (2 diffs)
• src/wp-includes/ai-client/adapters/class-wp-ai-client-cache.php (modified) (1 diff)
• src/wp-includes/ai-client/adapters/class-wp-ai-client-http-client.php (modified) (2 diffs)
• src/wp-includes/ai-client/class-wp-ai-client-prompt-builder.php (modified) (2 diffs)
• tests/phpunit/tests/ai-client/wpAiClientPromptBuilder.php (modified) (2 diffs)

branches/7.0/src/wp-includes/ai-client.php

@@ -9 +9 @@
 
 use WordPress\AiClient\AiClient;
+use WordPress\AiClient\Messages\DTO\Message;
+use WordPress\AiClient\Messages\DTO\MessagePart;
 
 /**
@@ -56 +58 @@
  * @return WP_AI_Client_Prompt_Builder The prompt builder instance.
  */
-function wp_ai_client_prompt( $prompt = null ) {
+function wp_ai_client_prompt( $prompt = null ): WP_AI_Client_Prompt_Builder {
         return new WP_AI_Client_Prompt_Builder( AiClient::defaultRegistry(), $prompt );
 }

branches/7.0/src/wp-includes/ai-client/adapters/class-wp-ai-client-cache.php

@@ -105 +105 @@
          * @return array<string, mixed> A list of key => value pairs.
          */
-        public function getMultiple( $keys, $default_value = null ) {
+        public function getMultiple( $keys, $default_value = null ): array {
                 /**
                  * Keys array.

branches/7.0/src/wp-includes/ai-client/adapters/class-wp-ai-client-http-client.php

@@ -33 +33 @@
          *
          * @since 7.0.0
-         * @var ResponseFactoryInterface
-         */
-        private $response_factory;
+         */
+        private ResponseFactoryInterface $response_factory;
 
         /**
@@ -41 +40 @@
          *
          * @since 7.0.0
-         * @var StreamFactoryInterface
-         */
-        private $stream_factory;
+         */
+        private StreamFactoryInterface $stream_factory;
 
         /**

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

@@ -191 +191 @@
                 }
 
+                $default_timeout = 30.0;
+
                 /**
                  * Filters the default request timeout in seconds for AI Client HTTP requests.
@@ -196 +198 @@
                  * @since 7.0.0
                  *
-                 * @param int $default_timeout The default timeout in seconds.
+                 * @param float $default_timeout The default timeout in seconds.
                  */
-                $default_timeout = (int) apply_filters( 'wp_ai_client_default_request_timeout', 30 );
+                $filtered_default_timeout = apply_filters( 'wp_ai_client_default_request_timeout', $default_timeout );
+                if ( is_numeric( $filtered_default_timeout ) && (float) $filtered_default_timeout >= 0.0 ) {
+                        $default_timeout = (float) $filtered_default_timeout;
+                } else {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                sprintf(
+                                        /* translators: %s: wp_ai_client_default_request_timeout */
+                                        __( 'The %s filter must return a non-negative number.' ),
+                                        '<code>wp_ai_client_default_request_timeout</code>'
+                                ),
+                                '7.0.0'
+                        );
+                }
 
                 $this->builder->usingRequestOptions(

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

@@ -193 +193 @@
 
         /**
-         * Test that the constructor allows overriding the default request timeout.
-         *
-         * @ticket 64591
-         */
-        public function test_constructor_allows_overriding_request_timeout() {
+         * Test that the constructor allows overriding the default request timeout with a valid value.
+         *
+         * @ticket 64591
+         * @ticket 65094
+         *
+         * @dataProvider data_valid_request_timeout_overrides
+         *
+         * @param mixed $input    The timeout value returned by the filter.
+         * @param float $expected The expected timeout stored on the request options.
+         */
+        public function test_constructor_allows_overriding_request_timeout_with_valid_timeout( $input, float $expected ) {
                 add_filter(
                         'wp_ai_client_default_request_timeout',
-                        static function () {
-                                return 45;
+                        static function () use ( $input ) {
+                                return $input;
                         }
                 );
@@ -211 +217 @@
 
                 $this->assertInstanceOf( RequestOptions::class, $request_options );
-                $this->assertSame( 45.0, $request_options->getTimeout() );
+                $this->assertSame( $expected, $request_options->getTimeout() );
+        }
+
+        /**
+         * Data provider for {@see self::test_constructor_allows_overriding_request_timeout_with_valid_timeout()}.
+         *
+         * @return array<string, array{0: mixed, 1: float}>
+         */
+        public function data_valid_request_timeout_overrides(): array {
+                return array(
+                        'float'    => array( 45.5, 45.5 ),
+                        'integer'  => array( 67, 67.0 ),
+                        'string'   => array( '20', 20.0 ),
+                        'infinity' => array( INF, INF ),
+                        'zero'     => array( 0.0, 0.0 ),
+                );
+        }
+
+        /**
+         * Test that the constructor disallows overriding the default request timeout with an invalid value.
+         *
+         * @ticket 65094
+         *
+         * @dataProvider data_invalid_request_timeouts
+         *
+         * @expectedIncorrectUsage WP_AI_Client_Prompt_Builder::__construct
+         *
+         * @param mixed $timeout The invalid timeout value returned by the filter.
+         */
+        public function test_constructor_disallows_overriding_with_invalid_request_timeout( $timeout ) {
+                add_filter(
+                        'wp_ai_client_default_request_timeout',
+                        static function () use ( $timeout ) {
+                                return $timeout;
+                        }
+                );
+
+                $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->assertSame( 30.0, $request_options->getTimeout() );
+        }
+
+        /**
+         * Data provider for {@see self::test_constructor_disallows_overriding_with_invalid_request_timeout()}.
+         *
+         * @return array<string, array{0: mixed}>
+         */
+        public function data_invalid_request_timeouts(): array {
+                return array(
+                        'negative number' => array( -1 ),
+                        'array'           => array( array() ),
+                        'null'            => array( null ),
+                );
         }