GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.
Completed
Push — master ( 8880c5...ea0bba )
by Freek
09:42 queued 07:59
created

Controller   A

Complexity

Total Complexity 14

Size/Duplication

Total Lines 94
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 11

Importance

Changes 0
Metric Value
wmc 14
lcom 1
cbo 11
dl 0
loc 94
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 6 1
A getResponse() 0 19 4
A guardAgainstInvalidRequest() 0 16 4
A determineHandler() 0 21 3
A convertToResponse() 0 14 2
1
<?php
2
3
namespace Spatie\SlashCommand;
4
5
use Exception;
6
use Illuminate\Config\Repository;
7
use Illuminate\Http\Request as IlluminateRequest;
8
use Spatie\SlashCommand\Exceptions\InvalidHandler;
9
use Spatie\SlashCommand\Exceptions\InvalidRequest;
10
use Spatie\SlashCommand\Handlers\SignatureHandler;
11
use Illuminate\Http\Response as IlluminateResponse;
12
use Illuminate\Routing\Controller as IlluminateController;
13
use Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled;
14
use Spatie\SlashCommand\Exceptions\SlackSlashCommandException;
15
16
class Controller extends IlluminateController
17
{
18
    /** @var \Spatie\SlashCommand\Request */
19
    protected $request;
20
21
    /** @var \Illuminate\Support\Collection */
22
    protected $config;
23
24
    public function __construct(IlluminateRequest $request, Repository $config)
25
    {
26
        $this->request = Request::createFromIlluminateRequest($request);
0 ignored issues
show
Documentation Bug introduced by
It seems like \Spatie\SlashCommand\Req...minateRequest($request) of type object<self> is incompatible with the declared type object<Spatie\SlashCommand\Request> of property $request.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
27
28
        $this->config = collect($config->get('laravel-slack-slash-command'));
29
    }
30
31
    public function getResponse(): IlluminateResponse
32
    {
33
        $this->guardAgainstInvalidRequest();
34
35
        $handler = $this->determineHandler();
36
37
        try {
38
            if ($handler instanceof SignatureHandler) {
39
                $handler->validate();
40
            }
41
            $response = $handler->handle($this->request);
42
        } catch (SlackSlashCommandException $exception) {
43
            $response = $exception->getResponse($this->request);
44
        } catch (Exception $exception) {
45
            $response = $this->convertToResponse($exception);
46
        }
47
48
        return $response->getIlluminateResponse();
49
    }
50
51
    protected function guardAgainstInvalidRequest()
52
    {
53
        if (! request()->has('token')) {
54
            throw InvalidRequest::tokenNotFound();
55
        }
56
57
        $validTokens = $this->config->get('token');
58
59
        if (! is_array($validTokens)) {
60
            $validTokens = [$validTokens];
61
        }
62
63
        if (! in_array($this->request->get('token'), $validTokens)) {
64
            throw InvalidRequest::invalidToken($this->request->get('token'));
65
        }
66
    }
67
68
    /**
69
     * @return \Spatie\SlashCommand\Handlers\BaseHandler
70
     *
71
     * @throws \Spatie\SlashCommand\Exceptions\RequestCouldNotBeHandled
72
     */
73
    protected function determineHandler()
74
    {
75
        $handler = collect($this->config->get('handlers'))
76
            ->map(function (string $handlerClassName) {
77
                if (! class_exists($handlerClassName)) {
78
                    throw InvalidHandler::handlerDoesNotExist($handlerClassName);
79
                }
80
81
                return new $handlerClassName($this->request);
82
            })
83
            ->filter(function (HandlesSlashCommand $handler) {
84
                return $handler->canHandle($this->request);
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface Spatie\SlashCommand\HandlesSlashCommand as the method canHandle() does only exist in the following implementations of said interface: Spatie\SlashCommand\Handlers\BaseHandler, Spatie\SlashCommand\Handlers\CatchAll, Spatie\SlashCommand\Handlers\Help, Spatie\SlashCommand\Handlers\SignatureHandler.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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 implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
85
            })
86
            ->first();
87
88
        if (! $handler) {
89
            throw RequestCouldNotBeHandled::noHandlerFound($this->request);
90
        }
91
92
        return $handler;
93
    }
94
95
    protected function convertToResponse(Exception $exception) : Response
96
    {
97
        $message = config('app.debug') ? (string) $exception : 'Whoops, something went wrong...';
98
99
        $exception = new SlackSlashCommandException(
100
            $message,
101
            $exception->getCode(),
102
            $exception
103
        );
104
105
        $response = $exception->getResponse($this->request);
106
107
        return $response;
108
    }
109
}
110