From e7e982a68f1d2eb4721eedc7461d6c202c83aba8 Mon Sep 17 00:00:00 2001
From: Guy Sartorelli <guy.sartorelli@gmail.com>
Date: Wed, 28 Aug 2024 14:11:33 +1200
Subject: [PATCH] API Update API to reflect changes to CLI interaction

---
 _config/dev.yml                               |  17 +-
 _config/logging.yml                           |   2 +-
 src/Dev/Build.php                             | 100 +++++++-----
 src/Dev/DevelopmentAdmin.php                  | 146 ------------------
 ...uildExtension.php => DbBuildExtension.php} |  13 +-
 .../TestSessionEnvironmentExtension.php       |   7 +
 src/Schema/Logger.php                         |  60 +++++--
 7 files changed, 130 insertions(+), 215 deletions(-)
 delete mode 100644 src/Dev/DevelopmentAdmin.php
 rename src/Extensions/{DevBuildExtension.php => DbBuildExtension.php} (80%)

diff --git a/_config/dev.yml b/_config/dev.yml
index c19ab4e1..3ce2d860 100644
--- a/_config/dev.yml
+++ b/_config/dev.yml
@@ -1,19 +1,10 @@
 ---
 Name: graphql-dev
 ---
-SilverStripe\ORM\DatabaseAdmin:
+SilverStripe\Dev\Command\DbBuild:
   extensions:
-    - SilverStripe\GraphQL\Extensions\DevBuildExtension
+    - SilverStripe\GraphQL\Extensions\DbBuildExtension
 
 SilverStripe\Dev\DevelopmentAdmin:
-  registered_controllers:
-    graphql:
-      controller: SilverStripe\GraphQL\Dev\DevelopmentAdmin
-      links:
-        graphql: 'List GraphQL development tools'
-SilverStripe\GraphQL\Dev\DevelopmentAdmin:
-  registered_controllers:
-    build:
-      controller: SilverStripe\GraphQL\Dev\Build
-      links:
-        build: Build the GraphQL schema
+  commands:
+    'graphql/build': 'SilverStripe\GraphQL\Dev\Build'
diff --git a/_config/logging.yml b/_config/logging.yml
index e19a72a8..0de75516 100644
--- a/_config/logging.yml
+++ b/_config/logging.yml
@@ -4,7 +4,7 @@ after: '#logging'
 ---
 
 SilverStripe\Core\Injector\Injector:
-  # Omits the HTTPOutputHandler from the logger so errors won't appear in output
+  # Omits the ErrorOutputHandler from the logger so errors won't appear in output
   Psr\Log\LoggerInterface.graphql-quiet:
     type: singleton
     class: Monolog\Logger
diff --git a/src/Dev/Build.php b/src/Dev/Build.php
index 97eb2b07..e2e1b9a6 100644
--- a/src/Dev/Build.php
+++ b/src/Dev/Build.php
@@ -4,11 +4,10 @@
 namespace SilverStripe\GraphQL\Dev;
 
 use Psr\Log\LoggerInterface;
-use SilverStripe\Control\Controller;
-use SilverStripe\Control\Director;
-use SilverStripe\Control\HTTPRequest;
 use SilverStripe\Core\Injector\Injector;
-use SilverStripe\Dev\DebugView;
+use SilverStripe\Dev\Command\DevCommand;
+use SilverStripe\Dev\DevelopmentAdmin;
+use SilverStripe\HybridExecution\HybridOutput;
 use SilverStripe\GraphQL\Schema\DataObject\FieldAccessor;
 use SilverStripe\GraphQL\Schema\Exception\EmptySchemaException;
 use SilverStripe\GraphQL\Schema\Exception\SchemaBuilderException;
@@ -18,38 +17,44 @@
 use SilverStripe\GraphQL\Schema\SchemaBuilder;
 use SilverStripe\GraphQL\Schema\Storage\CodeGenerationStore;
 use SilverStripe\ORM\Connect\NullDatabaseException;
+use SilverStripe\Security\PermissionProvider;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 
-class Build extends Controller
+class Build extends DevCommand implements PermissionProvider
 {
-    private static $url_handlers = [
-        '' => 'build'
-    ];
+    protected static string $commandName = 'graphql:build';
+
+    protected static string $description = 'Build the GraphQL schema(s)';
 
-    private static $allowed_actions = [
-        'build'
+    private static array $permissions_for_browser_execution = [
+        'CAN_DEV_GRAPHQL',
     ];
 
-    /**
-     * @throws SchemaBuilderException
-     * @throws SchemaNotFoundException
-     */
-    public function build(HTTPRequest $request): void
+    public function getTitle(): string
     {
-        $isBrowser = !Director::is_cli();
-        if ($isBrowser) {
-            $renderer = DebugView::create();
-            echo $renderer->renderHeader();
-            echo $renderer->renderInfo("GraphQL Schema Builder", Director::absoluteBaseURL());
-            echo "<div class=\"build\">";
-        }
-        $clear = true;
-
-        $this->buildSchema($request->getVar('schema'), $clear);
+        return 'GraphQL Schema Builder';
+    }
 
-        if ($isBrowser) {
-            echo "</div>";
-            echo $renderer->renderFooter();
+    protected function execute(InputInterface $input, HybridOutput $output): int
+    {
+        $originalLogger = Injector::inst()->get(LoggerInterface::class . '.graphql-build');
+        try {
+            $logger = Logger::singleton();
+            $logger->setOutput($output);
+            Injector::inst()->registerService($logger, LoggerInterface::class . '.graphql-build');
+            $this->buildSchema($input->getOption('schema'), true, $output);
+        } finally {
+            // Restore default logger back to its starting state
+            Injector::inst()->registerService($originalLogger, LoggerInterface::class . '.graphql-build');
         }
+        return Command::SUCCESS;
+    }
+
+    protected function getHeading(): string
+    {
+        return '';
     }
 
     /**
@@ -97,15 +102,15 @@ public function buildSchema(string $key = null, bool $clear = true): void
                         break;
                     }
                 }
-                $logger->warning("
-                    Your schema configuration requires access to the database. This can happen
+                $logger->warning(
+                    "Your schema configuration requires access to the database. This can happen
                     when you add fields that require type introspection (i.e. custom getters).
                     It is recommended that you specify an explicit type when adding custom getters
-                    to your schema.");
+                    to your schema."
+                );
                 if ($candidate) {
                     $logger->warning(sprintf(
-                        "
-                    This most likely happened when you tried to add the field '%s' to '%s'",
+                        "This most likely happened when you tried to add the field '%s' to '%s'",
                         $candidate['args'][1],
                         get_class($candidate['args'][0])
                     ));
@@ -114,9 +119,32 @@ public function buildSchema(string $key = null, bool $clear = true): void
                 throw $e;
             }
 
-            $logger->info(
-                Benchmark::end('build-schema-' . $key, 'Built schema in %sms.')
-            );
+            $logger->info(Benchmark::end('build-schema-' . $key, 'Built schema in %sms.'));
         }
     }
+
+    public function getOptions(): array
+    {
+        return [
+            new InputOption(
+                'schema',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'The name of the schema to be built. If not passed, all schemas will be built',
+                suggestedValues: array_keys(Schema::config()->get('schemas') ?? [])
+            )
+        ];
+    }
+
+    public function providePermissions(): array
+    {
+        return [
+            'CAN_DEV_GRAPHQL' => [
+                'name' => _t(__CLASS__ . '.CAN_DEV_GRAPHQL_DESCRIPTION', 'Can view and execute /dev/graphql'),
+                'help' => _t(__CLASS__ . '.CAN_DEV_GRAPHQL_HELP', 'Can view and execute GraphQL development tools (/dev/graphql).'),
+                'category' => DevelopmentAdmin::permissionsCategory(),
+                'sort' => 80
+            ],
+        ];
+    }
 }
diff --git a/src/Dev/DevelopmentAdmin.php b/src/Dev/DevelopmentAdmin.php
deleted file mode 100644
index d1e29cc0..00000000
--- a/src/Dev/DevelopmentAdmin.php
+++ /dev/null
@@ -1,146 +0,0 @@
-<?php
-
-
-namespace SilverStripe\GraphQL\Dev;
-
-use SilverStripe\Control\Controller;
-use SilverStripe\Control\Director;
-use SilverStripe\Control\HTTPRequest;
-use SilverStripe\Core\Config\Config;
-use SilverStripe\Dev\DebugView;
-use SilverStripe\Dev\DevelopmentAdmin as RootDevelopmentAdmin;
-use SilverStripe\Security\Permission;
-use SilverStripe\Security\PermissionProvider;
-use SilverStripe\Security\Security;
-use Exception;
-use Psr\Log\LoggerInterface;
-use SilverStripe\Core\Injector\Injector;
-use SilverStripe\GraphQL\Schema\Logger;
-
-class DevelopmentAdmin extends Controller implements PermissionProvider
-{
-    private static $allowed_actions = [
-        'runRegisteredController'
-    ];
-
-    private static $url_handlers = [
-        '' => 'index',
-        '$Action' => 'runRegisteredController',
-    ];
-
-    private static $init_permissions = [
-        'ADMIN',
-        'ALL_DEV_ADMIN',
-        'CAN_DEV_GRAPHQL',
-    ];
-
-    protected function init()
-    {
-        parent::init();
-
-        if (RootDevelopmentAdmin::config()->get('deny_non_cli') && !Director::is_cli()) {
-            return $this->httpError(404);
-        }
-
-        if (!$this->canInit()) {
-            Security::permissionFailure($this);
-        }
-
-        // Define custom logger
-        $logger = Logger::singleton();
-        Injector::inst()->registerService($logger, LoggerInterface::class . '.graphql-build');
-    }
-
-    public function index(HTTPRequest $request)
-    {
-        // Web mode
-        if (!Director::is_cli()) {
-            $renderer = DebugView::create();
-            echo $renderer->renderHeader();
-            echo $renderer->renderInfo("Silverstripe CMS GraphQL Tools", Director::absoluteBaseURL());
-            $base = Director::baseURL();
-
-            echo '<div class="options"><ul>';
-            $evenOdd = "odd";
-            foreach (DevelopmentAdmin::get_links() as $action => $description) {
-                echo "<li class=\"$evenOdd\"><a href=\"{$base}dev/graphql/$action\"><b>/dev/graphql/$action:</b>"
-                    . " $description</a></li>\n";
-                $evenOdd = ($evenOdd == "odd") ? "even" : "odd";
-            }
-
-            echo $renderer->renderFooter();
-
-            // CLI mode
-        } else {
-            echo "SILVERSTRIPE CMS GRAPHQL TOOLS\n--------------------------\n\n";
-            echo "You can execute any of the following commands:\n\n";
-            foreach (DevelopmentAdmin::get_links() as $action => $description) {
-                echo "  sake dev/graphql/$action: $description\n";
-            }
-            echo "\n\n";
-        }
-    }
-
-    public function runRegisteredController(HTTPRequest $request)
-    {
-        $controllerClass = null;
-
-        $baseUrlPart = $request->param('Action');
-        $reg = Config::inst()->get(static::class, 'registered_controllers');
-        if (isset($reg[$baseUrlPart])) {
-            $controllerClass = $reg[$baseUrlPart]['controller'];
-        }
-
-        if ($controllerClass && class_exists($controllerClass ?? '')) {
-            return $controllerClass::create();
-        }
-
-        $msg = 'Error: no controller registered in ' . __CLASS__ . ' for: ' . $request->param('Action');
-        if (Director::is_cli()) {
-            throw new Exception($msg);
-        } else {
-            $this->httpError(404, $msg);
-        }
-    }
-
-    public function canInit(): bool
-    {
-        return (
-            Director::isDev()
-            // We need to ensure that DevelopmentAdminTest can simulate permission failures when running
-            // "dev/tasks" from CLI.
-            || (Director::is_cli() && RootDevelopmentAdmin::config()->get('allow_all_cli'))
-            || Permission::check(static::config()->get('init_permissions'))
-        );
-    }
-
-    public function providePermissions(): array
-    {
-        return [
-            'CAN_DEV_GRAPHQL' => [
-                'name' => _t(__CLASS__ . '.CAN_DEV_GRAPHQL_DESCRIPTION', 'Can view and execute /dev/graphql'),
-                'help' => _t(__CLASS__ . '.CAN_DEV_GRAPHQL_HELP', 'Can view and execute GraphQL development tools (/dev/graphql).'),
-                'category' => RootDevelopmentAdmin::permissionsCategory(),
-                'sort' => 80
-            ],
-        ];
-    }
-
-    /**
-     * @return array of url => description
-     */
-    protected static function get_links(): array
-    {
-        $links = [];
-
-        $reg = Config::inst()->get(static::class, 'registered_controllers');
-        foreach ($reg as $registeredController) {
-            if (isset($registeredController['links'])) {
-                foreach ($registeredController['links'] as $url => $desc) {
-                    $links[$url] = $desc;
-                }
-            }
-        }
-        return $links;
-    }
-}
diff --git a/src/Extensions/DevBuildExtension.php b/src/Extensions/DbBuildExtension.php
similarity index 80%
rename from src/Extensions/DevBuildExtension.php
rename to src/Extensions/DbBuildExtension.php
index acc6ae07..9d905dfc 100644
--- a/src/Extensions/DevBuildExtension.php
+++ b/src/Extensions/DbBuildExtension.php
@@ -5,16 +5,17 @@
 
 use Psr\Log\LoggerInterface;
 use SilverStripe\Core\Config\Configurable;
+use SilverStripe\Core\Extension;
 use SilverStripe\Core\Injector\Injector;
+use SilverStripe\Dev\Command\DbBuild;
+use SilverStripe\HybridExecution\HybridOutput;
 use SilverStripe\GraphQL\Dev\Build;
 use SilverStripe\GraphQL\Schema\Logger;
-use SilverStripe\ORM\DatabaseAdmin;
-use SilverStripe\Core\Extension;
 
 /**
- * @extends Extension<DatabaseAdmin>
+ * @extends Extension<DbBuild>
  */
-class DevBuildExtension extends Extension
+class DbBuildExtension extends Extension
 {
     use Configurable;
 
@@ -23,7 +24,7 @@ class DevBuildExtension extends Extension
      */
     private static bool $enabled = true;
 
-    protected function onAfterBuild(): void
+    protected function onAfterBuild(HybridOutput $output): void
     {
         if (!static::config()->get('enabled')) {
             return;
@@ -35,7 +36,7 @@ protected function onAfterBuild(): void
         try {
             // Define custom logger
             $logger = Logger::singleton();
-            $logger->setVerbosity(Logger::INFO);
+            $logger->setOutput($output);
             Injector::inst()->registerService($logger, LoggerInterface::class . '.graphql-build');
 
             Build::singleton()->buildSchema();
diff --git a/src/Extensions/TestSessionEnvironmentExtension.php b/src/Extensions/TestSessionEnvironmentExtension.php
index 47081895..4206eb0f 100644
--- a/src/Extensions/TestSessionEnvironmentExtension.php
+++ b/src/Extensions/TestSessionEnvironmentExtension.php
@@ -2,12 +2,14 @@
 
 namespace SilverStripe\GraphQL\Extensions;
 
+use SilverStripe\Control\Director;
 use SilverStripe\Core\Extension;
 use SilverStripe\GraphQL\Schema\Logger;
 use SilverStripe\GraphQL\Schema\Schema;
 use SilverStripe\GraphQL\Schema\SchemaBuilder;
 use SilverStripe\GraphQL\Schema\Exception\EmptySchemaException;
 use SilverStripe\GraphQL\Dev\Benchmark;
+use SilverStripe\HybridExecution\HybridOutput;
 use SilverStripe\TestSession\TestSessionEnvironment;
 
 /**
@@ -24,7 +26,12 @@ class TestSessionEnvironmentExtension extends Extension
      */
     protected function onAfterStartTestSession(): void
     {
+        $output = HybridOutput::create(
+            Director::is_cli() ? HybridOutput::FORMAT_ANSI : HybridOutput::FORMAT_HTML,
+            HybridOutput::VERBOSITY_QUIET
+        );
         $logger = Logger::singleton();
+        $logger->setOutput($output);
         $keys = array_keys(Schema::config()->get('schemas') ?? []);
         $keys = array_filter($keys ?? [], function ($key) {
             return $key !== Schema::ALL;
diff --git a/src/Schema/Logger.php b/src/Schema/Logger.php
index cfb49a6d..3285ad1f 100644
--- a/src/Schema/Logger.php
+++ b/src/Schema/Logger.php
@@ -1,11 +1,11 @@
 <?php
 
-
 namespace SilverStripe\GraphQL\Schema;
 
 use Psr\Log\LoggerInterface;
 use SilverStripe\Control\Director;
 use SilverStripe\Core\Injector\Injectable;
+use SilverStripe\HybridExecution\HybridOutput;
 use Stringable;
 
 class Logger implements LoggerInterface
@@ -33,6 +33,13 @@ class Logger implements LoggerInterface
 
     private int $level = Logger::INFO;
 
+    private ?HybridOutput $output = null;
+
+    public function setOutput(?HybridOutput $output): void
+    {
+        $this->output = $output;
+    }
+
     public function setVerbosity(int $level): Logger
     {
         $this->level = $level;
@@ -118,18 +125,45 @@ public function warning(Stringable|string $message, array $context = []): void
 
     public function output(string $msg, ?string $prefix = null, ?string $colour = null): void
     {
-        $cli = Director::is_cli();
-        $formatted = sprintf(
-            '%s%s%s%s',
-            $colour && $cli ? $colour :'',
-            $prefix ? '[' . $prefix . ']: ' : '',
-            $colour && $cli ? Logger::RESET : '',
-            $msg
-        );
-        if ($cli) {
-            fwrite(STDOUT, $formatted . PHP_EOL);
-        } else {
-            echo $formatted . "<br>";
+        $prefix = $prefix ? '[' . $prefix . ']: ' : '';
+        $this->output?->writeln($this->colouriseText($prefix, $colour) . $msg);
+        if (!$this->output) {
+            $cli = Director::is_cli();
+            $formatted = sprintf(
+                '%s%s%s%s',
+                $colour && $cli ? $colour :'',
+                $prefix,
+                $colour && $cli ? Logger::RESET : '',
+                $msg
+            );
+            if ($cli) {
+                fwrite(STDOUT, $formatted . PHP_EOL);
+            } else {
+                echo $formatted . "<br>";
+            }
+        }
+    }
+
+    private function colouriseText(string $msg, ?string $colour): string
+    {
+        switch ($colour) {
+            case Logger::BLACK:
+                return "<fg=black>$msg</>";
+            case Logger::RED:
+                return "<fg=red>$msg</>";
+            case Logger::GREEN:
+                return "<fg=green>$msg</>";
+            case Logger::YELLOW:
+                return "<fg=yellow>$msg</>";
+            case Logger::BLUE:
+                return "<fg=blue>$msg</>";
+            case Logger::MAGENTA:
+                return "<fg=magenta>$msg</>";
+            case Logger::CYAN:
+                return "<fg=cyan>$msg</>";
+            case Logger::WHITE:
+                return "<fg=white;bg=black>$msg</>";
         }
+        return $msg;
     }
 }