JWTAuth\BlockList\FileJwtBlockList

Complexity

Total Complexity

15

Size/Duplication

Total Lines	142
Duplicated Lines	0 %

Test Coverage

Coverage

82.22%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	minutesToObsolescence()	0	3	1
A	isBlockListed()	0	8	2
A	__construct()	0	10	1
A	add()	0	12	2
A	maybeRemoveObsoleteRecords()	0	9	2
A	getFileData()	0	14	3
A	fileExtension()	0	3	1
A	removeObsoleteRecords()	0	13	3

<?php

namespace JWTAuth\BlockList;

use Carbon\Carbon;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Storage;
use JWTAuth\Contracts\HasObsoleteRecords;
use JWTAuth\Contracts\JwtBlockListContract;
use JWTAuth\Exceptions\JWTConfigurationException;
use JWTAuth\JWTManager;

/**
 * Class FileJwtBlockList
 * @package JWTAuth\BlockList
 */
class FileJwtBlockList implements JwtBlockListContract, HasObsoleteRecords
{

    /**
     * Filesystem disk name
     * @var string
     */
    protected string $disk;

    /**
     * Filesystem directory name
     * @var string
     */
    protected string $directory;

    /**
     * Minutes count before blocklist removing
     * @var int
     */
    protected int $minutesToObsolescence;

    /**
     * Seconds for remove obsoleted files
     * @var int
     */
    protected int $periodRemoveObsolete;

    public function __construct(array $configs = [])
    {
        $this->disk = $configs['disk'] ?? '';
        throw_if(empty($this->disk), JWTConfigurationException::class, 'FileJwtBlockList: Disk is empty');

        $this->directory = rtrim($configs['directory'] ?? '', '/');
        throw_if(empty($this->directory), JWTConfigurationException::class, 'FileJwtBlockList: Directory is empty');

        $this->minutesToObsolescence = (int) ($configs['minutes_to_obsolescence']         ?? 0);
        $this->periodRemoveObsolete  = (int) ($configs['remove_obsoleted_each_x_seconds'] ?? 0);
    }

    /**
     * @inheritDoc
     */
    public function add(JWTManager $token): static
    {
        $this->maybeRemoveObsoleteRecords();
        if ($token->payload()->isValid()) {
            $data                       = $this->getFileData($token->payload()->exp());
            $data[ $token->getToken() ] = Carbon::now()->toString();

            Storage::disk($this->disk)->makeDirectory($this->directory);
            Storage::disk($this->disk)->put("{$this->directory}/{$token->payload()->exp()}{$this->fileExtension()}", json_encode($data));
        }

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function isBlockListed(JWTManager $token): bool
    {
        if (!$token->payload()->isValid()) {
            return true;
        }
        $data = $this->getFileData($token->payload()->exp());

        return isset($data[ $token->getToken() ]);
    }

    /**
     * Get content of blocklist file
     *
     * @param string $filePrefix
     *
     * @return array
     */
    protected function getFileData(string $filePrefix): array
    {
        try {
            $data = Storage::disk($this->disk)->get("{$this->directory}/{$filePrefix}{$this->fileExtension()}");
            $data = json_decode($data, true);

It seems like $data can also be of type null; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

            if (!$data) {
                $data = [];
            }
        } catch (\Exception $e) {
            // File not found
            return [];
        }

        return $data;
    }

    /**
     * Remove obsolete records if not removed recently
     *
     * @return bool
     */
    protected function maybeRemoveObsoleteRecords(): bool
    {
        if (!Cache::has('__FileJwtBlackList_REMOVED')) {
            Cache::put('__FileJwtBlackList_REMOVED', true, $this->periodRemoveObsolete);

            return $this->removeObsoleteRecords();
        }

        return false;
    }

    /**
     * @inheritDoc
     */
    public function removeObsoleteRecords(): bool
    {
        collect(Storage::disk($this->disk)->listContents($this->directory, true))

The method listContents() does not exist on Illuminate\Contracts\Filesystem\Filesystem. It seems like you code against a sub-type of Illuminate\Contracts\Filesystem\Filesystem such as Illuminate\Filesystem\FilesystemAdapter.

            ->each(function ($file) {
                if (
                    $file['type'] == 'file' &&
                    $file['lastModified'] < Carbon::now()->subMinutes($this->minutesToObsolescence())->getTimestamp()
                ) {
                    Storage::disk($this->disk)->delete($file['path']);
                }
            });

        return true;
    }

    /**
     * @inheritDoc
     */
    public function minutesToObsolescence(): int
    {
        return $this->minutesToObsolescence;
    }

    /**
     * File extension.
     *
     * @return string
     */
    protected function fileExtension(): string
    {
        return '.json';
    }
}