Always cache the compiled menus

config/services.yaml

@@ -87,11 +87,11 @@ services:
         tags:
             - { name: knp_menu.menu_builder, method: createAdminMenu, alias: admin_menu } # The alias is what is used to retrieve the menu
 
-    Bolt\Menu\BackendMenuBuilderInterface: '@Bolt\Menu\BackendMenuBuilder'
+    Bolt\Menu\BackendMenuBuilderInterface: '@Bolt\Menu\BackendMenu'
 
     Bolt\Menu\FrontendMenuBuilder: ~
 
-    Bolt\Menu\FrontendMenuBuilderInterface: '@Bolt\Menu\FrontendMenuBuilder'
+    Bolt\Menu\FrontendMenuBuilderInterface: '@Bolt\Menu\FrontendMenu'
 
     # Needed for SetContent from bolt/core
     Bolt\Storage\ContentQueryParser:

src/Menu/BackendMenu.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bolt\Menu;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Contracts\Cache\CacheInterface;
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+
+final class BackendMenu implements BackendMenuBuilderInterface
+{
+    /** @var CacheInterface */
+    private $cache;
+
+    /** @var BackendMenuBuilder */
+    private $menuBuilder;
+
+    /** @var RequestStack */
+    private $requestStack;
+
+    /** @var Stopwatch */
+    private $stopwatch;
+
+    public function __construct(BackendMenuBuilder $menuBuilder, TagAwareCacheInterface $cache, RequestStack $requestStack, Stopwatch $stopwatch)
+    {
+        $this->cache = $cache;
+        $this->menuBuilder = $menuBuilder;
+        $this->requestStack = $requestStack;
+        $this->stopwatch = $stopwatch;
+    }
+
+    public function buildAdminMenu(): array
+    {
+        $this->stopwatch->start('bolt.backendMenu');
+
+        $locale = $this->requestStack->getCurrentRequest()->getLocale();
+        $cacheKey = 'bolt.backendmenu_' . $locale;
+
+        $menu = $this->cache->get($cacheKey, function (ItemInterface $item) {
+            $item->tag('backendmenu');
+
+            return $this->menuBuilder->buildAdminMenu();
+        });
+
+        $this->stopwatch->stop('bolt.backendMenu');
+
+        return $menu;
+    }
+}

src/Menu/BackendMenuBuilder.php

@@ -240,17 +240,6 @@ private function createAdminMenu(): ItemInterface
             ]);
         }
 
-        /*
-         * @todo Make fixtures work from the backend
-         */
-        // $menu->getChild('Maintenance')->addChild('Fixtures', [
-        //     'uri' => '',
-        //     'extras' => [
-        //         'name' => $t->trans('caption.fixtures_dummy_content'),
-        //         'icon' => 'fa-hat-wizard',
-        //     ],
-        // ]);
-
         if ($this->authorizationChecker->isGranted('clearcache')) {
             $menu->getChild('Maintenance')->addChild('Clear the cache', [
                 'uri' => $this->urlGenerator->generate('bolt_clear_cache'),
@@ -261,17 +250,6 @@ private function createAdminMenu(): ItemInterface
             ]);
         }
 
-        /*
-         * @todo Make Installation checks work from the backend
-         */
-        // $menu->getChild('Maintenance')->addChild('Installation checks', [
-        //     'uri' => '',
-        //     'extras' => [
-        //         'name' => $t->trans('caption.installation_checks'),
-        //         'icon' => 'fa-clipboard-check',
-        //     ],
-        // ]);
-
         if ($this->authorizationChecker->isGranted('translation')) {
             $menu->getChild('Maintenance')->addChild('Translations', [
                 'uri' => $this->urlGenerator->generate('translation_index'),

src/Menu/CachedBackendMenuBuilder.php

@@ -4,38 +4,21 @@
 
 namespace Bolt\Menu;
 
-use Symfony\Component\HttpFoundation\RequestStack;
-use Symfony\Contracts\Cache\CacheInterface;
-use Symfony\Contracts\Cache\ItemInterface;
-use Symfony\Contracts\Cache\TagAwareCacheInterface;
-
+/**
+ * @deprecated since Bolt 5.1. This class is just an empty wrapper around BackendMenu now. Use that class instead
+ */
 final class CachedBackendMenuBuilder implements BackendMenuBuilderInterface
 {
-    /** @var CacheInterface */
-    private $cache;
-
-    /** @var BackendMenuBuilderInterface */
+    /** @var BackendMenu */
     private $menuBuilder;
 
-    /** @var RequestStack */
-    private $requestStack;
-
-    public function __construct(BackendMenuBuilderInterface $menuBuilder, TagAwareCacheInterface $cache, RequestStack $requestStack)
+    public function __construct(BackendMenu $menuBuilder)
     {
-        $this->cache = $cache;
         $this->menuBuilder = $menuBuilder;
-        $this->requestStack = $requestStack;
     }
 
     public function buildAdminMenu(): array
     {
-        $locale = $this->requestStack->getCurrentRequest()->getLocale();
-        $cacheKey = 'backendmenu_' . $locale;
-
-        return $this->cache->get($cacheKey, function (ItemInterface $item) {
-            $item->tag('backendmenu');
-
-            return $this->menuBuilder->buildAdminMenu();
-        });
+        return $this->menuBuilder->buildAdminMenu();
     }
 }

src/Menu/CachedFrontendMenuBuilder.php

@@ -4,38 +4,23 @@
 
 namespace Bolt\Menu;
 
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\RequestStack;
-use Symfony\Contracts\Cache\ItemInterface;
-use Symfony\Contracts\Cache\TagAwareCacheInterface;
 use Twig\Environment;
 
+/**
+ * @deprecated since Bolt 5.1. This class is just an empty wrapper around FrontendMenu now. Use that class instead
+ */
 final class CachedFrontendMenuBuilder implements FrontendMenuBuilderInterface
 {
-    /** @var TagAwareCacheInterface */
-    private $cache;
-
     /** @var FrontendMenuBuilderInterface */
     private $menuBuilder;
 
-    /** @var Request */
-    private $request;
-
-    public function __construct(FrontendMenuBuilderInterface $menuBuilder, TagAwareCacheInterface $cache, RequestStack $requestStack)
+    public function __construct(FrontendMenu $menuBuilder)
     {
-        $this->cache = $cache;
         $this->menuBuilder = $menuBuilder;
-        $this->request = $requestStack->getCurrentRequest();
     }
 
     public function buildMenu(Environment $twig, ?string $name = null): array
     {
-        $key = 'frontendmenu_' . ($name ?: 'main') . '_' . $this->request->getLocale();
-
-        return $this->cache->get($key, function (ItemInterface $item) use ($name, $twig) {
-            $item->tag('frontendmenu');
-
-            return $this->menuBuilder->buildMenu($twig, $name);
-        });
+        return $this->menuBuilder->buildMenu($twig, $name);
     }
 }

src/Menu/FrontendMenu.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bolt\Menu;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Contracts\Cache\ItemInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+use Twig\Environment;
+
+
+final class FrontendMenu implements FrontendMenuBuilderInterface
+{
+    /** @var TagAwareCacheInterface */
+    private $cache;
+
+    /** @var FrontendMenuBuilder */
+    private $menuBuilder;
+
+    /** @var Request */
+    private $request;
+
+    /** @var Stopwatch */
+    private $stopwatch;
+
+    public function __construct(FrontendMenuBuilder $menuBuilder, TagAwareCacheInterface $cache, RequestStack $requestStack, Stopwatch $stopwatch)
+    {
+        $this->cache = $cache;
+        $this->menuBuilder = $menuBuilder;
+        $this->request = $requestStack->getCurrentRequest();
+        $this->stopwatch = $stopwatch;
+    }
+
+    public function buildMenu(Environment $twig, ?string $name = null): array
+    {
+        $this->stopwatch->start('bolt.frontendMenu');
+
+        $key = 'frontendmenu_' . ($name ?: 'main') . '_' . $this->request->getLocale();
+
+        $menu = $this->cache->get($key, function (ItemInterface $item) use ($name, $twig) {
+            $item->tag('frontendmenu');
+
+            return $this->menuBuilder->buildMenu($twig, $name);
+        });
+
+        $this->stopwatch->stop('bolt.frontendMenu');
+
+        return $menu;
+    }
+}

src/Menu/StopwatchBackendMenuBuilder.php

@@ -4,28 +4,22 @@
 
 namespace Bolt\Menu;
 
-use Symfony\Component\Stopwatch\Stopwatch;
-
+/**
+ * @deprecated since Bolt 5.1. This class is just an empty wrapper around BackendMenu now. Use that class instead
+ */
 final class StopwatchBackendMenuBuilder implements BackendMenuBuilderInterface
 {
-    /** @var BackendMenuBuilderInterface */
+    /** @var BackendMenu */
     private $menuBuilder;
 
-    /** @var Stopwatch */
-    private $stopwatch;
-
-    public function __construct(BackendMenuBuilderInterface $menuBuilder, Stopwatch $stopwatch)
+    public function __construct(BackendMenu $menuBuilder)
     {
         $this->menuBuilder = $menuBuilder;
-        $this->stopwatch = $stopwatch;
     }
 
     public function buildAdminMenu(): array
     {
-        $this->stopwatch->start('bolt.backendMenu');
-        $menu = $this->menuBuilder->buildAdminMenu();
-        $this->stopwatch->stop('bolt.backendMenu');
-
-        return $menu;
+        return $this->menuBuilder->buildAdminMenu();
+        ;
     }
 }

src/Menu/StopwatchFrontendMenuBuilder.php

@@ -4,29 +4,23 @@
 
 namespace Bolt\Menu;
 
-use Symfony\Component\Stopwatch\Stopwatch;
 use Twig\Environment;
 
+/**
+ * @deprecated since Bolt 5.1. This class is just an empty wrapper around FrontendMenu now. Use that class instead
+ */
 final class StopwatchFrontendMenuBuilder implements FrontendMenuBuilderInterface
 {
-    /** @var FrontendMenuBuilderInterface */
+    /** @var FrontendMenu */
     private $menuBuilder;
 
-    /** @var Stopwatch */
-    private $stopwatch;
-
-    public function __construct(FrontendMenuBuilderInterface $menuBuilder, Stopwatch $stopwatch)
+    public function __construct(FrontendMenu $menuBuilder)
     {
         $this->menuBuilder = $menuBuilder;
-        $this->stopwatch = $stopwatch;
     }
 
     public function buildMenu(Environment $twig, ?string $name = null): array
     {
-        $this->stopwatch->start('bolt.frontendMenu');
-        $menu = $this->menuBuilder->buildMenu($twig, $name);
-        $this->stopwatch->stop('bolt.frontendMenu');
-
-        return $menu;
+        return $this->menuBuilder->buildMenu($twig, $name);
     }
 }

yaml-migrations/m_2021-10-26-services.yaml

@@ -0,0 +1,10 @@
+# Remove keys (and underlying values) from the file: `services.yaml`
+# See: https://github.com/bolt/core/pull/2886
+
+file: services.yaml
+since: 5.0.6
+
+add:
+    services:
+        Bolt\Menu\BackendMenuBuilderInterface: '@Bolt\Menu\BackendMenu'
+        Bolt\Menu\FrontendMenuBuilderInterface: '@Bolt\Menu\FrontendMenu'

yaml-migrations/m_2021-10-26-services_dev.yaml

@@ -0,0 +1,12 @@
+# Remove keys (and underlying values) from the file: `services_dev.yaml`
+# See: https://github.com/bolt/core/pull/2886
+
+file: services_dev.yaml
+since: 5.0.6
+
+remove:
+    services:
+        Bolt\Menu\StopwatchBackendMenuBuilder: ~
+        Bolt\Menu\BackendMenuBuilderInterface: ~
+        Bolt\Menu\StopwatchFrontendMenuBuilder: ~
+        Bolt\Menu\FrontendMenuBuilderInterface: ~

yaml-migrations/m_2021-10-26-services_prod.yaml

@@ -0,0 +1,12 @@
+# Remove keys (and underlying values) from the file: `services_prod.yaml`
+# See: https://github.com/bolt/core/pull/2886
+
+file: services_prod.yaml
+since: 5.0.6
+
+remove:
+    services:
+        Bolt\Menu\CachedBackendMenuBuilder: ~
+        Bolt\Menu\BackendMenuBuilderInterface: ~
+        Bolt\Menu\CachedFrontendMenuBuilder: ~
+        Bolt\Menu\FrontendMenuBuilderInterface: ~