Add a better dump() helper for responses (#616)

* Add a better dump() helper for responses

* CHANGELOG about QUERY_STRING

Author: srtfisher

CHANGELOG.md

@@ -7,18 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-Minimum PHP version is now 8.2. The framework supports 8.2 - 8.4.
+📢 Minimum PHP version is now 8.2. The framework supports 8.2 - 8.4.
 
 ### Added
 
 - Add a `without_local_object_cache()` method to prevent the `object-cache.php` drop-in from being loaded locally.
+- Added a better `dump()` method to the response object when testing HTTP
+  requests that will dump the request/response to the console.
 
 ### Changed
 
 - Removed support for PHP 8.1. The minimum PHP version is now 8.2.
 - For projects that require PHPUnit 9, the `phpunit/phpunit` version is now set to `^9.6.22`.
 - Upgraded to Symfony 7.0 packages.
 - Disable `spatie/once`'s cache if found during unit testing.
+- Ensure that the `QUERY_STRING` server variable is set when testing HTTP
+	requests.
 
 ### Fixed
 

src/mantle/testing/class-pending-testable-request.php

@@ -278,21 +278,21 @@ public function call( string $method, mixed $uri, array $parameters = [], array
 
 		$this->test_case->call_before_callbacks();
 
+		// Setup the current request object.
+		$request = new Request(
+			$_GET,
+			$_POST,
+			[],
+			$_COOKIE,
+			$_FILES,
+			$_SERVER,
+			$content
+		);
+
 		// Attempt to run the query through the Mantle router.
 		if ( isset( $this->test_case->app['router'] ) ) {
 			$kernel = new HttpKernel( $this->test_case->app, $this->test_case->app['router'] );
 
-			// Setup the current request object.
-			$request = new Request(
-				$_GET,
-				$_POST,
-				[],
-				$_COOKIE,
-				$_FILES,
-				$_SERVER,
-				$content
-			);
-
 			// Mirror the logic from Request::createFromGlobals().
 			if (
 				str_starts_with( (string) $request->headers->get( 'CONTENT_TYPE', '' ), 'application/x-www-form-urlencoded' )
@@ -330,6 +330,7 @@ public function call( string $method, mixed $uri, array $parameters = [], array
 			} catch ( \Exception $e ) {
 				// If an exception occurs, make sure the output buffer is closed before the exception continues to the caller.
 				ob_end_clean();
+
 				throw $e;
 			}
 
@@ -364,7 +365,9 @@ public function call( string $method, mixed $uri, array $parameters = [], array
 			);
 		}
 
-		$response->set_app( $this->test_case->app );
+		$response
+			->set_app( $this->test_case->app )
+			->set_request( $request );
 
 		$this->test_case->call_after_callbacks( $response );
 
@@ -421,13 +424,11 @@ protected function reset_request_state(): void {
 			if ( str_starts_with( $key, 'HTTP_' ) && 'HTTP_HOST' !== $key ) {
 				unset( $_SERVER[ $key ] );
 			}
+		}
 
-			if ( isset( $_SERVER['CONTENT_TYPE'] ) ) {
-				unset( $_SERVER['CONTENT_TYPE'] );
-			}
-
-			if ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
-				unset( $_SERVER['REMOTE_ADDR'] );
+		foreach ( [ 'CONTENT_TYPE', 'QUERY_STRING', 'REMOTE_ADDR' ] as $header ) {
+			if ( isset( $_SERVER[ $header ] ) ) {
+				unset( $_SERVER[ $header ] );
 			}
 		}
 
@@ -468,6 +469,8 @@ protected function set_server_state( $method, $url, $server, $data, array $cooki
 			$req = $url;
 		}
 
+		$_SERVER['QUERY_STRING'] = $parts['query'] ?? '';
+
 		$_SERVER['REQUEST_URI'] = $req;
 
 		$_POST = $data;

src/mantle/testing/class-test-response.php

@@ -9,6 +9,7 @@
 
 use Exception;
 use Mantle\Contracts\Application;
+use Mantle\Http\Request;
 use Mantle\Http\Response;
 use Mantle\Support\Traits\Macroable;
 use PHPUnit\Framework\Assert as PHPUnit;
@@ -18,6 +19,7 @@
  */
 class Test_Response {
 	use Concerns\Element_Assertions;
+	use Concerns\Response_Dumper;
 	use Concerns\Response_Snapshot_Testing;
 	use Macroable;
 
@@ -28,6 +30,8 @@ class Test_Response {
 
 	/**
 	 * Response headers.
+	 *
+	 * @var array<string, string|array<string>>
 	 */
 	public array $headers;
 
@@ -46,6 +50,11 @@ class Test_Response {
 	 */
 	protected Assertable_Json_String $decoded_json;
 
+	/**
+	 * Request that generated the response.
+	 */
+	protected Request $request;
+
 	/**
 	 * Create a new test response instance.
 	 *
@@ -69,14 +78,31 @@ public function __construct(
 	 * Set the container instance.
 	 *
 	 * @param Application $app Application instance.
-	 * @return static
 	 */
-	public function set_app( Application $app ) {
+	public function set_app( Application $app ): static {
 		$this->app = $app;
 
 		return $this;
 	}
 
+	/**
+	 * Set the request that generated the response.
+	 *
+	 * @param Request $request Request instance.
+	 */
+	public function set_request( Request $request ): static {
+		$this->request = $request;
+
+		return $this;
+	}
+
+	/**
+	 * Get the request that generated the response.
+	 */
+	public function get_request(): ?Request {
+		return $this->request ?? null;
+	}
+
 	/**
 	 * Create a response from a base response instance.
 	 *
@@ -802,109 +828,4 @@ public function decoded_json(): Assertable_Json_String {
 	public function json( ?string $key = null ) {
 		return $this->decoded_json()->json( $key );
 	}
-
-	/**
-	 * Dump the contents of the response to the screen.
-	 */
-	public function dump(): static {
-		$content = $this->get_content();
-
-		// If the content is not JSON, dump it as is.
-		if ( 'application/json' !== $this->get_header( 'Content-Type' ) ) {
-			dump( $content );
-
-			return $this;
-		}
-
-		$json = json_decode( $content );
-
-		if ( json_last_error() === JSON_ERROR_NONE ) {
-			$content = $json;
-		}
-
-		dump( $content );
-
-		return $this;
-	}
-
-	/**
-	 * Dump the headers of the response to the screen.
-	 */
-	public function dump_headers(): static {
-		dump( $this->headers );
-
-		return $this;
-	}
-
-	/**
-	 * Camel-case alias to dump_headers().
-	 */
-	public function dumpHeaders(): static {
-		return $this->dump_headers();
-	}
-
-	/**
-	 * Dump the JSON, optionally by path, to the screen.
-	 *
-	 * @param string|null $path
-	 */
-	public function dump_json( ?string $path = null ): static {
-		dump( $this->json( $path ) );
-
-		return $this;
-	}
-
-	/**
-	 * Camel-case alias to dump_json().
-	 *
-	 * @param string|null $path
-	 */
-	public function dumpJson( ?string $path = null ): static {
-		return $this->dump_json( $path );
-	}
-
-	/**
-	 * Dump the content from the response and end the script.
-	 */
-	public function dd(): void {
-		$this->dump();
-
-		exit( 1 );
-	}
-
-	/**
-	 * Dump the headers from the response and end the script.
-	 */
-	public function dd_headers(): void {
-		$this->dump_headers();
-
-		exit( 1 );
-	}
-
-	/**
-	 * Camel-case alias to dd_headers().
-	 */
-	public function ddHeaders(): void {
-		$this->dd_headers();
-	}
-
-	/**
-	 * Dump the JSON from the response and end the script.
-	 *
-	 * @param string|null $path
-	 */
-	public function dd_json( ?string $path = null ): void {
-		$this->dump_json( $path );
-
-		exit( 1 );
-	}
-
-	/**
-	 * Camel-case alias to dd_json().
-	 *
-	 * @param string|null $path
-	 */
-	public function ddJson( ?string $path = null ): void {
-		$this->dd_json( $path );
-	}
 }