From af0b45013ee29a6704cf4b71504fde718ef7299d Mon Sep 17 00:00:00 2001
From: Pierre Gordon <pierregordon@protonmail.com>
Date: Thu, 2 Apr 2020 14:39:32 -0400
Subject: [PATCH] Add FailedRemoteRequest interface to mark exception classes
 related to remote requests

---
 lib/common/phpstan.neon.dist                        |  2 ++
 lib/common/src/Exception/FailedRemoteRequest.php    | 13 +++++++++++++
 ...sponseData.php => FailedToGetCachedResponse.php} |  4 ++--
 .../src/Exception/FailedToGetFromRemoteUrl.php      |  2 +-
 lib/common/src/RemoteGetRequest.php                 |  4 ++--
 .../src/RemoteRequest/CurlRemoteGetRequest.php      |  3 ++-
 .../src/RemoteRequest/FallbackRemoteGetRequest.php  |  4 ++--
 .../RemoteRequest/FilesystemRemoteGetRequest.php    |  3 ++-
 .../src/RemoteRequest/StubbedRemoteGetRequest.php   |  4 ++--
 src/RemoteRequest/CachedRemoteGetRequest.php        |  7 ++++---
 src/RemoteRequest/WpHttpRemoteGetRequest.php        |  3 ++-
 11 files changed, 34 insertions(+), 15 deletions(-)
 create mode 100644 lib/common/src/Exception/FailedRemoteRequest.php
 rename lib/common/src/Exception/{FailedToGetCachedResponseData.php => FailedToGetCachedResponse.php} (73%)

diff --git a/lib/common/phpstan.neon.dist b/lib/common/phpstan.neon.dist
index 1857a8b4809..fb2b62bf871 100644
--- a/lib/common/phpstan.neon.dist
+++ b/lib/common/phpstan.neon.dist
@@ -8,3 +8,5 @@ parameters:
 		- %currentWorkingDirectory%/src/
 	autoload_files:
 		- %currentWorkingDirectory%/vendor/autoload.php
+	ignoreErrors:
+		- '#^PHPDoc tag @throws with type AmpProject\\Exception\\FailedRemoteRequest is not subtype of Throwable$#'
diff --git a/lib/common/src/Exception/FailedRemoteRequest.php b/lib/common/src/Exception/FailedRemoteRequest.php
new file mode 100644
index 00000000000..0a03765943b
--- /dev/null
+++ b/lib/common/src/Exception/FailedRemoteRequest.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace AmpProject\Exception;
+
+/**
+ * Marker interface to enable consumers to catch all exceptions for failed remote requests.
+ *
+ * @package ampproject/common
+ */
+interface FailedRemoteRequest extends AmpException
+{
+
+}
diff --git a/lib/common/src/Exception/FailedToGetCachedResponseData.php b/lib/common/src/Exception/FailedToGetCachedResponse.php
similarity index 73%
rename from lib/common/src/Exception/FailedToGetCachedResponseData.php
rename to lib/common/src/Exception/FailedToGetCachedResponse.php
index f1fde591bdc..8ac4ab32bd1 100644
--- a/lib/common/src/Exception/FailedToGetCachedResponseData.php
+++ b/lib/common/src/Exception/FailedToGetCachedResponse.php
@@ -9,7 +9,7 @@
  *
  * @package ampproject/common
  */
-final class FailedToGetCachedResponseData extends RuntimeException implements AmpException
+final class FailedToGetCachedResponse extends RuntimeException implements FailedRemoteRequest
 {
 
     /**
@@ -20,7 +20,7 @@ final class FailedToGetCachedResponseData extends RuntimeException implements Am
      */
     public static function withUrl($url)
     {
-        $message = "Failed to retrieve the cached response data for the URL '{$url}'.";
+        $message = "Failed to retrieve the cached response for the URL '{$url}'.";
 
         return new self($message);
     }
diff --git a/lib/common/src/Exception/FailedToGetFromRemoteUrl.php b/lib/common/src/Exception/FailedToGetFromRemoteUrl.php
index 8383c4e8fd4..015d1dca6b6 100644
--- a/lib/common/src/Exception/FailedToGetFromRemoteUrl.php
+++ b/lib/common/src/Exception/FailedToGetFromRemoteUrl.php
@@ -10,7 +10,7 @@
  *
  * @package ampproject/common
  */
-final class FailedToGetFromRemoteUrl extends RuntimeException implements AmpException
+final class FailedToGetFromRemoteUrl extends RuntimeException implements FailedRemoteRequest
 {
 
     /**
diff --git a/lib/common/src/RemoteGetRequest.php b/lib/common/src/RemoteGetRequest.php
index 0469eb1db2d..9d96ec11daa 100644
--- a/lib/common/src/RemoteGetRequest.php
+++ b/lib/common/src/RemoteGetRequest.php
@@ -2,7 +2,7 @@
 
 namespace AmpProject;
 
-use AmpProject\Exception\FailedToGetFromRemoteUrl;
+use AmpProject\Exception\FailedRemoteRequest;
 
 /**
  * Interface for abstracting away the transport that is being used for making remote requests.
@@ -19,7 +19,7 @@ interface RemoteGetRequest
      *
      * @param string $url URL to get.
      * @return Response Response for the executed request.
-     * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+     * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
      */
     public function get($url);
 }
diff --git a/lib/common/src/RemoteRequest/CurlRemoteGetRequest.php b/lib/common/src/RemoteRequest/CurlRemoteGetRequest.php
index 8a6528d01da..940ed6974d9 100644
--- a/lib/common/src/RemoteRequest/CurlRemoteGetRequest.php
+++ b/lib/common/src/RemoteRequest/CurlRemoteGetRequest.php
@@ -2,6 +2,7 @@
 
 namespace AmpProject\RemoteRequest;
 
+use AmpProject\Exception\FailedRemoteRequest;
 use AmpProject\Exception\FailedToGetFromRemoteUrl;
 use AmpProject\RemoteGetRequest;
 use AmpProject\Response;
@@ -92,7 +93,7 @@ public function __construct($sslVerify = true, $timeout = self::DEFAULT_TIMEOUT,
      *
      * @param string $url URL to get.
      * @return Response Response for the executed request.
-     * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+     * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
      */
     public function get($url)
     {
diff --git a/lib/common/src/RemoteRequest/FallbackRemoteGetRequest.php b/lib/common/src/RemoteRequest/FallbackRemoteGetRequest.php
index 95f6d86a088..d6a36fe1de8 100644
--- a/lib/common/src/RemoteRequest/FallbackRemoteGetRequest.php
+++ b/lib/common/src/RemoteRequest/FallbackRemoteGetRequest.php
@@ -2,7 +2,7 @@
 
 namespace AmpProject\RemoteRequest;
 
-use AmpProject\Exception\FailedToGetFromRemoteUrl;
+use AmpProject\Exception\FailedRemoteRequest;
 use AmpProject\RemoteGetRequest;
 use AmpProject\Response;
 use Exception;
@@ -55,7 +55,7 @@ private function addRemoteGetRequestInstance(RemoteGetRequest $remoteGetRequest)
      *
      * @param string $url URL to get.
      * @return Response Response for the executed request.
-     * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+     * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
      */
     public function get($url)
     {
diff --git a/lib/common/src/RemoteRequest/FilesystemRemoteGetRequest.php b/lib/common/src/RemoteRequest/FilesystemRemoteGetRequest.php
index baf0028ca5b..00b0ef7e3ae 100644
--- a/lib/common/src/RemoteRequest/FilesystemRemoteGetRequest.php
+++ b/lib/common/src/RemoteRequest/FilesystemRemoteGetRequest.php
@@ -2,6 +2,7 @@
 
 namespace AmpProject\RemoteRequest;
 
+use AmpProject\Exception\FailedRemoteRequest;
 use AmpProject\Exception\FailedToGetFromRemoteUrl;
 use AmpProject\RemoteGetRequest;
 use AmpProject\Response;
@@ -40,7 +41,7 @@ public function __construct($argumentMap)
      *
      * @param string $url URL to get.
      * @return Response Response for the executed request.
-     * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+     * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
      */
     public function get($url)
     {
diff --git a/lib/common/src/RemoteRequest/StubbedRemoteGetRequest.php b/lib/common/src/RemoteRequest/StubbedRemoteGetRequest.php
index bd8fa8e7304..7fbebd52dee 100644
--- a/lib/common/src/RemoteRequest/StubbedRemoteGetRequest.php
+++ b/lib/common/src/RemoteRequest/StubbedRemoteGetRequest.php
@@ -2,7 +2,7 @@
 
 namespace AmpProject\RemoteRequest;
 
-use AmpProject\Exception\FailedToGetFromRemoteUrl;
+use AmpProject\Exception\FailedRemoteRequest;
 use AmpProject\RemoteGetRequest;
 use AmpProject\Response;
 use LogicException;
@@ -37,7 +37,7 @@ public function __construct($argumentMap)
      *
      * @param string $url URL to get.
      * @return Response Response for the executed request.
-     * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+     * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
      */
     public function get($url)
     {
diff --git a/src/RemoteRequest/CachedRemoteGetRequest.php b/src/RemoteRequest/CachedRemoteGetRequest.php
index d2d7d54d4bc..b1316dfb346 100644
--- a/src/RemoteRequest/CachedRemoteGetRequest.php
+++ b/src/RemoteRequest/CachedRemoteGetRequest.php
@@ -7,7 +7,8 @@
 
 namespace AmpProject\AmpWP\RemoteRequest;
 
-use AmpProject\Exception\FailedToGetCachedResponseData;
+use AmpProject\Exception\FailedRemoteRequest;
+use AmpProject\Exception\FailedToGetCachedResponse;
 use AmpProject\Exception\FailedToGetFromRemoteUrl;
 use AmpProject\RemoteGetRequest;
 use AmpProject\RemoteRequest\RemoteGetRequestResponse;
@@ -102,7 +103,7 @@ public function __construct(
 	 *
 	 * @param string $url URL to get.
 	 * @return Response Response for the executed request.
-	 * @throws FailedToGetCachedResponseData If retrieving the contents from the cache failed.
+	 * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
 	 */
 	public function get( $url ) {
 		$cache_key       = self::TRANSIENT_PREFIX . md5( __CLASS__ . $url );
@@ -140,7 +141,7 @@ public function get( $url ) {
 		}
 
 		if ( ! $cached_response->is_valid() ) {
-			throw new FailedToGetCachedResponseData( $url );
+			throw new FailedToGetCachedResponse( $url );
 		}
 
 		return new RemoteGetRequestResponse( $cached_response->get_body(), $cached_response->get_headers(), $cached_response->get_status_code() );
diff --git a/src/RemoteRequest/WpHttpRemoteGetRequest.php b/src/RemoteRequest/WpHttpRemoteGetRequest.php
index 2f08364456c..f1e5d73768e 100644
--- a/src/RemoteRequest/WpHttpRemoteGetRequest.php
+++ b/src/RemoteRequest/WpHttpRemoteGetRequest.php
@@ -7,6 +7,7 @@
 
 namespace AmpProject\AmpWP\RemoteRequest;
 
+use AmpProject\Exception\FailedRemoteRequest;
 use AmpProject\Exception\FailedToGetFromRemoteUrl;
 use AmpProject\RemoteGetRequest;
 use AmpProject\RemoteRequest\RemoteGetRequestResponse;
@@ -98,7 +99,7 @@ public function __construct( $ssl_verify = true, $timeout = self::DEFAULT_TIMEOU
 	 *
 	 * @param string $url URL to get.
 	 * @return Response Response for the executed request.
-	 * @throws FailedToGetFromRemoteUrl If retrieving the contents from the URL failed.
+	 * @throws FailedRemoteRequest If retrieving the contents from the URL failed.
 	 */
 	public function get( $url ) {
 		$retries_left = $this->retries;