Add RedirectingClient to handle http redirections as a middelware

Author: adamziel

components/HttpClient/CacheClient.php

@@ -99,7 +99,7 @@ public function get_request(): ?Request {
 
 	public function get_response(): ?Response {
 		return $this->response;
-	}
+	}	
 
 	public function get_response_body_chunk(): ?string {
 		return $this->cache_key;

components/HttpClient/Client.php

@@ -57,7 +57,7 @@
  * @package  WordPress
  * @subpackage Async_HTTP
  */
-class Client {
+class Client implements ClientInterface {
 
 	/**
 	 * The maximum number of concurrent connections allowed.
@@ -71,16 +71,6 @@ class Client {
 	 */
 	protected $concurrency;
 
-	/**
-	 * The maximum number of redirects to follow for a single request.
-	 *
-	 * This prevents infinite redirect loops and provides a degree of control over the client's behavior.
-	 * Setting it too high might lead to unexpected navigation paths.
-	 *
-	 * @var int
-	 */
-	protected $max_redirects = 3;
-
 	/**
 	 * All the HTTP requests ever enqueued with this Client.
 	 *
@@ -112,34 +102,35 @@ class Client {
 	protected $requests_started_at = array();
 
 	public function __construct( $options = array() ) {
-		$this->concurrency   = $options['concurrency'] ?? 10;
-		$this->max_redirects = $options['max_redirects'] ?? 3;
+		$this->concurrency        = $options['concurrency'] ?? 10;
 		$this->request_timeout_ms = $options['timeout_ms'] ?? 30000;
-		$this->requests      = array();
+		$this->requests           = array();
 	}
 
 	/**
 	 * Returns a RemoteFileReader that streams the response body of the
 	 * given request.
 	 *
 	 * @param  Request  $request  The request to stream.
+	 * @param  array    $options  Options for the request.
 	 *
 	 * @return RequestReadStream
 	 */
-	public function fetch( $request, $options = array() ) {
+	public function fetch( Request $request, array $options = [] ) {
 		return new RequestReadStream( $request,
-			array_merge( [ 'client' => $this ], is_array( $options ) ? $options : iterator_to_array( $options ) ) );
+			array_merge( [ 'client' => $this ], $options ) );
 	}
 
 	/**
 	 * Returns an array of RemoteFileReader instances that stream the response bodies
 	 * of the given requests.
 	 *
 	 * @param  Request[]  $requests  The requests to stream.
+	 * @param  array      $options   Options for the requests.
 	 *
 	 * @return RequestReadStream[]
 	 */
-	public function fetch_many( array $requests, $options = array() ) {
+	public function fetch_many( array $requests, array $options = [] ) {
 		$streams = array();
 
 		foreach ( $requests as $request ) {
@@ -155,11 +146,11 @@ public function fetch_many( array $requests, $options = array() ) {
 	 * an internal queue. Network transmission is delayed until one of the returned
 	 * streams is read from.
 	 *
-	 * @param  Request|Request[]  $requests  The HTTP request(s) to enqueue. Can be a single request or an array of requests.
+	 * @param  Request[]  $requests  The HTTP request(s) to enqueue.
 	 */
 	public function enqueue( $requests ) {
-		if ( ! is_array( $requests ) ) {
-			$requests = array( $requests );
+		if(!is_array($requests)) {
+			$requests = [$requests];
 		}
 
 		foreach ( $requests as $request ) {
@@ -199,7 +190,6 @@ public function enqueue( $requests ) {
 	 *
 	 * * `Client::EVENT_GOT_HEADERS`
 	 * * `Client::EVENT_BODY_CHUNK_AVAILABLE`
-	 * * `Client::EVENT_REDIRECT`
 	 * * `Client::EVENT_FAILED`
 	 * * `Client::EVENT_FINISHED`
 	 *
@@ -227,7 +217,7 @@ public function enqueue( $requests ) {
 	 * $request = new Request( "https://w.org" );
 	 *
 	 * $client = new HttpClientClient();
-	 * $client->enqueue( $request );
+	 * $client->enqueue( [$request] );
 	 * $event = $client->await_next_event( [
 	 *    'request_id' => $request->id,
 	 * ] );
@@ -239,15 +229,14 @@ public function enqueue( $requests ) {
 	 * request #1 has finished before you started awaiting
 	 * events for request #2.
 	 *
-	 * @param $query
+	 * @param array $query Query parameters for filtering events.
 	 *
 	 * @return bool
 	 */
-	public function await_next_event( $query = array() ) {
+	public function await_next_event( array $query = [] ) {
 		$ordered_events            = array(
 			self::EVENT_GOT_HEADERS,
 			self::EVENT_BODY_CHUNK_AVAILABLE,
-			self::EVENT_REDIRECT,
 			self::EVENT_FAILED,
 			self::EVENT_FINISHED,
 		);
@@ -269,10 +258,6 @@ public function await_next_event( $query = array() ) {
 				$events = array();
 				foreach ( $query['requests'] as $query_request ) {
 					$events[] = $query_request->id;
-					while ( $query_request->redirected_to ) {
-						$query_request = $query_request->redirected_to;
-						$events[]      = $query_request->id;
-					}
 				}
 			}
 
@@ -308,7 +293,7 @@ public function await_next_event( $query = array() ) {
 		return false;
 	}
 
-	public function has_pending_event( $request, $event_type ) {
+	public function has_pending_event( Request $request, string $event_type ): bool {
 		return $this->events[ $request->id ][ $event_type ] ?? false;
 	}
 
@@ -403,7 +388,11 @@ protected function event_loop_tick() {
 			$this->get_active_requests( Request::STATE_RECEIVING_HEADERS )
 		);
 
-		$this->handle_redirects(
+		$this->receive_response_body(
+			$this->get_active_requests( Request::STATE_RECEIVING_BODY )
+		);
+
+		$this->mark_requests_finished(
 			$this->get_active_requests( Request::STATE_RECEIVED )
 		);
 
@@ -427,11 +416,6 @@ protected function event_loop_tick() {
 			return true;
 		}
 
-		$this->receive_response_body(
-			$this->get_active_requests( Request::STATE_RECEIVING_BODY )
-		);
-
-
 		return true;
 	}
 
@@ -779,8 +763,6 @@ protected function receive_response_headers( $requests ) {
 	}
 
 	/**
-	 * Reads the next received portion of HTTP response headers for multiple requests.
-	 *
 	 * @param  array  $requests  An array of requests.
 	 */
 	protected function receive_response_body( $requests ) {
@@ -807,60 +789,6 @@ protected function receive_response_body( $requests ) {
 		}
 	}
 
-	/**
-	 * @param  array  $requests  An array of requests.
-	 */
-	protected function handle_redirects( $requests ) {
-		foreach ( $requests as $request ) {
-			$response = $request->response;
-			if ( ! $response ) {
-				continue;
-			}
-			$code = $response->status_code;
-			$this->mark_finished( $request );
-			if ( ! ( $code >= 300 && $code < 400 ) ) {
-				continue;
-			}
-
-			$location = $response->get_header( 'location' );
-			if ( null === $location ) {
-				continue;
-			}
-
-			$redirects_so_far = 0;
-			$cause            = $request;
-			while ( $cause->redirected_from ) {
-				++ $redirects_so_far;
-				$cause = $cause->redirected_from;
-			}
-
-			if ( $redirects_so_far >= $this->max_redirects ) {
-				$this->set_error( $request, new HttpError( 'Too many redirects' ) );
-				continue;
-			}
-
-			$redirect_url = $location;
-			$parsed = WPURL::parse($redirect_url, $request->url);
-			if(false === $parsed) {
-				$this->set_error( $request, new HttpError( sprintf( 'Invalid redirect URL: %s', $redirect_url ) ) );
-				continue;
-			}
-			$redirect_url = $parsed->toString();
-
-			$this->events[ $request->id ][ self::EVENT_REDIRECT ] = true;
-			$this->enqueue(
-				new Request(
-					$redirect_url,
-					array(
-						// Redirects are always GET requests
-						'method'          => 'GET',
-						'redirected_from' => $request,
-					)
-				)
-			);
-		}
-	}
-
 	/**
 	 * Parses an HTTP headers string into an array containing the status and headers.
 	 *
@@ -1082,7 +1010,6 @@ protected function stream_select( $requests, $mode ) {
 
 	const EVENT_GOT_HEADERS = 'EVENT_GOT_HEADERS';
 	const EVENT_BODY_CHUNK_AVAILABLE = 'EVENT_BODY_CHUNK_AVAILABLE';
-	const EVENT_REDIRECT = 'EVENT_REDIRECT';
 	const EVENT_FAILED = 'EVENT_FAILED';
 	const EVENT_FINISHED = 'EVENT_FINISHED';
 
@@ -1097,4 +1024,10 @@ protected function stream_select( $requests, $mode ) {
 	 * 5/100th of a second
 	 */
 	const NONBLOCKING_TIMEOUT_MICROSECONDS = 0.05 * self::MICROSECONDS_TO_SECONDS;
+
+	protected function mark_requests_finished( $requests ) {
+		foreach ( $requests as $request ) {
+			$this->mark_finished( $request );
+		}
+	}
 }

components/HttpClient/ClientInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace WordPress\HttpClient;
+
+interface ClientInterface {
+	public function fetch( Request $request, array $options = [] );
+	public function fetch_many( array $requests, array $options = [] );
+	public function enqueue( array $requests );
+	public function await_next_event( array $query = [] );
+	public function has_pending_event( Request $request, string $event_type );
+	public function get_event();
+	public function get_request();
+	public function get_response();
+	public function get_response_body_chunk();
+}