nystudio107\pluginvite\services\ViteService

Complexity

Total Complexity

37

Size/Duplication

Total Lines	339
Duplicated Lines	0 %

Importance

Changes	16
Bugs	0	Features	1

11 Methods

Rating	Name	Duplication	Size	Complexity
A	fetch()	0	3	1
B	injectErrorEntry()	0	28	9
A	devServerRegister()	0	9	1
B	manifestScript()	0	30	7
A	init()	0	11	3
A	devServerScript()	0	10	1
A	register()	0	9	2
A	script()	0	7	2
A	devServerRunning()	0	14	3
A	invalidateCaches()	0	5	1
B	manifestRegister()	0	32	7

<?php
/**
 * Vite plugin for Craft CMS 3.x
 *
 * Allows the use of the Vite.js next generation frontend tooling with Craft CMS
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2021 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

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

namespace nystudio107\pluginvite\services;

use nystudio107\pluginvite\helpers\FileHelper;
use nystudio107\pluginvite\helpers\ManifestHelper;
use nystudio107\pluginvite\helpers\UrlHelper;

use Craft;
use craft\base\Component;
use craft\helpers\Html as HtmlHelper;
use craft\helpers\Json as JsonHelper;
use craft\web\View;

use yii\base\InvalidConfigException;
use yii\caching\TagDependency;

use Throwable;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Vite

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

The tag in position 3 should be the @author tag

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ViteService extends Component
{
    // Constants
    // =========================================================================

    const VITE_CLIENT = '@vite/client.js';
    const LEGACY_POLYFILLS = 'vite/legacy-polyfills';

    const SAFARI_NOMODULE_FIX = '!function(){var e=document,t=e.createElement("script");if(!("noModule"in t)&&"onbeforeload"in t){var n=!1;e.addEventListener("beforeload",function(e){if(e.target===t)n=!0;else if(!e.target.hasAttribute("nomodule")||!n)return;e.preventDefault()},!0),t.type="module",t.src=".",e.head.appendChild(t),t.remove()}}();';

    // Public Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool Should the dev server be used for?
     */
    public $useDevServer;

    /**

Missing short description in doc comment

     * @var string File system path (or URL) to the Vite-built manifest.json
     */
    public $manifestPath;

    /**

Missing short description in doc comment

     * @var string The public URL to the dev server (what appears in `<script src="">` tags
     */
    public $devServerPublic;

    /**

Missing short description in doc comment

     * @var string The public URL to use when not using the dev server
     */
    public $serverPublic;

    /**

Missing short description in doc comment

     * @var string The JavaScript entry from the manifest.json to inject on Twig error pages
     *              This can be a string or an array of strings
     */
    public $errorEntry = '';

    /**

Missing short description in doc comment

     * @var string String to be appended to the cache key
     */
    public $cacheKeySuffix = '';

    /**

Missing short description in doc comment

     * @var string The internal URL to the dev server, when accessed from the environment in which PHP is executing
     *              This can be the same as `$devServerPublic`, but may be different in containerized or VM setups.
     *              ONLY used if $checkDevServer = true
     */
    public $devServerInternal;

    /**

Missing short description in doc comment

     * @var bool Should we check for the presence of the dev server by pinging $devServerInternal to make sure it's running?
     */
    public $checkDevServer = false;

    // Protected Properties
    // =========================================================================

    /**

Missing short description in doc comment

     * @var bool Whether the legacy polyfill has been included yet or not
     */
    protected $legacyPolyfillIncluded = false;

    // Public Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritDoc
     */

Missing @return tag in function comment

    public function init()
    {
        parent::init();
        // Do nothing for console requests
        $request = Craft::$app->getRequest();
        if ($request->getIsConsoleRequest()) {
            return;
        }
        // Our component is lazily loaded, so the View will be instantiated by now
        if (Craft::$app->getConfig()->getGeneral()->devMode) {
            Craft::$app->getView()->on(View::EVENT_END_BODY, [$this, 'injectErrorEntry']);
        }
    }

    /**
     * Return the appropriate tags to load the Vite script, either via the dev server or
     * extracting it from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $scriptTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $cssTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return string
     */
    public function script(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): string
    {
        if ($this->devServerRunning()) {
            return $this->devServerScript($path, $scriptTagAttrs);
        }

        return $this->manifestScript($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
    }

    /**
     * Return the script tag to load the script from the Vite dev server
     *
     * @param string $path

Missing parameter comment

     * @param array $scriptTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return string
     */
    public function devServerScript(string $path, array $scriptTagAttrs = []): string
    {
        $lines = [];
        // Include the entry script
        $url = UrlHelper::createUrl($this->devServerPublic, $path);
        $lines[] = HtmlHelper::jsFile($url, array_merge([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'type' => 'module',
        ], $scriptTagAttrs));

For multi-line function calls, the closing parenthesis should be on a new line.

        return implode("\r\n", $lines);
    }

    /**
     * Return the script, module link, and CSS link tags for the script from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $scriptTagAttrs

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     * @param array $cssTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return string
     */
    public function manifestScript(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): string
    {
        $lines = [];
        ManifestHelper::fetchManifest($this->manifestPath);
        $tags = ManifestHelper::manifestTags($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
        $legacyTags = ManifestHelper::legacyManifestTags($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
        // Handle any legacy polyfills
        if (!empty($legacyTags) && !$this->legacyPolyfillIncluded) {
            $lines[] = HtmlHelper::script(self::SAFARI_NOMODULE_FIX, []);
            $legacyPolyfillTags = ManifestHelper::extractManifestTags(self::LEGACY_POLYFILLS, $asyncCss, $scriptTagAttrs, $cssTagAttrs, true);
            $tags = array_merge($legacyPolyfillTags, $tags);
            $this->legacyPolyfillIncluded = true;
        }
        foreach(array_merge($tags, $legacyTags) as $tag) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (!empty($tag)) {
                $url = UrlHelper::createUrl($this->serverPublic, $tag['url']);
                switch ($tag['type']) {
                    case 'file':

Line indented incorrectly; expected 16 spaces, found 20

                        $lines[] = HtmlHelper::jsFile($url, $tag['options']);
                        break;
                    case 'css':

Line indented incorrectly; expected 16 spaces, found 20

                        $lines[] = HtmlHelper::cssFile($url, $tag['options']);
                        break;
                    default:

Line indented incorrectly; expected 16 spaces, found 20

                        break;
                }
            }
        }

        return implode("\r\n", $lines);
    }

    /**
     * Register the appropriate tags to the Craft View to load the Vite script, either via the dev server or
     * extracting it from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param array $scriptTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $cssTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return void
     * @throws InvalidConfigException
     */
    public function register(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = [])
    {
        if ($this->devServerRunning()) {
            $this->devServerRegister($path, $scriptTagAttrs);

            return;
        }

        $this->manifestRegister($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
    }

    /**
     * Register the script tag to the Craft View to load the script from the Vite dev server
     *
     * @param string $path

Missing parameter comment

     * @param array $scriptTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return void
     * @throws InvalidConfigException
     */
    public function devServerRegister(string $path, array $scriptTagAttrs = [])
    {
        $view = Craft::$app->getView();
        // Include the entry script
        $url = UrlHelper::createUrl($this->devServerPublic, $path);
        $view->registerJsFile(
            $url,
            array_merge(['type' => 'module'], $scriptTagAttrs),
            md5($url . JsonHelper::encode($scriptTagAttrs))
        );
    }

    /**
     * Register the script, module link, and CSS link tags to the Craft View for the script from the manifest.json file
     *
     * @param string $path

Missing parameter comment

     * @param bool $asyncCss

Expected 3 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $scriptTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     * @param array $cssTagAttrs

Expected 2 spaces after parameter type; 1 found

Missing parameter comment

     *
     * @return void
     * @throws InvalidConfigException
     */
    public function manifestRegister(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = [])
    {
        $view = Craft::$app->getView();
        ManifestHelper::fetchManifest($this->manifestPath);
        $tags = ManifestHelper::manifestTags($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
        $legacyTags = ManifestHelper::legacyManifestTags($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
        // Handle any legacy polyfills
        if (!empty($legacyTags) && !$this->legacyPolyfillIncluded) {
            $view->registerScript(self::SAFARI_NOMODULE_FIX, $view::POS_HEAD, [], 'SAFARI_NOMODULE_FIX');
            $legacyPolyfillTags = ManifestHelper::extractManifestTags(self::LEGACY_POLYFILLS, $asyncCss, $scriptTagAttrs, $cssTagAttrs, true);
            $tags = array_merge($legacyPolyfillTags, $tags);
            $this->legacyPolyfillIncluded = true;
        }
        foreach(array_merge($tags, $legacyTags) as $tag) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            if (!empty($tag)) {
                $url = UrlHelper::createUrl($this->serverPublic, $tag['url']);
                switch ($tag['type']) {
                    case 'file':

Line indented incorrectly; expected 16 spaces, found 20

                        $view->registerJsFile(
                            $url,
                            $tag['options'],
                            md5($url . JsonHelper::encode($tag['options']))
                        );
                        break;
                    case 'css':

Line indented incorrectly; expected 16 spaces, found 20

                        $view->registerCssFile(
                            $url,
                            $tag['options']
                        );
                        break;
                    default:

Line indented incorrectly; expected 16 spaces, found 20

                        break;
                }
            }
        }
    }

    /**
     * Return the contents of a local file (via path) or remote file (via URL),
     * or null if the file doesn't exist or couldn't be fetched
     * Yii2 aliases and/or environment variables may be used
     *
     * @param string $pathOrUrl

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

     * @param callable|null $callback

Missing parameter comment

     *
     * @return string|array|null
     */
    public function fetch(string $pathOrUrl, callable $callback = null)
    {
        return FileHelper::fetch($pathOrUrl, $callback, $this->cacheKeySuffix);
    }

    /**
     * Determine whether the Vite dev server is running
     *
     * @return bool
     */
    public function devServerRunning(): bool
    {
        // If the dev server is turned off via config, say it's not running
        if (!$this->useDevServer) {
            return false;
        }
        // If we're not supposed to check that the dev server is actually running, just assume it is
        if (!$this->checkDevServer) {
            return true;
        }
        // Check to see if the dev server is actually running by pinging it
        $url = UrlHelper::createUrl($this->devServerInternal, self::VITE_CLIENT);

        return !($this->fetch($url) === null);
    }

    /**
     * Invalidate all of the Vite caches
     */

Missing @return tag in function comment

    public function invalidateCaches()
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, FileHelper::CACHE_TAG . $this->cacheKeySuffix);
        Craft::info('All Vite caches cleared', __METHOD__);
    }

    // Protected Methods
    // =========================================================================

    /**
     * Inject the error entry point JavaScript for auto-reloading of Twig error
     * pages
     */

Missing @return tag in function comment

    protected function injectErrorEntry()
    {
        // If there's no error entry provided, return
        if (empty($this->errorEntry)) {
            return;
        }
        // If it's not a server error or a client error, return
        $response = Craft::$app->getResponse();
        if (!($response->isServerError || $response->isClientError)) {
            return;
        }
        // If the dev server isn't running, return
        if (!$this->devServerRunning()) {
            return;
        }
        // Inject the errorEntry script tags to enable HMR on this page
        try {
            $errorEntry = $this->errorEntry;
            if (is_string($errorEntry)) {

The condition is_string($errorEntry) is always true.

                $errorEntry = [$errorEntry];
            }
            foreach ($errorEntry as $entry) {
                $tag = $this->script($entry);
                if ($tag !== null) {
                    echo $tag;
                }
            }
        } catch (Throwable $e) {
            // That's okay, Vite will have already logged the error
        }
    }
}