MAGETWO-90863: Error handling responses from MBI

Author: fascinosum

app/code/Magento/Analytics/Model/Connector/Http/ConverterInterface.php

@@ -30,4 +30,9 @@ public function toBody(array $data);
      * @return string
      */
     public function getContentTypeHeader();
+
+    /**
+     * @return string
+     */
+    public function getContentMediaType(): string ;
 }

app/code/Magento/Analytics/Model/Connector/Http/JsonConverter.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Analytics\Model\Connector\Http;
 
 use Magento\Framework\Serialize\Serializer\Json;
@@ -14,9 +16,16 @@ class JsonConverter implements ConverterInterface
 {
     /**
      * Content-Type HTTP header for json.
+     * @deprecated
+     * @see CONTENT_MEDIA_TYPE
      */
     const CONTENT_TYPE_HEADER = 'Content-Type: application/json';
 
+    /**
+     * Media-Type corresponding to this converter.
+     */
+    const CONTENT_MEDIA_TYPE = 'application/json';
+
     /**
      * @var Json
      */
@@ -56,6 +65,14 @@ public function toBody(array $data)
      */
     public function getContentTypeHeader()
     {
-        return self::CONTENT_TYPE_HEADER;
+        return sprintf('Content-Type: %s', self::CONTENT_MEDIA_TYPE);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getContentMediaType(): string
+    {
+        return self::CONTENT_MEDIA_TYPE;
     }
 }

app/code/Magento/Analytics/Model/Connector/Http/ResponseResolver.php

@@ -38,10 +38,10 @@ public function __construct(ConverterInterface $converter, array $responseHandle
     public function getResult(\Zend_Http_Response $response)
     {
         $result = false;
-        preg_match('#(?:Content-Type:\s*)(\w\S+)#i', $this->converter->getContentTypeHeader(), $contentType);
-        $converterContentType = $contentType[1];
+        $converterMediaType = $this->converter->getContentMediaType();
 
-        if ($response->getBody() && is_int(strripos($response->getHeader('Content-Type'), $converterContentType))) {
+        /** Content-Type header may not only contain media-type declaration */
+        if ($response->getBody() && is_int(strripos($response->getHeader('Content-Type'), $converterMediaType))) {
             $responseBody = $this->converter->fromBody($response->getBody());
         } else {
             $responseBody = [];

app/code/Magento/Analytics/Test/Unit/Model/Connector/Http/Client/CurlTest.php

@@ -97,7 +97,6 @@ public function getTestData()
                     'version' => '1.1',
                     'body'=> ['name' => 'value'],
                     'url' => 'http://www.mystore.com',
-                    'headers' => [JsonConverter::CONTENT_TYPE_HEADER],
                     'method' => \Magento\Framework\HTTP\ZendClient::POST,
                 ]
             ]
@@ -118,7 +117,7 @@ public function testRequestSuccess(array $data)
                 $data['method'],
                 $data['url'],
                 $data['version'],
-                $data['headers'],
+                [$this->converterMock->getContentTypeHeader()],
                 json_encode($data['body'])
             );
         $this->curlAdapterMock->expects($this->once())
@@ -139,7 +138,7 @@ public function testRequestSuccess(array $data)
                 $data['method'],
                 $data['url'],
                 $data['body'],
-                $data['headers'],
+                [$this->converterMock->getContentTypeHeader()],
                 $data['version']
             )
         );
@@ -158,7 +157,7 @@ public function testRequestError(array $data)
                 $data['method'],
                 $data['url'],
                 $data['version'],
-                $data['headers'],
+                [$this->converterMock->getContentTypeHeader()],
                 json_encode($data['body'])
             );
         $this->curlAdapterMock->expects($this->once())
@@ -184,7 +183,7 @@ public function testRequestError(array $data)
                 $data['method'],
                 $data['url'],
                 $data['body'],
-                $data['headers'],
+                [$this->converterMock->getContentTypeHeader()],
                 $data['version']
             )
         );
@@ -195,14 +194,13 @@ public function testRequestError(array $data)
      */
     private function createJsonConverter()
     {
-        $converterMock = $this->getMockBuilder(ConverterInterface::class)
-            ->getMockForAbstractClass();
+        $converterMock = $this->getMockBuilder(JsonConverter::class)
+            ->setMethodsExcept(['getContentTypeHeader'])
+            ->disableOriginalConstructor()
+            ->getMock();
         $converterMock->expects($this->any())->method('toBody')->willReturnCallback(function ($value) {
             return json_encode($value);
         });
-        $converterMock->expects($this->any())
-            ->method('getContentTypeHeader')
-            ->willReturn(JsonConverter::CONTENT_TYPE_HEADER);
         return $converterMock;
     }
 }

app/code/Magento/Analytics/Test/Unit/Model/Connector/Http/JsonConverterTest.php

@@ -39,7 +39,10 @@ protected function setUp()
 
     public function testConverterContainsHeader()
     {
-        $this->assertEquals(JsonConverter::CONTENT_TYPE_HEADER, $this->converter->getContentTypeHeader());
+        $this->assertEquals(
+            'Content-Type: ' . JsonConverter::CONTENT_MEDIA_TYPE,
+            $this->converter->getContentTypeHeader()
+        );
     }
 
     /**

app/code/Magento/Analytics/Test/Unit/Model/Connector/Http/ResponseResolverTest.php

@@ -73,8 +73,8 @@ public function testGetResultHandleResponseSuccess()
         $expectedBody = ['test' => 'testValue'];
         $response = new \Zend_Http_Response(201, ['Content-Type' => 'application/json'], json_encode($expectedBody));
         $this->converterMock
-            ->method('getContentTypeHeader')
-            ->willReturn('Content-Type: application/json');
+            ->method('getContentMediaType')
+            ->willReturn('application/json');
 
         $this->successResponseHandlerMock
             ->expects($this->once())
@@ -99,8 +99,8 @@ public function testGetResultHandleResponseUnexpectedContentType()
         $expectedBody = 'testString';
         $response = new \Zend_Http_Response(201, ['Content-Type' => 'plain/text'], $expectedBody);
         $this->converterMock
-            ->method('getContentTypeHeader')
-            ->willReturn('Content-Type: application/json');
+            ->method('getContentMediaType')
+            ->willReturn('application/json');
         $this->converterMock
             ->expects($this->never())
             ->method('fromBody');

app/code/Magento/Analytics/Test/Unit/Model/Connector/SignUpCommandTest.php

@@ -163,7 +163,6 @@ private function getTestData()
             'url' => 'http://www.mystore.com',
             'access-token' => 'thisisaccesstoken',
             'integration-token' => 'thisisintegrationtoken',
-            'headers' => [JsonConverter::CONTENT_TYPE_HEADER],
             'method' => \Magento\Framework\HTTP\ZendClient::POST,
             'body'=> ['token' => 'thisisintegrationtoken','url' => 'http://www.mystore.com'],
         ];