turnaev / monitor-bundle

src/Controller/TraitApiCheck.php

<?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\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use JMS\Serializer\Serializer;
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
 * @property Serializer      $serializer
 *
 * @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 TraitApiCheck
{
    public function checkAction(Request $request, string $id, string $version): Response

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

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

Missing doc comment for function checkAction()

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

            /** @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 $this->creatResponse($res[0], Response::HTTP_OK, true);

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

            }

            throw new NotFoundHttpException(sprintf('Check %s not found', $id));
        } catch (NotFoundHttpException $e) {
            $e = new HttpException($e->getStatusCode(), $e->getMessage());

            return $this->creatResponse($e->toArray(), $e->getStatusCode(), true);
        } catch (\Exception $e) {
            return $this->creatResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
        }
    }

    public function checksAction(Request $request, string $version): Response

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

Missing doc comment for function checksAction()

    {
        try {
            list($ids, $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?

            $checks = $checks ? $checks : $ids;

            $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();

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

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

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

            return $this->creatResponse($data, Response::HTTP_OK, true);
        } catch (\Exception $e) {
            return $this->creatResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
        }
    }

    public function checkStatusAction(Request $request, string $id, string $version): Response

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

Missing doc comment for function checkStatusAction()

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

            $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();

            $res = $reporter->getCheckResults();

            if (isset($res[0])) {
                $code = $reporter->getStatusCode() === $reporter::STATUS_CODE_SUCCESS
                    ? Response::HTTP_OK
                    : Response::HTTP_BAD_GATEWAY;

                return $this->creatResponse($reporter->getStatusName(), $code);
            }

            throw new NotFoundHttpException(sprintf('Check "%s" not found', $id));
        } catch (NotFoundHttpException $e) {
            return $this->creatResponse($e->getMessage(), $e->getStatusCode());
        } catch (\Exception $e) {
            return $this->creatResponse($e->getMessage(), Response::HTTP_INTERNAL_SERVER_ERROR);
        }
    }

    public function checkStatusesAction(Request $request, string $version): Response

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

Missing doc comment for function checkStatusesAction()

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

            $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
                    ? Response::HTTP_OK
                    : Response::HTTP_BAD_GATEWAY;

                return $this->creatResponse($reporter->getStatusName(), $code);
            }

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