Skip to content

fix(schema): Performance improvements for better AST caching #1379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 20, 2023
Merged

fix(schema): Performance improvements for better AST caching #1379

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a449ed0
fix(schema): Performance improvements for better AST caching
klausi Nov 12, 2023
6898337
make methods private
klausi Nov 29, 2023
9b7c764
Merge branch '8.x-4.x' into perf-build-schema
klausi Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions src/Plugin/GraphQL/Schema/AlterableComposableSchema.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,6 @@ protected function getSchemaDocument(array $extensions = []) {
* @see \Drupal\graphql\Plugin\GraphQL\Schema\ComposableSchema::getSchemaDocument()
*/
protected function getExtensionDocument(array $extensions = []) {
// Only use caching of the parsed document if we aren't in development mode.
$cid = "extension:{$this->getPluginId()}";
if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
return $cache->data;
}

$extensions = array_filter(array_map(function (SchemaExtensionPluginInterface $extension) {
return $extension->getExtensionDefinition();
}, $extensions), function ($definition) {
Expand All @@ -176,10 +170,8 @@ protected function getExtensionDocument(array $extensions = []) {
AlterSchemaExtensionDataEvent::EVENT_NAME
);
$ast = !empty($extensions) ? Parser::parse(implode("\n\n", $event->getSchemaExtensionData()), ['noLocation' => TRUE]) : NULL;
if (empty($this->inDevelopment)) {
$this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
}

// No AST caching here as that will be done in getFullSchemaDocument().
return $ast;
}

Expand Down
71 changes: 51 additions & 20 deletions src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@
use Drupal\graphql\Plugin\SchemaExtensionPluginInterface;
use Drupal\graphql\Plugin\SchemaExtensionPluginManager;
use Drupal\graphql\Plugin\SchemaPluginInterface;
use GraphQL\Language\AST\DocumentNode;
use GraphQL\Language\AST\InterfaceTypeDefinitionNode;
use GraphQL\Language\AST\TypeDefinitionNode;
use GraphQL\Language\AST\UnionTypeDefinitionNode;
use GraphQL\Language\Parser;
use GraphQL\Type\Schema;
use GraphQL\Utils\BuildSchema;
use GraphQL\Utils\SchemaExtender;
use GraphQL\Utils\SchemaPrinter;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
Expand Down Expand Up @@ -117,15 +120,8 @@ public function __construct(
*/
public function getSchema(ResolverRegistryInterface $registry) {
$extensions = $this->getExtensions();
$resolver = [$registry, 'resolveType'];
$document = $this->getSchemaDocument($extensions);
$schema = BuildSchema::build($document, function ($config, TypeDefinitionNode $type) use ($resolver) {
if ($type instanceof InterfaceTypeDefinitionNode || $type instanceof UnionTypeDefinitionNode) {
$config['resolveType'] = $resolver;
}

return $config;
});
$schema = $this->buildSchema($document, $registry);

if (empty($extensions)) {
return $schema;
Expand All @@ -135,10 +131,29 @@ public function getSchema(ResolverRegistryInterface $registry) {
$extension->registerResolvers($registry);
}

if ($extendSchema = $this->getExtensionDocument($extensions)) {
return SchemaExtender::extend($schema, $extendSchema);
$extendedDocument = $this->getFullSchemaDocument($schema, $extensions);
if (empty($extendedDocument)) {
return $schema;
}

return $this->buildSchema($extendedDocument, $registry);
}

/**
* Create a GraphQL schema object from the given AST document.
*/
protected function buildSchema(DocumentNode $astDocument, ResolverRegistryInterface $registry): Schema {
$resolver = [$registry, 'resolveType'];
// Performance: only validate the schema in development mode, skip it in
// production on every request.
$options = empty($this->inDevelopment) ? ['assumeValid' => TRUE] : [];
$schema = BuildSchema::build($astDocument, function ($config, TypeDefinitionNode $type) use ($resolver) {
if ($type instanceof InterfaceTypeDefinitionNode || $type instanceof UnionTypeDefinitionNode) {
$config['resolveType'] = $resolver;
}

return $config;
}, $options);
return $schema;
}

Expand Down Expand Up @@ -185,6 +200,31 @@ protected function getSchemaDocument(array $extensions = []) {
return $ast;
}

/**
* Returns the full AST combination of parsed schema with extensions, cached.
*/
protected function getFullSchemaDocument(Schema $schema, array $extensions): ?DocumentNode {
// Only use caching of the parsed document if we aren't in development mode.
$cid = "full:{$this->getPluginId()}";
if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
return $cache->data;
}

$ast = NULL;
if ($extendAst = $this->getExtensionDocument($extensions)) {
$fullSchema = SchemaExtender::extend($schema, $extendAst);
// Performance: export the full schema as string and parse it again. That
// way we can cache the full AST.
$fullSchemaString = SchemaPrinter::doPrint($fullSchema);
$ast = Parser::parse($fullSchemaString, ['noLocation' => TRUE]);
}

if (empty($this->inDevelopment)) {
$this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
}
return $ast;
}

/**
* Retrieves the parsed AST of the schema extension definitions.
*
Expand All @@ -196,23 +236,14 @@ protected function getSchemaDocument(array $extensions = []) {
* @throws \GraphQL\Error\SyntaxError
*/
protected function getExtensionDocument(array $extensions = []) {
// Only use caching of the parsed document if we aren't in development mode.
$cid = "extension:{$this->getPluginId()}";
if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
return $cache->data;
}

$extensions = array_filter(array_map(function (SchemaExtensionPluginInterface $extension) {
return $extension->getExtensionDefinition();
}, $extensions), function ($definition) {
return !empty($definition);
});

$ast = !empty($extensions) ? Parser::parse(implode("\n\n", $extensions), ['noLocation' => TRUE]) : NULL;
if (empty($this->inDevelopment)) {
$this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
}

// No AST caching here as that will be done in getFullSchemaDocument().
return $ast;
}

Expand Down