Feature/cli table output (#386)

Refactor to support automatic CLI table output for all Buddy plugins not just Show
manticoresoftware · Dec 12, 2024 · 04dd8cd · 04dd8cd
1 parent b02bf18
commit 04dd8cd
Show file tree

Hide file tree

Showing 28 changed files with 201 additions and 299 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/src/Handler.php b/src/Handler.php
@@ -41,10 +41,9 @@ public function run(): Task {
 				throw new RuntimeException('Failed to prepare query');
 			}
 
-			$queryResult = $manticoreClient
-				->sendRequest($query, $payload->path)
-				->getResult();
-			return TaskResult::raw($queryResult);
+			$resp = $manticoreClient
+				->sendRequest($query, $payload->path);
+			return TaskResult::fromResponse($resp);
 		};
 
 		return Task::create(

diff --git a/src/Lib/QueryProcessor.php b/src/Lib/QueryProcessor.php
@@ -224,6 +224,7 @@ public static function detectPluginPrefixFromRequest(Request $request): string {
 			foreach ($plugins as $plugin) {
 				$pluginPrefix = $prefix . ucfirst(Strings::camelcaseBySeparator($plugin['short'], '-'));
 				/** @var BasePayload<T> $pluginPayloadClass */
+
 				$pluginPayloadClass = "$pluginPrefix\\Payload";
 				$pluginPayloadClass::setParser(static::$sqlQueryParser);
 				$hasMatch = $pluginPayloadClass::hasMatch($request);

diff --git a/src/Network/EventHandler.php b/src/Network/EventHandler.php
@@ -16,6 +16,7 @@
 use Manticoresearch\Buddy\Core\Error\GenericError;
 use Manticoresearch\Buddy\Core\Error\InvalidNetworkRequestError;
 use Manticoresearch\Buddy\Core\ManticoreSearch\RequestFormat;
+use Manticoresearch\Buddy\Core\Network\OutputFormat;
 use Manticoresearch\Buddy\Core\Network\Request;
 use Manticoresearch\Buddy\Core\Network\Response;
 use Manticoresearch\Buddy\Core\Task\Column;
@@ -87,6 +88,8 @@ static function () use ($requestId, $body, $channel, $startTime) {
 	 */
 	public static function process(string $id, string $payload): Response {
 		try {
+			/** @var int $startTime */
+			$startTime = hrtime(true);
 			$request = Request::fromString($payload, $id);
 			$handler = QueryProcessor::process($request)->run();
 
@@ -101,7 +104,18 @@ public static function process(string $id, string $payload): Response {
 				$result = $handler->getResult();
 			}
 
-			$response = Response::fromResult($result, $request->format);
+			// Check if this is a cli and we need to activate Table Formatter
+			$outputFormat = $request->getOutputFormat();
+			$message = match ($outputFormat) {
+				// TODO: Maybe later we can use meta for time, but not now cuz no time for non select
+				OutputFormat::Table => $result->getTableFormatted($startTime),
+				default => $result->getStruct(),
+			};
+			$response = Response::fromMessageAndMeta(
+				$message,
+				$result->getMeta(),
+				$request->format,
+			);
 		} catch (Throwable $e) {
 			if (isset($request)) {
 				/** @var string $originalError */

diff --git a/src/Plugin/Alias/Handler.php b/src/Plugin/Alias/Handler.php
@@ -41,10 +41,9 @@ public function run(): Task {
 				throw new RuntimeException('Failed to prepare query');
 			}
 
-			$queryResult = $manticoreClient
-				->sendRequest($query, $payload->path)
-				->getResult();
-			return TaskResult::raw($queryResult);
+			$queryResponse = $manticoreClient
+				->sendRequest($query, $payload->path);
+			return TaskResult::fromResponse($queryResponse);
 		};
 
 		return Task::create(

diff --git a/src/Plugin/AlterDistributedTable/Handler.php b/src/Plugin/AlterDistributedTable/Handler.php
@@ -96,12 +96,12 @@ private static function createTable(string $tableName, array $options, Client $m
 			}
 		}
 
-		$request = $manticoreClient->sendRequest($sql);
-		if ($request->hasError()) {
-			throw ManticoreSearchResponseError::create((string)$request->getError());
+		$response = $manticoreClient->sendRequest($sql);
+		if ($response->hasError()) {
+			throw ManticoreSearchResponseError::create((string)$response->getError());
 		}
 
-		return TaskResult::raw($request->getResult());
+		return TaskResult::fromResponse($response);
 	}
 
 	/**

diff --git a/src/Plugin/AlterRenameTable/Handler.php b/src/Plugin/AlterRenameTable/Handler.php
@@ -14,6 +14,7 @@
 use Manticoresearch\Buddy\Core\Error\ManticoreSearchClientError;
 use Manticoresearch\Buddy\Core\Error\ManticoreSearchResponseError;
 use Manticoresearch\Buddy\Core\ManticoreSearch\Client;
+use Manticoresearch\Buddy\Core\ManticoreSearch\Response;
 use Manticoresearch\Buddy\Core\Plugin\BaseHandlerWithClient;
 use Manticoresearch\Buddy\Core\Task\Task;
 use Manticoresearch\Buddy\Core\Task\TaskResult;
@@ -60,11 +61,11 @@ public function run(): Task {
 			}
 			self::createTableLike($payload->sourceTableName, $payload->destinationTableName, $client);
 
-			$result = self::attachTable($payload->sourceTableName, $payload->destinationTableName, $client);
+			$resp = self::attachTable($payload->sourceTableName, $payload->destinationTableName, $client);
 
 			self::dropTable($payload->sourceTableName, $client);
 
-			return TaskResult::raw($result);
+			return TaskResult::fromResponse($resp);
 		};
 
 		return Task::create(
@@ -103,15 +104,15 @@ private static function createTableLike(
 	 * @param string $sourceTableName
 	 * @param string $destinationTableName
 	 * @param Client $client
-	 * @return mixed
+	 * @return Response
 	 * @throws GenericError
 	 * @throws ManticoreSearchClientError
 	 */
 	private static function attachTable(
 		string $sourceTableName,
 		string $destinationTableName,
 		Client $client
-	): mixed {
+	): Response {
 
 		$sql = /** @lang ManticoreSearch */
 			"ATTACH TABLE $sourceTableName TO TABLE $destinationTableName";
@@ -122,7 +123,7 @@ private static function attachTable(
 				'Reason: ' . $result->getError()
 			);
 		}
-		return $result->getResult();
+		return $result;
 	}
 
 

diff --git a/src/Plugin/CliTable/Handler.php b/src/Plugin/CliTable/Handler.php
@@ -12,16 +12,15 @@
 namespace Manticoresearch\Buddy\Base\Plugin\CliTable;
 
 use Manticoresearch\Buddy\Core\ManticoreSearch\Client;
-use Manticoresearch\Buddy\Core\Plugin\BaseHandlerWithTableFormatter;
-use Manticoresearch\Buddy\Core\Plugin\TableFormatter;
+use Manticoresearch\Buddy\Core\Plugin\BaseHandlerWithClient;
 use Manticoresearch\Buddy\Core\Task\Task;
 use Manticoresearch\Buddy\Core\Task\TaskResult;
 use RuntimeException;
 
 /**
  * This is the class to return response to the '/cli' endpoint in table format
  */
-final class Handler extends BaseHandlerWithTableFormatter {
+final class Handler extends BaseHandlerWithClient {
 
 	/**
 	 *  Initialize the executor
@@ -44,42 +43,18 @@ public function run(): Task {
 		$taskFn = static function (
 			Payload $payload,
 			Client $manticoreClient,
-			?TableFormatter $tableFormatter
 		): TaskResult {
-			$time0 = hrtime(true);
 			$resp = $manticoreClient->sendRequest(
 				$payload->query,
 				$payload->path,
 				disableAgentHeader: true
 			);
-			$data = null;
-			$total = -1;
-			$respBody = $resp->getBody();
-			$result = (array)json_decode($respBody, true);
-			if ($tableFormatter === null
-			 || (!isset($result['error']) && (!isset($result[0]) || !is_array($result[0])))
-			) {
-				return TaskResult::raw($result);
-			}
-			// Convert JSON response from Manticore to table format
-			if (isset($result['error'])) {
-				/** @var string $errorMsg */
-				$errorMsg = $result['error'];
-				if ($errorMsg !== '') {
-					return TaskResult::raw($tableFormatter->getTable($time0, $data, $total, $errorMsg));
-				}
-			}
-
-			if (isset($result[0]) && is_array($result[0])) {
-				static::processResultInfo($result[0], $data, $total);
-			}
-
-			return TaskResult::raw($tableFormatter->getTable($time0, $data, $total));
+			return TaskResult::fromResponse($resp);
 		};
 
 		return Task::create(
 			$taskFn,
-			[$this->payload, $this->manticoreClient, $this->tableFormatter]
+			[$this->payload, $this->manticoreClient]
 		)->run();
 	}