Prevent double-registering of asset bundles and JS files in the CP

CHANGELOG-v3.md

@@ -4,6 +4,8 @@
 
 ### Added
 - Added `craft\helpers\Stringy::getLangSpecificCharsArray()`.
+- Added `craft\web\View::setRegisteredAssetBundles()`.
+- Added `craft\web\View::setRegisteredJsFiles()`.
 
 ### Changed
 - Generated site URLs now always include full host info, even if the base site URL is root/protocol-relative. ([#2919](https://github.com/craftcms/cms/issues/2919))
@@ -24,6 +26,7 @@
 - Fixed a bug where `craft\helpers\StringHelper::toAscii()` and the `Craft.asciiString()` JS method weren’t using language-specific character replacements, or any custom replacements defined by the `customAsciiCharMappings` config setting.
 - Fixed a bug where the number `0` would not save in a Plain Text field.
 - Fixed a bug where Craft could pick the wrong current site if the primary site had a root-relative or protocol-relative URL, and another site didn’t, but was otherwise an equal match.
+- Fixed a bug where Control Panel Ajax requests could cause some asset bundles and JavaScript files to be double-registered in the browser.
 
 ## 3.0.9 - 2018-05-22
 

src/config/app.php

@@ -113,9 +113,6 @@
         'users' => [
             'class' => craft\services\Users::class,
         ],
-        'view' => [
-            'class' => craft\web\View::class,
-        ],
         'volumes' => [
             'class' => craft\services\Volumes::class,
         ],
@@ -263,5 +260,20 @@
                 ]
             ]);
         },
+
+        'view' => function() {
+            $config = [
+                'class' => craft\web\View::class,
+            ];
+
+            $request = Craft::$app->getRequest();
+            if ($request->getIsCpRequest()) {
+                $headers = $request->getHeaders();
+                $config['registeredAssetBundles'] = explode(',', $headers->get('X-Registered-Asset-Bundles', ''));
+                $config['registeredJsFiles'] = explode(',', $headers->get('X-Registered-Js-Files', ''));
+            }
+
+            return Craft::createObject($config);
+        },
     ],
 ];

src/web/View.php

@@ -39,6 +39,8 @@
  * @property-read Environment $twig the Twig environment
  * @property-read string $bodyHtml the content to be inserted at the end of the body section
  * @property-read string $headHtml the content to be inserted in the head section
+ * @property-write string[] $registeredAssetBundles the asset bundle names that should be marked as already registered
+ * @property-write string[] $registeredJsFiles the JS files that should be marked as already registered
  * @author Pixel & Tonic, Inc. <[email protected]>
  * @since 3.0
  */
@@ -196,6 +198,20 @@ class View extends \yii\web\View
      */
     private $_isRenderingPageTemplate = false;
 
+    /**
+     * @var string[]
+     * @see registerAssetFiles()
+     * @see setRegisteredAssetBundles()
+     */
+    private $_registeredAssetBundles = [];
+
+    /**
+     * @var string[]
+     * @see registerJsFile()
+     * @see setRegisteredJsfiles()
+     */
+    private $_registeredJsFiles = [];
+
     // Public Methods
     // =========================================================================
 
@@ -791,6 +807,19 @@ public function clearJsBuffer(bool $scriptTag = true)
         return $js;
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function registerJsFile($url, $options = [], $key = null)
+    {
+        $key = $key ?: $url;
+        if (isset($this->_registeredJsFiles[$key])) {
+            return;
+        }
+        $this->_registeredJsFiles[$key] = true;
+        parent::registerJsFile($url, $options, $key);
+    }
+
     /**
      * Registers a generic `<script>` code block.
      *
@@ -1206,6 +1235,26 @@ public function invokeHook(string $hook, array &$context): string
         return $return;
     }
 
+    /**
+     * Sets the JS files that should be marked as already registered.
+     *
+     * @param string[] $keys
+     */
+    public function setRegisteredJsFiles(array $keys)
+    {
+        $this->_registeredJsFiles = array_flip($keys);
+    }
+
+    /**
+     * Sets the asset bundle names that should be marked as already registered.
+     *
+     * @param string[] $names Asset bundle names
+     */
+    public function setRegisteredAssetBundles(array $names)
+    {
+        $this->_registeredAssetBundles = array_flip($names);
+    }
+
     // Events
     // -------------------------------------------------------------------------
 
@@ -1335,6 +1384,28 @@ protected function renderBodyEndHtml($ajaxMode)
             $lines[] = implode("\n", $this->_scripts[self::POS_END]);
         }
 
+        if (Craft::$app->getRequest()->getIsCpRequest()) {
+            if (!empty($this->_registeredJsFiles)) {
+                $json = Json::encode($this->_registeredJsFiles);
+                $js = <<<JS
+if (typeof Craft !== 'undefined') {
+    jQuery.extend(Craft.registeredJsFiles, {$json}); 
+}
+JS;
+                $this->registerJs($js, self::POS_END);
+            }
+
+            if (!empty($this->_registeredAssetBundles)) {
+                $json = Json::encode($this->_registeredAssetBundles);
+                $js = <<<JS
+if (typeof Craft !== 'undefined') {
+    jQuery.extend(Craft.registeredAssetBundles, {$json}); 
+}
+JS;
+                $this->registerJs($js, self::POS_END);
+            }
+        }
+
         $html = parent::renderBodyEndHtml($ajaxMode);
 
         return empty($lines) ? $html : implode("\n", $lines).$html;
@@ -1376,6 +1447,19 @@ protected function registerAllAssetFiles()
         }
     }
 
+    /**
+     * @inheritdoc
+     */
+    protected function registerAssetFiles($name)
+    {
+        // Don't re-register bundles
+        if (isset($this->_registeredAssetBundles[$name])) {
+            return;
+        }
+        $this->_registeredAssetBundles[$name] = true;
+        parent::registerAssetFiles($name);
+    }
+
     // Private Methods
     // =========================================================================
 

src/web/assets/cp/CpAsset.php

@@ -251,6 +251,8 @@ private function _craftData(): array
             'primarySiteId' => $isInstalled && !$isMigrationNeeded ? $sitesService->getPrimarySite()->id : null,
             'Pro' => Craft::Pro,
             'publishableSections' => $isInstalled && $currentUser ? $this->_publishableSections($currentUser) : [],
+            'registeredAssetBundles' => ['' => ''], // force encode as JS object
+            'registeredJsFiles' => ['' => ''], // force encode as JS object
             'remainingSessionTime' => !in_array($request->getSegment(1), ['updates', 'manualupdate'], true) ? $userService->getRemainingSessionTime() : 0,
             'right' => $orientation === 'ltr' ? 'right' : 'left',
             'runQueueAutomatically' => (bool)$generalConfig->runQueueAutomatically,

src/web/assets/cp/dist/js/Craft.js

@@ -1,4 +1,4 @@
-/*!   - 2018-05-30 */
+/*!   - 2018-06-01 */
 (function($){
 
 /** global: Craft */
@@ -340,7 +340,10 @@ $.extend(Craft,
                 data = {};
             }
 
-            var headers = {};
+            var headers = {
+                'X-Registered-Asset-Bundles': Object.keys(Craft.registeredAssetBundles).join(','),
+                'X-Registered-Js-Files': Object.keys(Craft.registeredJsFiles).join(',')
+            };
 
             if (Craft.csrfTokenValue && Craft.csrfTokenName) {
                 headers['X-CSRF-Token'] = Craft.csrfTokenValue;

src/web/assets/cp/src/js/Craft.js

@@ -337,7 +337,10 @@ $.extend(Craft,
                 data = {};
             }
 
-            var headers = {};
+            var headers = {
+                'X-Registered-Asset-Bundles': Object.keys(Craft.registeredAssetBundles).join(','),
+                'X-Registered-Js-Files': Object.keys(Craft.registeredJsFiles).join(',')
+            };
 
             if (Craft.csrfTokenValue && Craft.csrfTokenName) {
                 headers['X-CSRF-Token'] = Craft.csrfTokenValue;