Skip to content
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.

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

Introduce extended schema plugin. #792

Merged
merged 4 commits into from
Jun 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions src/Plugin/GraphQL/Schema/SdlExtendedSchemaPluginBase.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?php

namespace Drupal\graphql\Plugin\GraphQL\Schema;

use Drupal\Core\Cache\CacheBackendInterface;
use GraphQL\Language\Parser;
use GraphQL\Utils\SchemaExtender;

/**
* Allows to extend the GraphQL schema.
*
* When GraphQL schema is distributed across multiple files it might be useful
* to allow extension of certain types. This schema plugin allows that. See an
* example of code to extend the schema with using webonyx/graphql-php library:
* https://github.com/webonyx/graphql-php/issues/180#issuecomment-444407411
*/
abstract class SdlExtendedSchemaPluginBase extends SdlSchemaPluginBase {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should have a class comment why we need this and what it does.


/**
* Retrieves the parsed AST of the extended schema definition.
*
* @return \GraphQL\Language\AST\DocumentNode
* The parsed extended schema document.
*/
protected function getExtendedSchemaDocument() {
// Only use caching of the parsed document if we aren't in development mode.
if (empty($this->inDevelopment) && $cache = $this->astCache->get($this->getPluginId())) {
return $cache->data;
}

$ast = Parser::parse($this->getExtendedSchemaDefinition());
if (!empty($this->inDevelopment)) {
$this->astCache->set($this->getPluginId(), $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
}

return $ast;
}

/**
* {@inheritdoc}
*/
public function getSchema() {
return SchemaExtender::extend(parent::getSchema(), $this->getExtendedSchemaDocument());
}

/**
* Retrieves the raw extended schema definition string.
*
* @return string
* The extended schema definition.
*/
abstract protected function getExtendedSchemaDefinition();

}
2 changes: 1 addition & 1 deletion src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ protected function getTypeResolver(TypeDefinitionNode $type) {
* The parsed schema document.
*/
protected function getSchemaDocument() {
// Only use caching of the parsed document if aren't in development mode.
// Only use caching of the parsed document if we aren't in development mode.
if (empty($this->inDevelopment) && $cache = $this->astCache->get($this->getPluginId())) {
return $cache->data;
}
Expand Down