Defer creation of URL helper in RouteHelper to avoid early plugin invokation. (#5062)

Author: EreMaijala

module/VuFind/src/VuFind/Http/RouteHelper.php

@@ -31,6 +31,7 @@
 namespace VuFind\Http;
 
 use Closure;
+use Laminas\View\Helper\Url;
 
 /**
  * Route Helper class.  Wrapper around Laminas UrlHelper.
@@ -44,14 +45,21 @@
  */
 class RouteHelper
 {
+    /**
+     * URL helper
+     *
+     * @var ?Url
+     */
+    protected ?Url $urlHelper = null;
+
     /**
      * Constructor.
      *
-     * @param Closure $urlHelper URL helper function
+     * @param Closure $urlHelperFactory URL helper factory callback
      *
      * @return void
      */
-    public function __construct(protected Closure $urlHelper)
+    public function __construct(protected Closure $urlHelperFactory)
     {
     }
 
@@ -71,7 +79,7 @@ public function __construct(protected Closure $urlHelper)
      * @throws \Laminas\View\Exception\InvalidArgumentException If the params object was not an
      * array or Traversable object.
      *
-     * @return self|string Url For the link href attribute
+     * @return string Url For the link href attribute
      */
     public function getUrlFromRoute(
         string $name,
@@ -80,6 +88,19 @@ public function getUrlFromRoute(
     ): string {
         // Path normalization can cause problems with IDs containing escaped slashes, so let's always disable it:
         $routeOptions = ['normalize_path' => false] + ($queryParams ? ['query' => $queryParams] : []);
-        return ($this->urlHelper)($name, $routeParams, $routeOptions);
+        return ($this->getUrlHelper())($name, $routeParams, $routeOptions);
+    }
+
+    /**
+     * Get URL helper.
+     *
+     * @return Url
+     */
+    protected function getUrlHelper(): Url
+    {
+        if (null === $this->urlHelper) {
+            $this->urlHelper = ($this->urlHelperFactory)();
+        }
+        return $this->urlHelper;
     }
 }

module/VuFind/src/VuFind/Http/RouteHelperFactory.php

@@ -72,7 +72,9 @@ public function __invoke(
 
         $viewRenderer = $container->get('ViewRenderer');
         return new $requestedName(
-            Closure::fromCallable($viewRenderer->plugin('url'))
+            // Defer fetching of the plugin until it's actually needed to allow for Laminas MvcEvent to be dispatched
+            // first:
+            Closure::fromCallable(fn () => $viewRenderer->plugin('url'))
         );
     }
 }

module/VuFind/tests/unit-tests/src/VuFindTest/Http/RouteHelperTest.php

@@ -62,7 +62,7 @@ public function testShallowGetUrlFromRoute(): void
             ->with($routeName, $routeParams, ['query' => $queryParams, 'normalize_path' => false])
             ->willReturn($routeResult);
         $routeHelper = new RouteHelper(
-            Closure::fromCallable($urlHelper)
+            Closure::fromCallable(fn () => $urlHelper)
         );
 
         $url = $routeHelper->getUrlFromRoute($routeName, $routeParams, $queryParams);