Handler::renderExceptionWithWhoops() - Code Metrics - johnnymast/myio - Measure and Improve Code Quality continuously with Scrutinizer

Handler::renderExceptionWithWhoops() A
last analyzed 2017-04-13 21:26 UTC

↳ Parent: Handler

Complexity

Conditions	2
Paths	2

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	0
cts	9
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	8
nc	2
nop	1
crap	6

<?php

namespace App\Exceptions;

use Exception;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Session\TokenMismatchException;
use Illuminate\Validation\ValidationException;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that should not be reported.
     *
     * @var array
     */
    protected $dontReport = [
        \Illuminate\Auth\AuthenticationException::class,
        \Illuminate\Auth\Access\AuthorizationException::class,
        \Symfony\Component\HttpKernel\Exception\HttpException::class,
        \Illuminate\Database\Eloquent\ModelNotFoundException::class,
        \Illuminate\Session\TokenMismatchException::class,
        \Illuminate\Validation\ValidationException::class,
        \Illuminate\Database\Eloquent\ModelNotFoundException::class,
    ];

    /**
     * Report or log an exception.
     *
     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
     *
     * @param \Exception $exception
     *
     * @return void
     */
    public function report(Exception $exception)
    {
        parent::report($exception);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param \Illuminate\Http\Request $request
     *
     * @return \Illuminate\Http\Response
     */
    public function render($request, Exception $e)
    {
        // the below code is for Whoops support. Since Whoops can open some security holes we want to only have it
        // enabled in the debug environment. We also don't want Whoops to handle 404 and Validation related exceptions.
        if (config('app.debug') && ! ($e instanceof ValidationException) && ! ($e instanceof HttpResponseException)) {
            return $this->renderExceptionWithWhoops($e);
        }

        // this line allows you to redirect to a route or even back to the current page
        // if there is a CSRF Token Mismatch
        if ($e instanceof TokenMismatchException) {
            return redirect()->route('homepage');
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        // let's add some support if a Model is not found
        // for example, if you were to run a query for User #10000 and that user didn't exist we can return a 404 error
        if ($e instanceof ModelNotFoundException) {
            return response()->view('errors.404', [], 404);
        }

        // Let's return a default error page instead of the ugly Laravel error page when we have fatal exceptions
        if ($e instanceof \Symfony\Component\Debug\Exception\FatalErrorException) {
            return response()->view('errors.500', [], 500);
        }

        // finally we are back to the original default error handling provided by Laravel
        if ($this->isHttpException($e)) {
            switch ($e->getStatusCode()) {
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                // not found
                case 404:
                    return response()->view('errors.404', [], 404);
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                // internal error
                case 500:
                    return response()->view('errors.500', [], 500);
                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

                default:
                    return $this->renderHttpException($e);

                    break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            }
        } else {
            return parent::render($request, $e);
        }
    }

    /**
     * Render an exception using Whoops.
     *
     * @param \Exception $e
     *
     * @return \Illuminate\Http\Response
     */
    protected function renderExceptionWithWhoops(Exception $e)
    {
        if (config('app.debug')) {
            $whoops = new \Whoops\Run();
            $whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            return new \Illuminate\Http\Response(
                $whoops->handleException($e),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $e->getStatusCode(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $e->getHeaders()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            );
        }
    }

    /**
     * Convert an authentication exception into an unauthenticated response.
     *
     * @param \Illuminate\Http\Request                 $request
     * @param \Illuminate\Auth\AuthenticationException $exception
     *
     * @return \Illuminate\Http\Response
     */
    protected function unauthenticated($request, AuthenticationException $exception)

    {
        if ($request->expectsJson()) {
            return response()->json(['error' => 'Unauthenticated.'], 401);
        }

        return redirect()->guest(route('login'));
    }
}


1		<?php
2
3		namespace App\Exceptions;
4
5		use Exception;
6		use Illuminate\Auth\AuthenticationException;
7		use Illuminate\Database\Eloquent\ModelNotFoundException;
8		use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
9		use Illuminate\Http\Exceptions\HttpResponseException;
10		use Illuminate\Session\TokenMismatchException;
11		use Illuminate\Validation\ValidationException;
12
13		class Handler extends ExceptionHandler
14		{
15		/**
16		* A list of the exception types that should not be reported.
17		*
18		* @var array
19		*/
20		protected $dontReport = [
21		\Illuminate\Auth\AuthenticationException::class,
22		\Illuminate\Auth\Access\AuthorizationException::class,
23		\Symfony\Component\HttpKernel\Exception\HttpException::class,
24		\Illuminate\Database\Eloquent\ModelNotFoundException::class,
25		\Illuminate\Session\TokenMismatchException::class,
26		\Illuminate\Validation\ValidationException::class,
27		\Illuminate\Database\Eloquent\ModelNotFoundException::class,
28		];
29
30		/**
31		* Report or log an exception.
32		*
33		* This is a great spot to send exceptions to Sentry, Bugsnag, etc.
34		*
35		* @param \Exception $exception
36		*
37		* @return void
38		*/
39	12	public function report(Exception $exception)
40		{
41	12	parent::report($exception);
42	12	}
43
44		/**
45		* Render an exception into an HTTP response.
46		*
47		* @param \Illuminate\Http\Request $request
48		*
49		* @return \Illuminate\Http\Response
50		*/
51		public function render($request, Exception $e)
52		{
53		// the below code is for Whoops support. Since Whoops can open some security holes we want to only have it
54		// enabled in the debug environment. We also don't want Whoops to handle 404 and Validation related exceptions.
55		if (config('app.debug') && ! ($e instanceof ValidationException) && ! ($e instanceof HttpResponseException)) {
56		return $this->renderExceptionWithWhoops($e);
57		}
58
59		// this line allows you to redirect to a route or even back to the current page
60		// if there is a CSRF Token Mismatch
61		if ($e instanceof TokenMismatchException) {
62		return redirect()->route('homepage');
		0 ignored issues – show Bug Best Practice introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report The return type of `return redirect()->route('homepage');` (`Illuminate\Http\RedirectResponse`) is incompatible with the return type documented by `App\Exceptions\Handler::render` of type `Illuminate\Http\Response\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
63		}
64
65		// let's add some support if a Model is not found
66		// for example, if you were to run a query for User #10000 and that user didn't exist we can return a 404 error
67		if ($e instanceof ModelNotFoundException) {
68		return response()->view('errors.404', [], 404);
69		}
70
71		// Let's return a default error page instead of the ugly Laravel error page when we have fatal exceptions
72		if ($e instanceof \Symfony\Component\Debug\Exception\FatalErrorException) {
73		return response()->view('errors.500', [], 500);
74		}
75
76		// finally we are back to the original default error handling provided by Laravel
77		if ($this->isHttpException($e)) {
78		switch ($e->getStatusCode()) {
		0 ignored issues – show Bug introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getStatusCode()` does only exist in the following sub-classes of `Exception`: `Illuminate\Foundation\Ht...aintenanceModeException`, `Symfony\Component\HttpKe...cessDeniedHttpException`, `Symfony\Component\HttpKe...BadRequestHttpException`, `Symfony\Component\HttpKe...n\ConflictHttpException`, `Symfony\Component\HttpKe...ption\GoneHttpException`, `Symfony\Component\HttpKe...Exception\HttpException`, `Symfony\Component\HttpKe...thRequiredHttpException`, `Symfony\Component\HttpKe...NotAllowedHttpException`, `Symfony\Component\HttpKe...AcceptableHttpException`, `Symfony\Component\HttpKe...n\NotFoundHttpException`, `Symfony\Component\HttpKe...tionFailedHttpException`, `Symfony\Component\HttpKe...onRequiredHttpException`, `Symfony\Component\HttpKe...navailableHttpException`, `Symfony\Component\HttpKe...nyRequestsHttpException`, `Symfony\Component\HttpKe...authorizedHttpException`, `Symfony\Component\HttpKe...ableEntityHttpException`, `Symfony\Component\HttpKe...dMediaTypeHttpException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
79		// not found
80		case 404:
81		return response()->view('errors.404', [], 404);
82		break;
		0 ignored issues – show Unused Code introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
83		// internal error
84		case 500:
85		return response()->view('errors.500', [], 500);
86		break;
		0 ignored issues – show Unused Code introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
87
88		default:
89		return $this->renderHttpException($e);
		0 ignored issues – show Compatibility introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `$e` of type `object<Exception>` is not a sub-type of `object<Symfony\Component...xception\HttpException>`. It seems like you assume a child class of the class `Exception` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
90		break;
		0 ignored issues – show Unused Code introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
91		}
92		} else {
93		return parent::render($request, $e);
94		}
95		}
96
97		/**
98		* Render an exception using Whoops.
99		*
100		* @param \Exception $e
101		*
102		* @return \Illuminate\Http\Response
103		*/
104		protected function renderExceptionWithWhoops(Exception $e)
105		{
106		if (config('app.debug')) {
107		$whoops = new \Whoops\Run();
108		$whoops->pushHandler(new \Whoops\Handler\PrettyPageHandler());
		0 ignored issues – show Documentation introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `new \Whoops\Handler\PrettyPageHandler()` is of type `object<Whoops\Handler\PrettyPageHandler>`, but the function expects a `callable`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
109
110		return new \Illuminate\Http\Response(
111		$whoops->handleException($e),
		0 ignored issues – show Documentation introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report `$e` is of type `object<Exception>`, but the function expects a `object<Throwable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112		$e->getStatusCode(),
		0 ignored issues – show Bug introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getStatusCode()` does only exist in the following sub-classes of `Exception`: `Illuminate\Foundation\Ht...aintenanceModeException`, `Symfony\Component\HttpKe...cessDeniedHttpException`, `Symfony\Component\HttpKe...BadRequestHttpException`, `Symfony\Component\HttpKe...n\ConflictHttpException`, `Symfony\Component\HttpKe...ption\GoneHttpException`, `Symfony\Component\HttpKe...Exception\HttpException`, `Symfony\Component\HttpKe...thRequiredHttpException`, `Symfony\Component\HttpKe...NotAllowedHttpException`, `Symfony\Component\HttpKe...AcceptableHttpException`, `Symfony\Component\HttpKe...n\NotFoundHttpException`, `Symfony\Component\HttpKe...tionFailedHttpException`, `Symfony\Component\HttpKe...onRequiredHttpException`, `Symfony\Component\HttpKe...navailableHttpException`, `Symfony\Component\HttpKe...nyRequestsHttpException`, `Symfony\Component\HttpKe...authorizedHttpException`, `Symfony\Component\HttpKe...ableEntityHttpException`, `Symfony\Component\HttpKe...dMediaTypeHttpException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
113		$e->getHeaders()
		0 ignored issues – show Bug introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Exception` as the method `getHeaders()` does only exist in the following sub-classes of `Exception`: `Illuminate\Foundation\Ht...aintenanceModeException`, `Symfony\Component\HttpKe...cessDeniedHttpException`, `Symfony\Component\HttpKe...BadRequestHttpException`, `Symfony\Component\HttpKe...n\ConflictHttpException`, `Symfony\Component\HttpKe...ption\GoneHttpException`, `Symfony\Component\HttpKe...Exception\HttpException`, `Symfony\Component\HttpKe...thRequiredHttpException`, `Symfony\Component\HttpKe...NotAllowedHttpException`, `Symfony\Component\HttpKe...AcceptableHttpException`, `Symfony\Component\HttpKe...n\NotFoundHttpException`, `Symfony\Component\HttpKe...tionFailedHttpException`, `Symfony\Component\HttpKe...onRequiredHttpException`, `Symfony\Component\HttpKe...navailableHttpException`, `Symfony\Component\HttpKe...nyRequestsHttpException`, `Symfony\Component\HttpKe...authorizedHttpException`, `Symfony\Component\HttpKe...ableEntityHttpException`, `Symfony\Component\HttpKe...dMediaTypeHttpException`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
114		);
115		}
116		}
117
118		/**
119		* Convert an authentication exception into an unauthenticated response.
120		*
121		* @param \Illuminate\Http\Request $request
122		* @param \Illuminate\Auth\AuthenticationException $exception
123		*
124		* @return \Illuminate\Http\Response
125		*/
126		protected function unauthenticated($request, AuthenticationException $exception)
		0 ignored issues – show Unused Code introduced 2017-03-22 18:33 UTC by Report Bug Copy Issue Report The parameter `$exception` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
127		{
128		if ($request->expectsJson()) {
129		return response()->json(['error' => 'Unauthenticated.'], 401);
130		}
131
132		return redirect()->guest(route('login'));
133		}
134		}
135

johnnymast / myio

Handler::renderExceptionWithWhoops() A last analyzed 2017-04-13 21:26 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Handler::renderExceptionWithWhoops() A
last analyzed 2017-04-13 21:26 UTC