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.

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

Allow schema caching per server when using a common base schema #1224

Open
wants to merge 11 commits into
base: 8.x-4.x
Choose a base branch
from
Open

Allow schema caching per server when using a common base schema #1224

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c7a38e0
demonstrate problem
Jul 22, 2021
d99470d
pass server ID to plugin
Jul 23, 2021
bed2473
satisfy phpstan
Jul 23, 2021
5ae3f29
satisfy phpstan #2
Jul 23, 2021
b7d1f4c
satisfy phpcs
Jul 23, 2021
0368ccf
Update src/Plugin/SchemaPluginInterface.php
darvanen Aug 5, 2021
8d1a98d
Update src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php
darvanen Aug 5, 2021
112fcf8
Merge branch '8.x-4.x' into 1223-schema-caching
darvanen Oct 6, 2021
48c0b44
Merge branch '8.x-4.x' into 1223-schema-caching
darvanen Jun 8, 2022
88c8e6c
Merge branch '8.x-4.x' of github.com:darvanen/graphql into 1223-schem…
Sep 3, 2024
2ec7f03
Add server id to cache key in getFullSchemaDocument
Sep 3, 2024
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
1 change: 1 addition & 0 deletions src/Entity/Server.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,7 @@ public function configuration() {

/** @var \Drupal\graphql\Plugin\SchemaPluginInterface $plugin */
$plugin = $manager->createInstance($schema);
$plugin->setServerId($this->name);
if ($plugin instanceof ConfigurableInterface && $config = $this->get('schema_configuration')) {
$plugin->setConfiguration($config[$schema] ?? []);
}
Expand Down
1 change: 1 addition & 0 deletions src/GraphQL/Execution/Executor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,7 @@ protected function cachePrefix() {
ksort($extensions);

$hash = hash('sha256', serialize([
'server' => $this->context->getServer()->name,
'query' => DocumentSerializer::serializeDocument($this->document),
'variables' => $variables,
'extensions' => $extensions,
Expand Down
18 changes: 16 additions & 2 deletions src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,13 @@ abstract class SdlSchemaPluginBase extends PluginBase implements SchemaPluginInt
*/
protected $inDevelopment;

/**
* The ID of the server using this plugin.
*
* @var string $serverId
darvanen marked this conversation as resolved.
Show resolved Hide resolved
*/
protected $serverId;

/**
* The schema extension plugin manager.
*
Expand Down Expand Up @@ -108,6 +115,13 @@ public function __construct(
$this->moduleHandler = $moduleHandler;
}

/**
* {@inheritdoc}
*/
public function setServerId(string $serverId): void {
$this->serverId = $serverId;
}

Comment on lines +121 to +127
Copy link

Choose a reason for hiding this comment

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

Instead of using a setter to configure the server ID, I'm wondering if it wouldn't be better to make the plugin configurable by implementing ConfigurableInterface. In fact, both schema plugins we ship are already configurable (but the base class SdlSchemaPluginBase isn't, and changing this would be a B/C break).

/**
* {@inheritdoc}
*
Expand Down Expand Up @@ -162,7 +176,7 @@ protected function getExtensions() {
*/
protected function getSchemaDocument(array $extensions = []) {
// Only use caching of the parsed document if we aren't in development mode.
$cid = "schema:{$this->getPluginId()}";
$cid = "server:{$this->serverId}:schema:{$this->getPluginId()}";
Comment on lines -182 to +196
Copy link

Choose a reason for hiding this comment

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

This assumes that the setter has always been called, but it might not have been, and $this->serverId might be NULL.

Probably using a setter is not the best approach. Since the server ID is required for the plugin to work in the current it is essential that the setter is always called. The setter is not part of the SchemaPluginInterface and it also should not be, since it is not essential for all schema plugins, only for the ones that use caching.

Maybe we can add a server_name key to the standard plugin configuration and check that this is populated in the plugin constructor? That would also enable us to gracefully introduce this change. We can emit a deprecation warning if it is missing.

if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
return $cache->data;
}
Expand Down Expand Up @@ -194,7 +208,7 @@ protected function getSchemaDocument(array $extensions = []) {
*/
protected function getExtensionDocument(array $extensions = []) {
// Only use caching of the parsed document if we aren't in development mode.
$cid = "extension:{$this->getPluginId()}";
$cid = "server:{$this->serverId}:extension:{$this->getPluginId()}";
if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
return $cache->data;
}
Expand Down
8 changes: 8 additions & 0 deletions src/Plugin/SchemaPluginInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@
*/
interface SchemaPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface {

/**
* Set the serverID, required for cache id generation.
*
* @param string
darvanen marked this conversation as resolved.
Show resolved Hide resolved
* The machine name of the server using this plugin.
*/
public function setServerId(string $serverId): void;

/**
* Retrieves the schema.
*
Expand Down