Yiisoft\Yii\Debug\Storage\FileStorage

Complexity

Total Complexity

17

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Test Coverage

Coverage

76.47%

Importance

Changes	5
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	reindexObjects()	0	8	2
A	getData()	0	8	2
A	__construct()	0	10	1
A	read()	0	13	2
A	flush()	0	18	1
A	collectIndexData()	0	11	3
A	addCollector()	0	3	1
A	gc()	0	18	4
A	setHistorySize()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Storage;

use League\Flysystem\FilesystemException;
use Yiisoft\Aliases\Aliases;
use Yiisoft\Json\Json;
use Yiisoft\VarDumper\VarDumper;
use Yiisoft\Yii\Debug\Collector\CollectorInterface;
use Yiisoft\Yii\Debug\Collector\IndexCollectorInterface;
use Yiisoft\Yii\Debug\DebuggerIdGenerator;
use Yiisoft\Yii\Filesystem\FilesystemInterface;

use function array_merge;
use function array_slice;
use function count;
use function dirname;
use function filemtime;
use function get_class;
use function glob;
use function strlen;
use function substr;
use function uasort;

final class FileStorage implements StorageInterface
{
    /**
     * @var CollectorInterface[]
     */
    private array $collectors = [];

    private string $path;

    private int $historySize = 50;

    private DebuggerIdGenerator $idGenerator;

    private FilesystemInterface $filesystem;

    private Aliases $aliases;

    public function __construct(
        string $path,
        FilesystemInterface $filesystem,
        DebuggerIdGenerator $idGenerator,
        Aliases $aliases
    ) {
        $this->path = $path;
        $this->filesystem = $filesystem;
        $this->idGenerator = $idGenerator;
        $this->aliases = $aliases;
    }

    public function addCollector(CollectorInterface $collector): void
    {
        $this->collectors[get_class($collector)] = $collector;
    }

    public function setHistorySize(int $historySize): void
    {
        $this->historySize = $historySize;
    }

    public function read($type = self::TYPE_INDEX): array
    {
        clearstatcache();
        $data = [];
        $path = $this->aliases->get($this->path);
        $dataFiles = glob($path . '/**/**/' . $type . '.json', GLOB_NOSORT);
        foreach ($dataFiles as $file) {
            $dir = dirname($file);
            $id = substr($dir, strlen(dirname($file, 2)) + 1);
            $data[$id] = Json::decode(file_get_contents($file));
        }

        return $data;
    }

    public function flush(): void
    {
        $basePath = $this->path . '/' . date('Y-m-d') . '/' . $this->idGenerator->getId() . '/';
        try {
            $varDumper = VarDumper::create($this->getData());
            $jsonData = $varDumper->asJson();
            $this->filesystem->write($basePath . self::TYPE_DATA . '.json', $jsonData);

            $jsonObjects = json_decode($varDumper->asJsonObjectsMap(), true);
            $jsonObjects = $this->reindexObjects($jsonObjects);
            $this->filesystem->write($basePath . self::TYPE_OBJECTS . '.json', VarDumper::create($jsonObjects)->asJson());

            $indexData = VarDumper::create($this->collectIndexData())->asJson();
            $this->filesystem->write($basePath . self::TYPE_INDEX . '.json', $indexData);

            $this->gc();
        } finally {
            $this->collectors = [];
        }
    }

    public function getData(): array
    {
        $data = [];
        foreach ($this->collectors as $collector) {
            $data[get_class($collector)] = $collector->getCollected();
        }

        return $data;
    }

    /**
     * Collects summary data of current request.
     *
     * @return array
     */
    private function collectIndexData(): array
    {
        $indexData = ['id' => $this->idGenerator->getId()];

        foreach ($this->collectors as $collector) {
            if ($collector instanceof IndexCollectorInterface) {
                $indexData = array_merge($indexData, $collector->getIndexData());
            }
        }

        return $indexData;
    }

    /**
     * Removes obsolete data files
     *
     * @throws FilesystemException
     */
    private function gc(): void
    {
        $indexFiles = glob($this->aliases->get($this->path) . '/**/**/index.json', GLOB_NOSORT);
        if (count($indexFiles) >= $this->historySize + 1) {

It seems like $indexFiles can also be of type false; however, parameter $var of count() does only seem to accept Countable|array, maybe add an additional type check?

            uasort($indexFiles, static fn ($a, $b) => filemtime($b) <=> filemtime($a));

It seems like $indexFiles can also be of type false; however, parameter $array of uasort() does only seem to accept array, maybe add an additional type check?

            $excessFiles = array_slice($indexFiles, $this->historySize);
            foreach ($excessFiles as $file) {
                $path1 = dirname($file);
                $path2 = dirname($file, 2);
                $path3 = dirname($file, 3);
                $resource = substr($path1, strlen($path3));
                $this->filesystem->deleteDirectory($this->path . $resource);

                // Clean empty group directories
                $group = substr($path2, strlen($path3));
                $list = $this->filesystem->listContents($this->path . $group);
                if (empty($list->toArray())) {
                    $this->filesystem->deleteDirectory($this->path . $group);
                }
            }
        }
    }

    private function reindexObjects(array $objectsAsArraysCollection): array
    {
        $result = [];
        foreach ($objectsAsArraysCollection as $objectAsArray) {
            $result = array_merge($result, $objectAsArray);
        }

        return $result;
    }
}