Automatically exclude assets from popular caching/optimizer plugins

src/AssetFactory.php

@@ -14,8 +14,8 @@
 namespace Inpsyde\Assets;
 
 use Inpsyde\Assets\Exception\InvalidArgumentException;
-use Inpsyde\Assets\Loader\PhpFileLoader;
 use Inpsyde\Assets\Loader\ArrayLoader;
+use Inpsyde\Assets\Loader\PhpFileLoader;
 
 /**
  * Class AssetFactory
@@ -90,7 +90,7 @@ public static function create(array $config): Asset
             }
 
             $inFooter = $config['inFooter'] ?? true;
-            $inFooter
+            $inFooter === true
                 ? $asset->isInFooter()
                 : $asset->isInHeader();
 

src/AssetManager.php

@@ -13,12 +13,12 @@
 
 namespace Inpsyde\Assets;
 
+use Inpsyde\Assets\Caching\IgnoreCacheHandler;
 use Inpsyde\Assets\Handler\AssetHandler;
 use Inpsyde\Assets\Handler\OutputFilterAwareAssetHandler;
 use Inpsyde\Assets\Handler\ScriptHandler;
 use Inpsyde\Assets\Handler\StyleHandler;
 use Inpsyde\Assets\Util\AssetHookResolver;
-use Inpsyde\Assets\Asset;
 
 final class AssetManager
 {
@@ -51,6 +51,10 @@ final class AssetManager
      * @var bool
      */
     private $setupDone = false;
+    /**
+     * @var IgnoreCacheHandler
+     */
+    private $ignoreCacheHandler;
 
     /**
      * @param AssetHookResolver|null $hookResolver
@@ -59,6 +63,7 @@ public function __construct(AssetHookResolver $hookResolver = null)
     {
         $this->hookResolver = $hookResolver ?? new AssetHookResolver();
         $this->assets = new \SplObjectStorage();
+        $this->ignoreCacheHandler = new IgnoreCacheHandler();
     }
 
     /**
@@ -108,7 +113,7 @@ public function register(Asset $asset, Asset ...$assets): AssetManager
 
         foreach ($assets as $asset) {
             $handle = $asset->handle();
-            if ($handle) {
+            if ($handle !== '') {
                 $this->assets->attach($asset, [$handle, get_class($asset)]);
             }
         }
@@ -252,7 +257,7 @@ private function loopCurrentHookAssets(string $currentHook, bool $process): arra
 
         /** @var int|null $locationId */
         $locationId = Asset::HOOK_TO_LOCATION[$currentHook] ?? null;
-        if (!$locationId) {
+        if (is_null($locationId)) {
             return [];
         }
 
@@ -308,7 +313,10 @@ private function ensureSetup(): void
          *
          * @psalm-suppress PossiblyNullArgument
          */
-        if (!$lastHook && did_action($lastHook) && !doing_action($lastHook)) {
+        if (
+            (is_null($lastHook) || $lastHook === '') &&
+            did_action($lastHook) && !doing_action($lastHook)
+        ) {
             $this->assets = new \SplObjectStorage();
 
             return;
@@ -317,4 +325,9 @@ private function ensureSetup(): void
         $this->useDefaultHandlers();
         do_action(self::ACTION_SETUP, $this);
     }
+
+    public function ignoreCache(): void
+    {
+        $this->ignoreCacheHandler->run($this);
+    }
 }

src/BaseAsset.php

@@ -13,6 +13,7 @@
 
 namespace Inpsyde\Assets;
 
+use Inpsyde\Assets\Caching\IgnoreCacheHandler;
 use Inpsyde\Assets\Handler\AssetHandler;
 use Inpsyde\Assets\Util\AssetPathResolver;
 use Inpsyde\Assets\OutputFilter\AssetOutputFilter;

src/Caching/IgnoreCacheHandler.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Assets\Caching;
+
+use Inpsyde\Assets\AssetManager;
+use Inpsyde\Assets\Script;
+use Inpsyde\Assets\Style;
+
+class IgnoreCacheHandler
+{
+    public function run(AssetManager $assetManager): bool
+    {
+        /** @var IgnorePluginCacheInterface[] $handlers */
+        $handlers = [
+            new IgnoreW3TotalCache(),
+            new IgnoreSitegroundCache(),
+        ];
+
+        $assetHandles = $this->extractHandles($assetManager);
+
+        if (
+            count($assetHandles[Script::class]) === 0 &&
+            count($assetHandles[Style::class]) === 0
+        ) {
+            return false;
+        }
+
+        foreach ($handlers as $ignorePluginHandler) {
+            if ($ignorePluginHandler->isInstalled()) {
+                $ignorePluginHandler->apply($assetHandles);
+            }
+        }
+        return true;
+    }
+
+    protected function extractHandles(AssetManager $assetManager): array
+    {
+        $assets = $assetManager->assets();
+        $assetHandles = [
+            Script::class => [],
+            Style::class => [],
+        ];
+
+        foreach ($assets as $assetKey => $assetType) {
+            foreach ($assetType as $asset) {
+                $assetHandles[$assetKey][] = $asset->handle();
+            }
+        }
+        return $assetHandles;
+    }
+}

src/Caching/IgnorePluginCacheInterface.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Assets\Caching;
+
+interface IgnorePluginCacheInterface
+{
+    public function isInstalled(): bool;
+    public function apply(array $handles): void;
+}

src/Caching/IgnoreSitegroundCache.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Assets\Caching;
+
+use Inpsyde\Assets\Script;
+use Inpsyde\Assets\Style;
+
+/**
+ * Add this tag to the script: script data-wpfc-render=“false”
+ */
+
+class IgnoreSitegroundCache implements IgnorePluginCacheInterface
+{
+    public function isInstalled(): bool
+    {
+        return class_exists('SiteGround_Optimizer\Loader\Loader');
+    }
+
+    public function apply(array $handles): void
+    {
+        /**
+         * Ignore Javascript
+         */
+        add_filter('sgo_js_minify_exclude', function (array $scripts) use ($handles) {
+            assert(is_array($handles[Script::class]));
+            return $this->applyExcludedHandles($scripts, $handles[Script::class]);
+        });
+
+        add_filter(
+            'sgo_javascript_combine_exclude',
+            function (array $scripts) use ($handles) {
+                assert(is_array($handles[Script::class]));
+                return $this->applyExcludedHandles($scripts, $handles[Script::class]);
+            }
+        );
+
+        /**
+         * Ignore Styles
+         */
+        add_filter('sgo_css_minify_exclude', function (array $styles) use ($handles) {
+            assert(is_array($handles[Style::class]));
+            return $this->applyExcludedHandles($styles, $handles[Style::class]);
+        });
+        add_filter('sgo_css_combine_exclude', function (array $styles) use ($handles) {
+            assert(is_array($handles[Style::class]));
+            return $this->applyExcludedHandles($styles, $handles[Style::class]);
+        });
+    }
+
+    protected function applyExcludedHandles(array $excluded, array $toExclude): array
+    {
+
+        return array_merge($excluded, $toExclude);
+    }
+}

src/Caching/IgnoreW3TotalCache.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Inpsyde\Assets\Caching;
+
+use Inpsyde\Assets\Script;
+use Inpsyde\Assets\Style;
+
+/**
+ * Check filters
+ */
+
+class IgnoreW3TotalCache implements IgnorePluginCacheInterface
+{
+    public function isInstalled(): bool
+    {
+        return class_exists('W3TC\Root_Loader');
+    }
+
+    // phpcs:disable Inpsyde.CodeQuality.NestingLevel.High
+    public function apply(array $handles): void
+    {
+        /**
+         * Ignore Javascript
+         */
+        add_filter('w3tc_minify_js_do_tag_minification', function (bool $doMinification, string $scriptTag) use ($handles) {
+            assert(is_array($handles[Script::class]));
+            return $this->determineMinification($doMinification, $scriptTag, $handles[Script::class]);
+        }, 10, 2);
+
+        /**
+         * Ignore Styles
+         */
+        add_filter('w3tc_minify_css_do_tag_minification', function (bool $doMinification, string $scriptTag) use ($handles) {
+            assert(is_array($handles[Style::class]));
+            return $this->determineMinification($doMinification, $scriptTag, $handles[Style::class]);
+        }, 10, 2);
+    }
+
+    protected function determineMinification(bool $doMinification, string $scriptTag, array $handles): bool
+    {
+
+        foreach ($handles as $handle) {
+            if (strpos($scriptTag, (string)$handle) !== false) {
+                return false;
+            }
+        }
+        return $doMinification;
+    }
+}

src/Loader/AbstractWebpackLoader.php

@@ -68,10 +68,13 @@ public function load($resource): array
                 )
             );
         }
+        $json = @file_get_contents($resource);
 
-        $data = @file_get_contents($resource)
-            ?: ''; // phpcs:ignore
-        $data = json_decode($data, true);
+        if ($json === false) {
+            $json = '';
+        }
+
+        $data = json_decode($json, true);
         $errorCode = json_last_error();
         if (0 < $errorCode) {
             throw new InvalidResourceException(
@@ -183,23 +186,23 @@ protected function sanitizeFileName(string $file): string
      */
     protected function resolveLocation(string $fileName): int
     {
-        if (stristr($fileName, '-backend')) {
+        if (stristr($fileName, '-backend') !== false) {
             return Asset::BACKEND;
         }
 
-        if (stristr($fileName, '-block')) {
+        if (stristr($fileName, '-block') !== false) {
             return Asset::BLOCK_EDITOR_ASSETS;
         }
 
-        if (stristr($fileName, '-login')) {
+        if (stristr($fileName, '-login') !== false) {
             return Asset::LOGIN;
         }
 
-        if (stristr($fileName, '-customizer-preview')) {
+        if (stristr($fileName, '-customizer-preview') !== false) {
             return Asset::CUSTOMIZER_PREVIEW;
         }
 
-        if (stristr($fileName, '-customizer')) {
+        if (stristr($fileName, '-customizer') !== false) {
             return Asset::CUSTOMIZER;
         }
 

src/OutputFilter/AsyncStyleOutputFilter.php

@@ -39,7 +39,7 @@ public function __invoke(string $html, Asset $asset): string
     {
         $url = $asset->url();
         $version = $asset->version();
-        if ($version) {
+        if ($version !== null && $version !== '') {
             $url = add_query_arg('ver', $version, $url);
         }
 

src/OutputFilter/InlineAssetOutputFilter.php

@@ -35,7 +35,7 @@ public function __invoke(string $html, Asset $asset): string
         }
 
         $content = @file_get_contents($filePath);
-        if (! $content) {
+        if ($content === false) {
             return $html;
         }
 

src/Script.php

@@ -13,7 +13,6 @@
 
 namespace Inpsyde\Assets;
 
-use Inpsyde\Assets\Handler\AssetHandler;
 use Inpsyde\Assets\Handler\ScriptHandler;
 
 class Script extends BaseAsset implements Asset
@@ -260,7 +259,7 @@ protected function resolveDependencyExtractionPlugin(): bool
         $version = $data['version'] ?? null;
 
         $this->withDependencies(...$dependencies);
-        if (!$this->version && $version) {
+        if (is_null($this->version) && !is_null($version)) {
             $this->withVersion($version);
         }
 

src/Style.php

@@ -13,7 +13,6 @@
 
 namespace Inpsyde\Assets;
 
-use Inpsyde\Assets\Handler\AssetHandler;
 use Inpsyde\Assets\Handler\StyleHandler;
 use Inpsyde\Assets\OutputFilter\AsyncStyleOutputFilter;
 
@@ -73,7 +72,7 @@ public function inlineStyles(): ?array
      */
     public function withInlineStyles(string $inline): Style
     {
-        if (!$this->inlineStyles) {
+        if (!is_array($this->inlineStyles)) {
             $this->inlineStyles = [];
         }