refactor(drupal): Drop Drupal 8 support, introduce Drupal 10 compat (#1267)

Author: chrfritsch

.github/workflows/testing.yml

@@ -16,9 +16,9 @@ jobs:
         php-versions: ['7.3', '7.4', '8.0', '8.1']
         drupal-core: ['9.3.x']
         include:
-          # Extra run to also test on latest Drupal 8 and PHP 7.2.
-          - php-versions: '7.2'
-            drupal-core: '8.9.x'
+          # Extra run to also test on latest Drupal 10 and PHP 8.1.
+          - php-versions: '8.1'
+            drupal-core: '10.0.x'
     steps:
       - name: Checkout Drupal core
         uses: actions/checkout@v2
@@ -73,17 +73,18 @@ jobs:
         run: |
           composer install --no-progress --prefer-dist --optimize-autoloader
           composer --no-interaction run-script drupal-phpunit-upgrade
+          composer config --no-plugins allow-plugins.phpstan/extension-installer true
 
       - name: Install GraphQL dependencies
         run: composer --no-interaction --no-progress require \
           webonyx/graphql-php:^14.8 \
           drupal/typed_data:^1.0 \
-          drupal/redirect:^1.6 \
           phpstan/phpstan:^1.4.6 \
           mglaman/phpstan-drupal:^1.1.2 \
           phpstan/phpstan-deprecation-rules:^1.0.0 \
           jangregor/phpstan-prophecy:^1.0.0 \
-          phpstan/phpstan-phpunit:^1.0.0
+          phpstan/phpstan-phpunit:^1.0.0 \
+          phpstan/extension-installer:^1.0
 
       # We install Coder separately because updating did not work in the local
       # Drupal vendor dir.

composer.json

@@ -5,7 +5,7 @@
   "homepage": "http://drupal.org/project/graphql",
   "license": "GPL-2.0+",
   "require": {
-    "php": ">=7.2",
+    "php": ">=7.3",
     "webonyx/graphql-php": "^14.8.0"
   },
   "minimum-stability": "dev"

examples/graphql_composable/graphql_composable.info.yml

@@ -2,8 +2,7 @@ name: GraphQL composable example
 type: module
 description: 'Examples for composable GraphQL schema.'
 package: GraphQL
-core: 8.x
 dependencies:
   - graphql:graphql
   - node:node
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^9.3 || ^10

examples/graphql_composable/src/Plugin/GraphQL/DataProducer/CreateArticle.php

@@ -8,6 +8,7 @@
 use Drupal\graphql_composable\GraphQL\Response\ArticleResponse;
 use Drupal\node\Entity\Node;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
 
 /**
  * Creates a new article entity.
@@ -28,6 +29,8 @@
  */
 class CreateArticle extends DataProducerPluginBase implements ContainerFactoryPluginInterface {
 
+  use StringTranslationTrait;
+
   /**
    * The current user.
    *

examples/graphql_example/graphql_examples.info.yml

@@ -2,8 +2,7 @@ name: GraphQL examples
 type: module
 description: 'Examples for the GraphQL module.'
 package: GraphQL
-core: 8.x
 dependencies:
   - graphql:graphql
   - node:node
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^9.3 || ^10

graphql.info.yml

@@ -3,7 +3,6 @@ type: module
 description: 'Base module for integrating GraphQL with Drupal.'
 package: GraphQL
 configure: graphql.config_page
-core: 8.x
-core_version_requirement: ^8 || ^9
+core_version_requirement: ^9.3 || ^10
 dependencies:
   - typed_data:typed_data

graphql.services.yml

@@ -159,6 +159,7 @@ services:
       - '@lock'
       - '@config.factory'
       - '@renderer'
+      - '@event_dispatcher'
 
   plugin.manager.graphql.persisted_query:
     class: Drupal\graphql\Plugin\PersistedQueryPluginManager

phpstan.neon

@@ -1,9 +1,3 @@
-includes:
-  - ../../vendor/phpstan/phpstan-deprecation-rules/rules.neon
-  - ../../vendor/mglaman/phpstan-drupal/extension.neon
-  - ../../vendor/jangregor/phpstan-prophecy/extension.neon
-  - ../../vendor/phpstan/phpstan-phpunit/extension.neon
-
 parameters:
   # PHPStan cannot find files in this test directory automatically.
   scanDirectories:
@@ -21,6 +15,10 @@ parameters:
   # Not sure we can specify generic types properly with Drupal coding standards
   # yet, disable for now.
   checkGenericClassInNonGenericObjectType: false
+  # Exclude the RouteLoad producer because the redirect module is not D10
+  # compatible so we are not downloading it.
+  excludePaths:
+    - src/Plugin/GraphQL/DataProducer/Routing/RouteLoad.php
   ignoreErrors:
     # @todo Ignore phpstan-drupal extension's rules for now, activate later.
     - '#\Drupal calls should be avoided in classes, use dependency injection instead#'
@@ -31,28 +29,7 @@ parameters:
     - "#^Access to an undefined property Drupal\\\\#"
     # PHPUnit deprecation warnings in Drupal 9 that we don't care about.
     - "#^Call to deprecated method setMethods\\(\\) of class PHPUnit\\\\Framework\\\\MockObject\\\\MockBuilder:#"
-    # Other deprecations in Drupal 9 that we can't change because we want to
-    # support Drupal 8.
-    - "#deprecated class Symfony\\\\Component\\\\EventDispatcher\\\\Event#"
-    - "#deprecated class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseEvent#"
     - "#^Method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch\\(\\) invoked with 2 parameters, 1 required\\.$#"
-    - "#deprecated interface Symfony\\\\Component\\\\HttpFoundation\\\\File\\\\MimeType\\\\MimeTypeGuesserInterface#"
-    - "#^Parameter .+ of class Symfony\\\\Component\\\\HttpFoundation\\\\File\\\\UploadedFile constructor expects .+ given\\.$#"
-    - "#^Parameter \\#1 \\$event of method Symfony\\\\Contracts\\\\EventDispatcher\\\\EventDispatcherInterface\\:\\:dispatch\\(\\) expects object, string given\\.$#"
-    - """
-      #^Call to deprecated method toInt\\(\\) of class Drupal\\\\Component\\\\Utility\\\\Bytes\\:
-      in drupal\\:9\\.1\\.0 and is removed from drupal\\:10\\.0\\.0\\. Use \\\\Drupal\\\\Component\\\\Utility\\\\Bytes\\:\\:toNumber\\(\\) instead$#
-      """
-    - """
-      #^Call to deprecated function file_munge_filename\\(\\)#
-      """
-    - """
-      #^Call to deprecated function drupal_get_path\\(\\)#
-      """
-    - """
-      #^Call to deprecated function file_create_url\\(\\)#
-      """
-    - "#^Call to an undefined method Drupal\\\\Tests\\\\graphql\\\\Kernel\\\\DataProducer\\\\EntityTest\\:\\:assertMatchesRegularExpression\\(\\)\\.$#"
     # Drupal allows object property access to custom fields, so we cannot fix
     # that.
     - "#^Property Drupal\\\\.+ \\(Drupal\\\\Core\\\\Field\\\\FieldItemListInterface\\) does not accept .+\\.$#"

src/Event/OperationEvent.php

@@ -4,7 +4,7 @@
 
 use Drupal\graphql\GraphQL\Execution\ResolveContext;
 use GraphQL\Executor\ExecutionResult;
-use Symfony\Component\EventDispatcher\Event;
+use Drupal\Component\EventDispatcher\Event;
 
 /**
  * Represents an event that is triggered before and after a GraphQL operation.

src/EventSubscriber/SubrequestSubscriber.php

@@ -8,7 +8,7 @@
 use Drupal\language\LanguageNegotiatorInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\FinishRequestEvent;
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
 /**
@@ -36,10 +36,10 @@ public function __construct(LanguageManagerInterface $languageManager, Translato
   /**
    * Handle kernel request events.
    *
-   * @param \Symfony\Component\HttpKernel\Event\GetResponseEvent $event
+   * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
    *   The kernel event object.
    */
-  public function onKernelRequest(GetResponseEvent $event): void {
+  public function onKernelRequest(RequestEvent $event): void {
     $request = $event->getRequest();
     if (!$request->attributes->has('_graphql_subrequest')) {
       return;

src/GraphQL/Execution/Executor.php

@@ -277,11 +277,11 @@ protected function doExecuteUncached() {
     );
 
     $event = new OperationEvent($this->context);
-    $this->dispatcher->dispatch(OperationEvent::GRAPHQL_OPERATION_BEFORE, $event);
+    $this->dispatcher->dispatch($event, OperationEvent::GRAPHQL_OPERATION_BEFORE);
 
     return $executor->doExecute()->then(function ($result) {
       $event = new OperationEvent($this->context, $result);
-      $this->dispatcher->dispatch(OperationEvent::GRAPHQL_OPERATION_AFTER, $event);
+      $this->dispatcher->dispatch($event, OperationEvent::GRAPHQL_OPERATION_AFTER);
 
       $this->logUnsafeErrors($this->context->getOperation(), $result);
 
@@ -443,7 +443,13 @@ protected function cacheWrite($prefix, CacheableExecutionResult $result) {
    * @see \Drupal\Core\Cache\CacheBackendInterface::set()
    */
   protected function maxAgeToExpire($maxAge) {
-    $time = $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME');
+    /* @todo Can be removed when D9 support is dropped. In D9
+     * \Drupal\Core\Http\RequestStack is used here for forward compatibility,
+     * but phpstan thinks it's \Symfony\Component\HttpFoundation\RequestStack
+     * which doesn't have getMainRequest(), but in Drupal10 (Symfony 6) it has.
+     */
+    /* @phpstan-ignore-next-line */
+    $time = $this->requestStack->getMainRequest()->server->get('REQUEST_TIME');
     return ($maxAge === Cache::PERMANENT) ? Cache::PERMANENT : (int) $time + $maxAge;
   }
 

src/GraphQL/Utility/FileUpload.php

@@ -19,8 +19,10 @@
 use Drupal\Core\Utility\Token;
 use Drupal\file\FileInterface;
 use Drupal\graphql\GraphQL\Response\FileUploadResponse;
-use Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
+use Drupal\Core\File\Event\FileUploadSanitizeNameEvent;
+use Symfony\Component\Mime\MimeTypeGuesserInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 
 /**
  * Service to manage file uploads within GraphQL mutations.
@@ -48,7 +50,7 @@ class FileUpload {
   /**
    * The mime type guesser service.
    *
-   * @var \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface
+   * @var \Symfony\Component\Mime\MimeTypeGuesserInterface
    */
   protected $mimeTypeGuesser;
 
@@ -94,6 +96,13 @@ class FileUpload {
    */
   protected $renderer;
 
+  /**
+   * The event dispatcher service.
+   *
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
+   */
+  protected $eventDispatcher;
+
   /**
    * Constructor.
    */
@@ -106,7 +115,8 @@ public function __construct(
     Token $token,
     LockBackendInterface $lock,
     ConfigFactoryInterface $config_factory,
-    RendererInterface $renderer
+    RendererInterface $renderer,
+    EventDispatcherInterface $eventDispatcher
   ) {
     /** @var \Drupal\file\FileStorageInterface $file_storage */
     $file_storage = $entityTypeManager->getStorage('file');
@@ -119,6 +129,7 @@ public function __construct(
     $this->lock = $lock;
     $this->systemFileConfig = $config_factory->get('system.file');
     $this->renderer = $renderer;
+    $this->eventDispatcher = $eventDispatcher;
   }
 
   /**
@@ -127,14 +138,14 @@ public function __construct(
    * @param array $settings
    *   The file field settings.
    *
-   * @return int
+   * @return float
    *   Max upload size.
    */
-  protected function getMaxUploadSize(array $settings) {
+  protected function getMaxUploadSize(array $settings): float {
     // Cap the upload size according to the PHP limit.
-    $max_filesize = Bytes::toInt(Environment::getUploadMaxSize());
+    $max_filesize = Bytes::toNumber(Environment::getUploadMaxSize());
     if (!empty($settings['max_filesize'])) {
-      $max_filesize = min($max_filesize, Bytes::toInt($settings['max_filesize']));
+      $max_filesize = min($max_filesize, Bytes::toNumber($settings['max_filesize']));
     }
     return $max_filesize;
   }
@@ -240,7 +251,7 @@ public function saveFileUpload(UploadedFile $uploaded_file, array $settings): Fi
       $file = $this->fileStorage->create([]);
       $file->setOwnerId($this->currentUser->id());
       $file->setFilename($prepared_filename);
-      $file->setMimeType($this->mimeTypeGuesser->guess($prepared_filename));
+      $file->setMimeType($this->mimeTypeGuesser->guessMimeType($prepared_filename));
       $file->setFileUri($temp_file_path);
       // Set the size. This is done in File::preSave() but we validate the file
       // before it is saved.
@@ -378,13 +389,15 @@ protected function prepareFilename(string $filename, array &$validators): string
         // valid extensions, munge the filename to protect against possible
         // malicious extension hiding within an unknown file type. For example,
         // "filename.html.foo".
-        $filename = file_munge_filename($filename, $validators['file_validate_extensions'][0]);
+        $event = new FileUploadSanitizeNameEvent($filename, $validators['file_validate_extensions'][0]);
+        $this->eventDispatcher->dispatch($event);
+        $filename = $event->getFilename();
       }
 
       // Rename potentially executable files, to help prevent exploits (i.e.
       // will rename filename.php.foo and filename.php to filename._php._foo.txt
       // and filename._php.txt, respectively).
-      if (preg_match(FILE_INSECURE_EXTENSION_REGEX, $filename)) {
+      if (preg_match(FileSystemInterface::INSECURE_EXTENSION_REGEX, $filename)) {
         // If the file will be rejected anyway due to a disallowed extension, it
         // should not be renamed; rather, we'll let file_validate_extensions()
         // reject it below.
@@ -401,7 +414,10 @@ protected function prepareFilename(string $filename, array &$validators): string
             // URI.
             $filename .= '.txt';
           }
-          $filename = file_munge_filename($filename, $validators['file_validate_extensions'][0] ?? '');
+
+          $event = new FileUploadSanitizeNameEvent($filename, $validators['file_validate_extensions'][0] ?? '');
+          $this->eventDispatcher->dispatch($event);
+          $filename = $event->getFilename();
 
           // The .txt extension may not be in the allowed list of extensions. We
           // have to add it here or else the file upload will fail.
@@ -461,9 +477,9 @@ protected function getUploadValidators(array $settings): array {
     ];
 
     // Cap the upload size according to the PHP limit.
-    $max_filesize = Bytes::toInt(Environment::getUploadMaxSize());
+    $max_filesize = Bytes::toNumber(Environment::getUploadMaxSize());
     if (!empty($settings['max_filesize'])) {
-      $max_filesize = min($max_filesize, Bytes::toInt($settings['max_filesize']));
+      $max_filesize = min($max_filesize, Bytes::toNumber($settings['max_filesize']));
     }
 
     // There is always a file size limit due to the PHP server limit.

src/Plugin/GraphQL/DataProducer/DataProducerPluginBase.php

@@ -3,15 +3,17 @@
 namespace Drupal\graphql\Plugin\GraphQL\DataProducer;
 
 use Drupal\Component\Plugin\Exception\ContextException;
-use Drupal\Core\Plugin\ContextAwarePluginBase;
+use Drupal\Component\Plugin\ContextAwarePluginBase;
 use Drupal\graphql\GraphQL\Execution\FieldContext;
 use Drupal\graphql\Plugin\DataProducerPluginInterface;
+use Drupal\Core\Plugin\ContextAwarePluginTrait;
 
 /**
  * Base class for data producers that resolve fields for queries or mutations.
  */
 abstract class DataProducerPluginBase extends ContextAwarePluginBase implements DataProducerPluginInterface {
   use DataProducerPluginCachingTrait;
+  use ContextAwarePluginTrait;
 
   /**
    * {@inheritdoc}

src/Plugin/GraphQL/DataProducer/DataProducerProxy.php

@@ -363,7 +363,8 @@ protected function cacheWrite($prefix, $value, FieldContext $field): void {
    * @see \Drupal\Core\Cache\CacheBackendInterface::set()
    */
   protected function maxAgeToExpire($maxAge) {
-    $time = $this->requestStack->getMasterRequest()->server->get('REQUEST_TIME');
+    /* @phpstan-ignore-next-line */
+    $time = $this->requestStack->getMainRequest()->server->get('REQUEST_TIME');
     return ($maxAge === Cache::PERMANENT) ? Cache::PERMANENT : (int) $time + $maxAge;
   }