MOrtola\BehatSEOContexts\Context\PerformanceContext

Complexity

Total Complexity

43

Size/Duplication

Total Lines	385
Duplicated Lines	0 %

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	browserCacheMustNotBeEnabledForResources()	0	7	1
A	assertContentIsMinified()	0	6	1
A	minimizeCss()	0	12	1
A	htmlShouldNotBeMinified()	0	5	1
A	getResourceXpath()	0	19	6
A	criticalCssShouldNotExistInHead()	0	5	1
A	browserCacheMustBeEnabledForResources()	0	25	2
A	jsShouldNotLoadAsyncOr()	0	5	1
A	minimizeJs()	0	12	1
A	getResourceUrl()	0	18	3
A	criticalCssShouldExistInHead()	0	7	1
A	cssFilesShouldLoadDeferred()	0	7	1
A	cssOrJavascriptFilesShouldNotBeMinified()	0	7	1
A	htmlShouldBeMinified()	0	5	1
A	minimizeHtml()	0	3	1
A	cssOrJavascriptFilesShouldBeMinified()	0	19	5
A	getPageResources()	0	25	5
A	checkResourceCache()	0	32	2
A	getSelfHostedPageResources()	0	17	3
A	assertResourceTypeIsValid()	0	8	2
A	javascriptFilesShouldLoadAsync()	0	9	3

<?php declare(strict_types=1);

namespace MOrtola\BehatSEOContexts\Context;

use Behat\Mink\Element\NodeElement;
use Behat\Mink\Exception\UnsupportedDriverActionException;
use Behat\Symfony2Extension\Driver\KernelDriver;
use Exception;
use InvalidArgumentException;
use PHPUnit\Framework\Assert;

class PerformanceContext extends BaseContext
{
    const RES_EXT = [
        'PNG'             => 'png',
        'HTML'            => 'html',
        'JPEG'            => 'jpeg',
        'GIF'             => 'gif',
        'ICO'             => 'ico',
        'JAVASCRIPT'      => 'js',
        'CSS'             => 'css',
        'CSS_INLINE_HEAD' => 'css-inline-head',
        'CSS_LINK_HEAD'   => 'css-link-head',
    ];

    /**
     * @throws Exception
     *
     * @Then /^Javascript code should load (async|defer)$/
     */
    public function javascriptFilesShouldLoadAsync(): void
    {
        foreach ($this->getSelfHostedPageResources(self::RES_EXT['JAVASCRIPT']) as $scriptElement) {
            Assert::assertTrue(
                $scriptElement->hasAttribute('async') || $scriptElement->hasAttribute('defer'),
                sprintf(
                    'Javascript file %s is render blocking in %s',
                    $this->getResourceUrl($scriptElement, self::RES_EXT['JAVASCRIPT']),
                    $this->getCurrentUrl()
                )
            );
        }
    }

    /**
     * @return NodeElement[]
     */
    private function getPageResources(string $resourceType, string $host = null): array
    {
        if (!$xpath = $this->getResourceXpath($resourceType)) {
            return [];
        }

        if ('external' === $host) {
            $xpath = preg_replace(
                '/\[contains\(@(.*),/',
                '[not(starts-with(@$1,"'.$this->webUrl.'") or starts-with(@$1,"/")) and contains(@$1,',
                $xpath
            );
        } elseif (null !== $host) {
            $xpath = preg_replace(
                '/\[contains\(@(.*),/',
                '[(starts-with(@$1,"'.$host.'") or starts-with(@$1,"/")) and contains(@$1,',
                $xpath
            );
        }

        if ($xpath) {
            return $this->getSession()->getPage()->findAll('xpath', $xpath);
        }

        return [];
    }

    /**
     * @return NodeElement[]
     */
    private function getSelfHostedPageResources(string $resourceType): array
    {
        if (!$xpath = $this->getResourceXpath($resourceType)) {
            return [];
        }

        $xpath = preg_replace(
            '/\[contains\(@(.*),/',
            sprintf('[(starts-with(@$1,"%s") or starts-with(@$1,"/")) and contains(@$1,', $this->webUrl),
            $xpath
        );

        if ($xpath) {
            return $this->getSession()->getPage()->findAll('xpath', $xpath);
        }

        return [];
    }

    private function getResourceXpath(string $resourceType): string
    {
        if (in_array($resourceType, [self::RES_EXT['JPEG'], self::RES_EXT['PNG'], self::RES_EXT['GIF']], true)) {
            return sprintf('//img[contains(@src,".%s")]', $resourceType);
        }
        if (in_array($resourceType, [self::RES_EXT['ICO'], self::RES_EXT['CSS']], true)) {
            return sprintf('//link[contains(@href,".%s")]', $resourceType);
        }
        if (self::RES_EXT['JAVASCRIPT'] === $resourceType) {
            return '//script[contains(@src,".js")]';
        }
        if (self::RES_EXT['CSS_INLINE_HEAD'] === $resourceType) {
            return '//head//style';
        }
        if (self::RES_EXT['CSS_LINK_HEAD'] === $resourceType) {
            return '//head//link[contains(@href,".css")]';
        }

        return '';
    }

    /**
     * @throws Exception
     */
    private function getResourceUrl(NodeElement $element, string $resourceType): ?string
    {
        $this->assertResourceTypeIsValid($resourceType);

        if (in_array(
            $resourceType,
            [self::RES_EXT['PNG'], self::RES_EXT['JPEG'], self::RES_EXT['GIF'], self::RES_EXT['JAVASCRIPT']],
            true
        )) {
            return $element->getAttribute('src');
        }

        if (in_array($resourceType, [self::RES_EXT['CSS'], self::RES_EXT['ICO']], true)) {
            return $element->getAttribute('href');
        }

        throw new InvalidArgumentException(
            sprintf('%s resource type url is not implemented', $resourceType)
        );
    }

    private function assertResourceTypeIsValid(string $resourceType): void
    {
        if (!in_array($resourceType, self::RES_EXT, true)) {
            throw new InvalidArgumentException(
                sprintf(
                    '%s resource type is not valid. Allowed types are: %s',
                    $resourceType,
                    implode(',', self::RES_EXT)
                )
            );
        }
    }

    /**
     * @throws Exception
     *
     * @Then HTML code should be minified
     */
    public function htmlShouldBeMinified(): void
    {
        $this->assertContentIsMinified(
            $this->getSession()->getPage()->getContent(),
            $this->minimizeHtml($this->getSession()->getPage()->getContent())
        );
    }

    private function assertContentIsMinified(string $content, string $contentMinified): void
    {
        Assert::assertSame(
            $content,
            $contentMinified,
            'Code is not minified.'
        );
    }

    private function minimizeHtml(string $html): string
    {
        return preg_replace('/(?<=>)\s+|\s+(?=<)/', '', $html) ?? $html;
    }

    /**
     * @throws Exception
     *
     * @Then CSS code should load deferred
     */
    public function cssFilesShouldLoadDeferred(): void
    {
        Assert::assertEmpty(
            $this->getSelfHostedPageResources(self::RES_EXT['CSS_LINK_HEAD']),
            sprintf(
                'Some self hosted css files are loading in head in %s',
                $this->getCurrentUrl()
            )
        );
    }

    /**
     * @throws Exception
     *
     * @Then critical CSS code should exist in head
     */
    public function criticalCssShouldExistInHead(): void
    {
        Assert::assertNotEmpty(
            $this->getSelfHostedPageResources(self::RES_EXT['CSS_INLINE_HEAD']),
            sprintf(
                'No inline css is loading in head in %s',
                $this->getCurrentUrl()
            )
        );
    }

    /**
     * @Then HTML code should not be minified
     */
    public function htmlShouldNotBeMinified(): void
    {
        $this->assertInverse(
            [$this, 'htmlShouldBeMinified'],
            'HTML should not be minified.'
        );
    }

    /**
     * @Then /^(CSS|Javascript) code should not be minified$/
     */
    public function cssOrJavascriptFilesShouldNotBeMinified(string $resourceType): void
    {
        $this->assertInverse(
            function () use ($resourceType) {
                $this->cssOrJavascriptFilesShouldBeMinified($resourceType);
            },
            sprintf('%s should not be minified.', $resourceType)
        );
    }

    /**
     * @throws UnsupportedDriverActionException
     * @throws Exception
     * @Then /^(CSS|Javascript) code should be minified$/
     */
    public function cssOrJavascriptFilesShouldBeMinified(string $resourceType): void
    {
        $this->doesNotSupportDriver(KernelDriver::class);

        $resourceType = 'Javascript' === $resourceType ? 'js' : 'css';

        foreach ($this->getSelfHostedPageResources($resourceType) as $element) {
            if ($url = $this->getResourceUrl($element, $resourceType)) {
                $this->getSession()->visit($url);
            }

            $this->assertContentIsMinified(
                $this->getSession()->getPage()->getContent(),
                'js' === $resourceType ?
                    $this->minimizeJs($this->getSession()->getPage()->getContent())
                    : $this->minimizeCss($this->getSession()->getPage()->getContent())
            );

            $this->getSession()->back();
        }
    }

    private function minimizeJs(string $javascript): string
    {
        return preg_replace(
            [
                       '#\s*("(?:[^"\\\]++|\\\.)*+"|\'(?:[^\'\\\\]++|\\\.)*+\')\s*|\s*\/\*(?!\!|@cc_on)(?>[\s\S]*?\*\/)\s*|
                \s*(?<![\:\=])\/\/.*(?=[\n\r]|$)|^\s*|\s*$#',
                       '#("(?:[^"\\\]++|\\\.)*+"|\'(?:[^\'\\\\]++|\\\.)*+\'|\/\*(?>.*?\*\/)|\/(?!\/)[^\n\r]*?\/(?=[\s.,;]|
                [gimuy]|$))|\s*([!%&*\(\)\-=+\[\]\{\}|;:,.<>?\/])\s*#s',
                   ],
            ['$1', '$1$2'],
            $javascript
        ) ?? $javascript;
    }

    private function minimizeCss(string $css): string
    {
        return preg_replace(
            [
                       '#("(?:[^"\\\]++|\\\.)*+"|\'(?:[^\'\\\\]++|\\\.)*+\')|\/\*(?!\!)(?>.*?\*\/)|^\s*|\s*$#s',
                       '#("(?:[^"\\\]++|\\\.)*+"|\'(?:[^\'\\\\]++|\\\.)*+\'|\/\*(?>.*?\*\/))|\s*+;\s*+(})\s*+|\s*+([*$~^|
                ]?+=|[{};,>~+]|\s*+-(?![0-9\.])|!important\b)\s*+|([[(:])\s++|\s++([])])|\s++(:)\s*+(?!(?>[^{}"\']++|
                "(?:[^"\\\]++|\\\.)*+"|\'(?:[^\'\\\\]++|\\\.)*+\')*+{)|^\s++|\s++\z|(\s)\s+#si',
                   ],
            ['$1', '$1$2$3$4$5$6$7'],
            $css
        ) ?? $css;
    }

    /**
     * @Then critical CSS code should not exist in head
     */
    public function criticalCssShouldNotExistInHead(): void
    {
        $this->assertInverse(
            [$this, 'criticalCssShouldExistInHead'],
            'Critical CSS exist in head.'
        );
    }

    /**
     * @Then /^browser cache should not be enabled for (.+|external|internal) (png|jpeg|gif|ico|js|css) resources$/
     */
    public function browserCacheMustNotBeEnabledForResources(string $host, string $resourceType): void
    {
        $this->assertInverse(
            function () use ($host, $resourceType) {
                $this->browserCacheMustBeEnabledForResources($host, $resourceType);
            },
            sprintf('Browser cache is enabled for %s resources.', $resourceType)
        );
    }

    /**
     * @throws UnsupportedDriverActionException
     * @throws Exception
     * @Then /^browser cache should be enabled for (.+|external|internal) (png|jpeg|gif|ico|js|css) resources$/
     */
    public function browserCacheMustBeEnabledForResources(string $host, string $resourceType): void
    {
        $this->doesNotSupportDriver(KernelDriver::class);

        switch ($host) {
            case 'internal':
                $elements = $this->getSelfHostedPageResources($resourceType);
                break;
            default:
                $elements = $this->getPageResources($resourceType, $host);
                break;
        }

        Assert::assertNotEmpty(
            $elements,
            sprintf(
                'The are not %s resources in %s.',
                $host,
                $this->getCurrentUrl()
            )
        );

        $this->checkResourceCache(
            $elements[array_rand($elements)],
            $resourceType
        );
    }

    /**
     * @throws Exception
     */
    private function checkResourceCache(NodeElement $element, string $resourceType): void
    {
        if ($url = $this->getResourceUrl($element, $resourceType)) {
            $this->getSession()->visit($url);
        }

        $headers = array_change_key_case($this->getSession()->getResponseHeaders());
        $this->getSession()->back();

        Assert::assertTrue(
            array_key_exists('cache-control', $headers),
            sprintf(
                'Browser cache is not enabled for %s resources. Cache-Control HTTP header was not received.',
                $resourceType
            )
        );

        Assert::assertNotContains(
            'no-cache',
            $headers['cache-control'],
            sprintf(
                'Browser cache is not enabled for %s resources. Cache-Control HTTP header is "no-cache".',
                $resourceType
            )
        );

        Assert::assertNotContains(
            'max-age=0',
            $headers['cache-control'],
            sprintf(
                'Browser cache is not enabled for %s resources. Cache-Control HTTP header is "max-age=0".',
                $resourceType
            )
        );
    }

    /**
     * @Then /^Javascript code should not load (async|defer)$/
     */
    public function jsShouldNotLoadAsyncOr(): void
    {
        $this->assertInverse(
            [$this, 'javascriptFilesShouldLoadAsync'],
            'All JS files load async.'
        );
    }
}