LinkGenerator: refactoring, added validateLinkTarget()

Author: dg

src/Application/LinkGenerator.php

@@ -135,10 +135,10 @@ public function createRequest(
 				$method = $reflection->getSignalMethod($signal);
 				if (!$method) {
 					throw new UI\InvalidLinkException("Unknown signal '$signal', missing handler {$reflection->getName()}::{$component::formatSignalMethod($signal)}()");
-				} elseif ($this->isDeprecated($refPresenter, $method)) {
-					trigger_error("Link to deprecated signal '$signal'" . ($component === $refPresenter ? '' : ' in ' . $component::class) . " from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
 				}
 
+				$this->validateLinkTarget($refPresenter, $method, "signal '$signal'" . ($component === $refPresenter ? '' : ' in ' . $component::class));
+
 				// convert indexed parameters to named
 				UI\ParameterConverter::toParameters($method, $args, [], $missing);
 			}
@@ -166,9 +166,7 @@ public function createRequest(
 			$current = $refPresenter && ($action === '*' || strcasecmp($action, $refPresenter->getAction()) === 0) && $presenterClass === $refPresenter::class;
 
 			$reflection = new UI\ComponentReflection($presenterClass);
-			if ($this->isDeprecated($refPresenter, $reflection)) {
-				trigger_error("Link to deprecated presenter '$presenter' from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
-			}
+			$this->validateLinkTarget($refPresenter, $reflection, "presenter '$presenter'");
 
 			foreach (array_intersect_key($reflection->getParameters(), $args) as $name => $param) {
 				if ($args[$name] === $param['def']) {
@@ -178,9 +176,7 @@ public function createRequest(
 
 			// counterpart of run() & tryCall()
 			if ($method = $reflection->getActionRenderMethod($action)) {
-				if ($this->isDeprecated($refPresenter, $method)) {
-					trigger_error("Link to deprecated action '$presenter:$action' from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
-				}
+				$this->validateLinkTarget($refPresenter, $method, "action '$presenter:$action'");
 
 				UI\ParameterConverter::toParameters($method, $args, $path === 'this' ? $refPresenter->getParameters() : [], $missing);
 
@@ -296,10 +292,17 @@ public function withReferenceUrl(string $url): static
 	}
 
 
-	private function isDeprecated(?UI\Presenter $presenter, \ReflectionClass|\ReflectionMethod $reflection): bool
+	private function validateLinkTarget(
+		?UI\Presenter $presenter,
+		\ReflectionClass|\ReflectionMethod $element,
+		string $message,
+	): void
 	{
-		return $presenter?->invalidLinkMode
-			&& (UI\ComponentReflection::parseAnnotation($reflection, 'deprecated') || $reflection->getAttributes(Attributes\Deprecated::class));
+		if ($presenter?->invalidLinkMode
+			&& (UI\ComponentReflection::parseAnnotation($element, 'deprecated') || $element->getAttributes(Attributes\Deprecated::class))
+		) {
+			trigger_error("Link to deprecated $message from '{$presenter->getName()}:{$presenter->getAction()}'.", E_USER_DEPRECATED);
+		}
 	}
 
 

tests/UI/Deprecated.link().phpt

@@ -0,0 +1,96 @@
+<?php
+
+/**
+ * Test: Nette\Application\UI\Presenter::link() and #[Deprecated]
+ */
+
+declare(strict_types=1);
+
+use Nette\Application;
+use Nette\Application\Attributes\Deprecated;
+use Nette\Http;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+class TestPresenter extends Application\UI\Presenter
+{
+	protected function startup(): void
+	{
+		parent::startup();
+		$this->terminate();
+	}
+
+
+	#[Deprecated]
+	public function actionFoo()
+	{
+	}
+
+
+	#[Deprecated]
+	public function handleFoo()
+	{
+	}
+
+
+	#[Deprecated]
+	public function renderBar()
+	{
+	}
+}
+
+
+#[Deprecated]
+class DeprecatedPresenter extends TestPresenter
+{
+}
+
+
+$url = new Http\UrlScript('http://localhost/index.php', '/index.php');
+
+$presenterFactory = Mockery::mock(Nette\Application\IPresenterFactory::class);
+$presenterFactory->shouldReceive('getPresenterClass')
+	->andReturnUsing(fn($presenter) => $presenter . 'Presenter');
+
+$presenter = new TestPresenter;
+$presenter->injectPrimary(
+	new Http\Request($url),
+	new Http\Response,
+	$presenterFactory,
+	new Application\Routers\SimpleRouter,
+);
+
+$presenter->invalidLinkMode = TestPresenter::InvalidLinkWarning;
+
+$request = new Application\Request('Test', Http\Request::Get, []);
+$presenter->run($request);
+
+Assert::error(
+	fn() => $presenter->link('foo'),
+	E_USER_DEPRECATED,
+	"Link to deprecated action 'Test:foo' from 'Test:default'.",
+);
+
+Assert::error(
+	fn() => $presenter->link('bar'),
+	E_USER_DEPRECATED,
+	"Link to deprecated action 'Test:bar' from 'Test:default'.",
+);
+
+Assert::error(
+	fn() => $presenter->link('foo!'),
+	E_USER_DEPRECATED,
+	"Link to deprecated signal 'foo' from 'Test:default'.",
+);
+
+Assert::error(
+	fn() => $presenter->link('Deprecated:'),
+	E_USER_DEPRECATED,
+	"Link to deprecated presenter 'Deprecated' from 'Test:default'.",
+);
+
+Assert::noError(
+	fn() => $presenter->link('Test:'),
+);