Fix cache max age. (#671)

Author: fubhy

graphql.services.yml

@@ -47,6 +47,7 @@ services:
       - '@cache_contexts_manager'
       - '@plugin.manager.graphql.schema'
       - '@cache.graphql.results'
+      - '@request_stack'
 
   # Query map provider using the composite pattern.
   graphql.query_provider:

src/GraphQL/Execution/QueryProcessor.php

@@ -2,13 +2,11 @@
 
 namespace Drupal\graphql\GraphQL\Execution;
 
-use Drupal\Core\Cache\CacheableDependencyInterface;
+use Drupal\Core\Cache\Cache;
 use Drupal\Core\Cache\CacheableMetadata;
 use Drupal\Core\Cache\CacheBackendInterface;
 use Drupal\Core\Cache\Context\CacheContextsManager;
-use Drupal\Core\Session\AccountProxyInterface;
 use Drupal\graphql\Plugin\SchemaPluginManager;
-use Drupal\graphql\GraphQL\QueryProvider\QueryProviderInterface;
 use Drupal\graphql\GraphQL\Cache\CacheableRequestError;
 use GraphQL\Error\Error;
 use GraphQL\Error\FormattedError;
@@ -26,9 +24,9 @@
 use GraphQL\Utils\AST;
 use GraphQL\Utils\TypeInfo;
 use GraphQL\Utils\Utils;
-use GraphQL\Validator\DocumentValidator;
 use GraphQL\Validator\Rules\AbstractValidationRule;
 use GraphQL\Validator\ValidationContext;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 // TODO: Refactor this and clean it up.
 class QueryProcessor {
@@ -54,6 +52,13 @@ class QueryProcessor {
    */
   protected $contextsManager;
 
+  /**
+   * The request stack.
+   *
+   * @var \Symfony\Component\HttpFoundation\RequestStack
+   */
+  protected $requestStack;
+
   /**
    * Processor constructor.
    *
@@ -63,15 +68,19 @@ class QueryProcessor {
    *   The schema plugin manager.
    * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
    *   The cache backend for caching query results.
+   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
+   *   The request stack.
    */
   public function __construct(
     CacheContextsManager $contextsManager,
     SchemaPluginManager $pluginManager,
-    CacheBackendInterface $cacheBackend
+    CacheBackendInterface $cacheBackend,
+    RequestStack $requestStack
   ) {
     $this->contextsManager = $contextsManager;
     $this->pluginManager = $pluginManager;
     $this->cacheBackend = $cacheBackend;
+    $this->requestStack = $requestStack;
   }
 
   /**
@@ -223,24 +232,27 @@ protected function executeOperation(PromiseAdapter $adapter, ServerConfig $confi
    * @return \GraphQL\Executor\Promise\Promise|mixed
    */
   protected function executeCacheableOperation(PromiseAdapter $adapter, ServerConfig $config, OperationParams $params, DocumentNode $document) {
-    $contextCacheId = 'ccid:' . $this->cacheIdentifier($params, $document, new CacheableMetadata());
-
-    if (!$config->getDebug() && ($contextCache = $this->cacheBackend->get($contextCacheId)) && $contexts = $contextCache->data) {
-      $cacheId = 'cid:' . $this->cacheIdentifier($params, $document, (new CacheableMetadata())->addCacheContexts($contexts));
-      if (($cache = $this->cacheBackend->get($cacheId)) && $result = $cache->data) {
-        return $adapter->createFulfilled($result);
+    $contextCacheId = 'ccid:' . $this->cacheIdentifier($params, $document);
+    if (!$config->getDebug() && $contextCache = $this->cacheBackend->get($contextCacheId)) {
+      $contexts = $contextCache->data ?: [];
+      $cid = 'cid:' . $this->cacheIdentifier($params, $document, $contexts);
+      if ($cache = $this->cacheBackend->get($cid)) {
+        return $adapter->createFulfilled($cache->data);
       }
     }
 
     $result = $this->doExecuteOperation($adapter, $config, $params, $document);
-
     return $result->then(function (QueryResult $result) use ($contextCacheId, $params, $document) {
       // Write this query into the cache if it is cacheable.
       if ($result->getCacheMaxAge() !== 0) {
-        $cacheId = 'cid:' . $this->cacheIdentifier($params, $document, (new CacheableMetadata())->addCacheContexts($result->getCacheContexts()));
-        $this->cacheBackend->set($contextCacheId, $result->getCacheContexts(), $result->getCacheMaxAge(), $result->getCacheTags());
-        $this->cacheBackend->set($cacheId, $result, $result->getCacheMaxAge(), $result->getCacheTags());
+        $contexts = $result->getCacheContexts();
+        $expire = $this->maxAgeToExpire($result->getCacheMaxAge());
+        $tags = $result->getCacheTags();
+        $cid = 'cid:' . $this->cacheIdentifier($params, $document, $contexts);
+        $this->cacheBackend->set($contextCacheId, $contexts, $expire, $tags);
+        $this->cacheBackend->set($cid, $result, $expire, $tags);
       }
+
       return $result;
     });
   }
@@ -290,7 +302,6 @@ protected function doExecuteOperation(PromiseAdapter $adapter, ServerConfig $con
     );
 
     return $promise->then(function (ExecutionResult $result) use ($context) {
-
       $metadata = (new CacheableMetadata())
         ->addCacheContexts($this->filterCacheContexts($context->getCacheContexts()))
         ->addCacheTags($context->getCacheTags())
@@ -451,13 +462,13 @@ protected function sanitizeRecursive(array $item) {
   /**
    * @param \GraphQL\Server\OperationParams $params
    * @param \GraphQL\Language\AST\DocumentNode $document
-   * @param \Drupal\Core\Cache\CacheableMetadata $metadata
+   * @param array $contexts
    *
    * @return string
    */
-  protected function cacheIdentifier(OperationParams $params, DocumentNode $document, CacheableMetadata $metadata) {
+  protected function cacheIdentifier(OperationParams $params, DocumentNode $document, array $contexts = []) {
     // Ignore language contexts since they are handled by graphql internally.
-    $contexts = $this->filterCacheContexts($metadata->getCacheContexts());
+    $contexts = $this->filterCacheContexts($contexts);
     $keys = $this->contextsManager->convertTokensToKeys($contexts)->getKeys();
 
     // Sorting the variables will cause fewer cache vectors.
@@ -489,4 +500,19 @@ protected function filterCacheContexts(array $contexts) {
       return strpos($context, 'languages:') !== 0;
     });
   }
+
+  /**
+   * Maps a cache max age value to an "expire" value for the Cache API.
+   *
+   * @param int $maxAge
+   *
+   * @return int
+   *   A corresponding "expire" value.
+   *
+   * @see \Drupal\Core\Cache\CacheBackendInterface::set()
+   */
+  protected function maxAgeToExpire($maxAge) {
+    $time = $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME');
+    return ($maxAge === Cache::PERMANENT) ? Cache::PERMANENT : (int) $time + $maxAge;
+  }
 }