Sign upLogin

warlof/slackbot

View on GitHub
Star
src/Http/Controllers/Services/OAuthController.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method callback has 43 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function callback(Request $request)
    {
        // get back pending OAuth credentials validation from session
        $oauthCredentials = session()->get('warlof.slackbot.credentials');
Severity: Minor
Found in src/Http/Controllers/Services/OAuthController.php - About 1 hr to fix

    Function callback has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        public function callback(Request $request)
    {
        // get back pending OAuth credentials validation from session
        $oauthCredentials = session()->get('warlof.slackbot.credentials');
    Severity: Minor
    Found in src/Http/Controllers/Services/OAuthController.php - About 25 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Define and throw a dedicated exception instead of using a generic one.
    Open

                    throw new Exception('Returned status code : ' . $response->getStatusCode() .
    Severity: Major
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

    Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

    Noncompliant Code Example

    throw new Exception();  // Noncompliant

    Compliant Solution

    throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

    See

    Define a constant instead of duplicating this literal "client_id" 5 times.
    Open

                'client_id' => $request->input('slack-configuration-client'),
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define and throw a dedicated exception instead of using a generic one.
    Open

                    throw new Exception("response from Slack was empty.");
    Severity: Major
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

    Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

    Noncompliant Code Example

    throw new Exception();  // Noncompliant

    Compliant Solution

    throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

    See

    Define a constant instead of duplicating this literal "error" 3 times.
    Open

                    ->with('error', 'An error occurred while getting back the token. Returned state value is wrong. ' .
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "state" 4 times.
    Open

                'state' => $state
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "slack-configuration-verification" 3 times.
    Open

            ($request->input('slack-configuration-verification') != '')) {
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "client_secret" 4 times.
    Open

                'client_secret' => $request->input('slack-configuration-secret'),
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "warlof.slackbot.credentials" 3 times.
    Open

            session()->put('warlof.slackbot.credentials', [
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define and throw a dedicated exception instead of using a generic one.
    Open

                    throw new Exception($result['error']);
    Severity: Major
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    If you throw a general exception type, such as ErrorException, RuntimeException, or Exception in a library or framework, it forces consumers to catch all exceptions, including unknown exceptions that they do not know how to handle.

    Instead, either throw a subtype that already exists in the Standard PHP Library, or create your own type that derives from Exception.

    Noncompliant Code Example

    throw new Exception();  // Noncompliant

    Compliant Solution

    throw new InvalidArgumentException();
// or
throw new UnexpectedValueException();

    See

    Define a constant instead of duplicating this literal "slack-configuration-client" 3 times.
    Open

            (setting('warlof.slackbot.credentials.client_id', true) == $request->input('slack-configuration-client')) &&
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Define a constant instead of duplicating this literal "verification_token" 3 times.
    Open

                'verification_token' => $request->input('slack-configuration-verification'),
    Severity: Critical
    Found in src/Http/Controllers/Services/OAuthController.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    There are no issues that match your filters.

    Category
    Status