Context Navigation

← Previous Change
Next Change →

wpAiClientPromptBuilder.php

Timestamp:

04/22/2026 06:13:47 PM (3 months ago)

Author:

westonruter

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

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

File:

: 1 edited

trunk/tests/phpunit/tests/ai-client/wpAiClientPromptBuilder.php (modified) (2 diffs)

Legend:

: Unmodified
: Added
: Removed

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

-              r62248
+              r62255
         /**
+         * 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;
+                        }
                 );
 …
                 $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 ),
+                );
+        }

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 62255 for trunk/tests/phpunit/tests/ai-client/wpAiClientPromptBuilder.php

Legend:

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

Download in other formats: