fix: Serve icons sprite from Panel route

Co-authored-by: Nico Hoffmann <me@nhoffmann.com>

Author: bastianallgeier

src/Panel/Assets.php

@@ -190,9 +190,6 @@ public function favicons(): array
 	 */
 	public function icons(): string
 	{
-		// the version hash busts the browser cache for every release;
-		// in dev mode, the sprite changes without a release, so the
-		// modification time of the source file is used instead
 		$version = $this->isDev === true
 			? F::modified($this->iconsRoot())
 			: $this->kirby->versionHash();
@@ -221,7 +218,6 @@ public function importMaps(): array
 
 	/**
 	 * Whether the Panel is running in dev mode
-	 * and the assets are served by the Vite dev server
 	 * @since 6.0.0
 	 */
 	public function isDev(): bool

src/Panel/Router.php

@@ -113,18 +113,13 @@ protected function garbage(): void
 	}
 
 	/**
-	 * Response for the SVG icon sprite, which is referenced
-	 * by all `<use>` elements in the Panel
+	 * Response for the SVG icon sprite
 	 * @since 6.0.0
 	 */
 	public function icons(): Response
 	{
 		$assets = $this->panel->assets();
-
-		// the version hash in the URL only changes with a new release,
-		// so the sprite can be cached forever; the dev mode URL is busted
-		// by the modification time, which is only accurate to the second
-		$cache = $assets->isDev() === true
+		$cache  = $assets->isDev() === true
 			? 'no-store'
 			: 'public, max-age=31536000, immutable';
 

tests/Panel/AssetsTest.php

@@ -316,8 +316,6 @@ public function testIconsInDevMode(): void
 	{
 		$this->setDevMode();
 
-		// the sprite is never served by Vite, as `<use>` references
-		// are limited to the same origin as the Panel document
 		$assets   = new Assets();
 		$modified = F::modified($this->app->root('panel') . '/public/img/icons.svg');
 
@@ -327,17 +325,6 @@ public function testIconsInDevMode(): void
 		);
 	}
 
-	public function testIconsInDevModeAfterProduction(): void
-	{
-		$production = (new Assets())->icons();
-
-		$this->setDevMode();
-
-		// the dev URL must differ from the production URL, which the
-		// browser has cached as immutable and would not request again
-		$this->assertNotSame($production, (new Assets())->icons());
-	}
-
 	public function testIconsWithCustomMediaUrl(): void
 	{
 		$this->app = $this->app->clone([
@@ -407,9 +394,7 @@ public function testImportMaps(): void
 	public function testIsDev(): void
 	{
 		$this->assertFalse((new Assets())->isDev());
-
 		$this->setDevMode();
-
 		$this->assertTrue((new Assets())->isDev());
 	}
 

tests/Panel/RouterTest.php

@@ -2,53 +2,16 @@
 
 namespace Kirby\Panel;
 
-use Kirby\Cms\Url;
 use Kirby\Exception\Exception;
 use Kirby\Exception\NotFoundException;
 use Kirby\Filesystem\F;
 use Kirby\Http\Response;
-use Kirby\Toolkit\Str;
 use PHPUnit\Framework\Attributes\CoversClass;
 
 #[CoversClass(Router::class)]
 class RouterTest extends TestCase
 {
-	public const string TMP               = KIRBY_TMP_DIR . '/Panel.Panel';
-	public const string VITE_RUNNING_PATH = KIRBY_DIR . '/panel/.vite-running';
-
-	protected bool $hadViteRunning;
-
-	protected function setUp(): void
-	{
-		parent::setUp();
-
-		// initialize development mode to a known state
-		$this->hadViteRunning = is_file(static::VITE_RUNNING_PATH);
-		F::remove(static::VITE_RUNNING_PATH);
-	}
-
-	protected function tearDown(): void
-	{
-		parent::tearDown();
-
-		// reset development mode
-		if ($this->hadViteRunning === true) {
-			touch(static::VITE_RUNNING_PATH);
-		} else {
-			F::remove(static::VITE_RUNNING_PATH);
-		}
-	}
-
-	public function testCallIcons(): void
-	{
-		$router   = new Router($this->app->panel());
-		$response = $router->call('assets/' . $this->app->versionHash() . '/icons.svg');
-
-		// the sprite is served before any area route can catch the path
-		$this->assertSame(200, $response->code());
-		$this->assertSame('image/svg+xml', $response->type());
-		$this->assertStringContainsString('id="icon-accessibility"', $response->body());
-	}
+	public const string TMP = KIRBY_TMP_DIR . '/Panel.Panel';
 
 	public function testIcons(): void
 	{
@@ -60,32 +23,33 @@ public function testIcons(): void
 			'public, max-age=31536000, immutable',
 			$response->header('Cache-Control')
 		);
-		$this->assertStringContainsString('id="icon-accessibility"', $response->body());
+		$this->assertStringContainsString('<svg', $response->body());
 	}
 
 	public function testIconsInDevMode(): void
 	{
+		// fake a panel dir with a running Vite dev server
+		$panel = static::TMP . '/panel';
+		F::write($panel . '/public/img/icons.svg', '<svg></svg>');
+		F::write($panel . '/.vite-running', '');
+
 		$this->app = $this->app->clone([
+			'roots' => [
+				'panel' => $panel
+			],
 			'options' => [
 				'panel' => [
 					'dev' => true
 				]
 			]
 		]);
 
-		touch(static::VITE_RUNNING_PATH);
-
-		$panel = $this->app->panel();
-		$path  = Str::after(Url::path($panel->assets()->icons()), 'panel/');
-
-		// the modification time in the dev URL must resolve to the same route
-		$response = $panel->router()->call($path);
-
-		$this->assertSame(200, $response->code());
-		$this->assertStringContainsString('id="icon-accessibility"', $response->body());
+		$router   = new Router($this->app->panel());
+		$response = $router->icons();
 
-		// the sprite must not be cached while it is still being edited
+		$this->assertSame('image/svg+xml', $response->type());
 		$this->assertSame('no-store', $response->header('Cache-Control'));
+		$this->assertStringContainsString('<svg', $response->body());
 	}
 
 	public function testResponse(): void
@@ -147,7 +111,6 @@ public function testRoutes(): void
 		$routes = $router->routes($areas);
 
 		$this->assertSame('assets/(:any)/icons.svg', $routes[0]['pattern']);
-		$this->assertFalse($routes[0]['auth']);
 		$this->assertSame('browser', $routes[1]['pattern']);
 		$this->assertSame(['/', 'installation', 'login'], $routes[2]['pattern']);
 		$this->assertSame('(:all)', $routes[3]['pattern']);