Deprecate LoggerTrait

modules/common/common.services.yml

@@ -43,6 +43,10 @@ services:
       - [setResourceMapper, ['@?dkan.metastore.resource_mapper']]
       - [setImportInfo, ['@?dkan.datastore.import_info']]
 
+  dkan.common.logger_channel:
+    parent: logger.channel_base
+    arguments: [ 'dkan' ]
+
   plugin.manager.dkan_api_docs:
     class: \Drupal\common\Plugin\DkanApiDocsPluginManager
     parent: default_plugin_manager

modules/common/src/LoggerTrait.php

@@ -7,6 +7,8 @@
 
 /**
  * DKAN logger channel trait.
+ *
+ * @deprecated Use an injected logger service instead.
  */
 trait LoggerTrait {
 

modules/datastore/datastore.services.yml

@@ -50,14 +50,14 @@ services:
       - '@dkan.metastore.reference_lookup'
       - '@dkan.metastore.storage'
       - '@dkan.datastore.service'
-    calls:
-      - [setLoggerFactory, ['@logger.factory']]
+      - '@dkan.datastore.logger_channel'
 
   dkan.datastore.service.factory.import:
     class: \Drupal\datastore\Service\Factory\ImportServiceFactory
     arguments:
       - '@dkan.datastore.import_job_store_factory'
       - '@dkan.datastore.database_table_factory'
+      - '@dkan.datastore.logger_channel'
 
   dkan.datastore.logger_channel:
     parent: logger.channel_base
@@ -81,6 +81,7 @@ services:
     class: \Drupal\datastore\Storage\DatabaseTableFactory
     arguments:
       - '@dkan.datastore.database'
+      - '@dkan.datastore.logger_channel'
 
   dkan.datastore.sql_endpoint.service:
     class: \Drupal\datastore\SqlEndpoint\DatastoreSqlEndpointService

modules/datastore/modules/datastore_mysql_import/datastore_mysql_import.services.yml

@@ -1,11 +1,14 @@
 services:
-  dkan.datastore.service.factory.import:
+  dkan.datastore_mysql_import.service.factory.import:
+    decorates: dkan.datastore.service.factory.import
     class: \Drupal\datastore_mysql_import\Factory\MysqlImportFactory
     arguments:
       - '@dkan.datastore.import_job_store_factory'
       - '@dkan.datastore_mysql_import.database_table_factory'
+      - '@dkan.datastore.logger_channel'
 
   dkan.datastore_mysql_import.database_table_factory:
     class: \Drupal\datastore_mysql_import\Storage\MySqlDatabaseTableFactory
     arguments:
       - '@dkan.datastore.database'
+      - '@dkan.datastore.logger_channel'

modules/datastore/modules/datastore_mysql_import/src/Factory/MysqlImportFactory.php

@@ -7,6 +7,7 @@
 use Drupal\datastore\Storage\ImportJobStoreFactory;
 use Drupal\datastore_mysql_import\Service\MysqlImport;
 use Drupal\datastore_mysql_import\Storage\MySqlDatabaseTableFactory;
+use Psr\Log\LoggerInterface;
 
 /**
  * Mysql importer factory.
@@ -27,12 +28,24 @@ class MysqlImportFactory implements ImportFactoryInterface {
    */
   private $databaseTableFactory;
 
+  /**
+   * DKAN logger channel service.
+   *
+   * @var \Psr\Log\LoggerInterface
+   */
+  private LoggerInterface $logger;
+
   /**
    * Constructor.
    */
-  public function __construct(ImportJobStoreFactory $importJobStoreFactory, MySqlDatabaseTableFactory $databaseTableFactory) {
+  public function __construct(
+    ImportJobStoreFactory $importJobStoreFactory,
+    MySqlDatabaseTableFactory $databaseTableFactory,
+    LoggerInterface $loggerChannel
+  ) {
     $this->importJobStoreFactory = $importJobStoreFactory;
     $this->databaseTableFactory = $databaseTableFactory;
+    $this->logger = $loggerChannel;
   }
 
   /**
@@ -46,7 +59,12 @@ public function getInstance(string $identifier, array $config = []) {
       throw new \Exception("config['resource'] is required");
     }
 
-    $importer = new ImportService($resource, $this->importJobStoreFactory, $this->databaseTableFactory);
+    $importer = new ImportService(
+      $resource,
+      $this->importJobStoreFactory,
+      $this->databaseTableFactory,
+      $this->logger
+    );
     $importer->setImporterClass(MysqlImport::class);
     return $importer;
   }

modules/datastore/modules/datastore_mysql_import/src/Storage/MySqlDatabaseTableFactory.php

@@ -13,7 +13,7 @@ class MySqlDatabaseTableFactory extends DatabaseTableFactory {
    * {@inheritDoc}
    */
   protected function getDatabaseTable($resource) {
-    return new MySqlDatabaseTable($this->connection, $resource);
+    return new MySqlDatabaseTable($this->connection, $resource, $this->logger);
   }
 
 }

modules/datastore/src/Service/Factory/ImportServiceFactory.php

@@ -5,6 +5,7 @@
 use Drupal\datastore\Service\ImportService;
 use Drupal\datastore\Storage\DatabaseTableFactory;
 use Drupal\datastore\Storage\ImportJobStoreFactory;
+use Psr\Log\LoggerInterface;
 
 /**
  * Create an importer object for a given resource.
@@ -25,12 +26,24 @@ class ImportServiceFactory implements ImportFactoryInterface {
    */
   private $databaseTableFactory;
 
+  /**
+   * DKAN logger channel service.
+   *
+   * @var \Psr\Log\LoggerInterface
+   */
+  private LoggerInterface $logger;
+
   /**
    * Constructor.
    */
-  public function __construct(ImportJobStoreFactory $importJobStoreFactory, DatabaseTableFactory $databaseTableFactory) {
+  public function __construct(
+    ImportJobStoreFactory $importJobStoreFactory,
+    DatabaseTableFactory $databaseTableFactory,
+    LoggerInterface $loggerChannel
+  ) {
     $this->importJobStoreFactory = $importJobStoreFactory;
     $this->databaseTableFactory = $databaseTableFactory;
+    $this->logger = $loggerChannel;
   }
 
   /**
@@ -40,7 +53,12 @@ public function __construct(ImportJobStoreFactory $importJobStoreFactory, Databa
    */
   public function getInstance(string $identifier, array $config = []) {
     if ($resource = $config['resource'] ?? FALSE) {
-      return new ImportService($resource, $this->importJobStoreFactory, $this->databaseTableFactory);
+      return new ImportService(
+        $resource,
+        $this->importJobStoreFactory,
+        $this->databaseTableFactory,
+        $this->logger
+      );
     }
     throw new \Exception("config['resource'] is required");
   }

modules/datastore/src/Service/ImportService.php

@@ -3,14 +3,14 @@
 namespace Drupal\datastore\Service;
 
 use CsvParser\Parser\Csv;
-use Drupal\datastore\Plugin\QueueWorker\ImportJob;
-use Drupal\common\EventDispatcherTrait;
-use Drupal\common\LoggerTrait;
 use Drupal\common\DataResource;
+use Drupal\common\EventDispatcherTrait;
+use Drupal\datastore\Plugin\QueueWorker\ImportJob;
 use Drupal\datastore\Storage\DatabaseTable;
 use Drupal\datastore\Storage\DatabaseTableFactory;
 use Drupal\datastore\Storage\ImportJobStoreFactory;
 use Procrastinator\Result;
+use Psr\Log\LoggerInterface;
 
 /**
  * Datastore importer.
@@ -20,7 +20,7 @@
  *   as a property.
  */
 class ImportService {
-  use LoggerTrait;
+
   use EventDispatcherTrait;
 
   /**
@@ -76,6 +76,13 @@ class ImportService {
    */
   private ?ImportJob $importJob = NULL;
 
+  /**
+   * Logger channel service.
+   *
+   * @var \Psr\Log\LoggerInterface
+   */
+  private LoggerInterface $logger;
+
   /**
    * Create a resource service instance.
    *
@@ -85,11 +92,19 @@ class ImportService {
    *   Import jobstore factory.
    * @param \Drupal\datastore\Storage\DatabaseTableFactory $databaseTableFactory
    *   Database Table factory.
+   * @param \Psr\Log\LoggerInterface $loggerChannel
+   *   DKAN logger channel service.
    */
-  public function __construct(DataResource $resource, ImportJobStoreFactory $importJobStoreFactory, DatabaseTableFactory $databaseTableFactory) {
+  public function __construct(
+    DataResource $resource,
+    ImportJobStoreFactory $importJobStoreFactory,
+    DatabaseTableFactory $databaseTableFactory,
+    LoggerInterface $loggerChannel
+  ) {
     $this->resource = $resource;
     $this->importJobStoreFactory = $importJobStoreFactory;
     $this->databaseTableFactory = $databaseTableFactory;
+    $this->logger = $loggerChannel;
   }
 
   /**
@@ -117,8 +132,7 @@ public function import() {
 
     if ($result->getStatus() === Result::ERROR) {
       $datastore_resource = $this->getResource()->getDatastoreResource();
-      $this->setLoggerFactory(\Drupal::service('logger.factory'));
-      $this->error('Error importing resource id:%id path:%path message:%message', [
+      $this->logger->error('Error importing resource id:%id path:%path message:%message', [
         '%id' => $datastore_resource->getId(),
         '%path' => $datastore_resource->getFilePath(),
         '%message' => $result->getError(),

modules/datastore/src/Service/ResourceLocalizer.php

@@ -5,7 +5,6 @@
 use Contracts\FactoryInterface;
 use Drupal\common\DataResource;
 use Drupal\common\EventDispatcherTrait;
-use Drupal\common\LoggerTrait;
 use Drupal\common\UrlHostTokenResolver;
 use Drupal\common\Util\DrupalFiles;
 use Drupal\Core\File\FileSystemInterface;
@@ -21,7 +20,6 @@
  */
 class ResourceLocalizer {
 
-  use LoggerTrait;
   use EventDispatcherTrait;
 
   /**

modules/datastore/src/Service/ResourcePurger.php

@@ -4,22 +4,19 @@
 
 use Drupal\Core\Config\ConfigFactoryInterface;
 use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
-
-use Drupal\common\LoggerTrait;
-use Drupal\common\DataResource;
 use Drupal\Core\Entity\EntityPublishedInterface;
+use Drupal\common\DataResource;
 use Drupal\datastore\DatastoreService;
 use Drupal\metastore\ReferenceLookupInterface;
 use Drupal\metastore\Storage\DataFactory;
 use Drupal\node\NodeInterface;
-
+use Psr\Log\LoggerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Resource purger service.
  */
 class ResourcePurger implements ContainerInjectionInterface {
-  use LoggerTrait;
 
   /**
    * The datastore.settings config.
@@ -49,6 +46,13 @@ class ResourcePurger implements ContainerInjectionInterface {
    */
   private $storage;
 
+  /**
+   * DKAN logger channel service.
+   *
+   * @var \Psr\Log\LoggerInterface
+   */
+  private LoggerInterface $logger;
+
   /**
    * Constructs a ResourcePurger object.
    *
@@ -60,12 +64,21 @@ class ResourcePurger implements ContainerInjectionInterface {
    *   The dkan.metastore.storage service.
    * @param \Drupal\datastore\DatastoreService $datastore
    *   The dkan.datastore.service service.
+   * @param \Psr\Log\LoggerInterface $loggerChannel
+   *   DKAN logger channel service.
    */
-  public function __construct(ConfigFactoryInterface $configFactory, ReferenceLookupInterface $referenceLookup, DataFactory $dataFactory, DatastoreService $datastore) {
+  public function __construct(
+    ConfigFactoryInterface $configFactory,
+    ReferenceLookupInterface $referenceLookup,
+    DataFactory $dataFactory,
+    DatastoreService $datastore,
+    LoggerInterface $loggerChannel
+  ) {
     $this->config = $configFactory->get('datastore.settings');
     $this->referenceLookup = $referenceLookup;
     $this->storage = $dataFactory->getInstance('dataset');
     $this->datastore = $datastore;
+    $this->logger = $loggerChannel;
   }
 
   /**
@@ -76,7 +89,8 @@ public static function create(ContainerInterface $container) {
       $container->get('config.factory'),
       $container->get('dkan.metastore.reference_lookup'),
       $container->get('dkan.metastore.storage'),
-      $container->get('dkan.datastore.service')
+      $container->get('dkan.datastore.service'),
+      $container->get('dkan.datastore.logger_channel')
     );
   }
 
@@ -147,7 +161,7 @@ private function queue(array $uuids, bool $prior) {
       'uuids' => $uuids,
       'prior' => $prior,
     ]);
-    $this->notice('Queued resource purging with queueId:%queueId uuids:%uuids', [
+    $this->logger->notice('Queued resource purging with queueId:%queueId uuids:%uuids', [
       '%queueId' => $queueId,
       '%uuids' => implode(', ', $uuids),
     ]);
@@ -184,7 +198,7 @@ public function purgeHelper(int $vid, string $uuid, bool $prior) {
       $this->purge($vid, $uuid, $prior);
     }
     catch (\Exception $e) {
-      $this->error("Error purging uuid {$uuid}, revision id {$vid}: " . $e->getMessage());
+      $this->logger->error("Error purging uuid {$uuid}, revision id {$vid}: " . $e->getMessage());
     }
   }
 
@@ -387,7 +401,7 @@ private function removeResourceLocalizer(string $id, string $version) {
       $this->datastore->getResourceLocalizer()->remove($id, $version);
     }
     catch (\Exception $e) {
-      $this->error("Error removing resource localizer id {$id}, version {$version}: " . $e->getMessage());
+      $this->logger->error("Error removing resource localizer id {$id}, version {$version}: " . $e->getMessage());
     }
   }
 
@@ -404,7 +418,7 @@ private function removeDatastoreStorage(string $id, string $version) {
       $this->datastore->getStorage($id, $version)->destruct();
     }
     catch (\Exception $e) {
-      $this->error("Error deleting datastore id {$id}, version {$version}: " . $e->getMessage());
+      $this->logger->error("Error deleting datastore id {$id}, version {$version}: " . $e->getMessage());
     }
   }