gdbots/pbjx-bundle-php

View on GitHub
src/Controller/PbjxController.php

Summary

Maintainability
D
2 days
Test Coverage

Method handleAction has 99 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function handleAction(Request $request): Message
    {
        $request->attributes->set('pbjx_redact_error_message', false);
        $envelope = EnvelopeV1::create();
        if (!$this->isRequestMethodOk($envelope, $request) || !$this->isContentTypeOk($envelope, $request)) {
Severity: Major
Found in src/Controller/PbjxController.php - About 3 hrs to fix

    File PbjxController.php has 313 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php
    declare(strict_types=1);
    
    namespace Gdbots\Bundle\PbjxBundle\Controller;
    
    
    Severity: Minor
    Found in src/Controller/PbjxController.php - About 3 hrs to fix

      Function handleAction has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

          public function handleAction(Request $request): Message
          {
              $request->attributes->set('pbjx_redact_error_message', false);
              $envelope = EnvelopeV1::create();
              if (!$this->isRequestMethodOk($envelope, $request) || !$this->isContentTypeOk($envelope, $request)) {
      Severity: Minor
      Found in src/Controller/PbjxController.php - About 2 hrs 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

      Method isPbjxTokenOk has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function isPbjxTokenOk(Message $envelope, Request $request, string $content): bool
          {
              if ($request->attributes->getBoolean('pbjx_console')) {
                  // no tokens used on the console
                  return true;
      Severity: Minor
      Found in src/Controller/PbjxController.php - About 1 hr to fix

        Function isPbjxTokenOk has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

            private function isPbjxTokenOk(Message $envelope, Request $request, string $content): bool
            {
                if ($request->attributes->getBoolean('pbjx_console')) {
                    // no tokens used on the console
                    return true;
        Severity: Minor
        Found in src/Controller/PbjxController.php - About 1 hr 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

        Method handleException has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private function handleException(Message $envelope, Request $request, Message $message, \Throwable $exception): Message
            {
                if ($exception instanceof HttpExceptionInterface) {
                    $httpCode = HttpCode::tryFrom($exception->getStatusCode()) ?: HttpCode::UNKNOWN;
                    $code = StatusCodeUtil::httpToVendor($httpCode);
        Severity: Minor
        Found in src/Controller/PbjxController.php - About 1 hr to fix

          Avoid too many return statements within this method.
          Open

                      return $this->handleEvent($envelope, $request, $message);
          Severity: Major
          Found in src/Controller/PbjxController.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                        return $this->handleCommand($envelope, $request, $message);
            Severity: Major
            Found in src/Controller/PbjxController.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                          return $envelope
                              ->set('code', Code::OK->value)
                              ->set('http_code', HttpCode::HTTP_ACCEPTED)
                              ->set('message_ref', $message->generateMessageRef());
              Severity: Major
              Found in src/Controller/PbjxController.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                            return $this->handleRequest($envelope, $request, $message);
                Severity: Major
                Found in src/Controller/PbjxController.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                              return true;
                  Severity: Major
                  Found in src/Controller/PbjxController.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                return $envelope;
                    Severity: Major
                    Found in src/Controller/PbjxController.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                  return false;
                      Severity: Major
                      Found in src/Controller/PbjxController.php - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                                return $envelope
                                    ->set('code', Code::INVALID_ARGUMENT->value)
                                    ->set('http_code', HttpCode::HTTP_UNPROCESSABLE_ENTITY)
                                    ->set('error_name', 'UnprocessableEntity')
                                    ->set(
                        Severity: Major
                        Found in src/Controller/PbjxController.php - About 30 mins to fix

                          Similar blocks of code found in 2 locations. Consider refactoring.
                          Open

                              private function handleEvent(Message $envelope, Request $request, Message $event): Message
                              {
                                  try {
                                      $this->pbjx->publish($event);
                                  } catch (\Throwable $e) {
                          Severity: Major
                          Found in src/Controller/PbjxController.php and 1 other location - About 2 hrs to fix
                          src/Controller/PbjxController.php on lines 176..194

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 136.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          Similar blocks of code found in 2 locations. Consider refactoring.
                          Open

                              private function handleCommand(Message $envelope, Request $request, Message $command): Message
                              {
                                  try {
                                      $this->pbjx->send($command);
                                  } catch (\Throwable $e) {
                          Severity: Major
                          Found in src/Controller/PbjxController.php and 1 other location - About 2 hrs to fix
                          src/Controller/PbjxController.php on lines 196..214

                          Duplicated Code

                          Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                          Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                          When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                          Tuning

                          This issue has a mass of 136.

                          We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                          The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                          If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                          See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                          Refactorings

                          Further Reading

                          There are no issues that match your filters.

                          Category
                          Status