Added AuthenticationException to extend the behaviour of Laravel's default exception handler (#1633)

chrispage1 · web-flow · commit 08b1dabfdddb · 2023-02-14T15:08:49.000-06:00
Co-authored-by: Chris Page &lt;chris@motocom.co.uk&gt;
diff --git a/src/Exceptions/AuthenticationException.php b/src/Exceptions/AuthenticationException.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Laravel\Passport\Exceptions;
+
+use Illuminate\Auth\AuthenticationException as Exception;
+
+class AuthenticationException extends Exception
+{
+}
diff --git a/src/Http/Controllers/AuthorizationController.php b/src/Http/Controllers/AuthorizationController.php
@@ -2,13 +2,13 @@
 
 namespace Laravel\Passport\Http\Controllers;
 
-use Illuminate\Auth\AuthenticationException;
 use Illuminate\Contracts\Auth\StatefulGuard;
 use Illuminate\Contracts\Routing\ResponseFactory;
 use Illuminate\Http\Request;
 use Illuminate\Support\Str;
 use Laravel\Passport\Bridge\User;
 use Laravel\Passport\ClientRepository;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Passport;
 use Laravel\Passport\TokenRepository;
 use League\OAuth2\Server\AuthorizationServer;
@@ -209,7 +209,7 @@ protected function denyRequest($authRequest, $user = null)
      *
      * @param  \Illuminate\Http\Request  $request
      *
-     * @throws \Illuminate\Auth\AuthenticationException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException
      */
     protected function promptForLogin($request)
     {
diff --git a/src/Http/Middleware/CheckClientCredentials.php b/src/Http/Middleware/CheckClientCredentials.php
@@ -2,7 +2,7 @@
 
 namespace Laravel\Passport\Http\Middleware;
 
-use Illuminate\Auth\AuthenticationException;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Exceptions\MissingScopeException;
 
 class CheckClientCredentials extends CheckCredentials
@@ -13,7 +13,7 @@ class CheckClientCredentials extends CheckCredentials
      * @param  \Laravel\Passport\Token  $token
      * @return void
      *
-     * @throws \Illuminate\Auth\AuthenticationException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException
      */
     protected function validateCredentials($token)
     {
diff --git a/src/Http/Middleware/CheckClientCredentialsForAnyScope.php b/src/Http/Middleware/CheckClientCredentialsForAnyScope.php
@@ -2,7 +2,7 @@
 
 namespace Laravel\Passport\Http\Middleware;
 
-use Illuminate\Auth\AuthenticationException;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Exceptions\MissingScopeException;
 
 class CheckClientCredentialsForAnyScope extends CheckCredentials
@@ -13,7 +13,7 @@ class CheckClientCredentialsForAnyScope extends CheckCredentials
      * @param  \Laravel\Passport\Token  $token
      * @return void
      *
-     * @throws \Illuminate\Auth\AuthenticationException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException
      */
     protected function validateCredentials($token)
     {
diff --git a/src/Http/Middleware/CheckCredentials.php b/src/Http/Middleware/CheckCredentials.php
@@ -3,7 +3,7 @@
 namespace Laravel\Passport\Http\Middleware;
 
 use Closure;
-use Illuminate\Auth\AuthenticationException;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\TokenRepository;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\ResourceServer;
@@ -47,7 +47,7 @@ public function __construct(ResourceServer $server, TokenRepository $repository)
      * @param  mixed  ...$scopes
      * @return mixed
      *
-     * @throws \Illuminate\Auth\AuthenticationException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException
      */
     public function handle($request, Closure $next, ...$scopes)
     {
@@ -93,7 +93,7 @@ protected function validate($psr, $scopes)
      * @param  \Laravel\Passport\Token  $token
      * @return void
      *
-     * @throws \Illuminate\Auth\AuthenticationException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException
      */
     abstract protected function validateCredentials($token);
 
diff --git a/src/Http/Middleware/CheckForAnyScope.php b/src/Http/Middleware/CheckForAnyScope.php
@@ -2,7 +2,7 @@
 
 namespace Laravel\Passport\Http\Middleware;
 
-use Illuminate\Auth\AuthenticationException;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Exceptions\MissingScopeException;
 
 class CheckForAnyScope
@@ -15,7 +15,7 @@ class CheckForAnyScope
      * @param  mixed  ...$scopes
      * @return \Illuminate\Http\Response
      *
-     * @throws \Illuminate\Auth\AuthenticationException|\Laravel\Passport\Exceptions\MissingScopeException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException|\Laravel\Passport\Exceptions\MissingScopeException
      */
     public function handle($request, $next, ...$scopes)
     {
diff --git a/src/Http/Middleware/CheckScopes.php b/src/Http/Middleware/CheckScopes.php
@@ -2,7 +2,7 @@
 
 namespace Laravel\Passport\Http\Middleware;
 
-use Illuminate\Auth\AuthenticationException;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Exceptions\MissingScopeException;
 
 class CheckScopes
@@ -15,7 +15,7 @@ class CheckScopes
      * @param  mixed  ...$scopes
      * @return \Illuminate\Http\Response
      *
-     * @throws \Illuminate\Auth\AuthenticationException|\Laravel\Passport\Exceptions\MissingScopeException
+     * @throws \Laravel\Passport\Exceptions\AuthenticationException|\Laravel\Passport\Exceptions\MissingScopeException
      */
     public function handle($request, $next, ...$scopes)
     {
diff --git a/tests/Unit/AuthorizationControllerTest.php b/tests/Unit/AuthorizationControllerTest.php
@@ -8,6 +8,7 @@
 use Laravel\Passport\Bridge\Scope;
 use Laravel\Passport\Client;
 use Laravel\Passport\ClientRepository;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Exceptions\OAuthServerException;
 use Laravel\Passport\Http\Controllers\AuthorizationController;
 use Laravel\Passport\Passport;
@@ -337,7 +338,7 @@ public function test_authorization_denied_if_unauthenticated_and_request_has_pro
 
     public function test_logout_and_prompt_login_if_request_has_prompt_equals_to_login()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $server = m::mock(AuthorizationServer::class);
         $response = m::mock(ResponseFactory::class);
@@ -368,7 +369,7 @@ public function test_logout_and_prompt_login_if_request_has_prompt_equals_to_log
 
     public function test_user_should_be_authenticated()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $server = m::mock(AuthorizationServer::class);
         $response = m::mock(ResponseFactory::class);
diff --git a/tests/Unit/CheckClientCredentialsForAnyScopeTest.php b/tests/Unit/CheckClientCredentialsForAnyScopeTest.php
@@ -4,6 +4,7 @@
 
 use Illuminate\Http\Request;
 use Laravel\Passport\Client;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckClientCredentialsForAnyScope;
 use Laravel\Passport\Token;
 use Laravel\Passport\TokenRepository;
@@ -85,7 +86,7 @@ public function test_request_is_passed_along_if_token_has_any_required_scope()
 
     public function test_exception_is_thrown_when_oauth_throws_exception()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $tokenRepository = m::mock(TokenRepository::class);
         $resourceServer = m::mock(ResourceServer::class);
diff --git a/tests/Unit/CheckClientCredentialsTest.php b/tests/Unit/CheckClientCredentialsTest.php
@@ -4,6 +4,7 @@
 
 use Illuminate\Http\Request;
 use Laravel\Passport\Client;
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckClientCredentials;
 use Laravel\Passport\Token;
 use Laravel\Passport\TokenRepository;
@@ -84,7 +85,7 @@ public function test_request_is_passed_along_if_token_and_scope_are_valid()
 
     public function test_exception_is_thrown_when_oauth_throws_exception()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $tokenRepository = m::mock(TokenRepository::class);
         $resourceServer = m::mock(ResourceServer::class);
diff --git a/tests/Unit/CheckForAnyScopeTest.php b/tests/Unit/CheckForAnyScopeTest.php
@@ -2,6 +2,7 @@
 
 namespace Laravel\Passport\Tests\Unit;
 
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckForAnyScope as CheckScopes;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
@@ -47,7 +48,7 @@ public function test_exception_is_thrown_if_token_doesnt_have_scope()
 
     public function test_exception_is_thrown_if_no_authenticated_user()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $middleware = new CheckScopes;
         $request = m::mock();
@@ -60,7 +61,7 @@ public function test_exception_is_thrown_if_no_authenticated_user()
 
     public function test_exception_is_thrown_if_no_token()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $middleware = new CheckScopes;
         $request = m::mock();
diff --git a/tests/Unit/CheckScopesTest.php b/tests/Unit/CheckScopesTest.php
@@ -2,6 +2,7 @@
 
 namespace Laravel\Passport\Tests\Unit;
 
+use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckScopes;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
@@ -46,7 +47,7 @@ public function test_exception_is_thrown_if_token_doesnt_have_scope()
 
     public function test_exception_is_thrown_if_no_authenticated_user()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $middleware = new CheckScopes;
         $request = m::mock();
@@ -59,7 +60,7 @@ public function test_exception_is_thrown_if_no_authenticated_user()
 
     public function test_exception_is_thrown_if_no_token()
     {
-        $this->expectException('Illuminate\Auth\AuthenticationException');
+        $this->expectException(AuthenticationException::class);
 
         $middleware = new CheckScopes;
         $request = m::mock();

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Laravel\Passport\Http\Middleware;`
`4`	`4`
`5`		`-use Illuminate\Auth\AuthenticationException;`
	`5`	`+use Laravel\Passport\Exceptions\AuthenticationException;`
`6`	`6`	`use Laravel\Passport\Exceptions\MissingScopeException;`
`7`	`7`
`8`	`8`	`class CheckClientCredentials extends CheckCredentials`
`@@ -13,7 +13,7 @@ class CheckClientCredentials extends CheckCredentials`
`13`	`13`	`* @param \Laravel\Passport\Token $token`
`14`	`14`	`* @return void`
`15`	`15`	`*`
`16`		`- * @throws \Illuminate\Auth\AuthenticationException`
	`16`	`+ * @throws \Laravel\Passport\Exceptions\AuthenticationException`
`17`	`17`	`*/`
`18`	`18`	`protected function validateCredentials($token)`
`19`	`19`	`{`