-
Notifications
You must be signed in to change notification settings - Fork 201
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
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 { | ||
|
||
/** | ||
* 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(); | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.