Tvi\MonitorBundle\Controller\ApiCheckTrait

Complexity

Total Complexity

12

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	checkAction()	0	25	4
B	checkStatusAction()	0	35	6
A	checkListAction()	0	32	2

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Controller;

use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Tvi\MonitorBundle\Exception\HttpException;
use Tvi\MonitorBundle\Reporter\Api;
use Tvi\MonitorBundle\Reporter\ReporterManager;
use Tvi\MonitorBundle\Runner\RunnerManager;

/**

Missing short description in doc comment

 * @property RunnerManager   $runnerManager
 * @property ReporterManager $reporterManager
 *
 * @author Vladimir Turnaev <turnaev@gmail.com>
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ApiCheckTrait
{
    public function checkAction(Request $request, string $check): JsonResponse

The parameter $request is not used and could be removed.

Missing doc comment for function checkAction()

    {
        try {
            $runner = $this->runnerManager->getRunner($check);

            /** @var $reporter Api */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $reporter = $this->reporterManager->getReporter('api');

            $runner->addReporter($reporter);
            $runner->run();

            $res = $reporter->getCheckResults();

            if (isset($res[0])) {
                return new JsonResponse($res[0]);
            }
            throw new NotFoundHttpException(sprintf('Check %s not found', $check));
        } catch (NotFoundHttpException $e) {
            $e = new HttpException(404, $e->getMessage());

            return new JsonResponse($e->toArray(), $e->getStatusCode());
        } catch (\Exception $e) {
            $e = new HttpException(500, $e->getMessage());

            return new JsonResponse($e->toArray(), $e->getStatusCode());
        }
    }

    public function checkListAction(Request $request): JsonResponse

Missing doc comment for function checkListAction()

    {
        try {
            list($checks, $groups, $tags) = $this->getFilterParams($request);

It seems like getFilterParams() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $runner = $this->runnerManager->getRunner($checks, $groups, $tags);

            $breakOnFailure = (bool) $request->get('break-on-failure', false);
            $runner->setBreakOnFailure($breakOnFailure);

            /** @var $reporter Api */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $reporter = $this->reporterManager->getReporter('api');

            $runner->addReporter($reporter);
            $runner->run();

            return new JsonResponse([

The opening parenthesis of a multi-line function call should be the last content on the line.

                'statusCode' => $reporter->getStatusCode(),
                'statusName' => $reporter->getStatusName(),

                'successes' => $reporter->getSuccessCount(),
                'warnings' => $reporter->getWarningCount(),
                'failures' => $reporter->getFailureCount(),
                'unknowns' => $reporter->getUnknownCount(),
                'total' => $reporter->getTotalCount(),

                'checks' => $reporter->getCheckResults(),
            ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        } catch (\Exception $e) {
            $e = new HttpException(500, $e->getMessage());

            return new JsonResponse($e->toArray(), $e->getStatusCode());
        }
    }

    public function checkStatusAction(Request $request, ?string $checkSingle = null): Response

Missing doc comment for function checkStatusAction()

    {
        try {
            list($checks, $groups, $tags) = $this->getFilterParams($request);

            $checks = array_filter($checks, static function ($i) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                return null !== $i;
            });

For multi-line function calls, the closing parenthesis should be on a new line.

            if (null !== $checkSingle) {
                $runner = $this->runnerManager->getRunner($checkSingle);
            } else {
                $runner = $this->runnerManager->getRunner($checks, $groups, $tags);
            }

            $breakOnFailure = (bool) $request->get('break-on-failure', false);
            $runner->setBreakOnFailure($breakOnFailure);

            /** @var $reporter Api */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            $reporter = $this->reporterManager->getReporter('api');

            $runner->addReporter($reporter);
            $runner->run();

            if ($reporter->getTotalCount()) {
                $code = $reporter->getStatusCode() === $reporter::STATUS_CODE_SUCCESS ? 200 : 500;

                return new Response($reporter->getStatusName(), $code);
            }

            throw new NotFoundHttpException('Check(s) not found');
        } catch (NotFoundHttpException $e) {
            return new Response($e->getMessage(), $e->getStatusCode());
        } catch (\Exception $e) {
            return new Response($e->getMessage(), 502);
        }
    }
}