Issue #3457946 by slucero: Fix Deprecations and Breaking Issues for Drupal 10.3

Author: Stephen Lucero

modules/patternkit_media_library/patternkit_media_library.services.yml

@@ -4,3 +4,5 @@ services:
     arguments:
       - '@entity_type.manager'
       - '@file_url_generator'
+    tags:
+      - { name: media_library.opener }

patternkit.services.yml

@@ -50,6 +50,7 @@ services:
       - '@patternkit.schema.data_preprocessor.factory'
       - '@patternkit.pattern.dependency_resolver'
       - '@logger.channel.patternkit'
+      - '@?plugin.manager.sdc'
   patternkit.asset.library.parser.file:
     parent: patternkit.asset.library.parser.base
     class: Drupal\patternkit\Asset\PatternLibraryParser\FilePatternLibraryParser

src/Asset/PatternLibraryParserBase.php

@@ -14,6 +14,7 @@
 use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
 use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\Core\Theme\ComponentPluginManager;
 use Drupal\Core\Theme\ThemeManagerInterface;
 use Drupal\patternkit\Entity\PatternInterface;
 use Drupal\patternkit\Exception\PatternAssetException;
@@ -44,41 +45,13 @@ abstract class PatternLibraryParserBase extends LibraryDiscoveryParser implement
    */
   protected const DEFAULT_CATEGORY = 'default';
 
-  /**
-   * Serializes and de-serializes data.
-   *
-   * @var \Drupal\Component\Serialization\SerializationInterface
-   */
-  protected SerializationInterface $serializer;
-
   /**
    * The entity storage handler for the patternkit_pattern entity.
    *
    * @var \Drupal\Core\Entity\EntityStorageInterface
    */
   protected EntityStorageInterface $patternStorage;
 
-  /**
-   * The schema data preprocessor factory service.
-   *
-   * @var \Drupal\patternkit\Schema\DataPreProcessorFactory
-   */
-  protected DataPreProcessorFactory $dataPreProcessorFactory;
-
-  /**
-   * The pattern dependency resolver service.
-   *
-   * @var \Drupal\patternkit\Asset\PatternDependencyResolver
-   */
-  protected PatternDependencyResolver $patternDependencyResolver;
-
-  /**
-   * The patternkit logger channel.
-   *
-   * @var \Drupal\Core\Logger\LoggerChannelInterface
-   */
-  protected LoggerChannelInterface $logger;
-
   /**
    * Constructor for PatternLibraryParser implementations.
    *
@@ -104,30 +77,37 @@ abstract class PatternLibraryParserBase extends LibraryDiscoveryParser implement
    *   The pattern dependency resolver service.
    * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
    *   The patternkit logger channel.
+   * @param \Drupal\Core\Theme\ComponentPluginManager|null $componentPluginManager
+   *   The theme component plugin manager if available.
    *
    * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
    * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
    */
   public function __construct(
-    SerializationInterface $serializer,
+    protected SerializationInterface $serializer,
     string $root,
     ModuleHandlerInterface $module_handler,
     ThemeManagerInterface $theme_manager,
     StreamWrapperManagerInterface $stream_wrapper,
     LibrariesDirectoryFileFinder $libraries_directory_file_finder,
     ExtensionPathResolver $extension_path_resolver,
     EntityTypeManagerInterface $entity_type_manager,
-    DataPreProcessorFactory $dataPreProcessorFactory,
-    PatternDependencyResolver $patternDependencyResolver,
-    LoggerChannelInterface $logger,
+    protected DataPreProcessorFactory $dataPreProcessorFactory,
+    protected PatternDependencyResolver $patternDependencyResolver,
+    protected LoggerChannelInterface $logger,
+    ?ComponentPluginManager $componentPluginManager = NULL,
   ) {
-    parent::__construct($root, $module_handler, $theme_manager, $stream_wrapper, $libraries_directory_file_finder, $extension_path_resolver);
+    parent::__construct(
+      $root,
+      $module_handler,
+      $theme_manager,
+      $stream_wrapper,
+      $libraries_directory_file_finder,
+      $extension_path_resolver,
+      $componentPluginManager,
+    );
 
-    $this->serializer = $serializer;
     $this->patternStorage = $entity_type_manager->getStorage('patternkit_pattern');
-    $this->dataPreProcessorFactory = $dataPreProcessorFactory;
-    $this->patternDependencyResolver = $patternDependencyResolver;
-    $this->logger = $logger;
   }
 
   /**

tests/src/Functional/BlockTest.php

@@ -43,9 +43,6 @@ public function testBlockCacheTags(): void {
     $pattern = $block->getPatternEntity();
     $pattern_id = $pattern->id();
 
-    // The page cache only works for anonymous users.
-    $this->drupalLogout();
-
     // Enable page caching.
     $config = $this->config('system.performance');
     $config->set('cache.page.max_age', 300);

tests/src/Functional/PatternkitBrowserTestBase.php

@@ -8,6 +8,7 @@
 use Drupal\Tests\patternkit\Traits\JsonDecodeTrait;
 use Drupal\Tests\patternkit\Traits\PatternkitBlockHelperTrait;
 use Drupal\Tests\patternkit\Traits\SchemaFixtureTrait;
+use Drupal\user\UserInterface;
 
 /**
  * A base class for all patternkit browser tests.
@@ -47,6 +48,13 @@ abstract class PatternkitBrowserTestBase extends BrowserTestBase {
    */
   protected EntityStorageInterface $patternStorage;
 
+  /**
+   * A test user with editor permissions.
+   *
+   * @var \Drupal\user\UserInterface
+   */
+  protected UserInterface $editorUser;
+
   /**
    * {@inheritdoc}
    */

tests/src/Unit/Asset/LibraryTest.php

@@ -167,9 +167,8 @@ protected function setUp(): void {
     );
 
     // Prepare and mock services called from the container.
-    $this->streamWrapperManager = new StreamWrapperManager();
-
     $this->container = new ContainerBuilder();
+    $this->streamWrapperManager = new StreamWrapperManager($this->container);
     $this->container->set('stream_wrapper_manager', $this->streamWrapperManager);
     \Drupal::setContainer($this->container);
   }

tests/src/Unit/Asset/PatternLibraryParser/PatternLibraryParserBaseTest.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\Tests\patternkit\Unit\Asset\PatternLibraryParser;
 
+use Drupal\Core\Theme\ComponentPluginManager;
 use Drupal\patternkit\Asset\PatternLibraryParserBase;
 use Drupal\patternkit\Asset\PatternLibraryParserInterface;
 use Drupal\patternkit\Entity\PatternInterface;
@@ -35,6 +36,10 @@ protected function getParserInstance(): PatternLibraryParserInterface {
     $this->entityTypeManager->getStorage('patternkit_pattern')
       ->willReturn($this->patternStorage->reveal());
 
+    if (class_exists(ComponentPluginManager::class)) {
+      $componentPluginManager = $this->prophesize(ComponentPluginManager::class);
+    }
+
     return $this->getMockForAbstractClass(PatternLibraryParserBase::class, [
       $this->serializer->reveal(),
       $this->vfsRoot->url(),
@@ -47,6 +52,7 @@ protected function getParserInstance(): PatternLibraryParserInterface {
       $this->dataPreProcessorFactory->reveal(),
       $this->patternDependencyResolver->reveal(),
       $this->logger->reveal(),
+      isset($componentPluginManager) ? $componentPluginManager->reveal() : NULL,
     ]);
   }
 

tests/src/Unit/Asset/PatternLibraryParser/PatternLibraryParserTestBase.php

@@ -12,6 +12,7 @@
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
+use Drupal\Core\Theme\ComponentPluginManager;
 use Drupal\Core\Theme\ThemeManagerInterface;
 use Drupal\patternkit\Asset\PatternDependencyResolver;
 use Drupal\patternkit\Asset\PatternLibraryParserInterface;
@@ -44,87 +45,94 @@ abstract class PatternLibraryParserTestBase extends UnitTestCase {
   /**
    * The module handler service.
    *
-   * @var \Drupal\Core\Extension\ModuleHandlerInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Extension\ModuleHandlerInterface>
    */
   protected ObjectProphecy $moduleHandler;
 
   /**
    * The theme manager service.
    *
-   * @var \Drupal\Core\Theme\ThemeManagerInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Theme\ThemeManagerInterface>
    */
   protected ObjectProphecy $themeManager;
 
   /**
    * A serializer service.
    *
-   * @var \Drupal\Component\Serialization\SerializationInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Component\Serialization\SerializationInterface>
    */
   protected ObjectProphecy $serializer;
 
   /**
    * The stream wrapper manager service.
    *
-   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\StreamWrapper\StreamWrapperManagerInterface>
    */
   protected ObjectProphecy $streamWrapperManager;
 
   /**
    * The library directory file finder service.
    *
-   * @var \Drupal\Core\Asset\LibrariesDirectoryFileFinder|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Asset\LibrariesDirectoryFileFinder>
    */
   protected ObjectProphecy $librariesDirectoryFileFinder;
 
   /**
    * The extension path resolver service.
    *
-   * @var \Drupal\Core\Extension\ExtensionPathResolver|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Extension\ExtensionPathResolver>
    */
   protected ObjectProphecy $extensionPathResolver;
 
   /**
    * The entity type manager service.
    *
-   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Entity\EntityTypeManagerInterface>
    */
   protected ObjectProphecy $entityTypeManager;
 
   /**
    * The pattern storage handler.
    *
-   * @var \Drupal\Core\Entity\EntityStorageInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Entity\EntityStorageInterface>
    */
   protected ObjectProphecy $patternStorage;
 
   /**
    * The schema data preprocessor factory service.
    *
-   * @var \Drupal\patternkit\Schema\DataPreProcessorFactory|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\patternkit\Schema\DataPreProcessorFactory>
    */
   protected ObjectProphecy $dataPreProcessorFactory;
 
   /**
    * The pattern dependency resolver service.
    *
-   * @var \Drupal\patternkit\Asset\PatternDependencyResolver|ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\patternkit\Asset\PatternDependencyResolver>
    */
   protected ObjectProphecy $patternDependencyResolver;
 
   /**
    * The patternkit logger channel.
    *
-   * @var \Drupal\Core\Logger\LoggerChannelInterface|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Logger\LoggerChannelInterface>
    */
   protected ObjectProphecy $logger;
 
   /**
    * The pattern environment service.
    *
-   * @var \Drupal\patternkit\PatternkitEnvironment|\Prophecy\Prophecy\ObjectProphecy
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\patternkit\PatternkitEnvironment>
    */
   protected ObjectProphecy $environment;
 
+  /**
+   * The component plugin manager service if it exists.
+   *
+   * @var \Prophecy\Prophecy\ObjectProphecy<\Drupal\Core\Theme\ComponentPluginManager>|null
+   */
+  protected ?ObjectProphecy $componentPluginManager;
+
   /**
    * The pattern library parser being tested.
    *
@@ -178,6 +186,8 @@ protected function setUpParserDependencies(): void {
     $this->logger = $this->prophesize(LoggerChannelInterface::class);
     $this->environment = $this->prophesize(PatternkitEnvironment::class);
     $this->environment->isDebug()->willReturn(FALSE);
+    $this->componentPluginManager = class_exists(ComponentPluginManager::class) ?
+      $this->prophesize(ComponentPluginManager::class) : NULL;
 
     $this->entityTypeManager->getStorage('patternkit_pattern')
       ->willReturn($this->patternStorage->reveal());
@@ -205,6 +215,7 @@ protected function getParserInstance(): PatternLibraryParserInterface {
       $this->dataPreProcessorFactory->reveal(),
       $this->patternDependencyResolver->reveal(),
       $this->logger->reveal(),
+      is_null($this->componentPluginManager) ? NULL : $this->componentPluginManager->reveal(),
     );
 
     if ($parser instanceof PatternkitEnvironmentAwareInterface) {
@@ -235,6 +246,7 @@ protected function getPartialMock(): MockBuilder {
         $this->dataPreProcessorFactory->reveal(),
         $this->patternDependencyResolver->reveal(),
         $this->logger->reveal(),
+        is_null($this->componentPluginManager) ? NULL : $this->componentPluginManager->reveal(),
       ]);
   }