exception messages use [Service ...]\n format [WIP]

added Definition::getDescriptor(), Helpers::entityToString()

Author: dg

src/DI/Definitions/AccessorDefinition.php

@@ -30,8 +30,8 @@ public function setImplement(string $interface)
 	{
 		if (!interface_exists($interface)) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Interface '%s' not found.",
-				$this->getName(),
+				"[%s]\nInterface '%s' not found.",
+				$this->getDescriptor(),
 				$interface
 			));
 		}
@@ -46,20 +46,20 @@ public function setImplement(string $interface)
 			|| count($rc->getMethods()) > 1
 		) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Interface %s must have just one non-static method get().",
-				$this->getName(),
+				"[%s]\nInterface %s must have just one non-static method get().",
+				$this->getDescriptor(),
 				$interface
 			));
 		} elseif ($method->getNumberOfParameters()) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Method %s::get() must have no parameters.",
-				$this->getName(),
+				"[%s]\nMethod %s::get() must have no parameters.",
+				$this->getDescriptor(),
 				$interface
 			));
 		}
 
 		try {
-			Helpers::ensureClassType(Type::fromReflection($method), "return type of $interface::get()");
+			Helpers::ensureClassType(Type::fromReflection($method), "return type of $interface::get()", $this->getDescriptor());
 		} catch (Nette\DI\ServiceCreationException $e) {
 			trigger_error($e->getMessage(), E_USER_DEPRECATED);
 		}

src/DI/Definitions/Definition.php

@@ -56,6 +56,29 @@ final public function getName(): ?string
 	}
 
 
+	final public function isAnonymous(): bool
+	{
+		return !$this->name || ctype_digit($this->name);
+	}
+
+
+	public function getDescriptor(): string
+	{
+		if (!$this->isAnonymous()) {
+			return "Service '$this->name'" . ($this->type ? " of type $this->type" : '');
+
+		} elseif ($this->type) {
+			return "Service of type $this->type";
+
+		} elseif ($this->name) {
+			return "Service '$this->name'";
+
+		} else {
+			return 'Service ?';
+		}
+	}
+
+
 	/** @return static */
 	protected function setType(?string $type)
 	{
@@ -67,8 +90,8 @@ protected function setType(?string $type)
 			$this->type = null;
 		} elseif (!class_exists($type) && !interface_exists($type)) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Class or interface '%s' not found.",
-				$this->name,
+				"[%s]\nClass or interface '%s' not found.",
+				$this->getDescriptor(),
 				$type
 			));
 		} else {

src/DI/Definitions/FactoryDefinition.php

@@ -42,8 +42,8 @@ public function setImplement(string $interface)
 	{
 		if (!interface_exists($interface)) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Interface '%s' not found.",
-				$this->getName(),
+				"[%s]\nInterface '%s' not found.",
+				$this->getDescriptor(),
 				$interface
 			));
 		}
@@ -52,14 +52,14 @@ public function setImplement(string $interface)
 		$method = $rc->getMethods()[0] ?? null;
 		if (!$method || $method->isStatic() || $method->name !== self::METHOD_CREATE || count($rc->getMethods()) > 1) {
 			throw new Nette\InvalidArgumentException(sprintf(
-				"Service '%s': Interface %s must have just one non-static method create().",
-				$this->getName(),
+				"[%s]\nInterface %s must have just one non-static method create().",
+				$this->getDescriptor(),
 				$interface
 			));
 		}
 
 		try {
-			Helpers::ensureClassType(Type::fromReflection($method), "return type of $interface::create()");
+			Helpers::ensureClassType(Type::fromReflection($method), "return type of $interface::create()", $this->getDescriptor());
 		} catch (Nette\DI\ServiceCreationException $e) {
 			trigger_error($e->getMessage(), E_USER_DEPRECATED);
 		}
@@ -107,8 +107,8 @@ public function setParameters(array $params)
 			}
 
 			trigger_error(sprintf(
-				"Service '%s': Option 'parameters' is deprecated and should be removed. The %s should be replaced with %s in configuration.",
-				$this->getName(),
+				"[%s]\nOption 'parameters' is deprecated and should be removed. The %s should be replaced with %s in configuration.",
+				$this->getDescriptor(),
 				implode(', ', $old),
 				implode(', ', $new)
 			), E_USER_DEPRECATED);
@@ -150,7 +150,8 @@ public function resolveType(Nette\DI\Resolver $resolver): void
 
 		if ($type && !$type->allows($resultDef->getType())) {
 			throw new ServiceCreationException(sprintf(
-				'Factory for %s cannot create incompatible %s type.',
+				"[%s]\nFactory for %s cannot create incompatible %s type.",
+				$this->getDescriptor(),
 				$type,
 				$resultDef->getType()
 			));

src/DI/Definitions/LocatorDefinition.php

@@ -28,12 +28,12 @@ final class LocatorDefinition extends Definition
 	public function setImplement(string $interface)
 	{
 		if (!interface_exists($interface)) {
-			throw new Nette\InvalidArgumentException(sprintf("Service '%s': Interface '%s' not found.", $this->getName(), $interface));
+			throw new Nette\InvalidArgumentException(sprintf("[%s]\nInterface '%s' not found.", $this->getDescriptor(), $interface));
 		}
 
 		$methods = (new \ReflectionClass($interface))->getMethods();
 		if (!$methods) {
-			throw new Nette\InvalidArgumentException(sprintf("Service '%s': Interface %s must have at least one method.", $this->getName(), $interface));
+			throw new Nette\InvalidArgumentException(sprintf("[%s]\nInterface %s must have at least one method.", $this->getDescriptor(), $interface));
 		}
 
 		foreach ($methods as $method) {
@@ -42,16 +42,16 @@ public function setImplement(string $interface)
 				|| (preg_match('#^(get|create)[A-Z]#', $method->name) && $method->getNumberOfParameters() === 0)
 			)) {
 				throw new Nette\InvalidArgumentException(sprintf(
-					"Service '%s': Method %s::%s() does not meet the requirements: is create(\$name), get(\$name), create*() or get*() and is non-static.",
-					$this->getName(),
+					"[%s]\nMethod %s::%s() does not meet the requirements: is create(\$name), get(\$name), create*() or get*() and is non-static.",
+					$this->getDescriptor(),
 					$interface,
 					$method->name
 				));
 			}
 
 			if ($method->getNumberOfParameters() === 0) {
 				try {
-					Nette\DI\Helpers::ensureClassType(Nette\Utils\Type::fromReflection($method), "return type of $interface::$method->name()", true);
+					Nette\DI\Helpers::ensureClassType(Nette\Utils\Type::fromReflection($method), "return type of $interface::$method->name()", $this->getDescriptor(), true);
 				} catch (Nette\DI\ServiceCreationException $e) {
 					trigger_error($e->getMessage(), E_USER_DEPRECATED);
 				}
@@ -115,8 +115,8 @@ public function complete(Nette\DI\Resolver $resolver): void
 			foreach ($resolver->getContainerBuilder()->findByTag($this->tagged) as $name => $tag) {
 				if (isset($this->references[$tag])) {
 					trigger_error(sprintf(
-						"Service '%s': duplicated tag '%s' with value '%s'.",
-						$this->getName(),
+						"[%s]\nDuplicated tag '%s' with value '%s'.",
+						$this->getDescriptor(),
 						$this->tagged,
 						$tag
 					), E_USER_NOTICE);

src/DI/Definitions/ServiceDefinition.php

@@ -35,6 +35,17 @@ public function __construct()
 	}
 
 
+	public function getDescriptor(): string
+	{
+		$entity = $this->getEntity();
+		if ($entity && $this->isAnonymous()) {
+			return 'Service ' . (is_string($entity) ? "of type $entity" : Nette\DI\Helpers::entityToString($entity));
+		}
+
+		return parent::getDescriptor();
+	}
+
+
 	/** @return static */
 	public function setType(?string $type)
 	{

src/DI/Extensions/InjectExtension.php

@@ -63,6 +63,7 @@ private function updateDefinition(Definitions\ServiceDefinition $def): void
 				}
 			}
 
+			self::checkType($class, $property, $type, $builder, $def);
 			array_unshift($setups, $inject);
 		}
 
@@ -155,7 +156,30 @@ public static function callInjects(DI\Container $container, $service): void
 		}
 
 		foreach (self::getInjectProperties(get_class($service)) as $property => $type) {
+			self::checkType($service, $property, $type, $container);
 			$service->$property = $container->getByType($type);
 		}
 	}
+
+
+	/**
+	 * @param  object|string  $class
+	 * @param  DI\Container|DI\ContainerBuilder|null  $container
+	 */
+	private static function checkType(
+		$class,
+		string $name,
+		?string $type,
+		$container,
+		Definitions\Definition $def = null
+	): void {
+		if ($container && !$container->getByType($type, false)) {
+			throw new Nette\DI\MissingServiceException(sprintf(
+				"%sService of type %s required by %s not found.\nDid you add it to configuration file?",
+				$def ? '[' . $def->getDescriptor() . "]\n" : '',
+				$type,
+				Reflection::toString(new \ReflectionProperty($class, $name))
+			));
+		}
+	}
 }

src/DI/Extensions/ServicesExtension.php

@@ -55,7 +55,7 @@ private function loadDefinition(?string $name, \stdClass $config): void
 				$this->getContainerBuilder()->removeDefinition($name);
 				return;
 			} elseif (!empty($config->alteration) && !$this->getContainerBuilder()->hasDefinition($name)) {
-				throw new Nette\DI\InvalidConfigurationException('missing original definition for alteration.');
+				throw new Nette\DI\InvalidConfigurationException('Missing original definition for alteration.');
 			}
 
 			$def = $this->retrieveDefinition($name, $config);
@@ -70,7 +70,12 @@ private function loadDefinition(?string $name, \stdClass $config): void
 			$this->{$methods[$config->defType]}($def, $config);
 			$this->updateDefinition($def, $config);
 		} catch (\Throwable $e) {
-			throw new Nette\DI\InvalidConfigurationException(($name ? "Service '$name': " : '') . $e->getMessage(), 0, $e);
+			$message = $e->getMessage();
+			if ($name && !Nette\Utils\Strings::startsWith($message, '[Service ')) {
+				$message = "[Service '$name']\n$message";
+			}
+
+			throw new Nette\DI\InvalidConfigurationException($message, 0, $e);
 		}
 	}
 

src/DI/Helpers.php

@@ -230,17 +230,22 @@ public static function getReturnTypeAnnotation(\ReflectionFunctionAbstract $func
 	}
 
 
-	public static function ensureClassType(?Type $type, string $hint, bool $allowNullable = false): string
-	{
+	public static function ensureClassType(
+		?Type $type,
+		string $hint,
+		string $descriptor = '',
+		bool $allowNullable = false
+	): string {
+		$descriptor = $descriptor ? "[$descriptor]\n" : '';
 		if (!$type) {
-			throw new ServiceCreationException(sprintf('%s is not declared.', ucfirst($hint)));
+			throw new ServiceCreationException(sprintf('%s%s is not declared.', $descriptor, ucfirst($hint)));
 		} elseif (!$type->isClass() || (!$allowNullable && $type->isUnion())) {
-			throw new ServiceCreationException(sprintf("%s is not expected to be %sunion/intersection/built-in, '%s' given.", ucfirst($hint), $allowNullable ? '' : 'nullable/', $type));
+			throw new ServiceCreationException(sprintf("%s%s is not expected to be %sunion/intersection/built-in, '%s' given.", $descriptor, ucfirst($hint), $allowNullable ? '' : 'nullable/', $type));
 		}
 
 		$class = $type->getSingleName();
 		if (!class_exists($class) && !interface_exists($class)) {
-			throw new ServiceCreationException(sprintf("Class '%s' not found.\nCheck the %s.", $class, $hint));
+			throw new ServiceCreationException(sprintf("%sClass '%s' not found.\nCheck the %s.", $descriptor, $class, $hint));
 		}
 
 		return $class;
@@ -282,4 +287,25 @@ public static function convertType($value, string $type)
 			$type
 		));
 	}
+
+
+	/**
+	 * @param  string|array|Reference  $entity
+	 */
+	public static function entityToString($entity, bool $inner = false): string
+	{
+		if (is_string($entity)) {
+			return $entity . ($inner ? '()' : '');
+
+		} elseif ($entity instanceof Reference) {
+			return '@' . $entity->getValue();
+
+		} elseif (is_array($entity)) {
+			[$a, $b] = $entity;
+			return self::entityToString($a instanceof Statement ? $a->entity : $a, true)
+				. '::'
+				. $b
+				. (strpos($b, '$') === false ? '()' : '');
+		}
+	}
 }

src/DI/PhpGenerator.php

@@ -104,7 +104,7 @@ public function generateMethod(Definitions\Definition $def): Php\Method
 			return $method;
 
 		} catch (\Throwable $e) {
-			throw new ServiceCreationException("Service '$name': " . $e->getMessage(), 0, $e);
+			throw new ServiceCreationException(sprintf("[%s]\n%s", $def->getDescriptor(), $e->getMessage()), 0, $e);
 		}
 	}