laravel9: test cannot have null content returned. also message in exceptions cannot be null

Leonardo-Atalla · Leonardo-Atalla · commit 6e8e24e41e53 · 2022-09-13T11:42:18.000+02:00
update composer json fix header check fix tests, catch session not found exception update applicationStubs add application stubs for laravel 9 , update version check fix get check version fix passing null to trim as dingo#1 argument fix deprecation for getClass preg_replace(): Passing null to parameter dingo#2 ($replacement) of type array|string is deprecated in C:\laragon\www\api\src\Http\Validation\Domain.php on line 69 match signature bump laravel, phpdocumentor
diff --git a/composer.json b/composer.json
@@ -14,26 +14,26 @@
     }],
     "require": {
         "php": ">=7.2.5",
-        "dingo/blueprint": "dev-master",
-        "illuminate/routing": "^7.0|^8.0",
-        "illuminate/support": "^7.0|^8.0",
-        "league/fractal": "^0.19"
+        "dingo/blueprint": "dev-laravel9",
+        "illuminate/routing": "^7.0|^8.0|^9.0",
+        "illuminate/support": "^7.0|^8.0|^9.0",
+        "league/fractal": "^0.20"
     },
     "require-dev": {
-        "phpdocumentor/reflection-docblock": "3.3.2",
-        "friendsofphp/php-cs-fixer": "~2",
-        "illuminate/auth": "^7.0|^8.0",
-        "illuminate/cache": "^7.0|^8.0",
-        "illuminate/console": "^7.0|^8.0",
-        "illuminate/database": "^7.0|^8.0",
-        "illuminate/events": "^7.0|^8.0",
-        "illuminate/filesystem": "^7.0|^8.0",
-        "illuminate/log": "^7.0|^8.0",
-        "illuminate/pagination": "^7.0|^8.0",
-        "laravel/lumen-framework": "^7.0|^8.0",
+        "phpdocumentor/reflection-docblock": "3.3.2 || ^4.1 || ^5",
+        "friendsofphp/php-cs-fixer": "~2|~3",
+        "illuminate/auth": "^7.0|^8.0|^9.0",
+        "illuminate/cache": "^7.0|^8.0|^9.0",
+        "illuminate/console": "^7.0|^8.0|^9.0",
+        "illuminate/database": "^7.0|^8.0|^9.0",
+        "illuminate/events": "^7.0|^8.0|^9.0",
+        "illuminate/filesystem": "^7.0|^8.0|^9.0",
+        "illuminate/log": "^7.0|^8.0|^9.0",
+        "illuminate/pagination": "^7.0|^8.0|^9.0",
+        "laravel/lumen-framework": "^7.0|^8.0|^9.0",
         "mockery/mockery": "~1.0",
         "phpunit/phpunit": "^8.5|^9.0",
-        "squizlabs/php_codesniffer": "~2.0",
+        "squizlabs/php_codesniffer": "~2.0|^3.6",
         "tymon/jwt-auth": "1.0.*"
     },
     "suggest": {
@@ -72,8 +72,8 @@
     "prefer-stable": true,
     "repositories": [
         {
-            "url": "https://github.com/EpsilonTelecommunications/blueprint",
-            "type": "vcs"
+            "url": "C:\\laragon\\www\\blueprint",
+            "type": "path"
         }
     ]
 }
diff --git a/src/Auth/Provider/Authorization.php b/src/Auth/Provider/Authorization.php
@@ -26,7 +26,7 @@ abstract class Authorization implements \Dingo\Api\Contract\Auth\Provider
      */
     public function validateAuthorizationHeader(Request $request)
     {
-        if (Str::startsWith(strtolower($request->headers->get('authorization')), $this->getAuthorizationMethod())) {
+        if ($request->headers->has('authorization') && Str::startsWith(strtolower($request->headers->get('authorization')), $this->getAuthorizationMethod())) {
             return true;
         }
 
diff --git a/src/Exception/Handler.php b/src/Exception/Handler.php
@@ -371,7 +371,7 @@ protected function handlerHint(callable $callback)
 
         $exception = $reflection->getParameters()[0];
 
-        return $exception->getClass()->getName();
+        return $exception->getType()->getName();
     }
 
     /**
diff --git a/src/Exception/InternalHttpException.php b/src/Exception/InternalHttpException.php
@@ -30,7 +30,7 @@ public function __construct(Response $response, $message = null, Exception $prev
     {
         $this->response = $response;
 
-        parent::__construct($response->getStatusCode(), $message, $previous, $headers, $code);
+        parent::__construct($response->getStatusCode(), $message ?? '', $previous, $headers, $code);
     }
 
     /**
diff --git a/src/Exception/ResourceException.php b/src/Exception/ResourceException.php
@@ -35,7 +35,7 @@ public function __construct($message = null, $errors = null, Exception $previous
             $this->errors = is_array($errors) ? new MessageBag($errors) : $errors;
         }
 
-        parent::__construct(422, $message, $previous, $headers, $code);
+        parent::__construct(422, $message ?? '', $previous, $headers, $code);
     }
 
     /**
diff --git a/src/Http/Request.php b/src/Http/Request.php
@@ -5,6 +5,7 @@
 use Dingo\Api\Http\Parser\Accept;
 use Illuminate\Http\Request as IlluminateRequest;
 use Dingo\Api\Contract\Http\Request as RequestInterface;
+use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
 
 class Request extends IlluminateRequest implements RequestInterface
 {
@@ -35,9 +36,11 @@ public function createFromIlluminate(IlluminateRequest $old)
             $old->query->all(), $old->request->all(), $old->attributes->all(),
             $old->cookies->all(), $old->files->all(), $old->server->all(), $old->content
         );
-
-        if ($session = $old->getSession()) {
-            $new->setLaravelSession($old->getSession());
+        try {
+            if ($session = $old->getSession()) {
+                $new->setLaravelSession($session);
+            }
+        } catch (SessionNotFoundException $exception) {
         }
 
         $new->setRouteResolver($old->getRouteResolver());
diff --git a/src/Http/Response.php b/src/Http/Response.php
@@ -190,7 +190,7 @@ protected function fireMorphingEvent()
     /**
      * {@inheritdoc}
      */
-    public function setContent($content)
+    public function setContent($content): static
     {
         // Attempt to set the content string, if we encounter an unexpected value
         // then we most likely have an object that cannot be type cast. In that
diff --git a/src/Http/Validation/Domain.php b/src/Http/Validation/Domain.php
@@ -66,7 +66,7 @@ protected function stripProtocol($domain)
      */
     protected function stripPort($domain)
     {
-        if ($domainStripped = preg_replace(self::PATTERN_STRIP_PROTOCOL, null, $domain)) {
+        if ($domainStripped = preg_replace(self::PATTERN_STRIP_PROTOCOL, '', $domain)) {
             return $domainStripped;
         }
 
diff --git a/src/Http/Validation/Prefix.php b/src/Http/Validation/Prefix.php
@@ -21,9 +21,9 @@ class Prefix implements Validator
      *
      * @return void
      */
-    public function __construct($prefix)
+    public function __construct(?string $prefix = null)
     {
-        $this->prefix = $prefix;
+        $this->prefix = $prefix ?? '';
     }
 
     /**
@@ -40,7 +40,7 @@ public function validate(Request $request)
 
         $path = $this->filterAndExplode($request->getPathInfo());
 
-        return ! is_null($this->prefix) && $prefix == array_slice($path, 0, count($prefix));
+        return ! empty($this->prefix) && $prefix == array_slice($path, 0, count($prefix));
     }
 
     /**
diff --git a/src/Provider/LaravelServiceProvider.php b/src/Provider/LaravelServiceProvider.php
@@ -16,6 +16,7 @@
 use Illuminate\Http\Request as IlluminateRequest;
 use Dingo\Api\Routing\Adapter\Laravel as LaravelAdapter;
 use Illuminate\Contracts\Validation\ValidatesWhenResolved;
+use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
 
 class LaravelServiceProvider extends DingoServiceProvider
 {
@@ -201,8 +202,11 @@ protected function initializeRequest(FormRequest $form, IlluminateRequest $curre
 
         $form->setJson($current->json());
 
-        if ($session = $current->getSession()) {
-            $form->setLaravelSession($session);
+        try {
+            if ($session = $current->getSession()) {
+                $form->setLaravelSession($session);
+            }
+        } catch (SessionNotFoundException $exception) {
         }
 
         $form->setUserResolver($current->getUserResolver());
diff --git a/src/Provider/LumenServiceProvider.php b/src/Provider/LumenServiceProvider.php
@@ -16,6 +16,7 @@
 use Dingo\Api\Routing\Adapter\Lumen as LumenAdapter;
 use Illuminate\Contracts\Validation\ValidatesWhenResolved;
 use FastRoute\DataGenerator\GroupCountBased as GcbDataGenerator;
+use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
 
 class LumenServiceProvider extends DingoServiceProvider
 {
@@ -175,8 +176,11 @@ protected function initializeRequest(FormRequest $form, IlluminateRequest $curre
 
         $form->setJson($current->json());
 
-        if ($session = $current->getSession()) {
-            $form->setLaravelSession($session);
+        try {
+            if ($session = $current->getSession()) {
+                $form->setLaravelSession($session);
+            }
+        } catch (SessionNotFoundException $exception) {
         }
 
         $form->setUserResolver($current->getUserResolver());
diff --git a/src/Routing/RouteCollection.php b/src/Routing/RouteCollection.php
@@ -5,6 +5,7 @@
 use Countable;
 use ArrayIterator;
 use IteratorAggregate;
+use Traversable;
 
 class RouteCollection implements Countable, IteratorAggregate
 {
@@ -72,9 +73,9 @@ protected function addLookups(Route $route)
      *
      * @return \Dingo\Api\Routing\Route|null
      */
-    public function getByName($name)
+    public function getByName($name): ?Route
     {
-        return isset($this->names[$name]) ? $this->names[$name] : null;
+        return $this->names[$name] ?? null;
     }
 
     /**
@@ -84,9 +85,9 @@ public function getByName($name)
      *
      * @return \Dingo\Api\Routing\Route|null
      */
-    public function getByAction($action)
+    public function getByAction($action): ?Route
     {
-        return isset($this->actions[$action]) ? $this->actions[$action] : null;
+        return $this->actions[$action] ?? null;
     }
 
     /**
@@ -102,9 +103,9 @@ public function getRoutes()
     /**
      * Get an iterator for the items.
      *
-     * @return \ArrayIterator
+     * @return Traversable
      */
-    public function getIterator()
+    public function getIterator(): Traversable
     {
         return new ArrayIterator($this->getRoutes());
     }
@@ -114,7 +115,7 @@ public function getIterator()
      *
      * @return int
      */
-    public function count()
+    public function count(): int
     {
         return count($this->getRoutes());
     }
diff --git a/src/Routing/Router.php b/src/Routing/Router.php
@@ -491,7 +491,7 @@ protected function formatNamespace(array $new, array $old)
     protected function formatPrefix($new, $old)
     {
         if (isset($new['prefix'])) {
-            return trim(Arr::get($old, 'prefix'), '/').'/'.trim($new['prefix'], '/');
+            return trim(Arr::get($old, 'prefix') ?? '', '/') . '/' . trim($new['prefix'], '/');
         }
 
         return Arr::get($old, 'prefix', '');
diff --git a/tests/ChecksLaravelVersionTrait.php b/tests/ChecksLaravelVersionTrait.php
@@ -3,6 +3,8 @@
 namespace Dingo\Api\Tests;
 
 use Dingo\Api\Tests\Stubs\Application7Stub;
+use Dingo\Api\Tests\Stubs\Application8Stub;
+use Dingo\Api\Tests\Stubs\Application9Stub;
 use Dingo\Api\Tests\Stubs\ApplicationStub;
 use Dingo\Api\Tests\Stubs\Application6Stub;
 use Dingo\Api\Tests\Stubs\Application58Stub;
@@ -16,16 +18,18 @@ private function getFrameworkVersion()
     {
         $contents = file_get_contents($this->installed_file_path);
         $parsed_data = json_decode($contents, true);
+        if ($parsed_data['packages']) {
+            $parsed_data = $parsed_data['packages'];
+        }
         $just_laravel = array_filter($parsed_data, function ($val) {
             if ('laravel/framework' === $val['name'] || 'laravel/lumen-framework' === $val['name']) {
                 return true;
             }
+            return false;
         });
-        $laravelVersion = array_map(function ($val) {
+        return array_map(function ($val) {
             return $val['version'];
         }, array_values($just_laravel))[0];
-
-        return $laravelVersion;
     }
 
     private function getApplicationStub()
@@ -39,7 +43,11 @@ private function getApplicationStub()
         $version = str_replace('v', '', $version);
 
         // Return the version stub for the right version
-        if (version_compare($version, '7.0.0', '>=')) {
+        if (version_compare($version, '9.0.0', '>=')) {
+            return new Application9Stub;
+        } elseif (version_compare($version, '8.0.0', '>=')) {
+            return new Application8Stub;
+        }elseif (version_compare($version, '7.0.0', '>=')) {
             return new Application7Stub;
         } elseif (version_compare($version, '6.0.0', '>=')) {
             return new Application6Stub;
diff --git a/tests/DispatcherTest.php b/tests/DispatcherTest.php
@@ -212,6 +212,7 @@ public function testPretendingToBeUserForSingleRequest()
         $this->router->version('v1', function () use ($user) {
             $this->router->get('test', function () use ($user) {
                 $this->assertSame($user, $this->auth->user());
+                return 'test';
             });
         });
 
@@ -267,16 +268,19 @@ public function testRequestStackIsMaintained()
                 $this->assertSame('bar', $this->router->getCurrentRequest()->input('foo'));
                 $this->dispatcher->with(['foo' => 'baz'])->post('api/bar');
                 $this->assertSame('bar', $this->router->getCurrentRequest()->input('foo'));
+                return 'foo';
             });
 
             $this->router->post('bar', function () {
                 $this->assertSame('baz', $this->router->getCurrentRequest()->input('foo'));
                 $this->dispatcher->with(['foo' => 'bazinga'])->post('api/baz');
                 $this->assertSame('baz', $this->router->getCurrentRequest()->input('foo'));
+                return 'bar';
             });
 
             $this->router->post('baz', function () {
                 $this->assertSame('bazinga', $this->router->getCurrentRequest()->input('foo'));
+                return 'baz';
             });
         });
 
@@ -290,16 +294,19 @@ public function testRouteStackIsMaintained()
                 $this->assertSame('foo', $this->router->getCurrentRoute()->getName());
                 $this->dispatcher->post('bar');
                 $this->assertSame('foo', $this->router->getCurrentRoute()->getName());
+                return 'foo';
             }]);
 
             $this->router->post('bar', ['as' => 'bar', function () {
                 $this->assertSame('bar', $this->router->getCurrentRoute()->getName());
                 $this->dispatcher->post('baz');
                 $this->assertSame('bar', $this->router->getCurrentRoute()->getName());
+                return 'bar';
             }]);
 
             $this->router->post('baz', ['as' => 'bazinga', function () {
                 $this->assertSame('bazinga', $this->router->getCurrentRoute()->getName());
+                return 'baz';
             }]);
         });
 
@@ -311,10 +318,12 @@ public function testSendingJsonPayload()
         $this->router->version('v1', function () {
             $this->router->post('foo', function () {
                 $this->assertSame('jason', $this->router->getCurrentRequest()->json('username'));
+                return 'foo';
             });
 
             $this->router->post('bar', function () {
                 $this->assertSame('mat', $this->router->getCurrentRequest()->json('username'));
+                return 'bar';
             });
         });
 
diff --git a/tests/Http/ResponseTest.php b/tests/Http/ResponseTest.php
@@ -41,7 +41,10 @@ public function testNonCastableObjectsSetAsOriginalContent()
 
         $response = new Response($object);
 
+        $this->expectException(\TypeError::class);
+        $this->expectExceptionMessage('Symfony\Component\HttpFoundation\Response::getContent(): Return value must be of type string|false, null returned');
         $this->assertNull($response->getContent());
+
         $this->assertSame($object, $response->getOriginalContent());
     }
 
diff --git a/tests/Routing/RouterTest.php b/tests/Routing/RouterTest.php
@@ -34,6 +34,7 @@ public function testRouteOptionsMergeCorrectly()
                     $this->router->getCurrentRoute()->getScopes(),
                     'Router did not merge string based group scopes with route based array scopes.'
                 );
+                return 'foo';
             }]);
 
             $this->router->get('baz', function () {
@@ -42,6 +43,7 @@ public function testRouteOptionsMergeCorrectly()
                     $this->router->getCurrentRoute()->getScopes(),
                     'Router did not merge string based group scopes with route.'
                 );
+                return 'baz';
             });
         });
 
diff --git a/tests/Stubs/Application8Stub.php b/tests/Stubs/Application8Stub.php
diff --git a/tests/Stubs/Application9Stub.php b/tests/Stubs/Application9Stub.php
diff --git a/tests/Stubs/ApplicationStub.php b/tests/Stubs/ApplicationStub.php

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ abstract class Authorization implements \Dingo\Api\Contract\Auth\Provider`
`26`	`26`	`*/`
`27`	`27`	`public function validateAuthorizationHeader(Request $request)`
`28`	`28`	`{`
`29`		`- if (Str::startsWith(strtolower($request->headers->get('authorization')), $this->getAuthorizationMethod())) {`
	`29`	`+ if ($request->headers->has('authorization') && Str::startsWith(strtolower($request->headers->get('authorization')), $this->getAuthorizationMethod())) {`
`30`	`30`	`return true;`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -371,7 +371,7 @@ protected function handlerHint(callable $callback)`
`371`	`371`
`372`	`372`	`$exception = $reflection->getParameters()[0];`
`373`	`373`
`374`		`- return $exception->getClass()->getName();`
	`374`	`+ return $exception->getType()->getName();`
`375`	`375`	`}`
`376`	`376`
`377`	`377`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function __construct(Response $response, $message = null, Exception $prev`
`30`	`30`	`{`
`31`	`31`	`$this->response = $response;`
`32`	`32`
`33`		`- parent::__construct($response->getStatusCode(), $message, $previous, $headers, $code);`
	`33`	`+ parent::__construct($response->getStatusCode(), $message ?? '', $previous, $headers, $code);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct($message = null, $errors = null, Exception $previous`
`35`	`35`	`$this->errors = is_array($errors) ? new MessageBag($errors) : $errors;`
`36`	`36`	`}`
`37`	`37`
`38`		`- parent::__construct(422, $message, $previous, $headers, $code);`
	`38`	`+ parent::__construct(422, $message ?? '', $previous, $headers, $code);`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ protected function fireMorphingEvent()`
`190`	`190`	`/**`
`191`	`191`	`* {@inheritdoc}`
`192`	`192`	`*/`
`193`		`- public function setContent($content)`
	`193`	`+ public function setContent($content): static`
`194`	`194`	`{`
`195`	`195`	`// Attempt to set the content string, if we encounter an unexpected value`
`196`	`196`	`// then we most likely have an object that cannot be type cast. In that`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ protected function stripProtocol($domain)`
`66`	`66`	`*/`
`67`	`67`	`protected function stripPort($domain)`
`68`	`68`	`{`
`69`		`- if ($domainStripped = preg_replace(self::PATTERN_STRIP_PROTOCOL, null, $domain)) {`
	`69`	`+ if ($domainStripped = preg_replace(self::PATTERN_STRIP_PROTOCOL, '', $domain)) {`
`70`	`70`	`return $domainStripped;`
`71`	`71`	`}`
`72`	`72`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,9 @@ class Prefix implements Validator`
`21`	`21`	`*`
`22`	`22`	`* @return void`
`23`	`23`	`*/`
`24`		`- public function __construct($prefix)`
	`24`	`+ public function __construct(?string $prefix = null)`
`25`	`25`	`{`
`26`		`- $this->prefix = $prefix;`
	`26`	`+ $this->prefix = $prefix ?? '';`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`/**`
`@@ -40,7 +40,7 @@ public function validate(Request $request)`
`40`	`40`
`41`	`41`	`$path = $this->filterAndExplode($request->getPathInfo());`
`42`	`42`
`43`		`- return ! is_null($this->prefix) && $prefix == array_slice($path, 0, count($prefix));`
	`43`	`+ return ! empty($this->prefix) && $prefix == array_slice($path, 0, count($prefix));`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/**`