[HttpClient] CurlClient (#16)

Adds a CurlClient class to benefit from `libcurl` when available:

```php
$client = Client::create();
// $client is CurlClient when libcurl extension is available and SocketClient otherwise

$client->fetch("https://w.org");
```

### Motivateion

Curl is faster than `stream_socket_*` functions and supports more HTTP
features (e.g. HTTP 2.0).

### Implementation

Before this PR there was a single `Client` class that used
`stream_socket_*` functions for managing HTTP connections.

After this PR there's:

* `Client` abstract class with `Client::create( $options )` method.
* `SocketClient` – the previous `Client` class.
* `CurlClient` – the new libcurl-based HTTP client.

The event-based API remains the same. Both clients pass a similar test
suite.

### Testing instructions

Confirm the tests worked

Author: adamziel

components/Blueprints/DataReference/DataReferenceResolver.php

@@ -12,14 +12,14 @@
 use WordPress\Git\GitFilesystem;
 use WordPress\Git\GitRepository;
 use WordPress\HttpClient\ByteStream\SeekableRequestReadStream;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 
 use function WordPress\Filesystem\wp_join_unix_paths;
 use function WordPress\Filesystem\wp_unix_sys_get_temp_dir;
 
 class DataReferenceResolver {
 	/**
-	 * @var Client
+	 * @var SocketClient
 	 */
 	private $client;
 	/**
@@ -47,7 +47,7 @@ class DataReferenceResolver {
 	 */
 	private $tmpRoot;
 
-	public function __construct( Client $client, ?string $tmpRoot = null ) {
+	public function __construct( SocketClient $client, ?string $tmpRoot = null ) {
 		$this->client  = $client;
 		$this->tmpRoot = $tmpRoot ?: wp_unix_sys_get_temp_dir();
 	}

components/Blueprints/Runner.php

@@ -51,7 +51,7 @@
 use WordPress\Filesystem\InMemoryFilesystem;
 use WordPress\Filesystem\LocalFilesystem;
 use WordPress\HttpClient\ByteStream\RequestReadStream;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\Zip\ZipFilesystem;
 
 use function WordPress\Encoding\utf8_is_valid_byte_stream;
@@ -65,7 +65,7 @@ class Runner {
 	private $configuration;
 	// TODO: Rename httpClient
 	/**
-	 * @var Client
+	 * @var SocketClient
 	 */
 	private $client;
 	/**
@@ -113,7 +113,7 @@ public function __construct( RunnerConfiguration $configuration ) {
 		$this->configuration = $configuration;
 		$this->validateConfiguration( $configuration );
 
-		$this->client      = new Client();
+		$this->client      = new SocketClient();
 		$this->mainTracker = new Tracker();
 
 		// Set up progress logging
@@ -652,16 +652,16 @@ private function createStepObject( string $stepType, array $data ) {
 			case 'importContent':
 				/**
 				 * Flatten the content declaration from
-				 * 
+				 *
 				 *     "content": [
 				 *         {
 				 *             "type": "posts",
 				 *             "source": [ "post1.html", "post2.html" ]
 				 *         }
 				 *     ]
-				 * 
+				 *
 				 * into
-				 * 
+				 *
 				 *     "content": [
 				 *         {
 				 *             "type": "posts",

components/Blueprints/Runtime.php

@@ -2,9 +2,7 @@
 
 namespace WordPress\Blueprints;
 
-use Exception;
 use Psr\Log\LoggerInterface;
-use RuntimeException;
 use Symfony\Component\Process\Process;
 use WordPress\Blueprints\DataReference\DataReference;
 use WordPress\Blueprints\DataReference\DataReferenceResolver;
@@ -14,7 +12,7 @@
 use WordPress\ByteStream\WriteStream\FileWriteStream;
 use WordPress\Filesystem\Filesystem;
 use WordPress\Filesystem\LocalFilesystem;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 
 use function WordPress\Filesystem\pipe_stream;
 use function WordPress\Filesystem\wp_join_unix_paths;
@@ -49,7 +47,7 @@ class Runtime {
 	 */
 	private $assets;
 	/**
-	 * @var Client
+	 * @var SocketClient
 	 */
 	private $client;
 	/**
@@ -69,7 +67,7 @@ public function __construct(
 		Filesystem $targetFs,
 		RunnerConfiguration $configuration,
 		DataReferenceResolver $assets,
-		Client $client,
+		SocketClient $client,
 		array $blueprint,
 		string $tempRoot,
 		DataReference $wpCliReference
@@ -83,7 +81,7 @@ public function __construct(
 		$this->wpCliReference = $wpCliReference;
 	}
 
-	public function getHttpClient(): Client {
+	public function getHttpClient(): SocketClient {
 		return $this->client;
 	}
 

components/Blueprints/SiteResolver/NewSiteResolver.php

@@ -2,14 +2,13 @@
 
 namespace WordPress\Blueprints\SiteResolver;
 
-use Exception;
 use WordPress\Blueprints\DataReference\DataReference;
 use WordPress\Blueprints\DataReference\File;
 use WordPress\Blueprints\Exception\BlueprintExecutionException;
 use WordPress\Blueprints\Progress\Tracker;
 use WordPress\Blueprints\Runtime;
 use WordPress\Blueprints\VersionStrings\VersionConstraint;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\Zip\ZipFilesystem;
 
 use function WordPress\Filesystem\copy_between_filesystems;
@@ -144,7 +143,7 @@ static public function resolve( Runtime $runtime, Tracker $progress, ?VersionCon
 		$progress->finish();
 	}
 
-	static private function resolveWordPressZipUrl( Client $client, string $version_string ): string {
+	static private function resolveWordPressZipUrl( SocketClient $client, string $version_string ): string {
 		if ( $version_string === 'latest' ) {
 			return 'https://wordpress.org/latest.zip';
 		}

components/Blueprints/Steps/SetSiteLanguageStep.php

@@ -5,7 +5,7 @@
 use Exception;
 use WordPress\Blueprints\Progress\Tracker;
 use WordPress\Blueprints\Runtime;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\HttpClient\Request;
 use WordPress\Zip\ZipFilesystem;
 
@@ -226,7 +226,7 @@ function(\$theme) {
 	 *
 	 * @return string|false
 	 */
-	private function getWordPressTranslationUrl( Runtime $runtime, string $wpVersion, string $language, Client $client ) {
+	private function getWordPressTranslationUrl( Runtime $runtime, string $wpVersion, string $language, SocketClient $client ) {
 		try {
 			$api_url           = "https://api.wordpress.org/translations/core/1.0/?version={$wpVersion}";
 			$translations_data = $client->fetch( $api_url )->json();

components/Blueprints/Tests/Unit/DataReference/DataReferenceResolverTest.php

@@ -5,7 +5,6 @@
 use Exception;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
-use RuntimeException;
 use WordPress\Blueprints\DataReference\DataReference;
 use WordPress\Blueprints\DataReference\DataReferenceResolver;
 use WordPress\Blueprints\DataReference\Directory;
@@ -19,10 +18,10 @@
 use WordPress\ByteStream\MemoryPipe;
 use WordPress\ByteStream\ReadStream\ByteReadStream;
 use WordPress\Filesystem\Filesystem;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 
 class DataReferenceResolverTest extends TestCase {
-	/** @var Client&MockObject */
+	/** @var SocketClient&MockObject */
 	protected $client;
 	protected $resolver;
 	/** @var Filesystem&MockObject */
@@ -31,7 +30,7 @@ class DataReferenceResolverTest extends TestCase {
 
 	protected function setUp(): void {
 		// @TODO: Don't mock. Just test actual resolution.
-		$this->client           = new Client();
+		$this->client           = new SocketClient();
 		$this->resolver         = new DataReferenceResolver( $this->client );
 		$this->executionContext = $this->createMock( Filesystem::class );
 		$this->tracker          = $this->createMock( Tracker::class );

components/DataLiberation/Importer/AttachmentDownloader.php

@@ -4,7 +4,7 @@
 
 use Exception;
 use WordPress\Filesystem\Filesystem;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\HttpClient\Request;
 
 use function WordPress\Filesystem\wp_join_unix_paths;
@@ -25,7 +25,7 @@ class AttachmentDownloader {
 	private $progress = array();
 
 	public function __construct( $output_root, $options = array() ) {
-		$this->client                 = new Client();
+		$this->client                 = new SocketClient();
 		$this->output_root            = $output_root;
 		$this->source_from_filesystem = $options['source_from_filesystem'] ?? null;
 	}
@@ -181,7 +181,7 @@ public function poll() {
 		 */
 
 		switch ( $event ) {
-			case Client::EVENT_GOT_HEADERS:
+			case SocketClient::EVENT_GOT_HEADERS:
 				if ( ! $request->is_redirected() ) {
 					if ( file_exists( $this->output_paths[ $original_request_id ] . '.partial' ) ) {
 						unlink( $this->output_paths[ $original_request_id ] . '.partial' );
@@ -196,7 +196,7 @@ public function poll() {
 					}
 				}
 				break;
-			case Client::EVENT_BODY_CHUNK_AVAILABLE:
+			case SocketClient::EVENT_BODY_CHUNK_AVAILABLE:
 				$chunk = $this->client->get_response_body_chunk();
 				if ( ! fwrite( $this->fps[ $original_request_id ], $chunk ) ) {
 					// @TODO: Don't echo the error message. Attach it to the import session instead for the user to review later on.
@@ -205,10 +205,10 @@ public function poll() {
 				}
 				$this->progress[ $original_url ]['received'] += strlen( $chunk );
 				break;
-			case Client::EVENT_FAILED:
+			case SocketClient::EVENT_FAILED:
 				$this->on_failure( $original_url, $original_request_id, $request->error );
 				break;
-			case Client::EVENT_FINISHED:
+			case SocketClient::EVENT_FINISHED:
 				if ( ! $request->is_redirected() ) {
 					// Only process if this was the last request in the chain.
 					$is_success = (

components/Git/GitRemote.php

@@ -18,13 +18,13 @@
 use WordPress\Git\Model\TreeEntry;
 use WordPress\Git\Protocol\GitProtocolEncoderPipe;
 use WordPress\Git\Protocol\Parser\GitProtocolDecoder;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\HttpClient\Request;
 
 
 class GitRemote {
 	/**
-	 * @var Client
+	 * @var SocketClient
 	 */
 	private $http_client;
 	/**
@@ -36,7 +36,7 @@ class GitRemote {
 	public function __construct( GitRepository $repository, $remote_name, $options = array() ) {
 		$this->remote_name = $remote_name;
 		$this->repository  = $repository;
-		$this->http_client = $options['http_client'] ?? new Client(
+		$this->http_client = $options['http_client'] ?? new SocketClient(
 			array(
 				'timeout_ms' => 300000,
 			)

components/HttpClient/ByteStream/RequestReadStream.php

@@ -4,7 +4,7 @@
 
 use WordPress\ByteStream\ByteStreamException;
 use WordPress\ByteStream\ReadStream\BaseByteReadStream;
-use WordPress\HttpClient\Client;
+use WordPress\HttpClient\Client\SocketClient;
 use WordPress\HttpClient\HttpClientException;
 use WordPress\HttpClient\Request;
 use WordPress\HttpClient\Response;
@@ -15,7 +15,7 @@
 class RequestReadStream extends BaseByteReadStream {
 
 	/**
-	 * @var Client
+	 * @var SocketClient
 	 */
 	private $client;
 	/**
@@ -43,7 +43,7 @@ public function __construct( $request, $options = array() ) {
 		if ( is_string( $request ) ) {
 			$request = new Request( $request );
 		}
-		$this->client  = $options['client'] ?? new Client();
+		$this->client  = $options['client'] ?? new SocketClient();
 		$this->request = $request;
 		if ( isset( $options['buffer_size'] ) ) {
 			$this->buffer_size = $options['buffer_size'];
@@ -87,13 +87,13 @@ protected function internal_pull( $max_bytes = 8096 ): string {
 		return $this->pull_until_event(
 			array(
 				'max_bytes' => $max_bytes,
-				'event'     => Client::EVENT_BODY_CHUNK_AVAILABLE,
+				'event'     => SocketClient::EVENT_BODY_CHUNK_AVAILABLE,
 			)
 		);
 	}
 
 	private function pull_until_event( $options = array() ) {
-		$stop_at_event = $options['event'] ?? Client::EVENT_BODY_CHUNK_AVAILABLE;
+		$stop_at_event = $options['event'] ?? SocketClient::EVENT_BODY_CHUNK_AVAILABLE;
 		$this->ensure_is_enqueued();
 
 		while ( $this->client->await_next_event(
@@ -113,7 +113,7 @@ private function pull_until_event( $options = array() ) {
 				continue;
 			}
 			switch ( $this->client->get_event() ) {
-				case Client::EVENT_GOT_HEADERS:
+				case SocketClient::EVENT_GOT_HEADERS:
 					$this->response = $response;
 					$content_length = $response->get_header( 'Content-Length' );
 					if ( null !== $content_length ) {
@@ -126,12 +126,12 @@ private function pull_until_event( $options = array() ) {
 						 */
 						$this->remote_file_length = (int) $content_length;
 					}
-					if ( $stop_at_event === Client::EVENT_GOT_HEADERS ) {
+					if ( $stop_at_event === SocketClient::EVENT_GOT_HEADERS ) {
 						return true;
 					}
 					break;
-				case Client::EVENT_BODY_CHUNK_AVAILABLE:
-					if ( $stop_at_event === Client::EVENT_BODY_CHUNK_AVAILABLE ) {
+				case SocketClient::EVENT_BODY_CHUNK_AVAILABLE:
+					if ( $stop_at_event === SocketClient::EVENT_BODY_CHUNK_AVAILABLE ) {
 						$body_chunk = $this->client->get_response_body_chunk();
 
 						if ( $this->progress_tracker ) {
@@ -144,7 +144,7 @@ private function pull_until_event( $options = array() ) {
 						return $body_chunk;
 					}
 					break;
-				case Client::EVENT_FINISHED:
+				case SocketClient::EVENT_FINISHED:
 					/**
 					 * If the server did not provide a Content-Length header,
 					 * backfill the file length with the number of downloaded
@@ -155,7 +155,7 @@ private function pull_until_event( $options = array() ) {
 					}
 
 					return '';
-				case Client::EVENT_FAILED:
+				case SocketClient::EVENT_FAILED:
 					// TODO: Think through error handling. Errors are expected when working with
 					// the network. Should we auto retry? Make it easy for the caller to retry?
 					// Something else?
@@ -174,7 +174,7 @@ public function await_response() {
 		if ( ! $this->response ) {
 			$this->pull_until_event(
 				array(
-					'event' => Client::EVENT_GOT_HEADERS,
+					'event' => SocketClient::EVENT_GOT_HEADERS,
 				)
 			);
 		}
@@ -188,7 +188,7 @@ public function await_response() {
 	protected function internal_reached_end_of_data(): bool {
 		return (
 			Request::STATE_FINISHED === $this->request->latest_redirect()->state &&
-			! $this->client->has_pending_event( $this->request, Client::EVENT_BODY_CHUNK_AVAILABLE ) &&
+			! $this->client->has_pending_event( $this->request, SocketClient::EVENT_BODY_CHUNK_AVAILABLE ) &&
 			strlen( $this->buffer ) === $this->offset_in_current_buffer
 		);
 	}