RFC - tichý konflikt parametrů akce s parametry signálu

Ahoj!

Nette fórum obsahuje řadu vláken věnovaných problémům se signály. Jedním z opakujících se problémů jsou kolize parametrů – signál buď nedostane parametr, který očekává, nebo naopak přepíše parametr akce. Poslední podrobně zdokumentovaný případ popsal @SamuelThorn zde:

https://forum.nette.org/…i-nazvu-ajax

Parametry akcí i signálů presenteru se ukládají do stejného pole Component::$params. Konflikt navíc nevzniká jako chyba. Framework jej vyřeší tichým přepsáním hodnoty, což výrazně ztěžuje jeho odhalení i následné debugování.

Test aktuálního chování:

final class HomePresenter extends BasePresenter
{
    public function actionHome(?int $count = null): void
    {
        bdump('action__' . $count);
    }

    public function handlePing(int $count): void
    {
        bdump('signal__' . $count);
    }
}

latte:

<a data-ajax n:href="ping!, count: 2">ping</a>

url:

http://localhost/dev/tex/admin?count=1

dump reload stránky:

'action__1'

dump po kliknutí na signál ping:

'action__2'
'signal__2'

očekávané chování:

'action__1'
'signal__2'

Závěr testu:

Parametr signálu potichu přepíše parametr akce. Parametry akce a signálu představují dva nezávislé zdroje dat. Architektonicky žádoucí je proto jejich oddělený scope, aby se vzájemně nemohly ovlivňovat.

Popis řešení

Nette prefixuje parametry signálu component-parameter. Pokud je handler signálu přímo v presenteru, pak prefix chybí a parametry signálů se tlučou s parametry akcí.

Navrhuji přidat speciální prefix pro parametry signálu presenteru a tím vytvořit izolovaný scope od parametrů akce. Prefix musí fungovat obousměrně. Navrhuji dvě změny v nette codebase:

a) Nette\Application\LinkGenerator::createRequest() – úplně na konci metody

// začátek změn
//            if ($args && $component !== $refPresenter) {
//            $prefix = $component->getUniqueId() . UI\Component::NameSeparator;
            if ($args && !str_contains($signal, UI\Component::NameSeparator)) {
                $uniqueId = $component === $refPresenter ? '__signal' : $component->getUniqueId();
                $prefix = $uniqueId . UI\Component::NameSeparator;
// konec změn
                foreach ($args as $key => $val) {
					unset($args[$key]);
					$args[$prefix . $key] = $val;
				}
			}

Jsme v místě, kde Nette prefixuje parametry signálu komponenty. Pokud komponenta není presenter, přidá ke jménu parametru prefix, pokud je presenter nechá parametr bez prefixu. Přidáme speciální prefixování ‚__signal‘ i pro parametry presenteru. Současně ve vstupní podmínce ošetříme již prefixovaný link na volání signálu komponenty z presenteru (n:href=„MyControl-ping!, MyControl-count: 2“)

b) Nette\Application\UI\Component::signalReceived()

	public function signalReceived(string $signal): void
	{
// začátek změn
//		if (!$this->tryCall(static::formatSignalMethod($signal), $this->params)) {
       $method = static::formatSignalMethod($signal);
       $params = $this->params;
        $presenter = $this->getPresenter();
        if ($presenter) {
            $signalParams = $presenter->popGlobalParameters($this->getParameterId('__signal'));
            if ($signalParams && static::getReflection()->hasMethod($method)) {
                foreach (static::getReflection()->getMethod($method)->getParameters() as $reflParam) {
                    $name = $reflParam->getName();
                    if (array_key_exists($name, $signalParams)) {
                        $params[$name] = $signalParams[$name];
                    }
                }
            }
        }
        if (!$this->tryCall($method, $params)) {
// konec změn
			$class = static::class;
			throw new BadSignalException("There is no handler for signal '$signal' in class $class.");
		}
	}

Upravujeme těsně před voláním metody handleru signálu, protože přímo v tryCall() to už nejde, je to metoda sdílená i pro jiné scénáře než signál. Protože jsou parametry signálu prefixované, nejsou v $this->params. Vyzvedneme si je pomocí Presenter::popGlobalParameters() a ověříme, že je handler signálu skutečně očekává. Parametry signálu se přidávají do lokální proměnné $params, nikoliv do $this->params, kde jsou parametry akce presenteru.

Zpětná kompatibilita

Navržené změny ovlivní pouze aplikace které (vědomě či nevědomě) spoléhají na automatické přepsání parametrů akce signálem. Odhaduji, že takových aplikací bude minimum.

Jsem přesvědčen, že signály Nette si navrženou opravu zaslouží i přes případné drobné problémy se zpětnou kompatibilitou.

Uvítám jakékoliv relevantní komentáře k navrženým úpravám.