Merge pull request #143 from laravel/fix-exception-type-declaration

Ensure timout exception always recieves an array.

Author: taylorotwell

src/Exceptions/TimeoutException.php

@@ -9,17 +9,17 @@ class TimeoutException extends Exception
     /**
      * The output returned from the operation.
      *
-     * @var array|null
+     * @var array
      */
     public $output;
 
     /**
      * Create a new exception instance.
      *
-     * @param  array|null  $output
+     * @param  array  $output
      * @return void
      */
-    public function __construct(array $output = null)
+    public function __construct(array $output)
     {
         parent::__construct('Script timed out while waiting for the process to complete.');
 
@@ -29,7 +29,7 @@ public function __construct(array $output = null)
     /**
      * The output returned from the operation.
      *
-     * @return array|null
+     * @return array
      */
     public function output()
     {

src/MakesHttpRequests.php

@@ -141,6 +141,14 @@ public function retry($timeout, $callback, $sleep = 5)
             goto beginning;
         }
 
+        if ($output === null || $output === false) {
+            $output = [];
+        }
+
+        if (! is_array($output)) {
+            $output = [$output];
+        }
+
         throw new TimeoutException($output);
     }
 }

tests/ForgeSDKTest.php

@@ -6,8 +6,10 @@
 use GuzzleHttp\Psr7\Response;
 use Laravel\Forge\Exceptions\FailedActionException;
 use Laravel\Forge\Exceptions\NotFoundException;
+use Laravel\Forge\Exceptions\TimeoutException;
 use Laravel\Forge\Exceptions\ValidationException;
 use Laravel\Forge\Forge;
+use Laravel\Forge\MakesHttpRequests;
 use Mockery;
 use PHPUnit\Framework\TestCase;
 
@@ -87,4 +89,89 @@ public function test_handling_failed_action_errors()
             $this->assertSame('Error!', $e->getMessage());
         }
     }
+
+    public function testRetryHandlesFalseResultFromClosure()
+    {
+        $requestMaker = new class()
+        {
+            use MakesHttpRequests;
+        };
+
+        try {
+            $requestMaker->retry(0, function () {
+                return false;
+            }, 0);
+            $this->fail();
+        } catch (TimeoutException $e) {
+            $this->assertSame([], $e->output());
+        }
+    }
+
+    public function testRetryHandlesNullResultFromClosure()
+    {
+        $requestMaker = new class()
+        {
+            use MakesHttpRequests;
+        };
+
+        try {
+            $requestMaker->retry(0, function () {
+                return null;
+            }, 0);
+            $this->fail();
+        } catch (TimeoutException $e) {
+            $this->assertSame([], $e->output());
+        }
+    }
+
+    public function testRetryHandlesFalseyStringResultFromClosure()
+    {
+        $requestMaker = new class()
+        {
+            use MakesHttpRequests;
+        };
+
+        try {
+            $requestMaker->retry(0, function () {
+                return '';
+            }, 0);
+            $this->fail();
+        } catch (TimeoutException $e) {
+            $this->assertSame([''], $e->output());
+        }
+    }
+
+    public function testRetryHandlesFalseyNumerResultFromClosure()
+    {
+        $requestMaker = new class()
+        {
+            use MakesHttpRequests;
+        };
+
+        try {
+            $requestMaker->retry(0, function () {
+                return 0;
+            }, 0);
+            $this->fail();
+        } catch (TimeoutException $e) {
+            $this->assertSame([0], $e->output());
+        }
+    }
+
+    public function testRetryHandlesFalseyArrayResultFromClosure()
+    {
+        $requestMaker = new class()
+        {
+            use MakesHttpRequests;
+        };
+
+        try {
+            $requestMaker->retry(0, function () {
+                return [];
+            }, 0);
+            $this->fail();
+        } catch (TimeoutException $e) {
+            $this->assertSame([], $e->output());
+        }
+    }
 }