Fix issues with clearing out globals that results in orphaned data. Account for sitemaps, feeds, and robots in testing. (#856)

* Migrating to contract for responses

* Adding a test for feeds

* Remove mutable from test response class

* Adding tests for sitemaps and a fake for sitemap renderer

* Docblock

* Reduce test

* Pass through to the sitemap renderer set instead of creating a new one

* Clear out wp_stylesheet_path

* Add reset_lazyload_queue from core

* Wrapping up with a need to fix locate_template

* Adding Makes_Http_Requests_With_Feeds

* CHANGELOG

* Drop comments

* Ensure rewrite is properly preserved and cleared (#857)

* Backup query variables between test runs

* Wrapping up wp_rewrite backup

* Use a deep copy when retrieving value

* Ensure rewrite is properly preserved and cleared

* CHANGELOG order

* Bump jetpack to 14.1

* Drop jetpack

* Reduce matrix

Author: srtfisher

.github/workflows/tests.yml

@@ -88,7 +88,7 @@ jobs:
         # https://make.wordpress.org/core/handbook/references/php-compatibility-and-wordpress-versions/
         php: [8.2, 8.3, 8.4, 8.5]
         wordpress: ${{fromJson(needs.get-versions.outputs.versions)}}
-        vip-mu-plugins: [true, false]
+        vip-mu-plugins: [false]
         exclude:
           # WordPress 6.7 added support for PHP 8.4.
           - php: 8.4
@@ -108,6 +108,17 @@ jobs:
           - php: 8.5
             wordpress: "6.5"
         include:
+          # Test with VIP MU Plugins enabled (using latest version of WordPress to prevent Jetpack compatibility issues).
+          - php: 8.4
+            wordpress: "latest"
+            dependencies: "prefer-stable"
+            multisite: true
+            vip-mu-plugins: true
+          - php: 8.4
+            wordpress: "latest"
+            dependencies: "prefer-stable"
+            multisite: false
+            vip-mu-plugins: true
           # Test with prefer-lowest selectively to check for compatibility issues with older dependencies.
           - php: 8.3
             wordpress: "latest"

CHANGELOG.md

@@ -7,9 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Added proper support for testing `robots.txt`, feeds, and sitemaps via the testing
+  framework's HTTP request methods.
+- Added a `Spy_Sitemaps_Renderer` class to replace the sitemap renderer during testing
+  to allow for spying on sitemap render calls.
+
 ### Changed
 
+- **Potentially breaking:** The `$wp_rewrite` global and public query variables in `WP`
+  are now backed up before any tests are run and restored before each test to prevent
+  side effects from tests that modify these globals. This will allow tests to properly
+  modify the rewrite rules and public query variables without affecting other tests.
 - Adds PHPStan testing to more traits.
+- Clear object metadata lazy load queue when tearing down a test.
 
 ## v1.16.0
 

composer.json

@@ -27,6 +27,7 @@
         "league/uri": "^7.5",
         "league/uri-interfaces": "^7.5",
         "monolog/monolog": "^2.9.1",
+        "myclabs/deep-copy": "^1.13",
         "nesbot/carbon": "^3.8.4",
         "nette/php-generator": "^4.1",
         "nunomaduro/termwind": "^1.15.1 || ^2.0",

src/mantle/contracts/http/interface-mutable-response.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * Mutable_Response interface file
+ *
+ * @package Mantle
+ */
+
+declare(strict_types=1);
+
+namespace Mantle\Contracts\Http;
+
+/**
+ * Mutable Response Interface
+ *
+ * Consistent response interface for HTTP responses used across packages for a
+ * mutable response.
+ */
+interface Mutable_Response extends Response {
+	/**
+	 * Set the response status code.
+	 *
+	 * @param int $code The status code to set.
+	 */
+	public function set_status_code( int $code ): void;
+
+	/**
+	 * Set the response headers.
+	 *
+	 * @param array<string, string> $headers The headers to set.
+	 */
+	public function set_headers( array $headers ): void;
+
+	/**
+	 * Set a response header.
+	 *
+	 * @param string          $name The header name.
+	 * @param string|string[] $value The header value.
+	 */
+	public function set_header( string $name, string|array $value ): void;
+
+	/**
+	 * Delete a response header.
+	 *
+	 * @param string $name The header name to delete.
+	 */
+	public function delete_header( string $name ): void;
+
+	/**
+	 * Set the response body.
+	 *
+	 * @param ?string $body The response body to set.
+	 */
+	public function set_body( ?string $body ): void;
+}

src/mantle/contracts/http/interface-response.php

@@ -0,0 +1,45 @@
+<?php
+/**
+ * Response interface file
+ *
+ * @package Mantle
+ */
+
+declare(strict_types=1);
+
+namespace Mantle\Contracts\Http;
+
+/**
+ * Response Interface
+ *
+ * Consistent response interface for HTTP responses used across packages.
+ */
+interface Response {
+	/**
+	 * Retrieve the response status code.
+	 */
+	public function get_status_code(): int;
+
+	/**
+	 * Retrieve all response headers.
+	 *
+	 * @return array<string, string> Array of headers.
+	 */
+	public function get_headers(): array;
+
+	/**
+	 * Retrieve a specific response header.
+	 *
+	 * @param string $name The header name to retrieve.
+	 * @param bool   $as_array Whether to return the header as an array.
+	 * @return ($as_array is true ? array<string> : string|null) The header value(s), or null if not found.
+	 */
+	public function get_header( string $name, bool $as_array = false ): string|array|null;
+
+	/**
+	 * Retrieve the response body.
+	 *
+	 * @return string|null The response body.
+	 */
+	public function get_body(): ?string;
+}

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

@@ -11,6 +11,7 @@
 
 use ArrayAccess;
 use LogicException;
+use Mantle\Contracts\Http\Response as ResponseContract;
 use Mantle\Support\Collection;
 use Mantle\Support\HTML;
 use Mantle\Support\Mixed_Data;
@@ -53,7 +54,7 @@
  *   http_response?: \WP_HTTP_Requests_Response,
  * }
  */
-class Response implements ArrayAccess {
+class Response implements ArrayAccess, ResponseContract {
 	use Concerns\Interacts_With_Feeds;
 	use Macroable;
 
@@ -159,21 +160,58 @@ public function response(): array {
 	/**
 	 * Retrieve all the headers from a response.
 	 *
-	 * @return array<string, string> Headers from the response.
+	 * @return array<string, string|string[]> Headers from the response.
 	 */
 	public function headers(): array {
 		return (array) ( $this->response['headers'] ?? [] );
 	}
 
+	/**
+	 * Alias for headers().
+	 *
+	 * @return array<string, string|string[]> Headers from the response.
+	 */
+	public function get_headers(): array {
+		return $this->headers();
+	}
+
 	/**
 	 * Retrieve a specific header (headers are case-insensitive).
 	 *
+	 * Similar to get_header().
+	 *
+	 * In the event of multiple headers with the same name, the first header will
+	 * be returned. If you need all headers, use `get_headers()`.
+	 *
 	 * @param string $header Header to retrieve.
-	 * @return mixed
+	 * @return string|null Header value(s), or null if not found.
 	 */
-	public function header( string $header ) {
-		$header = strtolower( $header );
-		return $this->headers()[ $header ] ?? null;
+	public function header( string $header ): ?string {
+		return $this->get_header( $header );
+	}
+
+	/**
+	 * Retrieve a specific response header.
+	 *
+	 * @param string $name The header name to retrieve.
+	 * @param bool   $as_array Whether to return the header as an array.
+	 * @return ($as_array is true ? array<string> : string|null) The header value(s), or null if not found.
+	 */
+	public function get_header( string $name, bool $as_array = false ): string|array|null {
+		$header  = strtolower( $name );
+		$headers = $this->headers();
+
+		if ( ! array_key_exists( $header, $headers ) ) {
+			return null;
+		}
+
+		$value = $headers[ $header ];
+
+		if ( is_array( $value ) ) {
+			return $as_array ? $value : $value[0] ?? '';
+		}
+
+		return $as_array ? [ $value ] : $value;
 	}
 
 	/**
@@ -183,6 +221,13 @@ public function status(): int {
 		return (int) ( $this->response['response']['code'] ?? 0 );
 	}
 
+	/**
+	 * Retrieve the response status code.
+	 */
+	public function get_status_code(): int {
+		return $this->status();
+	}
+
 	/**
 	 * Determine if the request was successful.
 	 */
@@ -304,6 +349,15 @@ public function body(): string {
 		return (string) ( $this->response['body'] ?? '' );
 	}
 
+	/**
+	 * Alias for body().
+	 *
+	 * @return string|null The response body.
+	 */
+	public function get_body(): ?string {
+		return $this->body();
+	}
+
 	/**
 	 * Retrieve the file path to the downloaded file.
 	 */

src/mantle/http-client/concerns/trait-interacts-with-feeds.php

@@ -2,6 +2,8 @@
 /**
  * Interacts_With_Feeds trait file
  *
+ * phpcs:disable WordPress.NamingConventions.ValidFunctionName
+ *
  * @package Mantle
  */
 
@@ -10,22 +12,23 @@
 namespace Mantle\Http_Client\Concerns;
 
 use Closure;
+use PHPUnit\Framework\Assert;
 use WP_SimplePie_Sanitize_KSES;
 
 /**
  * Integrations with feed responses.
  *
- * @mixin \Mantle\Http_Client\Response
+ * @mixin \Mantle\Contracts\Http\Response
  */
 trait Interacts_With_Feeds {
 	/**
 	 * Check if the response is a feed.
 	 */
 	public function is_feed(): bool {
-		return false !== strpos( (string) $this->header( 'content-type' ), 'application/rss+xml' ) ||
-			false !== strpos( (string) $this->header( 'content-type' ), 'application/atom+xml' ) ||
-			false !== strpos( (string) $this->header( 'content-type' ), 'application/xml' ) ||
-			false !== strpos( (string) $this->header( 'content-type' ), 'text/xml' );
+		return false !== strpos( (string) $this->get_header( 'content-type' ), 'application/rss+xml' ) ||
+			false !== strpos( (string) $this->get_header( 'content-type' ), 'application/atom+xml' ) ||
+			false !== strpos( (string) $this->get_header( 'content-type' ), 'application/xml' ) ||
+			false !== strpos( (string) $this->get_header( 'content-type' ), 'text/xml' );
 	}
 
 	/**
@@ -59,7 +62,7 @@ public function feed( ?Closure $options = null ): \SimplePie {
 		 */
 		$feed->sanitize = new \WP_SimplePie_Sanitize_KSES();
 
-		$feed->set_raw_data( $this->body() );
+		$feed->set_raw_data( (string) $this->get_body() );
 
 		if ( $options instanceof Closure ) {
 			$options( $feed );
@@ -70,4 +73,28 @@ public function feed( ?Closure $options = null ): \SimplePie {
 
 		return $feed; // @phpstan-ignore-line return.type
 	}
+
+	/**
+	 * Assert that the response is a feed.
+	 */
+	public function assertIsFeed(): static {
+		Assert::assertTrue(
+			$this->is_feed(),
+			'Failed asserting that the response is a feed.',
+		);
+
+		return $this;
+	}
+
+	/**
+	 * Assert that the response is not a feed.
+	 */
+	public function assertIsNotFeed(): static {
+		Assert::assertFalse(
+			$this->is_feed(),
+			'Failed asserting that the response is not a feed.',
+		);
+
+		return $this;
+	}
 }

src/mantle/testing/TestCase.php

@@ -270,9 +270,6 @@ function ( string|object $trait ): void {
 			'comment_depth',
 			'comment_thread_alt',
 
-			// Sitemap globals.
-			'wp_sitemaps',
-
 			// Template globals.
 			'wp_stylesheet_path',
 			'wp_template_path',
@@ -289,6 +286,7 @@ function ( string|object $trait ): void {
 		remove_filter( 'wp_die_handler', [ WP_Die::class, 'get_handler' ] );
 		static::restore_hooks();
 		wp_set_current_user( 0 );
+		$this->reset_lazyload_queue();
 		// phpcs:enable
 
 		parent::tearDown();
@@ -413,4 +411,14 @@ public function __get( string $name ): mixed {
 	public static function usesTrait( string $trait ): bool {
 		return isset( static::$test_uses[ $trait ] );
 	}
+
+	/**
+	 * Reset the lazy load meta queue.
+	 */
+	protected function reset_lazyload_queue(): void {
+		$lazyloader = wp_metadata_lazyloader();
+		$lazyloader->reset_queue( 'term' );
+		$lazyloader->reset_queue( 'comment' );
+		$lazyloader->reset_queue( 'blog' ); // @phpstan-ignore-line argument.type
+	}
 }