Chyby v konfiguraci – syntaxe property/konstanty v sekci services – aktualizace

Problém je poměrně komplexní a tak jsem testoval a analyzoval více do hloubky proces kompilace NEON sekce services a pokročil v případném řešení.

Test – konstanty, statické property

Otestujeme získání konstanty a statické property z třídy nebo služby/objektu, kde jsou chyby. Získání property ze služby @provider::property funguje bez chyb. Testujeme službu/třídu Test, definici služby umístíme do samostatného souboru test.neon, aby bylo možno snadno dumpovat procesy při kompilaci DI containeru.

Testovací třída:

class Test
{
    public function __construct(
        private readonly ?string $val1 = null,
        private readonly ?string $val2 = null,
        private readonly ?string $val3 = null,
        private readonly ?string $val4 = null,
    )
    {}

Pomocná testovací třída/služba:

class Provider
{
    public const string Constant = 'constantValue';
    public string $property = 'propertyValue';
    public static string $staticProperty = 'staticPropertyValue';
}

Testovací soubor test.neon:

services:
	test:
		class: App\Test\Test
		arguments:
			- App\Test\Provider::Constant
			- App\Test\Provider::$staticProperty
			- @provider::Constant
#			- @provider::$staticProperty  // dočasně vyřazeno - vyhazuje výjimku

Zkompilovaná služba @test v /temp containeru:

	public function createServiceTest(): App\Test\Test
	{
		return new App\Test\Test(
			'constantValue',                           // chyba a)
			'App\Test\Provider::$staticProperty',      // chyba b)
			App\Test\Provider::Constant,			   // překvapivé, ale správné
		);
	}

Chyby:

a) konstanta se nezkompiluje do App\Test\Provider::Constant, ale dosadí se natvrdo její hodnota, to je chyba, protože pokud změníme hodnotu konstanty v třídě Provider, tato změna se v konfiguraci neprojeví a konfigurace dál používá starou neplatnou hodnotu. Takové chyby se hledají obtížně !!

Chybu způsobuje třída NeonAdapter z balíčku nette/neon, v metodě load() se provede kód který hodnotu natvrdo dosadí:

$node = $traverser->traverse($node, $this->resolveConstants(...));

metodu NeonAdapter::resolveConstants() je potřeba odstranit a odstranit její volání a zkompilovat do výsledného containeru původní řádek App\Test\Provider::Constant.

Zakomentujeme problematický řádek v NeonAdapter::load():

 // $node = $traverser->traverse($node, $this->resolveConstants(...));

a zkompilovaný kód služby @test obsahuje už jenom chybu b):

	public function createServiceTest(): App\Test\Test
	{
		return new App\Test\Test(
			'App\Test\Provider::Constant',			// chyba b)
			'App\Test\Provider::$staticProperty',     // chyba b)
			App\Test\Provider::Constant,
		);
	}

Poznámka: odstraněním metody NeonAdapter::resolveConstants() vyřešíme ještě jinou chybu – metoda detekuje, zda konstanta existuje a pokud neexistuje tak nevyhodí výjimku, ale místo hodnoty konstanty předá kód entity argumentu ‚App\Test\Provider::Constant‘. O překlepu v názvu konstanty se tak nedozvíme a místo výjimky se do služby předá nesprávná hodnota. Vznikne chyba, která se obtížně hledá.

b) první dva argumenty se zkompilují syntakticky správně, ale jako string – stačí tedy v generátoru php kódu vynechat ohraničující apostrofy a máme obě chyby opravené. Vygenerovaný php kód po opravě kompilace by měl vypadat takto:

	public function createServiceTest(): App\Test\Test
	{
		return new App\Test\Test(
			App\Test\Provider::Constant,
			App\Test\Provider::$staticProperty,
			App\Test\Provider::Constant,
		);
	}

Poznámka: syntaxe @provider::Constant nevygeneruje, co bychom očekávali – volání konstanty na službě:

   $this->getService('provider')::Constant,

ale místo služby podstrčí třídu služby:

   App\Test\Provider::Constant,

což nevadí, protože funkce je správně.

Test static property služby

upravíme definici testovací třídy:

services:
	test:
		class: App\Test\Test
		arguments:
#			- App\Test\Provider::Constant
#			- App\Test\Provider::$staticProperty
#			- @provider::Constant
			- @provider::$staticProperty

Kompilace vyvolá výjimku:

Nette\DI\ServiceCreationException
... Expected function, method or property name, '$$staticProperty' given....

Výjimku vyhazuje třída Resolver v balíčku nette/di v metodě completeStatement() a problematický kód vypadá takto:

   case is_array($entity):
      if (!preg_match('#^\$?(\\\\?' . PhpHelpers::ReIdentifier . ')+(\[\])?$#D', $entity[1])) {
         throw new ServiceCreationException(sprintf(
            "Expected function, method or property name, '%s' given.",
            $entity[1],
         ));
      }

Zde se validuje syntaxe druhého členu entity <statement>::member ($entity[1]) a z důkladnějších testů vyplývá, že se k hodnotě member položky přidává jako prefix znak $ – ale pouze v případě, že se nejedná o konstantu ani metodu. Takže např. entita @provider::property v tomto místě $entity[1] hodnotu $property, zatímco u @provider::$staticProperty má hodnotu $$staticProperty.

Takže regulární výraz v třídě Resolver musíme upravit, aby syntaxe statické property s přidaným prefixem $$staticProperty prošla validací:

   case is_array($entity):
//      if (!preg_match('#^\$?(\\\\?' . PhpHelpers::ReIdentifier . ')+(\[\])?$#D', $entity[1])) {
      if (!preg_match('#^\$?\$?(\\\\?' . PhpHelpers::ReIdentifier . ')+(\[\])?$#D', $entity[1])) {  // povoleno $$
         throw new ServiceCreationException(sprintf(
//            "Expected function, method or property name, '%s' given.",
            "Expected function, method, property or static property name, '%s' given.",
            $entity[1],
         ));
      }

Služba @test se zkompiluje takto:

	public function createServiceTest(): App\Test\Test
	{
		return new App\Test\Test($this->getService('provider')->{'$staticProperty'});
	}

To je špatně, my potřebujeme vygenerovat tento kód:

	public function createServiceTest(): App\Test\Test
	{
		return new App\Test\Test($this->getService('provider')::$staticProperty);
	}

To ale nebude v php generátoru složitá úprava.

Závěr:

Logickými a čitelnými úpravami v NeonAdapter::load() a Resolver::completeStatement() se docílí toho, že do php generátoru kódu se předají syntakticky srozumitelné member položky konstant a static properties, které stačí správně detekovat a správně vygenerovat do php kódu.

Protudovat php generátor služeb jsem zatím neměl čas, ale již nyní je zřejmé, že vyřešení uvedených chyb je na spadnutí. Rád bych znal i názor autora nette/di @DavidGrudl na předložený rozbor a návrh řešení ;).

Poznámka: v konfiguraci služeb jsou ještě další chyby, na kterých pracuji, ale myslím, že lepší postup je soustředit se na tuto skupinu chyb, odstranit je a potom pokračovat na další chyby. Už tak je toto vlákno nepřehledné.

Editoval m.brecher (12. 11. 21:18)

Musim ocenit, jakou sis s tim dal praci.

Odsouhlasení syntaxe member členů Statement

Pokud by komunita + @DavidGrudl nic proti navržené syntaxi nenamítal, mohl bych již nyní připravit podklady pro @mesour pro opravu chyb v NEON Pro pluginu pro PhpStorm. Práce na DI a pluginu mohou probíhat současně.

Syntaxe member členů je stručně řečeno tato:

::Constant			# konstanta - first character uppercase [A-Z]
::property			# property - first character lowercase  [a-z]
::$staticProperty	# static property - first character $, second character [a-zA-Z_]
::method()			# first character [a-zA-Z], ends with () or (statement)

Konstanty a statické properties lze použít (doporučovaný postup) na třídě:

MyClass::Constant			# konstanta - first character uppercase [A-Z]
MyClass::$staticProperty	# static property - first character $, second character [a-zA-Z_]

Všechny member členy lze použít na službě:

@someService::Constant
@someService::$staticProperty
@someService::property
@someService::getValue()

Member členy lze libovolně řetězit za sebou, konstanta může být pouze na konci:

@someService::someObject::Constant
@someService::someObject::$staticProperty
@someService::someObject::anotherObject::property
@someService::getSomeObject()::property
@someService::getSomeObject()::getAnotherObject()::getValue()
@someService::$someObject::getAnotherObject()::getValue()

Poznámka: Použití statických properties na instancích tříd všeobecně není doporučovaný postup a měly by se používat na třídě. PHP nicméně použití statických properties na instanci třídy umožňuje a proto není důvod, aby neon syntax toto nepodporovala. Práce navíc se statickými properties je zanedbatelná.