fix: update REST transport error details

src/ApiException.php

@@ -115,6 +115,30 @@ public static function createFromApiResponse(
         );
     }
 
+    /**
+     * For REST-based responses, the metadata does not need to be decoded.
+     *
+     * @param string $basicMessage
+     * @param int $rpcCode
+     * @param array|null $metadata
+     * @param \Exception $previous
+     * @return ApiException
+     */
+    public static function createFromRestApiResponse(
+        $basicMessage,
+        $rpcCode,
+        array $metadata = null,
+        \Exception $previous = null
+    ) {
+        return self::create(
+            $basicMessage,
+            $rpcCode,
+            $metadata,
+            is_null($metadata) ? [] : $metadata,
+            $previous
+        );
+    }
+
     /**
      * Construct an ApiException with a useful message, including decoded metadata.
      *
@@ -184,7 +208,7 @@ public static function createFromRequestException(RequestException $ex, $isStrea
                 ? ApiStatus::rpcCodeFromStatus($error['status'])
                 : $ex->getCode();
             $metadata = isset($error['details']) ? $error['details'] : null;
-            return static::createFromApiResponse($basicMessage, $code, $metadata);
+            return static::createFromRestApiResponse($basicMessage, $code, $metadata);
         }
         // Use the RPC code instead of the HTTP Status Code.
         $code = ApiStatus::rpcCodeFromHttpStatusCode($res->getStatusCode());

tests/Tests/Unit/ApiExceptionTest.php

@@ -184,7 +184,8 @@ public function getMetadata()
     /**
      * @dataProvider getMetadata
      */
-    public function testCreateFromApiResponse($metadata, $metadataArray) {
+    public function testCreateFromApiResponse($metadata, $metadataArray)
+    {
         $basicMessage = 'testWithMetadata';
         $code = Code::OK;
         $status = 'OK';
@@ -203,10 +204,106 @@ public function testCreateFromApiResponse($metadata, $metadataArray) {
         $this->assertSame($metadata, $apiException->getMetadata());
     }
 
+    public function getRestMetadata()
+    {
+        $unknownBinData = [
+            [
+                '@type' => 'unknown-bin',
+                'data' => '<Unknown Binary Data>'
+            ]
+        ];
+        $asciiData = [
+            [
+                '@type' => 'ascii',
+                'data' => 'ascii-data'
+            ]
+        ];
+        $retryInfoData = [
+            [
+                '@type' => 'google.rpc.retryinfo-bin',
+                'retryDelay' => [
+                    'seconds' => 1,
+                    'nanos' => 2,
+                ],
+            ]
+        ];
+        $allKnownTypesData = [
+            [
+                '@type' => 'google.rpc.retryinfo-bin',
+            ],
+            [
+                '@type' => 'google.rpc.debuginfo-bin',
+                "stackEntries" => [],
+                "detail" => ""
+            ],
+            [
+                '@type' => 'google.rpc.quotafailure-bin',
+                'violations' => [],
+            ],
+            [
+                '@type' => 'google.rpc.badrequest-bin',
+                'fieldViolations' => []
+            ],
+            [
+                '@type' => 'google.rpc.requestinfo-bin',
+                'requestId' => '',
+                'servingData' => '',
+            ],
+            [
+                '@type' => 'google.rpc.resourceinfo-bin',
+                'resourceType' => '',
+                'resourceName' => '',
+                'owner' => '',
+                'description' => '',
+            ],
+            [
+                '@type' => 'google.rpc.help-bin',
+                'links' => [],
+            ],
+            [
+                '@type' => 'google.rpc.localizedmessage-bin',
+                'locale' => '',
+                'message' => '',
+            ],
+        ];
+
+        return [
+            [
+                [[]],
+                [[null]],
+                [$unknownBinData],
+                [$asciiData],
+                [$allKnownTypesData]
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider getRestMetadata
+     */
+    public function testCreateFromRestApiResponse($metadata)
+    {
+        $basicMessage = 'testWithRestMetadata';
+        $code = Code::OK;
+        $status = 'OK';
+
+        $apiException = ApiException::createFromRestApiResponse($basicMessage, $code, $metadata);
+
+        $expectedMessage = json_encode([
+            'message' => $basicMessage,
+            'code' => $code,
+            'status' => $status,
+            'details' => $metadata
+        ], JSON_PRETTY_PRINT);
+
+        $this->assertSame($expectedMessage, $apiException->getMessage());
+    }
+
     /**
      * @dataProvider getRpcStatusData
      */
-    public function testCreateFromRpcStatus($status, $expectedApiException) {
+    public function testCreateFromRpcStatus($status, $expectedApiException)
+    {
         $actualApiException = ApiException::createFromRpcStatus($status);
         $this->assertEquals($expectedApiException, $actualApiException);
     }
@@ -238,7 +335,11 @@ public function getRpcStatusData()
         return [
             [
                 $status,
-                new ApiException($expectedMessage, Code::OK, 'OK', [
+                new ApiException(
+                    $expectedMessage,
+                    Code::OK,
+                    'OK',
+                    [
                         'metadata' => $status->getDetails(),
                         'basicMessage' => $status->getMessage(),
                     ]
@@ -252,13 +353,12 @@ public function getRpcStatusData()
      */
     public function testCreateFromRequestException($re, $stream, $expectedCode)
     {
-
         $ae = ApiException::createFromRequestException($re, $stream);
         $this->assertSame($expectedCode, $ae->getCode());
     }
 
     public function buildRequestExceptions()
-    { 
+    {
         $error = [
             'error' => [
                 'status' => 'NOT_FOUND',

tests/Tests/Unit/Transport/RestTransportTest.php

@@ -40,7 +40,6 @@
 use Google\ApiCore\Testing\MockRequest;
 use Google\ApiCore\Testing\MockResponse;
 use Google\ApiCore\Transport\RestTransport;
-use Google\Auth\FetchAuthTokenInterface;
 use Google\Auth\HttpHandler\HttpHandlerFactory;
 use Google\Protobuf\Any;
 use Google\Rpc\ErrorInfo;
@@ -426,7 +425,9 @@ public function testAudienceOption()
         $credentialsWrapper = $this->prophesize(CredentialsWrapper::class);
         $credentialsWrapper->getAuthorizationHeaderCallback('an-audience')
             ->shouldBeCalledOnce()
-            ->willReturn(function() { return []; });
+            ->willReturn(function () {
+                return [];
+            });
 
         $options = [
             'audience' => 'an-audience',
@@ -465,7 +466,9 @@ public function testNonArrayAuthorizationHeaderThrowsException()
         $credentialsWrapper = $this->prophesize(CredentialsWrapper::class);
         $credentialsWrapper->getAuthorizationHeaderCallback(null)
             ->shouldBeCalledOnce()
-            ->willReturn(function() { return ''; });
+            ->willReturn(function () {
+                return '';
+            });
 
         $options = [
             'credentialsWrapper' => $credentialsWrapper->reveal(),