MAGETWO-38070 Incorrect WSDL generation

Author: Eugene Tulika

app/code/Magento/Catalog/Api/ProductRepositoryInterface.php

@@ -29,7 +29,7 @@ public function save(\Magento\Catalog\Api\Data\ProductInterface $product, $saveO
      *
      * @param string $sku
      * @param bool $editMode
-     * @param null|int $storeId
+     * @param int|null $storeId
      * @param bool $forceReload
      * @return \Magento\Catalog\Api\Data\ProductInterface
      * @throws \Magento\Framework\Exception\NoSuchEntityException

app/code/Magento/Quote/Api/GuestCartTotalManagementInterface.php

@@ -14,7 +14,7 @@ interface GuestCartTotalManagementInterface
      * Set shipping/billing methods and additional data for cart and collect totals for guest.
      *
      * @param string $cartId The cart ID.
-     * @param \Magento\Quote\Api\Data\PaymentInterface Payment method data.
+     * @param \Magento\Quote\Api\Data\PaymentInterface $paymentMethod Payment method data.
      * @param string $shippingCarrierCode The carrier code.
      * @param string $shippingMethodCode The shipping method code.
      * @param \Magento\Quote\Api\Data\TotalsAdditionalDataInterface $additionalData Additional data to collect totals.

app/code/Magento/Webapi/Model/Soap/Config/ClassReflector.php

@@ -5,8 +5,6 @@
  */
 namespace Magento\Webapi\Model\Soap\Config;
 
-use Zend\Server\Reflection;
-use Zend\Server\Reflection\ReflectionMethod;
 use Zend\Code\Reflection\MethodReflection;
 
 /**
@@ -66,8 +64,8 @@ public function __construct(\Magento\Framework\Reflection\TypeProcessor $typePro
     public function reflectClassMethods($className, $methods)
     {
         $data = [];
-        $classReflection = new \Zend\Server\Reflection\ReflectionClass(new \ReflectionClass($className));
-        /** @var $methodReflection ReflectionMethod */
+        $classReflection = new \Zend\Code\Reflection\ClassReflection($className);
+        /** @var \Zend\Code\Reflection\MethodReflection $methodReflection */
         foreach ($classReflection->getMethods() as $methodReflection) {
             $methodName = $methodReflection->getName();
             if (array_key_exists($methodName, $methods)) {
@@ -80,33 +78,30 @@ public function reflectClassMethods($className, $methods)
     /**
      * Retrieve method interface and documentation description.
      *
-     * @param ReflectionMethod $method
+     * @param \Zend\Code\Reflection\MethodReflection $method
      * @return array
      * @throws \InvalidArgumentException
      */
-    public function extractMethodData(ReflectionMethod $method)
+    public function extractMethodData(\Zend\Code\Reflection\MethodReflection $method)
     {
         $methodData = ['documentation' => $this->extractMethodDescription($method), 'interface' => []];
-        $prototypes = $method->getPrototypes();
-        /** Take the fullest interface that also includes optional parameters. */
-        /** @var \Zend\Server\Reflection\Prototype $prototype */
-        $prototype = end($prototypes);
-        /** @var \Zend\Server\Reflection\ReflectionParameter $parameter */
-        foreach ($prototype->getParameters() as $parameter) {
+        /** @var \Zend\Code\Reflection\ParameterReflection $parameter */
+        foreach ($method->getParameters() as $parameter) {
             $parameterData = [
-                'type' => $this->_typeProcessor->register($parameter->getType()),
+                'type' => $this->_typeProcessor->register($this->_typeProcessor->getParamType($parameter)),
                 'required' => !$parameter->isOptional(),
-                'documentation' => $parameter->getDescription(),
+                'documentation' => $this->_typeProcessor->getParamDescription($parameter),
             ];
             if ($parameter->isOptional()) {
                 $parameterData['default'] = $parameter->getDefaultValue();
             }
             $methodData['interface']['in']['parameters'][$parameter->getName()] = $parameterData;
         }
-        if ($prototype->getReturnType() != 'void' && $prototype->getReturnType() != 'null') {
+        $returnType = $this->_typeProcessor->getGetterReturnType($method);
+        if ($returnType != 'void' && $returnType != 'null') {
             $methodData['interface']['out']['parameters']['result'] = [
-                'type' => $this->_typeProcessor->register($prototype->getReturnType()),
-                'documentation' => $prototype->getReturnValue()->getDescription(),
+                'type' => $this->_typeProcessor->register($returnType['type']),
+                'documentation' => $returnType['description'],
                 'required' => true,
             ];
         }
@@ -117,10 +112,10 @@ public function extractMethodData(ReflectionMethod $method)
     /**
      * Retrieve method full documentation description.
      *
-     * @param ReflectionMethod $method
+     * @param \Zend\Code\Reflection\MethodReflection $method
      * @return string
      */
-    protected function extractMethodDescription(ReflectionMethod $method)
+    protected function extractMethodDescription(\Zend\Code\Reflection\MethodReflection $method)
     {
         $methodReflection = new MethodReflection(
             $method->getDeclaringClass()->getName(),

app/code/Magento/Webapi/Model/Soap/Wsdl/Generator.php

@@ -167,7 +167,9 @@ protected function _generate($requestedServices, $endPointUrl)
                 $wsdl->addSoapOperation($bindingOperation, $operationName, SOAP_1_2);
             }
         }
-        return $wsdl->toXML();
+        $dom = $wsdl->toDomDocument();
+        $dom->formatOutput = true;
+        return $dom->saveXML();
     }
 
     /**

lib/internal/Magento/Framework/Reflection/TypeProcessor.php

@@ -473,14 +473,24 @@ public function processSimpleAndAnyType($value, $type)
      *
      * @param ParameterReflection $param
      * @return string
+     * @throws \Exception
      */
     public function getParamType(ParameterReflection $param)
     {
         $type = $param->getType();
+        if ($param->getType() == 'null') {
+            throw new \Exception(sprintf(
+                    'Type declaration is incorrect for the parameter "%s" in annotation for a method in the class "%s".'
+                     . ' First declared type should not be null. E.g. string|null',
+                    $param->getName(),
+                    $param->getDeclaringClass()->getName()
+                ));
+        }
         if ($type == 'array') {
             // try to determine class, if it's array of objects
             $docBlock = $param->getDeclaringFunction()->getDocBlock();
             $pattern = "/\@param\s+([\w\\\_]+\[\])\s+\\\${$param->getName()}\n/";
+            $matches = [];
             if (preg_match($pattern, $docBlock->getContents(), $matches)) {
                 return $matches[1];
             }
@@ -489,6 +499,22 @@ public function getParamType(ParameterReflection $param)
         return $type;
     }
 
+    /**
+     * Get parameter description
+     *
+     * @param ParameterReflection $param
+     * @return mixed
+     */
+    public function getParamDescription(ParameterReflection $param)
+    {
+        $docBlock = $param->getDeclaringFunction()->getDocBlock();
+        $pattern = "/\@param\s+([\w\\\_\[\]]+)\s+(\\\${$param->getName()})(.*)\n/";
+        $matches = [];
+        if (preg_match($pattern, $docBlock->getContents(), $matches)) {
+            return $matches[3];
+        }
+    }
+
     /**
      * Find the getter method name for a property from the given class
      *