Merge branch '8.x-4.x' into fix-apq-with-page-caches

Author: klausi

.github/workflows/testing.yml

@@ -14,26 +14,31 @@ jobs:
       fail-fast: false
       matrix:
         php-versions: ['7.3', '7.4', '8.0', '8.1']
+        # Keep testing Drupal 9 untill 6 months after it got unsupported, so
+        # untill May 1st 2024.
         drupal-core: ['9.5.x']
         phpstan: ['0']
         include:
           # Extra runs to also test on latest Drupal 10.
           - php-versions: '8.1'
-            drupal-core: '10.1.x'
+            drupal-core: '10.2.x'
             phpstan: '0'
-          # We only need to run PHPStan once on the latest PHP version.
           - php-versions: '8.2'
-            drupal-core: '10.1.x'
+            drupal-core: '10.2.x'
+            phpstan: '0'
+          # We only need to run PHPStan once on the latest PHP version.
+          - php-versions: '8.3'
+            drupal-core: '10.2.x'
             phpstan: '1'
     steps:
       - name: Checkout Drupal core
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: drupal/drupal
           ref: ${{ matrix.drupal-core }}
 
       - name: Checkout graphql module
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           path: modules/graphql
 
@@ -48,7 +53,7 @@ jobs:
           key: cache-v1
 
       - name: Cache PHP extensions
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.extcache.outputs.dir }}
           key: ${{ steps.extcache.outputs.key }}
@@ -68,7 +73,7 @@ jobs:
         run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ${{ steps.composercache.outputs.dir }}
           # Use composer.json for key, if composer.lock is not committed.
@@ -110,7 +115,7 @@ jobs:
             jangregor/phpstan-prophecy:^1.0.0 \
             phpstan/phpstan-phpunit:^1.0.0 \
             phpstan/extension-installer:^1.0
-          composer --no-interaction --no-progress --with-all-dependencies upgrade drupal/coder:8.3.21
+          composer --no-interaction --no-progress --with-all-dependencies upgrade drupal/coder:8.3.23
 
       - name: Run PHPStan
         if: ${{ matrix.phpstan == '1' }}

examples/graphql_composable/src/Wrappers/Response/ArticleResponse.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql_composable\Wrappers\Response;
 

src/Event/AlterSchemaDataEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql\Event;
 

src/Event/AlterSchemaExtensionDataEvent.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql\Event;
 

src/GraphQL/Response/FileUploadResponse.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql\GraphQL\Response;
 

src/GraphQL/Response/Response.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql\GraphQL\Response;
 

src/GraphQL/Response/ResponseInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql\GraphQL\Response;
 

src/GraphQL/Utility/FileUpload.php

@@ -193,6 +193,9 @@ public function saveFileUpload(UploadedFile $uploaded_file, array $settings): Fi
     switch ($uploaded_file->getError()) {
       case UPLOAD_ERR_INI_SIZE:
       case UPLOAD_ERR_FORM_SIZE:
+        // @todo Drupal 9 compatibility, needs to be converted to ByteSizeMarkup
+        // later.
+        // @phpstan-ignore-next-line
         $maxUploadSize = format_size($this->getMaxUploadSize($settings));
         $response->addViolation($this->t('The file @file could not be saved because it exceeds @maxsize, the maximum allowed size for uploads.', [
           '@file' => $uploaded_file->getClientOriginalName(),
@@ -268,6 +271,9 @@ public function saveFileUpload(UploadedFile $uploaded_file, array $settings): Fi
       $file->setSize(@filesize($temp_file_path));
 
       // Validate against file_validate() first with the temporary path.
+      // @todo Drupal 9 compatibility, needs to be converted to file validate
+      // service later.
+      // @phpstan-ignore-next-line
       $errors = file_validate($file, $validators);
       $maxResolution = $settings['max_resolution'] ?? 0;
       $minResolution = $settings['min_resolution'] ?? 0;
@@ -499,6 +505,9 @@ protected function prepareFilename(string $filename, array &$validators): string
           /** @var \Drupal\file\FileInterface $file */
           $file = $this->fileStorage->create([]);
           $file->setFilename($filename);
+          // @todo Drupal 9 compatibility, needs to be converted to file
+          // validator service later.
+          // @phpstan-ignore-next-line
           $passes_validation = empty(file_validate_extensions($file, $validators['file_validate_extensions'][0]));
         }
         if (empty($validators['file_validate_extensions'][0]) || $passes_validation) {

src/Plugin/GraphQL/Schema/AlterableComposableSchema.php

@@ -157,12 +157,6 @@ protected function getSchemaDocument(array $extensions = []) {
    * @see \Drupal\graphql\Plugin\GraphQL\Schema\ComposableSchema::getSchemaDocument()
    */
   protected function getExtensionDocument(array $extensions = []) {
-    // Only use caching of the parsed document if we aren't in development mode.
-    $cid = "extension:{$this->getPluginId()}";
-    if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
-      return $cache->data;
-    }
-
     $extensions = array_filter(array_map(function (SchemaExtensionPluginInterface $extension) {
       return $extension->getExtensionDefinition();
     }, $extensions), function ($definition) {
@@ -176,10 +170,8 @@ protected function getExtensionDocument(array $extensions = []) {
       AlterSchemaExtensionDataEvent::EVENT_NAME
     );
     $ast = !empty($extensions) ? Parser::parse(implode("\n\n", $event->getSchemaExtensionData()), ['noLocation' => TRUE]) : NULL;
-    if (empty($this->inDevelopment)) {
-      $this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
-    }
 
+    // No AST caching here as that will be done in getFullSchemaDocument().
     return $ast;
   }
 

src/Plugin/GraphQL/Schema/SdlSchemaPluginBase.php

@@ -13,12 +13,15 @@
 use Drupal\graphql\Plugin\SchemaExtensionPluginInterface;
 use Drupal\graphql\Plugin\SchemaExtensionPluginManager;
 use Drupal\graphql\Plugin\SchemaPluginInterface;
+use GraphQL\Language\AST\DocumentNode;
 use GraphQL\Language\AST\InterfaceTypeDefinitionNode;
 use GraphQL\Language\AST\TypeDefinitionNode;
 use GraphQL\Language\AST\UnionTypeDefinitionNode;
 use GraphQL\Language\Parser;
+use GraphQL\Type\Schema;
 use GraphQL\Utils\BuildSchema;
 use GraphQL\Utils\SchemaExtender;
+use GraphQL\Utils\SchemaPrinter;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
@@ -117,15 +120,8 @@ public function __construct(
    */
   public function getSchema(ResolverRegistryInterface $registry) {
     $extensions = $this->getExtensions();
-    $resolver = [$registry, 'resolveType'];
     $document = $this->getSchemaDocument($extensions);
-    $schema = BuildSchema::build($document, function ($config, TypeDefinitionNode $type) use ($resolver) {
-      if ($type instanceof InterfaceTypeDefinitionNode || $type instanceof UnionTypeDefinitionNode) {
-        $config['resolveType'] = $resolver;
-      }
-
-      return $config;
-    });
+    $schema = $this->buildSchema($document, $registry);
 
     if (empty($extensions)) {
       return $schema;
@@ -135,10 +131,31 @@ public function getSchema(ResolverRegistryInterface $registry) {
       $extension->registerResolvers($registry);
     }
 
-    if ($extendSchema = $this->getExtensionDocument($extensions)) {
-      return SchemaExtender::extend($schema, $extendSchema);
+    $extendedDocument = $this->getFullSchemaDocument($schema, $extensions);
+    if (empty($extendedDocument)) {
+      return $schema;
     }
 
+    return $this->buildSchema($extendedDocument, $registry);
+  }
+
+  /**
+   * Create a GraphQL schema object from the given AST document.
+   *
+   * This method is private for now as the build/cache approach might change.
+   */
+  private function buildSchema(DocumentNode $astDocument, ResolverRegistryInterface $registry): Schema {
+    $resolver = [$registry, 'resolveType'];
+    // Performance: only validate the schema in development mode, skip it in
+    // production on every request.
+    $options = empty($this->inDevelopment) ? ['assumeValid' => TRUE] : [];
+    $schema = BuildSchema::build($astDocument, function ($config, TypeDefinitionNode $type) use ($resolver) {
+      if ($type instanceof InterfaceTypeDefinitionNode || $type instanceof UnionTypeDefinitionNode) {
+        $config['resolveType'] = $resolver;
+      }
+
+      return $config;
+    }, $options);
     return $schema;
   }
 
@@ -185,6 +202,33 @@ protected function getSchemaDocument(array $extensions = []) {
     return $ast;
   }
 
+  /**
+   * Returns the full AST combination of parsed schema with extensions, cached.
+   *
+   * This method is private for now as the build/cache approach might change.
+   */
+  private function getFullSchemaDocument(Schema $schema, array $extensions): ?DocumentNode {
+    // Only use caching of the parsed document if we aren't in development mode.
+    $cid = "full:{$this->getPluginId()}";
+    if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
+      return $cache->data;
+    }
+
+    $ast = NULL;
+    if ($extendAst = $this->getExtensionDocument($extensions)) {
+      $fullSchema = SchemaExtender::extend($schema, $extendAst);
+      // Performance: export the full schema as string and parse it again. That
+      // way we can cache the full AST.
+      $fullSchemaString = SchemaPrinter::doPrint($fullSchema);
+      $ast = Parser::parse($fullSchemaString, ['noLocation' => TRUE]);
+    }
+
+    if (empty($this->inDevelopment)) {
+      $this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
+    }
+    return $ast;
+  }
+
   /**
    * Retrieves the parsed AST of the schema extension definitions.
    *
@@ -196,23 +240,14 @@ protected function getSchemaDocument(array $extensions = []) {
    * @throws \GraphQL\Error\SyntaxError
    */
   protected function getExtensionDocument(array $extensions = []) {
-    // Only use caching of the parsed document if we aren't in development mode.
-    $cid = "extension:{$this->getPluginId()}";
-    if (empty($this->inDevelopment) && $cache = $this->astCache->get($cid)) {
-      return $cache->data;
-    }
-
     $extensions = array_filter(array_map(function (SchemaExtensionPluginInterface $extension) {
       return $extension->getExtensionDefinition();
     }, $extensions), function ($definition) {
       return !empty($definition);
     });
 
     $ast = !empty($extensions) ? Parser::parse(implode("\n\n", $extensions), ['noLocation' => TRUE]) : NULL;
-    if (empty($this->inDevelopment)) {
-      $this->astCache->set($cid, $ast, CacheBackendInterface::CACHE_PERMANENT, ['graphql']);
-    }
-
+    // No AST caching here as that will be done in getFullSchemaDocument().
     return $ast;
   }
 

tests/modules/graphql_alterable_schema_test/src/EventSubscriber/GraphQlSubscriber.php

@@ -1,6 +1,6 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Drupal\graphql_alterable_schema_test\EventSubscriber;
 

tests/src/Kernel/DataProducer/EntityDefinitionTest.php

@@ -211,7 +211,7 @@ class EntityDefinitionTest extends GraphQLTestBase {
         [
           'id' => 'created',
           'label' => 'Authored on',
-          'description' => 'The time that the node was created.',
+          'description' => 'The date and time that the content was created.',
           'type' => 'created',
           'required' => FALSE,
           'multiple' => FALSE,
@@ -496,6 +496,11 @@ enum FieldTypes {
         'entity_form_display_context' => $builder->fromContext('entity_form_display'),
       ])
     );
+
+    // @todo Different description between Drupal 9 and 10, can be removed when
+    // Drupal 9 support is dropped.
+    $this->fullDefinitionResult['entityDefinition']['fields'][11]['description'] =
+      $this->container->get('entity_field.manager')->getBaseFieldDefinitions('node')['created']->getDescription();
   }
 
   /**

tests/src/Kernel/DataProducer/EntityReferenceTest.php

@@ -5,16 +5,40 @@
 use Drupal\Core\Field\FieldStorageDefinitionInterface;
 use Drupal\node\Entity\Node;
 use Drupal\node\Entity\NodeType;
-use Drupal\Tests\field\Traits\EntityReferenceTestTrait;
 use Drupal\Tests\graphql\Kernel\GraphQLTestBase;
 
+// @todo Drupal 9 compatibility: use the deprecated trait for Drupal 9.
+if (strpos(\Drupal::VERSION, '9') === 0) {
+
+  /**
+   * Helper trait for compatibility with Drupal 9.
+   *
+   * @phpcs:disable Drupal.Classes.ClassFileName.NoMatch
+   */
+  trait EntityReferenceFieldCreationTrait {
+    // @phpstan-ignore-next-line
+    use \Drupal\Tests\field\Traits\EntityReferenceTestTrait;
+
+  }
+}
+else {
+
+  /**
+   * Helper trait for compatibility with Drupal 10.
+   */
+  trait EntityReferenceFieldCreationTrait {
+    use \Drupal\Tests\field\Traits\EntityReferenceFieldCreationTrait;
+
+  }
+}
+
 /**
  * Tests the entity_reference data producers.
  *
  * @group graphql
  */
 class EntityReferenceTest extends GraphQLTestBase {
-  use EntityReferenceTestTrait;
+  use EntityReferenceFieldCreationTrait;
 
   /**
    * Test node that will be referenced.

tests/src/Kernel/DataProducer/EntityTest.php

@@ -469,14 +469,7 @@ public function testResolveEntityRendered(): void {
 
     // @todo Add metadata check.
     // $this->assertContains('node:1', $metadata->getCacheTags());
-    // Rendered output is slightly different in Drupal 8 vs. 9.
-    [$version] = explode('.', \Drupal::VERSION, 2);
-    if ($version == 8) {
-      $this->assertStringContainsString('<a href="/node/1" rel="bookmark"><span>' . $this->node->getTitle() . '</span>', $result);
-    }
-    else {
-      $this->assertMatchesRegularExpression('#<a href="/node/1" rel="bookmark">\s*<span>' . $this->node->getTitle() . '</span>#', $result);
-    }
+    $this->assertMatchesRegularExpression('#<a href="/node/1" rel="bookmark">\s*<span>' . $this->node->getTitle() . '</span>#', $result);
   }
 
 }

tests/src/Kernel/GraphQLTestBase.php

@@ -82,11 +82,13 @@ protected function setUp(): void {
     ConfigurableLanguage::create([
       'id' => 'fr',
       'weight' => 1,
+      'label' => 'French',
     ])->save();
 
     ConfigurableLanguage::create([
       'id' => 'de',
       'weight' => 2,
+      'label' => 'German',
     ])->save();
 
     $this->builder = new ResolverBuilder();