App\Controller\HealthzController

Complexity

Total Complexity

2

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	11	1
A	__construct()	0	4	1

<?php
declare(strict_types = 1);
/**
 * /src/Controller/HealthzController.php
 *
 * @author TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
 */

namespace App\Controller;

use App\Rest\ResponseHandler;

The type App\Rest\ResponseHandler was not found. Maybe you did not declare it correctly or list all dependencies?

use App\Utils\HealthzService;
use Swagger\Annotations as SWG;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Throwable;

/**
 * Class HealthzController
 *
 * @package App\Controller
 * @author  TLe, Tarmo Leppänen <tarmo.leppanen@pinja.com>
 */
class HealthzController
{
    private ResponseHandler $responseHandler;
    private HealthzService $healthzService;

    /**
     * HealthzController constructor.
     */
    public function __construct(ResponseHandler $responseHandler, HealthzService $healthzService)
    {
        $this->responseHandler = $responseHandler;
        $this->healthzService = $healthzService;
    }

    /**
     * Route for application health check. This action will make some simple
     * tasks to ensure that application is up and running like expected.
     *
     * @see https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/
     *
     * @Route(
     *     path="/healthz",
     *     methods={"GET"}
     *  )
     *
     * @SWG\Response(
     *      response=200,
     *      description="success",
     *      @SWG\Schema(
     *          type="object",
     *          example={"timestamp": "2018-01-01T13:08:05+00:00"},
     *          @SWG\Property(property="timestamp", type="string"),
     *      ),
     *  )
     *
     * @throws Throwable
     */
    public function __invoke(Request $request): Response
    {
        return $this->responseHandler->createResponse(
            $request,
            $this->healthzService->check(),
            null,
            200,
            ResponseHandler::FORMAT_JSON,
            [
                'groups' => [
                    'Healthz.timestamp',
                ],
            ]
        );
    }
}