Merge pull request #1022 from 10up/fix/vip-timeouts

Fix timeouts that can happen for long running tasks on a WP VIP environment

Author: dkotter

includes/Classifai/Helpers.php

@@ -832,9 +832,13 @@ function is_local_path( string $resource_ref ): bool {
 /**
  * Safe generic HTTP wrapper compatible with WP VIP.
  *
- * - Use vip_safe_wp_remote_request() when available.
- * - Fall back to wp_remote_request() on other scenarios.
- * - Respect all call args (timeout, headers, method, etc).
+ * By default this function uses the WordPress HTTP API for requests,
+ * to use vip_safe_wp_remote_request() (if available) specify
+ * `$args['use_vip'] = true`.
+ *
+ * As a general guide, prompt requests should use the WordPress HTTP API;
+ * administrative requests (API authentication, scope requests) should use the
+ * WordPress VIP API if available.
  *
  * @since 3.6.0
  *
@@ -846,6 +850,9 @@ function is_local_path( string $resource_ref ): bool {
 function safe_wp_remote_request( string $method, string $url, array $args = [] ) {
 	$method         = strtoupper( $method );
 	$args['method'] = $method;
+	$use_vip        = $args['use_vip'] ?? false;
+
+	unset( $args['use_vip'] );
 
 	// Respect timeout if caller set.
 	$timeout = isset( $args['timeout'] ) ? (int) $args['timeout'] : 20;
@@ -860,7 +867,8 @@ function safe_wp_remote_request( string $method, string $url, array $args = [] )
 		$args['headers']['User-Agent'] = $cached_user_agent;
 	}
 
-	if ( function_exists( 'vip_safe_wp_remote_request' ) ) {
+	// Use VIP-safe wrapper if available and wanted. Some requests need a longer timeout than VIP allows.
+	if ( function_exists( 'vip_safe_wp_remote_request' ) && (bool) $use_vip ) {
 		$fallback  = '';
 		$threshold = 3;
 		$retry     = 20;
@@ -925,9 +933,10 @@ function safe_file_get_contents( string $file_path, array $args = [] ) {
 /**
  * Safe GET wrapper compatible with WP VIP.
  *
- * - Use vip_safe_wp_remote_get() when available.
- * - Fall back to wp_remote_get() on other scenarios.
- * - Respect all call args (timeout, headers, etc).
+ * - By default will use the WordPress HTTP API for requests.
+ * - If `$args['use_vip'] = true` and vip_safe_wp_remote_get() is available,
+ * then vip_safe_wp_remote_get() will be used instead.
+ * - Respects all call args (timeout, headers, etc).
  *
  * @since 3.6.0
  *
@@ -942,9 +951,10 @@ function safe_wp_remote_get( string $url, array $args = [] ) {
 /**
  * Safe POST wrapper compatible with WP VIP.
  *
- * - Use vip_safe_wp_remote_post() when available.
- * - Fall back to wp_remote_post() on other scenarios.
- * - Respect all call args (timeout, headers, etc).
+ * - By default will use the WordPress HTTP API for requests.
+ * - If `$args['use_vip'] = true` and vip_safe_wp_remote_post() is available,
+ * then vip_safe_wp_remote_post() will be used instead.
+ * - Respects all call args (timeout, headers, etc).
  *
  * @since 3.6.0
  *

includes/Classifai/Providers/Azure/ComputerVision.php

@@ -763,6 +763,7 @@ protected function authenticate_credentials( string $url, string $api_key ) {
 					'Content-Type'              => 'application/json',
 				],
 				'body'    => '{"url":"https://classifaiplugin.com/wp-content/themes/fse-classifai-theme/assets/img/header.png"}',
+				'use_vip' => true,
 			]
 		);
 

includes/Classifai/Providers/Azure/Embeddings.php

@@ -296,6 +296,7 @@ protected function authenticate_credentials( string $url, string $api_key, strin
 						'dimensions' => $this->get_dimensions(),
 					]
 				),
+				'use_vip' => true,
 			]
 		);
 

includes/Classifai/Providers/Azure/OpenAI.php

@@ -314,6 +314,7 @@ protected function authenticate_credentials( string $url, string $api_key, strin
 						'max_tokens' => 5,
 					]
 				),
+				'use_vip' => true,
 			]
 		);
 

includes/Classifai/Providers/Azure/Speech.php

@@ -207,6 +207,7 @@ public function connect_to_service( array $args = array() ): array {
 				'Ocp-Apim-Subscription-Key' => $default['api_key'],
 				'Content-Type'              => 'application/json',
 			),
+			'use_vip' => true,
 		);
 
 		// Create request URL.

includes/Classifai/Providers/ElevenLabs/ElevenLabs.php

@@ -219,7 +219,7 @@ protected function get_models( string $api_key = '' ) {
 			return new WP_Error( 'auth', esc_html__( 'Please enter your ElevenLabs API key.', 'classifai' ) );
 		}
 
-		$response = $this->request( $this->get_api_url( $this->model_path ), $api_key, 'get' );
+		$response = $this->request( $this->get_api_url( $this->model_path ), $api_key, 'get', [ 'use_vip' => true ] );
 
 		if ( is_wp_error( $response ) ) {
 			return $response;
@@ -260,7 +260,7 @@ protected function get_voices( string $api_key = '' ) {
 			return new WP_Error( 'auth', esc_html__( 'Please enter your ElevenLabs API key.', 'classifai' ) );
 		}
 
-		$response = $this->request( $this->get_api_url( 'voices?per_page=100' ), $api_key, 'get' );
+		$response = $this->request( $this->get_api_url( 'voices?per_page=100' ), $api_key, 'get', [ 'use_vip' => true ] );
 
 		if ( is_wp_error( $response ) ) {
 			return $response;

includes/Classifai/Providers/GoogleAI/GoogleAI.php

@@ -65,7 +65,7 @@ protected function get_models( string $api_key = '' ) {
 
 		// Make request to ensure credentials work.
 		$request  = new APIRequest( $api_key );
-		$response = $request->get( $this->model_url );
+		$response = $request->get( $this->model_url, [ 'use_vip' => true ] );
 
 		if ( is_wp_error( $response ) ) {
 			return $response;

includes/Classifai/Providers/Localhost/Ollama.php

@@ -149,6 +149,7 @@ public function get_models( array $args = [] ): array {
 			$this->get_api_model_url( $default['endpoint_url'] ),
 			[
 				'timeout' => 30, // phpcs:ignore WordPressVIPMinimum.Performance.RemoteRequestTimeout.timeout_timeout
+				'use_vip' => true,
 			]
 		);
 

includes/Classifai/Providers/Localhost/StableDiffusion.php

@@ -229,6 +229,7 @@ public function get_models( array $args = [] ): array {
 			$this->get_api_model_url( $default['endpoint_url'] ),
 			[
 				'timeout' => 30, // phpcs:ignore WordPressVIPMinimum.Performance.RemoteRequestTimeout.timeout_timeout
+				'use_vip' => true,
 			]
 		);
 

includes/Classifai/Providers/OpenAI/OpenAI.php

@@ -72,7 +72,7 @@ protected function authenticate_credentials( string $api_key = '' ) {
 
 		// Make request to ensure credentials work.
 		$request  = new APIRequest( $api_key );
-		$response = $request->get( $this->model_url );
+		$response = $request->get( $this->model_url, [ 'use_vip' => true ] );
 
 		return ! is_wp_error( $response ) ? true : $response;
 	}