Reduce the payload of the cached HTTP client response (#805)

Author: srtfisher

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.12.1
+
+### Changed
+
+- Remove some unnecessary data from the serialized HTTP response to reduce
+  the size when caching.
+
 ## v1.12.0
 
 ### Added

src/mantle/http-client/class-cache-flexible-middleware.php

@@ -60,6 +60,8 @@ public function __invoke( Pending_Request $request, Closure $next ): Response {
 					defer( fn () => $this->store_response( $fresh_request->send() ) );
 				}
 
+				$response->cached = true;
+
 				return $response;
 			}
 		}

src/mantle/http-client/class-cache-middleware.php

@@ -50,6 +50,8 @@ public function __invoke( Pending_Request $request, Closure $next ): Response {
 		$cache     = wp_cache_get( $cache_key, self::CACHE_GROUP );
 
 		if ( $cache && $cache instanceof Response ) {
+			$cache->cached = true;
+
 			return $cache;
 		}
 

src/mantle/http-client/class-response.php

@@ -48,6 +48,7 @@
  *     code: int,
  *     message: string,
  *   },
+ *   http_response?: \WP_HTTP_Requests_Response,
  * }
  */
 class Response implements ArrayAccess {
@@ -73,6 +74,16 @@ class Response implements ArrayAccess {
 	 */
 	protected array $response;
 
+	/**
+	 * The request URL.
+	 */
+	protected readonly ?string $url;
+
+	/**
+	 * Determine if the response was created from the cache.
+	 */
+	public bool $cached = false;
+
 	/**
 	 * Constructor.
 	 *
@@ -88,6 +99,13 @@ public function __construct( array $response ) {
 		$response['headers'] = array_change_key_case( (array) ( $response['headers'] ?? [] ) );
 
 		$this->response = $response;
+
+		// @phpstan-ignore instanceof.alwaysTrue
+		if ( isset( $response['http_response'] ) && $response['http_response'] instanceof \WP_HTTP_Requests_Response ) {
+			$this->url = $response['http_response']->get_response_object()->url;
+		} else {
+			$this->url = null;
+		}
 	}
 
 	/**
@@ -463,4 +481,25 @@ public function offsetSet( mixed $offset, mixed $value ): void {
 	public function offsetUnset( mixed $offset ): void {
 		throw new LogicException( 'Response values are read-only.' );
 	}
+
+	/**
+	 * Prepare the object for serialization.
+	 *
+	 * @return array<string, mixed>
+	 */
+	public function __serialize(): array {
+		// Purge some data from the response for lighter serialization.
+		unset( $this->response['http_response'] );
+
+		foreach ( [ 'cookies', 'filename', 'headers' ] as $key ) {
+			if ( empty( $this->response[ $key ] ) ) {
+				unset( $this->response[ $key ] );
+			}
+		}
+
+		return [
+			'url'      => $this->url,
+			'response' => $this->response,
+		];
+	}
 }

tests/HttpClient/CachedHttpClientTest.php

@@ -37,10 +37,17 @@ public function test_can_create_cached_client() {
 	}
 
 	public function test_it_can_make_http_request() {
+		// $this->allow_stray_requests();
 		$this->fake_request( mock_http_response()->with_json( [ 'example' => 'value' ] ) );
 
-		$this->client->get( 'https://example.com' );
-		$this->client->get( 'https://example.com' );
+		$response = $this->client->get( 'https://example.com' );
+
+		$this->assertEquals( 'value', $response->json( 'example' ) );
+
+		$response = $this->client->get( 'https://example.com' );
+
+		$this->assertEquals( 'value', $response->json( 'example' ) );
+		$this->assertTrue( $response->cached );
 
 		$this->assertRequestCount( 1 );
 	}