MAGETWO-93042: [Backport to 2.2 ] Write Logs for Failed Process of Generating Factories in Extensions

Author: NadiyaS

lib/internal/Magento/Framework/Code/Generator.php

@@ -52,7 +52,7 @@ class Generator
      * @param Generator\Io $ioObject
      * @param array $generatedEntities
      * @param DefinedClasses $definedClasses
-     * @param LoggerInterface|null $logger
+     * @param LoggerInterface $logger
      */
     public function __construct(
         Io $ioObject = null,
@@ -232,7 +232,7 @@ protected function shouldSkipGeneration($resultEntityType, $sourceClassName, $re
     {
         if (!$resultEntityType || !$sourceClassName) {
             return self::GENERATION_ERROR;
-        } elseif ($this->definedClasses->isClassLoadableFromDisk($resultClass)) {
+        } elseif ($this->definedClasses->isClassLoadableFromDisc($resultClass)) {
             $generatedFileName = $this->_ioObject->generateResultFileName($resultClass);
             /**
              * Must handle two edge cases: a competing process has generated the class and written it to disc already,

lib/internal/Magento/Framework/Code/Generator/EntityAbstract.php

@@ -5,8 +5,6 @@
  */
 namespace Magento\Framework\Code\Generator;
 
-use Zend\Code\Generator\ValueGenerator;
-
 abstract class EntityAbstract
 {
     /**
@@ -295,64 +293,11 @@ protected function _fixCodeStyle($sourceCode)
     /**
      * Get value generator for null default value
      *
-     * @return ValueGenerator
+     * @return \Zend\Code\Generator\ValueGenerator
      */
     protected function _getNullDefaultValue()
     {
-        $value = new ValueGenerator(null, ValueGenerator::TYPE_NULL);
-
-        return $value;
-    }
-
-    /**
-     * @param \ReflectionParameter $parameter
-     *
-     * @return null|string
-     */
-    private function extractParameterType(
-        \ReflectionParameter $parameter
-    ): ?string {
-        /** @var string|null $typeName */
-        $typeName = null;
-        if ($parameter->hasType()) {
-            if ($parameter->isArray()) {
-                $typeName = 'array';
-            } elseif ($parameter->getClass()) {
-                $typeName = $this->_getFullyQualifiedClassName(
-                    $parameter->getClass()->getName()
-                );
-            } elseif ($parameter->isCallable()) {
-                $typeName = 'callable';
-            } else {
-                $typeName = $parameter->getType()->getName();
-            }
-
-            if ($parameter->allowsNull()) {
-                $typeName = '?' .$typeName;
-            }
-        }
-
-        return $typeName;
-    }
-
-    /**
-     * @param \ReflectionParameter $parameter
-     *
-     * @return null|ValueGenerator
-     */
-    private function extractParameterDefaultValue(
-        \ReflectionParameter $parameter
-    ): ?ValueGenerator {
-        /** @var ValueGenerator|null $value */
-        $value = null;
-        if ($parameter->isOptional() && $parameter->isDefaultValueAvailable()) {
-            $valueType = ValueGenerator::TYPE_AUTO;
-            $defaultValue = $parameter->getDefaultValue();
-            if ($defaultValue === null) {
-                $valueType = ValueGenerator::TYPE_NULL;
-            }
-            $value = new ValueGenerator($defaultValue, $valueType);
-        }
+        $value = new \Zend\Code\Generator\ValueGenerator(null, \Zend\Code\Generator\ValueGenerator::TYPE_NULL);
 
         return $value;
     }
@@ -368,13 +313,26 @@ protected function _getMethodParameterInfo(\ReflectionParameter $parameter)
         $parameterInfo = [
             'name' => $parameter->getName(),
             'passedByReference' => $parameter->isPassedByReference(),
-            'variadic' => $parameter->isVariadic()
+            'type' => $parameter->getType()
         ];
-        if ($type = $this->extractParameterType($parameter)) {
-            $parameterInfo['type'] = $type;
+
+        if ($parameter->isArray()) {
+            $parameterInfo['type'] = 'array';
+        } elseif ($parameter->getClass()) {
+            $parameterInfo['type'] = $this->_getFullyQualifiedClassName($parameter->getClass()->getName());
+        } elseif ($parameter->isCallable()) {
+            $parameterInfo['type'] = 'callable';
         }
-        if ($default = $this->extractParameterDefaultValue($parameter)) {
-            $parameterInfo['defaultValue'] = $default;
+
+        if ($parameter->isOptional() && $parameter->isDefaultValueAvailable()) {
+            $defaultValue = $parameter->getDefaultValue();
+            if (is_string($defaultValue)) {
+                $parameterInfo['defaultValue'] = $parameter->getDefaultValue();
+            } elseif ($defaultValue === null) {
+                $parameterInfo['defaultValue'] = $this->_getNullDefaultValue();
+            } else {
+                $parameterInfo['defaultValue'] = $defaultValue;
+            }
         }
 
         return $parameterInfo;

lib/internal/Magento/Framework/Code/Test/Unit/Generator/EntityAbstractTest.php

@@ -233,7 +233,7 @@ protected function _prepareMocksForValidateData(
             ->willReturn($sourceClassExists);
         if ($resultClassExists) {
             $definedClassesMock->expects($this->once())
-                ->method('isClassLoadableFromDisk')
+                ->method('isClassLoadableFromDisc')
                 ->with($this->resultClass)
                 ->willReturn($resultClassExists);
         }

lib/internal/Magento/Framework/Code/Test/Unit/GeneratorTest.php

@@ -187,7 +187,7 @@ public function testGenerateClassWithErrors()
     public function testGenerateClassWithExistName($fileExists)
     {
         $this->definedClassesMock->expects($this->any())
-            ->method('isClassLoadableFromDisk')
+            ->method('isClassLoadableFromDisc')
             ->willReturn(true);
 
         $resultClassFileName = '/Magento/Path/To/Class.php';