feature #31831 [HttpClient] add $response->cancel() (nicolas-grekas)

fabpot · fabpot · commit 852fb361015a · 2019-06-04T07:48:40.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | yes | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - (BC break allowed by the `@experimental` annotation) Canceling a response is already possible but requires registering a progress function and throwing an exception from it. This new method aims at making this much simpler. /cc @jderusse as we discussed this on Slack. Commits ------- 549930e [HttpClient] add $response->cancel()
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -25,6 +25,11 @@ DependencyInjection
        factory: ['@factory_service', method]
    ```
 
+HttpClient
+----------
+
+ * Added method `cancel()` to `ResponseInterface`
+
 Messenger
 ---------
 
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -221,6 +221,11 @@ FrameworkBundle
  * Removed the "Psr\SimpleCache\CacheInterface" / "cache.app.simple" service, use "Symfony\Contracts\Cache\CacheInterface" / "cache.app" instead.
  * Removed support for `templating` engine in `TemplateController`, use Twig instead
 
+HttpClient
+----------
+
+ * Added method `cancel()` to `ResponseInterface`
+
 HttpFoundation
 --------------
 
diff --git a/src/Symfony/Component/HttpClient/CHANGELOG.md b/src/Symfony/Component/HttpClient/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.0
+-----
+
+ * added `$response->cancel()`
+
 4.3.0
 -----
 
diff --git a/src/Symfony/Component/HttpClient/Response/ResponseTrait.php b/src/Symfony/Component/HttpClient/Response/ResponseTrait.php
@@ -169,6 +169,15 @@ public function toArray(bool $throw = true): array
         return $content;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function cancel(): void
+    {
+        $this->info['error'] = 'Response has been canceled.';
+        $this->close();
+    }
+
     /**
      * Closes the response and all its network handles.
      */
diff --git a/src/Symfony/Contracts/HttpClient/ResponseInterface.php b/src/Symfony/Contracts/HttpClient/ResponseInterface.php
@@ -71,6 +71,11 @@ public function getContent(bool $throw = true): string;
      */
     public function toArray(bool $throw = true): array;
 
+    /**
+     * Cancels the response.
+     */
+    public function cancel(): void;
+
     /**
      * Returns info coming from the transport layer.
      *
