generate a SchemaCompiledEvent when Type files are generated

[mathroc]

fixes #718

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Documented?	no
Fixed tickets	#718
License	MIT

usage exemple:

<?php declare(strict_types=1);

namespace App\Infra\GraphQL\CacheWarmer;

use GraphQL\Utils\SchemaPrinter;
use Overblog\GraphQLBundle\Event\SchemaCompiledEvent;
use Overblog\GraphQLBundle\Request\Executor as RequestExecutor;
use Overblog\GraphQLBundle\Request\ParserInterface;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;

class GraphQLSchemaDumperSubscriber implements EventSubscriberInterface
{
    private RequestExecutor $requestExecutor;

    private string $projectDir;

    private bool $schemaWasRecompiled = false;

    public function __construct(RequestExecutor $requestExecutor, string $projectDir)
    {
        $this->requestExecutor = $requestExecutor;
        $this->projectDir = $projectDir;
    }

    public function onSchemaCompiled(): void
    {
        $this->schemaWasRecompiled = true;
    }

    public function dumpSchema(): void
    {
        if (!$this->schemaWasRecompiled) {
            return;
        }

        file_put_contents(
            "{$this->projectDir}/schema.graphql",
            SchemaPrinter::doPrint($this->requestExecutor->getSchema()),
        ) or die("failed to save {$this->projectDir}/schema.graphql");

        $result = $this->requestExecutor
            ->execute(null, [
                ParserInterface::PARAM_QUERY => <<<GQL
                    query {
                        __schema {
                            types {
                                kind
                                name
                                possibleTypes {
                                    name
                                }
                            }
                        }
                    }
                GQL,
                ParserInterface::PARAM_VARIABLES => [],
            ])
            ->toArray();

        file_put_contents(
            "{$this->projectDir}/schema-fragments.json",
            \json_encode($result, \JSON_PRETTY_PRINT),
        ) or die("failed to save {$this->projectDir}/schema-fragments.json");
    }

    public static function getSubscribedEvents()
    {
        return [
            SchemaCompiledEvent::class => "onSchemaCompiled",
            RequestEvent::class => "dumpSchema",
            ConsoleCommandEvent::class => "dumpSchema",
        ];
    }
}

[Vincz]

Looks good to me, but I think it could be interesting to do a little more.
Maybe we could also add a preCompile event with the ability to modify the $configs before the final compilation.
And we could also add a few parameters to the SchemaCompiledEvent.
@murtukov what do you think about it ?
Also, a little piece of doc would be great (maybe with your use-case a an example).

[mcg-web]

PreCompile will lead to bad behaviors since we also use configs in CompilePass, that is not something we want. This will make maintainers work much more difficult. Generator type is just a helper if you want to do something that it doesn't support, you can workaround with custom GraphQL types classes.

[mcg-web]

Thanks @mathroc this look good to me but can you provide some documentation and a simple test that verify that the event is well trigger at the right moment, no need of creating a listener, this could be done with simple mock I think.

[mathroc]

I’ve added a test and some documentation. I noticed something when writing the test, should I only dispatch the event in write mode ? if so, where should I tell the TypeGenerator to write the files in the tests ?

[murtukov]

@mathroc I already did a huge refactoring of the TypeGenerator class (a further refactoring still needed tho), which changed the constructor signature. I added info about it in the UPGRADE-1.0.md. Your PR changes the signature again, could you please also update the UPGRADE-1.0.md?

[mathroc]

@murtukov it’s done 👍

It also reminds me that I had to comment out calls to TypeGenerator::addUseStatement, TypeGenerator::addImplement & TypeGenerator::setExpressionLanguage in order to try my changes on master. Should I open an issue to add that to the UPGRADE document?