Add a clear task

.travis.yml

@@ -0,0 +1,4 @@
+version: ~> 1.0
+
+import:
+  - silverstripe/silverstripe-travis-shared:config/provision/standard-jobs-range.yml

README.md

@@ -22,6 +22,8 @@ This module adds an implementation of [graphiql](https://github.com/graphql/grap
 
 This is because GraphQL 4 has its own `DevelopmentAdmin` controller.
 
+The GraphQL v4 version of the module allows you to clear your schema by calling the `/dev/graphql/clear` task.
+
 ## Security
 
 By default, the tool has the same restrictions as other development tools like `dev/build`:
@@ -101,4 +103,3 @@ SilverStripe\Control\Director:
  CDN to download the latest distribution and drop it into this repository. Be sure
  to update the comment at the top of the `bundle.js` file to track the URL it was
  downloaded from.
-

_config/config.yml

@@ -21,6 +21,10 @@ SilverStripe\GraphQL\Dev\DevelopmentAdmin:
       controller: 'SilverStripe\GraphQLDevTools\Controller'
       links:
         ide: Run the GraphQL IDE
+    clear:
+      controller: SilverStripe\GraphQLDevTools\Clear
+      links:
+        clear: Clear the GraphQL schema
 
 ---
 Name: graphql3-devtool-routes

composer.json

@@ -2,18 +2,23 @@
   "name": "silverstripe/graphql-devtools",
   "description": "Tools to help developers building new applications on SilverStripe’s GraphQL API",
   "type": "silverstripe-vendormodule",
+  "license": "BSD-3-Clause",
   "require": {
-    "silverstripe/graphql": "*"
+    "silverstripe/graphql": "^3 || ^4",
+    "symfony/finder": "^4 || ^5",
+    "symfony/filesystem": "^4 || ^5"
+    },
+  "require-dev": {
+    "phpunit/phpunit": "^9.5",
+    "squizlabs/php_codesniffer": "^3.0"
   },
   "autoload": {
     "psr-4": {
-      "SilverStripe\\GraphQLDevTools\\": "src/"
+      "SilverStripe\\GraphQLDevTools\\": "src/",
+      "SilverStripe\\GraphQLDevTools\\Tests\\": "tests/"
     }
   },
   "extra": {
-    "branch-alias": {
-	  "dev-master": "1.x-dev"
-    },
     "expose": [
         "client/"
     ]

phpcs.xml.dist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="SilverStripe">
+    <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <exclude-pattern>*/\.graphql-generated/*</exclude-pattern>
+
+    <!-- base rules are PSR-2 -->
+    <rule ref="PSR2" >
+        <!-- Current exclusions -->
+        <exclude name="PSR1.Methods.CamelCapsMethodName" />
+        <exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
+        <exclude name="PSR2.Classes.PropertyDeclaration" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration" /> <!-- causes php notice while linting -->
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenercase" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenerdefault" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.TerminatingComment" />
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore" />
+        <exclude name="Squiz.Scope.MethodScope" />
+        <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
+        <exclude name="Generic.Files.LineLength.TooLong" />
+        <exclude name="PEAR.Functions.ValidDefaultValue.NotAtEnd" />
+    </rule>
+
+</ruleset>
+

phpunit.xml.dist

@@ -0,0 +1,18 @@
+<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
+
+    <testsuites>
+        <testsuite name="Default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist addUncoveredFilesFromWhitelist="true">
+            <directory suffix=".php">src/</directory>
+            <exclude>
+                <directory suffix=".php">tests/</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+
+</phpunit>

src/Clear.php

@@ -0,0 +1,49 @@
+<?php
+namespace SilverStripe\GraphQLDevTools;
+
+use Psr\Log\LoggerInterface;
+use SilverStripe\Control\Controller;
+use SilverStripe\Control\HTTPRequest;
+use SilverStripe\Core\Injector\Injector;
+use SilverStripe\GraphQL\Schema\Storage\CodeGenerationStore;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+
+class Clear extends Controller
+{
+    private static $url_handlers = [
+        '' => 'clear',
+    ];
+
+    private static $allowed_actions = [
+        'clear',
+    ];
+
+    public function clear(HTTPRequest $request): void
+    {
+        $logger = Injector::inst()->get(LoggerInterface::class . '.graphql-build');
+        $dirName = CodeGenerationStore::config()->get('dirName');
+        $expectedPath = BASE_PATH . DIRECTORY_SEPARATOR . $dirName;
+        $fs = new Filesystem();
+
+        $finder = new Finder();
+        // Make finder not recursive
+        $finder->depth('== 0');
+
+        $logger->info('Clearing GraphQL code generation directory');
+        if ($fs->exists($expectedPath)) {
+            $logger->info('Directory has been found');
+            if ($finder->in($expectedPath)->hasResults()) {
+                foreach ($finder as $file) {
+                    $logger->info('Removing ' . $file->getFilename());
+                    $fs->remove($file->getRealPath());
+                }
+                $logger->info('Directory now empty');
+            } else {
+                $logger->info('Directory is already empty.');
+            }
+        } else {
+            $logger->info('Directory was not found. There is nothing to clear');
+        }
+    }
+}

src/Controller.php

@@ -117,7 +117,6 @@ protected function findAvailableRoutes($schemas = []): array
                 }
             } catch (InjectorNotFoundException $ex) {
             }
-
         }
         return $routes;
     }

tests/ClearTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace SilverStripe\GraphQLDevTools\Tests;
+
+use SilverStripe\Dev\FunctionalTest;
+use SilverStripe\GraphQL\Schema\Storage\CodeGenerationStore;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+use SilverStripe\GraphQL\Schema\Logger;
+use SilverStripe\GraphQL\Schema\Schema;
+
+class ClearTest extends FunctionalTest
+{
+
+    private $originalDirName;
+    private $dirName = 'test-graphql-generated';
+    private $absDirName = BASE_PATH . DIRECTORY_SEPARATOR . 'test-graphql-generated';
+
+    protected $usesDatabase = true;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        if (!class_exists(Schema::class)) {
+            $this->markTestSkipped('GraphQL 4 test ' . __CLASS__ . ' skipped');
+            return;
+        }
+
+        $this->originalDirName = CodeGenerationStore::config()->get('dirName');
+        Logger::singleton()->setVerbosity(Logger::EMERGENCY);
+        CodeGenerationStore::config()->set('dirName', $this->dirName);
+
+        $fs = new Filesystem();
+        $fs->mkdir($this->absDirName);
+    }
+
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+        CodeGenerationStore::config()->set('dirName', $this->originalDirName);
+        $fs = new Filesystem();
+        if ($fs->exists($this->absDirName)) {
+            $fs->remove($this->absDirName);
+        }
+    }
+
+    public function testClear()
+    {
+        $fs = new Filesystem();
+        $finder = new Finder();
+        $finder->in($this->absDirName);
+
+        $this->assertTrue($fs->exists($this->absDirName), 'Test should begin with a fake code gen folder');
+
+        $this->get('dev/graphql/clear');
+        $this->assertFalse($finder->hasResults(), 'GraphQL clear should not break on an empty folder');
+
+        $fs->mkdir($this->absDirName . DIRECTORY_SEPARATOR . 'default');
+        $this->assertTrue($finder->hasResults(), 'A fake schema folder should have been created');
+
+        $this->get('dev/graphql/clear');
+        $this->assertFalse($finder->hasResults(), 'GraphQL clear should have removed the fake schema folder');
+
+        $fs->remove($this->absDirName);
+        $this->get('dev/graphql/clear');
+        $this->assertFalse($fs->exists($this->absDirName), 'GraphQL clear should not break on a non-existent folder');
+    }
+}