Issue #3480614 by slucero, petermallett: Update Logger Injection to be Autoconfigured

Author: Stephen Lucero

patternkit.services.yml

@@ -17,6 +17,9 @@ parameters:
       bypass_database_cache: false
 
 services:
+  _defaults:
+    autoconfigure: true
+
   logger.channel.patternkit:
     parent: logger.channel_base
     arguments: ['patternkit']
@@ -40,7 +43,6 @@ services:
       - '@entity_type.manager'
       - '@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
@@ -67,22 +69,19 @@ services:
       - '@patternkit.pattern.discovery.loader'
       - '@patternkit.library.namespace_resolver'
       - '@cache.patternkit'
-      - '@logger.channel.patternkit'
       - '@patternkit.environment'
   patternkit.pattern.discovery.loader:
     class: Drupal\patternkit\Asset\PatternDiscoveryLoader
     arguments:
       - '@patternkit.library.namespace_resolver'
       - '@plugin.manager.library.pattern'
-      - '@logger.channel.patternkit'
     public: false
   patternkit.pattern.dependency_resolver:
     class: Drupal\patternkit\Asset\PatternDependencyResolver
     arguments:
       - '@patternkit.pattern.discovery'
       - '@entity_type.manager'
       - '@patternkit.schema.data_preprocessor.factory'
-      - '@logger.channel.patternkit'
     calls:
       - ['setContextBuilder', ['@patternkit.schema.context_builder']]
   patternkit.pattern.repository:
@@ -126,14 +125,12 @@ services:
       - '@entity_type.manager'
       - '@keyvalue.expirable'
       - '@module_handler'
-      - '@logger.channel.patternkit'
   patternkit.helper.layout:
     class: Drupal\patternkit\LayoutHelper
     arguments:
       - '@entity_type.manager'
       - '@keyvalue.expirable'
       - '@patternkit.pattern.repository'
-      - '@logger.channel.patternkit'
       - '@?layout_builder.tempstore_repository'
       - '@?plugin.manager.layout_builder.section_storage'
   patternkit.layout_batch_manager:
@@ -154,7 +151,6 @@ services:
       - '@module_handler'
       - '@serialization.json'
       - '@patternkit.schema.schema_walker_factory'
-      - '@logger.channel.patternkit'
   patternkit.schema.schema_factory:
     class: Drupal\patternkit\Schema\SchemaFactory
     arguments:
@@ -184,7 +180,6 @@ services:
       - '@config.factory'
       - '@entity_type.manager'
       - '@state'
-      - '@logger.channel.patternkit'
       - '@messenger'
       - '@string_translation'
     calls:

src/Asset/PatternDependencyResolver.php

@@ -9,35 +9,16 @@
 use Drupal\patternkit\Schema\DataPreProcessorFactory;
 use Drupal\patternkit\Schema\UnresolvedSchema;
 use MJS\TopSort\Implementations\FixedArraySort;
-use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 
 /**
  * A service to parse and identify interdependencies between pattern schemas.
  */
-class PatternDependencyResolver {
+class PatternDependencyResolver implements LoggerAwareInterface {
 
   use ContextBuilderTrait;
-
-  /**
-   * The pattern discovery service.
-   *
-   * @var \Drupal\patternkit\Asset\PatternDiscoveryInterface
-   */
-  protected PatternDiscoveryInterface $patternDiscovery;
-
-  /**
-   * The data preprocessor factory service.
-   *
-   * @var \Drupal\patternkit\Schema\DataPreProcessorFactory
-   */
-  protected DataPreProcessorFactory $dataPreProcessorFactory;
-
-  /**
-   * The entity type manager service.
-   *
-   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
-   */
-  protected EntityTypeManagerInterface $entityTypeManager;
+  use LoggerAwareTrait;
 
   /**
    * The entity storage handler for the 'patternkit_pattern' entity type.
@@ -46,13 +27,6 @@ class PatternDependencyResolver {
    */
   protected EntityStorageInterface $patternStorage;
 
-  /**
-   * The patternkit logger channel.
-   *
-   * @var \Psr\Log\LoggerInterface
-   */
-  protected LoggerInterface $logger;
-
   /**
    * An associative array of pattern dependencies keyed by pattern ID.
    *
@@ -69,20 +43,12 @@ class PatternDependencyResolver {
    *   The entity type manager service.
    * @param \Drupal\patternkit\Schema\DataPreProcessorFactory $dataPreProcessorFactory
    *   The data preprocessor factory service.
-   * @param \Psr\Log\LoggerInterface $logger
-   *   The patternkit logger channel.
    */
   public function __construct(
-    PatternDiscoveryInterface $patternDiscovery,
-    EntityTypeManagerInterface $entityTypeManager,
-    DataPreProcessorFactory $dataPreProcessorFactory,
-    LoggerInterface $logger,
-  ) {
-    $this->patternDiscovery = $patternDiscovery;
-    $this->entityTypeManager = $entityTypeManager;
-    $this->dataPreProcessorFactory = $dataPreProcessorFactory;
-    $this->logger = $logger;
-  }
+    protected PatternDiscoveryInterface $patternDiscovery,
+    protected EntityTypeManagerInterface $entityTypeManager,
+    protected DataPreProcessorFactory $dataPreProcessorFactory,
+  ) {}
 
   /**
    * Identify dependencies for all discovered patterns.

src/Asset/PatternDiscovery.php

@@ -10,16 +10,18 @@
 use Drupal\patternkit\PatternkitEnvironment;
 use Drupal\patternkit\PatternkitEnvironmentAwareInterface;
 use Drupal\patternkit\PatternkitEnvironmentAwareTrait;
-use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 
 /**
  * The pattern discovery service.
  *
  * This service provides an interface to discover and load pattern definitions
  * per namespace or by fully-namespaced pattern identifier.
  */
-class PatternDiscovery implements PatternDiscoveryInterface, PatternkitEnvironmentAwareInterface {
+class PatternDiscovery implements PatternDiscoveryInterface, PatternkitEnvironmentAwareInterface, LoggerAwareInterface {
 
+  use LoggerAwareTrait;
   use PatternkitEnvironmentAwareTrait;
   use UseCacheBackendTrait;
 
@@ -45,27 +47,6 @@ class PatternDiscovery implements PatternDiscoveryInterface, PatternkitEnvironme
     'library_info',
   ];
 
-  /**
-   * The pattern discovery loader.
-   *
-   * @var \Drupal\patternkit\Asset\PatternDiscoveryLoader
-   */
-  protected PatternDiscoveryLoader $loader;
-
-  /**
-   * The library namespace resolver service.
-   *
-   * @var \Drupal\patternkit\Asset\LibraryNamespaceResolverInterface
-   */
-  protected LibraryNamespaceResolverInterface $resolver;
-
-  /**
-   * The patternkit logger channel.
-   *
-   * @var \Psr\Log\LoggerInterface
-   */
-  protected LoggerInterface $logger;
-
   /**
    * The final collection of pattern definitions, statically cached.
    *
@@ -80,26 +61,17 @@ class PatternDiscovery implements PatternDiscoveryInterface, PatternkitEnvironme
    *   The cache collector for pattern definitions.
    * @param \Drupal\patternkit\Asset\LibraryNamespaceResolverInterface $resolver
    *   The namespace resolver service.
-   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
+   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
    *   The cache backend.
-   * @param \Psr\Log\LoggerInterface $logger
-   *   The patternkit logger channel.
-   * @param \Drupal\patternkit\PatternkitEnvironment $environment
+   * @param \Drupal\patternkit\PatternkitEnvironment $patternkitEnvironment
    *   The patternkit environment service to be used.
    */
   public function __construct(
-    PatternDiscoveryLoader $loader,
-    LibraryNamespaceResolverInterface $resolver,
-    CacheBackendInterface $cache_backend,
-    LoggerInterface $logger,
-    PatternkitEnvironment $environment,
+    protected PatternDiscoveryLoader $loader,
+    protected LibraryNamespaceResolverInterface $resolver,
+    protected $cacheBackend,
+    protected PatternkitEnvironment $patternkitEnvironment,
   ) {
-    $this->loader = $loader;
-    $this->resolver = $resolver;
-    $this->cacheBackend = $cache_backend;
-    $this->logger = $logger;
-    $this->patternkitEnvironment = $environment;
-
     // Disable caches if we're in debug mode or have this cache specifically
     // disabled.
     $disable_caches = $this->isDebug() ||

src/Asset/PatternDiscoveryLoader.php

@@ -8,7 +8,8 @@
 use Drupal\patternkit\PatternLibrary;
 use Drupal\patternkit\PatternLibraryPluginInterface;
 use Drupal\patternkit\PatternLibraryPluginManager;
-use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
 use Symfony\Component\Serializer\Serializer;
@@ -22,7 +23,9 @@
  *
  * @internal
  */
-class PatternDiscoveryLoader {
+class PatternDiscoveryLoader implements LoggerAwareInterface {
+
+  use LoggerAwareTrait;
 
   /**
    * The default library parser plugin to be used if not explicitly specified.
@@ -38,15 +41,12 @@ class PatternDiscoveryLoader {
    *   The library namespace resolver service.
    * @param \Drupal\patternkit\PatternLibraryPluginManager $libraryPluginManager
    *   The pattern library plugin manager service.
-   * @param \Psr\Log\LoggerInterface $logger
-   *   A logger for message output.
    * @param \Symfony\Component\Serializer\Normalizer\DenormalizerInterface|null $serializer
    *   (optional) A serializer for normalizing pattern library properties.
    */
   public function __construct(
     protected readonly LibraryNamespaceResolverInterface $namespaceResolver,
     protected readonly PatternLibraryPluginManager $libraryPluginManager,
-    protected readonly LoggerInterface $logger,
     protected ?DenormalizerInterface $serializer = NULL,
   ) {
     $this->serializer = $serializer ?? new Serializer([new PropertyNormalizer()]);

src/Asset/PatternLibraryParserBase.php

@@ -22,15 +22,17 @@
 use Drupal\patternkit\PatternkitEnvironmentAwareInterface;
 use Drupal\patternkit\PatternkitEnvironmentAwareTrait;
 use Drupal\patternkit\Schema\DataPreProcessorFactory;
-use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 use Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator;
 use Webmozart\Assert\Assert;
 
 /**
  * Base functionality for a pattern library parser.
  */
-abstract class PatternLibraryParserBase extends LibraryDiscoveryParser implements PatternLibraryParserInterface, PatternkitEnvironmentAwareInterface {
+abstract class PatternLibraryParserBase extends LibraryDiscoveryParser implements PatternLibraryParserInterface, PatternkitEnvironmentAwareInterface, LoggerAwareInterface {
 
+  use LoggerAwareTrait;
   use StringTranslationTrait;
   use PatternkitEnvironmentAwareTrait;
 
@@ -74,8 +76,6 @@ abstract class PatternLibraryParserBase extends LibraryDiscoveryParser implement
    *   The schema data preprocessor factory service.
    * @param \Drupal\patternkit\Asset\PatternDependencyResolver $patternDependencyResolver
    *   The pattern dependency resolver service.
-   * @param \Psr\Log\LoggerInterface $logger
-   *   The patternkit logger channel.
    * @param \Drupal\Core\Theme\ComponentPluginManager|null $componentPluginManager
    *   The theme component plugin manager if available.
    *
@@ -93,7 +93,6 @@ public function __construct(
     EntityTypeManagerInterface $entity_type_manager,
     protected DataPreProcessorFactory $dataPreProcessorFactory,
     protected PatternDependencyResolver $patternDependencyResolver,
-    protected LoggerInterface $logger,
     ?ComponentPluginManager $componentPluginManager = NULL,
   ) {
     parent::__construct(

src/JsonEditorFormBuilder.php

@@ -17,14 +17,16 @@
 use Drupal\editor\Plugin\EditorManager;
 use Drupal\patternkit\Entity\PatternInterface;
 use Drupal\patternkit\Form\PatternLibraryJSONForm;
-use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerAwareInterface;
+use Psr\Log\LoggerAwareTrait;
 use Webmozart\Assert\Assert;
 
 /**
  * A helper service to assist building a JSONEditor form into a render array.
  */
-class JsonEditorFormBuilder implements PatternFormBuilderInterface {
+class JsonEditorFormBuilder implements PatternFormBuilderInterface, LoggerAwareInterface {
 
+  use LoggerAwareTrait;
   use MessengerTrait;
   use StringTranslationTrait;
 
@@ -74,8 +76,6 @@ class JsonEditorFormBuilder implements PatternFormBuilderInterface {
    *   The entity type manager service.
    * @param \Drupal\Core\State\StateInterface $state
    *   The state service.
-   * @param \Psr\Log\LoggerInterface $logger
-   *   The logger channel to be used.
    * @param \Drupal\Core\Messenger\MessengerInterface $messenger
    *   The messenger service.
    * @param \Drupal\Core\StringTranslation\TranslationInterface $stringTranslation
@@ -86,7 +86,6 @@ public function __construct(
     protected readonly ConfigFactoryInterface $configFactory,
     protected readonly EntityTypeManagerInterface $entityTypeManager,
     protected readonly StateInterface $state,
-    protected readonly LoggerInterface $logger,
     protected $messenger,
     protected $stringTranslation,
   ) {}