Access "response" of CoreAdmion queries

Author: thomascorthals

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Solarium\QueryType\Extract\Query::setStreamType()
 
+### Fixed
+- Solarium\QueryType\Server\CoreAdmin\Result\Result::getResponse() always returns a Solarium\Core\Client\Response object, even if the response data contains a field named `"response"`
+- Solarium\QueryType\Server\CoreAdmin\Result\Result::$response publicly exposes the `"response"` field from the response data
+
 ### Changed
  - Added `void` return type to `Solarium\Core\Plugin\PluginInterface::initPlugin()` method signature
  - Added `void` return type to `Solarium\Core\Plugin\PluginInterface::deinitPlugin()` method signature

src/QueryType/Server/CoreAdmin/ResponseParser.php

@@ -38,6 +38,20 @@ public function parse(ResultInterface $result): array
         $data = $this->parseInitFailures($data, $result);
         $data = $this->parseStatus($data, $result);
 
+        if (isset($data['response'])) {
+            /*
+             * The protected property Result::$response always holds the
+             * Response object for the Query and is accessible through
+             * Result::getResponse().
+             *
+             * We store this value as a different property and revert this in
+             * Result::__get() to make it accessible as if it were the public
+             * property Result::$response.
+             */
+            $data['_original_response'] = $data['response'];
+            unset($data['response']);
+        }
+
         return $data;
     }
 

src/QueryType/Server/CoreAdmin/Result/Result.php

@@ -132,4 +132,25 @@ public function getStatusResultByCoreName(string $coreName): ?StatusResult
     {
         return $this->statusResults[$coreName] ?? null;
     }
+
+    /**
+     * Magic method for getting inaccessible or non-existent properties.
+     *
+     * @see \Solarium\QueryType\Server\CoreAdmin\ResponseParser
+     *
+     * @param string $name
+     *
+     * @return mixed|null
+     */
+    public function __get(string $name)
+    {
+        /*
+         * Revert the workaround from ResponseParser::parse() to make
+         * Result::$response publicly accessible without conflicting with
+         * the actual protected property of that name.
+         */
+        if ('response' === $name && isset($this->_original_response)) {
+            return $this->_original_response;
+        }
+    }
 }

tests/QueryType/Server/CoreAdmin/ResponseParserTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Solarium\Tests\QueryType\Server\CoreAdmin;
+
+use PHPUnit\Framework\TestCase;
+use Solarium\Core\Client\Response;
+use Solarium\QueryType\Server\CoreAdmin\Query\Query;
+use Solarium\QueryType\Server\CoreAdmin\ResponseParser;
+use Solarium\QueryType\Server\CoreAdmin\Result\Result;
+
+class ResponseParserTest extends TestCase
+{
+    public function testParseWithResponseProperty()
+    {
+        $query = new Query();
+        $action = $query->createSplit();
+        $query->setAction($action);
+
+        $data = [
+            'response' => [
+                'timing' => [
+                    'time' => 318,
+                    'doSplit' => [
+                        'time' => 318,
+                    ],
+                    'findDocSetsPerLeaf' => [
+                        'time' => 0,
+                    ],
+                    'addIndexes' => [
+                        'time' => 21,
+                    ],
+                    'subIWCommit' => [
+                        'time' => 294,
+                    ],
+                ],
+            ],
+        ];
+
+        $response = new Response(json_encode($data), ['HTTP/1.1 200 OK']);
+        $result = new Result($query, $response);
+        $parser = new ResponseParser();
+        $parsed = $parser->parse($result);
+
+        $this->assertSame($data['response'], $parsed['_original_response']);
+        $this->assertArrayNotHasKey('response', $parsed);
+    }
+}

tests/QueryType/Server/CoreAdmin/Result/ResultTest.php

@@ -0,0 +1,82 @@
+<?php
+
+namespace Solarium\Tests\QueryType\Server\CoreAdmin\Result;
+
+use PHPUnit\Framework\TestCase;
+use Solarium\QueryType\Server\CoreAdmin\Result\Result;
+
+class ResultTest extends TestCase
+{
+    /**
+     * @var Result
+     */
+    protected $result;
+
+    public function setUp(): void
+    {
+        $this->result = new CoreAdminDummy();
+    }
+
+    public function testGetWasSuccessful()
+    {
+        $this->assertTrue($this->result->getWasSuccessful());
+    }
+
+    public function testGetStatusMessage()
+    {
+        $this->assertSame('OK', $this->result->getStatusMessage());
+    }
+
+    /**
+     * @see Solarium\QueryType\Server\CoreAdmin\ResponseParser::parse()
+     * @see Solarium\QueryType\Server\CoreAdmin\Result\Result::__get()
+     */
+    public function testAccessResponseAsProperty()
+    {
+        $data = [
+            '_original_response' => [
+                'timing' => [
+                    'time' => 318.0,
+                    'doSplit' => [
+                        'time' => 318.0,
+                    ],
+                    'findDocSetsPerLeaf' => [
+                        'time' => 0.0,
+                    ],
+                    'addIndexes' => [
+                        'time' => 21.0,
+                    ],
+                    'subIWCommit' => [
+                        'time' => 294.0,
+                    ],
+                ],
+            ],
+        ];
+
+        $this->result->mapData($data);
+        $this->assertSame($data['_original_response'], $this->result->response);
+    }
+
+    public function testAccessOtherProperty()
+    {
+        $this->result->mapData(['foo' => 'bar']);
+
+        $this->assertSame('bar', $this->result->foo);
+    }
+}
+
+class CoreAdminDummy extends Result
+{
+    protected $parsed = true;
+
+    public function __construct()
+    {
+        $this->wasSuccessful = true;
+        $this->statusMessage = 'OK';
+    }
+
+    public function mapData(array $mapData): void
+    {
+        parent::mapData($mapData);
+    }
+}