Add gql cache context to every response.

Author: fubhy

src/Annotation/GraphQLAnnotationBase.php

@@ -85,7 +85,7 @@ public function __construct($values) {
    *
    * @var array
    */
-  public $response_cache_contexts = ['gql', 'user'];
+  public $response_cache_contexts = ['user'];
 
   /**
    * The cache tags for caching theresponse.

src/Cache/Context/QueryCacheContext.php

@@ -57,21 +57,20 @@ public function getContext() {
     $hash = '';
     if ($request->attributes->has('query')) {
       $hash = $this->contextCache[$request] = $this->getHash(
-        $request->attributes->get('id') ?: '',
+        $request->attributes->get('schema') ?: '',
         $request->attributes->get('query') ?: '',
-        $request->attributes->get('variables') ?: [],
-        $request->attributes->get('version') ?: ''
+        $request->attributes->get('variables') ?: []
       );
     }
     else if ($request->attributes->has('queries')) {
       $queries = $request->attributes->get('queries');
+      $schema = $request->attributes->get('schema') ?: '';
 
-      return hash('sha256', json_encode(array_map(function($item) {
+      return hash('sha256', json_encode(array_map(function($item) use ($schema) {
         return $this->getHash(
-          !empty($item['id']) ? $item['id'] : '',
+          $schema,
           !empty($item['query']) ? $item['query'] : '',
-          !empty($item['variables']) ? $item['variables'] : [],
-          !empty($item['version']) ? $item['version'] : NULL
+          !empty($item['variables']) ? $item['variables'] : []
         );
       }, $queries)));
     }
@@ -85,27 +84,24 @@ public function getContext() {
    * Sorts the variables by their key and eliminates whitespace from the query
    * to enable better reuse of the cache entries.
    *
-   * @param string $id
-   *   The query id in case of a persisted query.
+   * @param string $schema
+   *   The schema id.
    * @param string $query
    *   The graphql query string.
    * @param array $variables
    *   The graphql query variables.
-   * @param string $version
-   *   The query map version in case of a persisted query.
    *
    * @return string
    *   The hashed string containing.
    */
-  protected function getHash($id = '', $query = '', array $variables = [], $version = '') {
+  protected function getHash($schema = '', $query = '', array $variables = []) {
     $query = preg_replace('/\s{2,}/', ' ', $query);
     ksort($variables);
 
     return hash('sha256', json_encode([
-      'id' => $id,
+      'schema' => $schema,
       'query' => $query,
       'variables' => $variables,
-      'version' => $version,
     ]));
   }
 

src/Plugin/GraphQL/Schemas/SchemaPluginBase.php

@@ -69,8 +69,12 @@ protected function constructCacheMetadata(SchemaBuilderInterface $schemaBuilder)
     // schema config and all included types/fields/etc.
     $this->responseMetadata = new CacheableMetadata();
     $this->responseMetadata->setCacheMaxAge(Cache::PERMANENT);
+    $this->responseMetadata->addCacheTags(['graphql_response', "graphql_response:{$this->getPluginId()}"]);
+    $this->responseMetadata->addCacheContexts(['gql']);
+
     $this->schemaMetadata = new CacheableMetadata();
     $this->schemaMetadata->setCacheMaxAge(Cache::PERMANENT);
+    $this->schemaMetadata->addCacheTags(['graphql_schema', "graphql_schema:{$this->getPluginId()}"]);
 
     foreach (TypeCollector::collectTypes($this) as $type) {
       if ($type instanceof TypeSystemPluginInterface) {

src/Plugin/GraphQL/Traits/CacheablePluginTrait.php

@@ -42,7 +42,7 @@ public function getSchemaCacheMetadata() {
   public function getResponseCacheMetadata() {
     $definition = $this->getPluginDefinition();
     $metadata = new CacheableMetadata();
-    $metadata->addCacheContexts(isset($definition['response_cache_contexts']) ? $definition['response_cache_contexts'] : ['gql', 'user']);
+    $metadata->addCacheContexts(isset($definition['response_cache_contexts']) ? $definition['response_cache_contexts'] : ['user']);
     $metadata->addCacheTags(isset($definition['response_cache_tags']) ? $definition['response_cache_tags'] : []);
     $metadata->setCacheMaxAge(isset($definition['response_cache_max_age']) ? $definition['response_cache_max_age'] : CacheBackendInterface::CACHE_PERMANENT);
     return $metadata;

tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/A.php

@@ -18,7 +18,7 @@
  *   type = "Int",
  *   parents = {"Root", "Object"},
  *   response_cache_tags = {"a", "graphql_response"},
- *   response_cache_contexts = {"graphql_test", "gql", "user"}
+ *   response_cache_contexts = {"graphql_test", "user"}
  * )
  */
 class A extends FieldPluginBase implements ContainerFactoryPluginInterface {

tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/B.php

@@ -12,7 +12,7 @@
  *   type = "Int",
  *   parents = {"Root", "Object"},
  *   response_cache_tags = {"b", "graphql_response"},
- *   response_cache_contexts = {"graphql_test", "gql", "user"}
+ *   response_cache_contexts = {"graphql_test", "user"}
  * )
  */
 class B extends A {

tests/modules/graphql_cache_test/src/Plugin/GraphQL/Fields/C.php

@@ -12,7 +12,7 @@
  *   type = "Int",
  *   parents = {"Root"},
  *   response_cache_tags = {"c", "graphql_response"},
- *   response_cache_contexts = {"graphql_test_root_field", "gql", "user"}
+ *   response_cache_contexts = {"graphql_test_root_field", "user"}
  * )
  */
 class C extends A {

tests/modules/graphql_test/src/Plugin/GraphQL/Schemas/TestSchema.php

@@ -31,8 +31,7 @@ protected function constructCacheMetadata(SchemaBuilderInterface $schemaBuilder)
     parent::constructCacheMetadata($schemaBuilder);
 
     $metadata = new CacheableMetadata();
-    $metadata->addCacheContexts(['gql', 'user']);
-    $metadata->addCacheTags(['graphql_response']);
+    $metadata->addCacheContexts(['user']);
 
     $this->responseMetadata->addCacheableDependency($metadata);
   }