yiisoft / yii-debug-api

src/Debug/Controller/DebugController.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Api\Debug\Controller;

use Psr\Container\ContainerInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Yiisoft\Assets\AssetManager;
use Yiisoft\Assets\AssetPublisherInterface;
use Yiisoft\DataResponse\DataResponse;
use Yiisoft\DataResponse\DataResponseFactoryInterface;
use Yiisoft\Router\CurrentRoute;
use Yiisoft\Yii\Debug\Api\Debug\Exception\NotFoundException;
use Yiisoft\Yii\Debug\Api\Debug\Exception\PackageNotInstalledException;
use Yiisoft\Yii\Debug\Api\Debug\HtmlViewProviderInterface;
use Yiisoft\Yii\Debug\Api\Debug\ModuleFederationProviderInterface;
use Yiisoft\Yii\Debug\Api\Debug\Repository\CollectorRepositoryInterface;
use Yiisoft\Yii\Debug\Api\ServerSentEventsStream;
use Yiisoft\Yii\Debug\Storage\StorageInterface;
use Yiisoft\Yii\View\ViewRenderer;

/**
 * Debug controller provides endpoints that expose information about requests processed that debugger collected.
 *
 * @OA\Tag(
 *     name="yii-debug-api",
 *     description="Yii Debug API"
 * )
 */
final class DebugController
{
    public function __construct(
        private DataResponseFactoryInterface $responseFactory,
        private CollectorRepositoryInterface $collectorRepository
    ) {
    }

    /**
     * List of requests processed.
     *
     * @OA\Get(
     *     tags={"yii-debug-api"},
     *     path="/debug/api",
     *     description="List of requests processed",
     *
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugSuccessResponse")
     *              }
     *          )
     *     )
     * )
     */
    public function index(): ResponseInterface
    {
        return $this->responseFactory->createResponse($this->collectorRepository->getSummary());
    }

    /**
     * Summary about a processed request identified by ID specified.
     *
     * @OA\Get(
     *     tags={"yii-debug-api"},
     *     path="/debug/api/summary/{id}",
     *     description="Summary about a processed request identified by ID specified",
     *
     *     @OA\Parameter(
     *          name="id",
     *          required=true,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="id",
     *          description="Request ID for getting the summary"
     *     ),
     *
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugSuccessResponse")
     *              }
     *          )
     *     ),
     *
     *     @OA\Response(
     *          response="404",
     *          description="Not found",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugNotFoundResponse")
     *              }
     *          )
     *     )
     * )
     */
    public function summary(CurrentRoute $currentRoute): ResponseInterface
    {
        $data = $this->collectorRepository->getSummary($currentRoute->getArgument('id'));
        return $this->responseFactory->createResponse($data);
    }

    /**
     * Detail information about a processed request identified by ID.
     *
     * @OA\Get(
     *     tags={"yii-debug-api"},
     *     path="/debug/api/view/{id}/?collector={collector}",
     *     description="Detail information about a processed request identified by ID",
     *
     *     @OA\Parameter(
     *          name="id",
     *          required=true,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="id",
     *          description="Request ID for getting the detail information"
     *     ),
     *
     *     @OA\Parameter(
     *          name="collector",
     *          allowEmptyValue=true,
     *
     *          @OA\Schema(type="string"),
     *          in="query",
     *          parameter="collector",
     *          description="Collector for getting the detail information"
     *     ),
     *
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugSuccessResponse")
     *              }
     *          )
     *     ),
     *
     *     @OA\Response(
     *          response="404",
     *          description="Not found",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugNotFoundResponse")
     *              }
     *          )
     *     )
     * )
     */
    public function view(
        CurrentRoute $currentRoute,
        ServerRequestInterface $serverRequest,
        ContainerInterface $container,
    ): ResponseInterface {
        $data = $this->collectorRepository->getDetail(
            $currentRoute->getArgument('id')

It seems like $currentRoute->getArgument('id') can also be of type null; however, parameter $id of Yiisoft\Yii\Debug\Api\Debug\Repository\CollectorRepositoryInterface::getDetail() does only seem to accept string, maybe add an additional type check?

        );

        $collectorClass = $serverRequest->getQueryParams()['collector'] ?? null;
        if ($collectorClass !== null) {
            $data = $data[$collectorClass] ?? throw new NotFoundException(
                sprintf("Requested collector doesn't exist: %s.", $collectorClass)
            );
        }
        if (is_subclass_of($collectorClass, HtmlViewProviderInterface::class)) {
            return $this->createHtmlPanelResponse($container, $collectorClass, $data);
        }
        if (is_subclass_of($collectorClass, ModuleFederationProviderInterface::class)) {
            return $this->createJsPanelResponse($container, $collectorClass, $data);
        }

        return $this->responseFactory->createResponse($data);
    }

    /**
     * Dump information about a processed request identified by ID.
     *
     * @OA\Get(
     *     tags={"yii-debug-api"},
     *     path="/debug/api/dump/{id}/{collector}",
     *     description="Dump information about a processed request identified by ID",
     *
     *     @OA\Parameter(
     *          name="id",
     *          required=true,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="id",
     *          description="Request ID for getting the dump information"
     *     ),
     *
     *     @OA\Parameter(
     *          name="collector",
     *          allowEmptyValue=true,
     *          required=false,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="collector",
     *          description="Collector for getting the dump information"
     *     ),
     *
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugSuccessResponse")
     *              }
     *          )
     *     ),
     *
     *     @OA\Response(
     *          response="404",
     *          description="Not found",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugNotFoundResponse")
     *              }
     *          )
     *     )
     * )
     *
     * @throws NotFoundException
     * @return ResponseInterface response.
     */
    public function dump(CurrentRoute $currentRoute): ResponseInterface
    {
        $data = $this->collectorRepository->getDumpObject(
            $currentRoute->getArgument('id')

It seems like $currentRoute->getArgument('id') can also be of type null; however, parameter $id of Yiisoft\Yii\Debug\Api\Debug\Repository\CollectorRepositoryInterface::getDumpObject() does only seem to accept string, maybe add an additional type check?

        );

        if ($currentRoute->getArgument('collector') !== null) {
            if (isset($data[$currentRoute->getArgument('collector')])) {
                $data = $data[$currentRoute->getArgument('collector')];
            } else {
                throw new NotFoundException('Requested collector doesn\'t exists.');
            }
        }

        return $this->responseFactory->createResponse($data);
    }

    /**
     * Object information about a processed request identified by ID.
     *
     * @OA\Get(
     *     tags={"yii-debug-api"},
     *     path="/debug/api/object/{id}/{objectId}",
     *     description="Object information about a processed request identified by ID",
     *
     *     @OA\Parameter(
     *          name="id",
     *          required=true,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="id",
     *          description="Request ID for getting the object information"
     *     ),
     *
     *     @OA\Parameter(
     *          name="objectId",
     *          required=true,
     *
     *          @OA\Schema(type="string"),
     *          in="path",
     *          parameter="objectId",
     *          description="ID for getting the object information"
     *     ),
     *
     *     @OA\Response(
     *          response="200",
     *          description="Success",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugSuccessResponse")
     *              }
     *          )
     *     ),
     *
     *     @OA\Response(
     *          response="404",
     *          description="Not found",
     *
     *          @OA\JsonContent(
     *              allOf={
     *
     *                  @OA\Schema(ref="#/components/schemas/DebugNotFoundResponse")
     *              }
     *          )
     *     )
     * )
     *
     * @return ResponseInterface response.
     */
    public function object(CurrentRoute $currentRoute): ResponseInterface
    {
        $data = $this->collectorRepository->getObject(
            $currentRoute->getArgument('id'),

It seems like $currentRoute->getArgument('id') can also be of type null; however, parameter $id of Yiisoft\Yii\Debug\Api\Debug\Repository\CollectorRepositoryInterface::getObject() does only seem to accept string, maybe add an additional type check?

            $currentRoute->getArgument('objectId')

It seems like $currentRoute->getArgument('objectId') can also be of type null; however, parameter $objectId of Yiisoft\Yii\Debug\Api\Debug\Repository\CollectorRepositoryInterface::getObject() does only seem to accept string, maybe add an additional type check?

        );

        return $this->responseFactory->createResponse([
            'class' => $data[0],
            'value' => $data[1],
        ]);
    }

    public function eventStream(
        StorageInterface $storage,
        ResponseFactoryInterface $responseFactory
    ): ResponseInterface {
        // TODO implement OS signal handling
        $compareFunction = function () use ($storage) {
            $read = $storage->read(StorageInterface::TYPE_SUMMARY, null);
            return md5(json_encode($read, JSON_THROW_ON_ERROR));
        };
        $hash = $compareFunction();
        $maxRetries = 10;
        $retries = 0;

        return $responseFactory->createResponse()
            ->withHeader('Content-Type', 'text/event-stream')
            ->withHeader('Cache-Control', 'no-cache')
            ->withHeader('Connection', 'keep-alive')
            ->withBody(
                new ServerSentEventsStream(function (array &$buffer) use (
                    $compareFunction,
                    &$hash,
                    &$retries,
                    $maxRetries
                ) {
                    $newHash = $compareFunction();

                    if ($hash !== $newHash) {
                        $response = [
                            'type' => 'debug-updated',
                            'payload' => [],
                        ];

                        $buffer[] = json_encode($response);
                        $hash = $newHash;
                    }

                    // break the loop if the client aborted the connection (closed the page)
                    if (connection_aborted()) {
                        return false;
                    }
                    if ($retries++ > $maxRetries) {
                        return false;
                    }

                    sleep(1);

                    return true;
                })
            );
    }

    private function createJsPanelResponse(
        ContainerInterface $container,
        string $collectorClass,
        mixed $data
    ): DataResponse {
        $asset = $collectorClass::getAsset();
        $module = $asset->getModule();
        $scope = $asset->getScope();
        /**
         * @psalm-suppress UndefinedClass
         */
        if (
            !class_exists(AssetManager::class)
            || !class_exists(AssetPublisherInterface::class)
            || !$container->has(AssetManager::class)
            || !$container->has(AssetPublisherInterface::class)
        ) {
            throw new PackageNotInstalledException(
                'yiisoft/assets',
                sprintf(
                    '"%s" or "%s" is not defined in the dependency container.',
                    AssetManager::class,
                    AssetPublisherInterface::class,
                ),
            );
        }
        /**
         * @psalm-suppress UndefinedClass
         */
        $assetManager = $container->get(AssetManager::class);
        $assetManager->register($asset::class);
        /**
         * @psalm-suppress UndefinedClass
         */
        $assetPublisher = $container->get(AssetPublisherInterface::class);
        $assetPublisher->publish($asset);

        $js = $assetManager->getJsFiles();

        $urls = end($js);

        return $this->responseFactory->createResponse([
            '__isPanelRemote__' => true,
            'url' => $urls[0],
            'module' => $module,
            'scope' => $scope,
            'data' => $data,
        ]);
    }

    private function createHtmlPanelResponse(
        ContainerInterface $container,
        string $collectorClass,
        mixed $data
    ): DataResponse {
        if (!class_exists(ViewRenderer::class) || !$container->has(ViewRenderer::class)) {
            /**
             * @psalm-suppress UndefinedClass
             */
            throw new PackageNotInstalledException(
                'yiisoft/yii-view',
                sprintf(
                    '"%s" is not defined in the dependency container.',
                    ViewRenderer::class,
                )
            );
        }
        $viewRenderer = $container->get(ViewRenderer::class);
        $viewDirectory = dirname($collectorClass::getView());
        $viewPath = basename($collectorClass::getView());

        return $viewRenderer
            ->withViewPath($viewDirectory)
            ->renderPartial($viewPath, ['data' => $data, 'collectorClass' => $collectorClass]);
    }
}