Adds logging to library parsing

feat(patternkit.services.yml::logger)

Author: cybtachyon

patternkit.services.yml

@@ -1,4 +1,7 @@
 services:
+  logger.channel.patternkit:
+    parent: logger.channel_base
+    arguments: ['patternkit']
   patternkit.library.discovery:
     class: Drupal\patternkit\PatternkitLibraryDiscovery
     arguments: ['@patternkit.library.discovery.collector']
@@ -18,6 +21,6 @@ services:
     # We use '.' instead of '@app.root' as the path for non-namespaced template
     # files so that they match the relative paths of templates loaded via the
     # theme registry or via Twig namespaces.
-    arguments: ['.', '@patternkit.library.discovery.collector']
+    arguments: ['.', '@logger.channel.patternkit', '@patternkit.library.discovery.collector']
     tags:
       - { name: twig.loader, priority: 100 }

src/Controller/PatternkitController.php

@@ -9,6 +9,7 @@
 use Drupal\Core\Link;
 use Drupal\Core\Url;
 use Drupal\patternkit\Pattern;
+use Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -30,7 +31,7 @@ class PatternkitController extends ControllerBase {
    *
    * @var \Drupal\patternkit\PatternkitLibraryDiscoveryInterface
    */
-  protected $patternLibraryDiscovery;
+  protected $libraryDiscovery;
 
   /**
    * The theme handler.
@@ -44,17 +45,17 @@ class PatternkitController extends ControllerBase {
    *
    * @param \Drupal\Core\Entity\EntityStorageInterface $patternkit_storage
    *   The Patternkit storage.
-   * @param \Drupal\Core\Asset\LibraryDiscoveryInterface $pattern_library_discovery
+   * @param \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery
    *   The Pattern Library Collector.
    * @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler
    *   The theme handler.
    */
   public function __construct(
     EntityStorageInterface $patternkit_storage,
-    LibraryDiscoveryInterface $pattern_library_discovery,
+    LibraryDiscoveryInterface $library_discovery,
     ThemeHandlerInterface $theme_handler) {
     $this->patternkitStorage = $patternkit_storage;
-    $this->patternLibraryDiscovery = $pattern_library_discovery;
+    $this->libraryDiscovery = $library_discovery;
     $this->themeHandler = $theme_handler;
   }
 
@@ -69,13 +70,13 @@ public function __construct(
   public static function create(ContainerInterface $container) {
     /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager */
     $entity_manager = $container->get('entity_type.manager');
-    /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $pattern_library_discovery */
-    $pattern_library_discovery = $container->get('patternkit.library.discovery');
-    /** @var ThemeHandlerInterface $theme_handler */
+    /** @var \Drupal\Core\Asset\LibraryDiscoveryInterface $library_discovery */
+    $library_discovery = $container->get('patternkit.library.discovery');
+    /** @var \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler */
     $theme_handler = $container->get('theme_handler');
     return new static(
       $entity_manager->getStorage('patternkit_block'),
-      $pattern_library_discovery,
+      $library_discovery,
       $theme_handler
     );
   }
@@ -88,15 +89,23 @@ public static function create(ContainerInterface $container) {
    *   added.
    */
   public function add(): array {
-    $types = $this->patternLibraryDiscovery->getAssets();
+    try {
+      $types = $this->libraryDiscovery->getAssets();
+    }
+    catch (Exception $exception) {
+      $this->getLogger('patternkit')->error('Error loading pattern library assets: ', ['@message' => $exception->getMessage()]);
+      return [
+        '#markup' => $this->t('Error loading pattern library assets - check the log or the format of your libraries.yml.'),
+      ];
+    }
     if (count($types) === 0) {
       return [
         '#markup' => $this->t('Could not find any patterns to load. Did you add a theme or module that includes a patterns definition in the libraries.yml?'),
       ];
     }
     $content['types'] = [];
     $query = \Drupal::request()->query->all();
-    /** @var Pattern $type */
+    /** @var \Drupal\patternkit\Pattern $type */
     foreach ($types as $type) {
       $id = $type->getId();
       $label = $type->getLabel();
@@ -133,9 +142,9 @@ public function addForm($pattern_id, Request $request): array {
     ]);
     if (($theme = $request->query->get('theme'))
       && array_key_exists($theme, $this->themeHandler->listInfo())) {
-      // We have navigated to this page from the block library and will keep track
-      // of the theme for redirecting the user to the configuration page for the
-      // newly created block in the given theme.
+      // We have navigated to this page from the block library and will keep
+      // track of the theme for redirecting the user to the configuration page
+      // for the newly created block in the given theme.
       $block->setTheme($theme);
     }
     return $this->entityFormBuilder()->getForm($block);
@@ -152,8 +161,14 @@ public function addForm($pattern_id, Request $request): array {
    * @return \Symfony\Component\HttpFoundation\JsonResponse
    *   The schema response.
    */
-  public function ApiPatternSchema($library, $pattern): JsonResponse {
-    return new JsonResponse($this->patternLibraryDiscovery->getLibraryAsset("$library.$pattern"));
+  public function apiPatternSchema($library, $pattern): JsonResponse {
+    try {
+      $response = $this->libraryDiscovery->getLibraryAsset("$library.$pattern");
+    }
+    catch (Exception $exception) {
+      $response = ['error' => $exception->getMessage()];
+    }
+    return new JsonResponse($response);
   }
 
   /**

src/Form/PatternkitSettingsForm.php

@@ -6,6 +6,7 @@
 use Drupal\Core\Form\ConfigFormBase;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\patternkit\PatternkitLibraryDiscoveryInterface;
+use Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 class PatternkitSettingsForm extends ConfigFormBase {
@@ -14,10 +15,10 @@ class PatternkitSettingsForm extends ConfigFormBase {
   public const SETTINGS = 'patternkit.settings';
 
   /** @var \Drupal\patternkit\PatternkitLibraryDiscoveryInterface */
-  protected $patternLibraryDiscovery;
+  protected $libraryDiscovery;
 
   public function __construct(ConfigFactoryInterface $config_factory, PatternkitLibraryDiscoveryInterface $pattern_discovery) {
-    $this->patternLibraryDiscovery = $pattern_discovery;
+    $this->libraryDiscovery = $pattern_discovery;
     parent::__construct($config_factory);
   }
 
@@ -34,7 +35,16 @@ public static function create(ContainerInterface $container) {
    */
   public function buildForm(array $form, FormStateInterface $form_state) :array {
     $config = $this->config(static::SETTINGS);
-    $libraries = $this->patternLibraryDiscovery->getLibraries();
+    try {
+      $libraries = $this->libraryDiscovery->getLibraries();
+    }
+    catch (Exception $exception) {
+      $this->getLogger('patternkit')->error('Unable to load Patternkit libraries list: @message', ['@message' => $exception->getMessage()]);
+      \Drupal::messenger()->addMessage(t('Unable to load Patternkit libraries list. Check the logs for more information.'), 'error');
+      return [
+        '#markup' => $this->t('Settings are unavailable when Pattern libraries fail to load to prevent config errors.'),
+      ];
+    }
     $library_options = array();
     $library_values = array();
     foreach ($libraries as $lib_title => $library) {
@@ -98,13 +108,11 @@ public function submitForm(array &$form, FormStateInterface $form_state): void {
     $config = $this->config(static::SETTINGS);
     if ($form_state['values']['patternkit_cache_enabled']
       && !$config->get('patternkit_cache_enabled')) {
-      $libraries = $this->patternLibraryDiscovery->getLibraries();
-      foreach ($libraries as $library) {
-        $library->getCachedMetadata(NULL, TRUE);
-      }
+      $this->libraryDiscovery->clearCachedDefinitions();
     }
-
-    $this->messenger()->addStatus($this->t('Rebuilt Patternkit Library Cache.'));
+    $libraries = $this->libraryDiscovery->getLibraries();
+    $count = count($libraries);
+    $this->messenger()->addStatus($this->t('Rebuilt Patternkit Library Cache with @count libraries.', ['@count' => $count]));
     parent::submitForm($form, $form_state);
   }
 

src/Loader/PatternLibraryLoader.php

@@ -2,8 +2,9 @@
 
 namespace Drupal\patternkit\Loader;
 
-use Drupal\Component\Plugin\Exception\PluginException;
+use Drupal\Core\Logger\LoggerChannelInterface;
 use Drupal\patternkit\PatternLibraryCollector;
+use Exception;
 
 /**
  * Functionality for parsing Twig pattern libraries.
@@ -15,19 +16,23 @@ class PatternLibraryLoader extends \Twig_Loader_Filesystem {
    *
    * @param string|array $paths
    *   Paths to pass to the Filesystem loader.
+   * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
+   *   Logs to the patternkit channel.
    * @param \Drupal\patternkit\PatternLibraryCollector $pattern_collector
    *   Provides library names and paths.
+   *
+   * @throws \Twig\Error\LoaderError
    */
   public function __construct($paths,
+    LoggerChannelInterface $logger,
     PatternLibraryCollector $pattern_collector) {
     parent::__construct($paths);
     $libraries = [];
     try {
       $libraries = $pattern_collector->getLibraryDefinitions();
     }
-    catch (PluginException $exception) {
-      // Do not block rendering if libraries do not load.
-      // @todo Add logging service and log.
+    catch (Exception $exception) {
+      $logger->error('Error loading pattern libraries: @message', ['@message' => $exception->getMessage()]);
     }
     foreach ($libraries as $namespace => $library) {
       $path = $library['data'];

src/PatternLibraryCollector.php

@@ -146,17 +146,17 @@ public static function create(ContainerInterface $container): self {
    */
   public function getLibraryDefinitions(): array {
     $config = $this->configFactory->get(PatternkitSettingsForm::SETTINGS);
-    $patternkit_cache_enabled = $config->get('patternkit_cache_enabled');
+    $cache_enabled = $config->get('patternkit_cache_enabled');
     // If cache is enabled, attempt to load from cache.
-    if ($patternkit_cache_enabled
+    if ($cache_enabled
       && ($cache = $this->cache->get(static::PERSISTENT_CACHE_ID))) {
       $cached_metadata = $cache->data;
     }
     else {
       $cached_metadata = $this->getLibraryMetadata();
       // Cache the data so that we don't have to build it again.
       // (if cache enabled, otherwise just a slow, redundant memcache set).
-      if ($patternkit_cache_enabled === TRUE) {
+      if ($cache_enabled === TRUE) {
         // Explicit copy of the data into cache_set to avoid implicit copy.
         $this->cache->set(static::PERSISTENT_CACHE_ID,
           $cached_metadata);
@@ -294,10 +294,13 @@ public function buildByExtension($extension_type, $extension): array {
 
   /**
    * Returns a specific library by name, collected from all extensions.
+   *
    * @param string $name
    *   The name of the library, registered by libraries.yml.
+   *
    * @return array|null
    *   The pattern library metadata.
+   *
    * @throws \Drupal\Component\Plugin\Exception\PluginException
    */
   public function getLibraryByName($name): ?array {
@@ -394,6 +397,8 @@ protected function applyLibrariesOverride($libraries, $extension): array {
    *   When a circular reference is detected.
    * @throws \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
    *   When the service is not defined.
+   * @throws \Drupal\Core\Asset\Exception\InvalidLibraryFileException
+   *   Thrown if an invalid library path was passed to the parser.
    */
   protected function getLibraryMetadata(): array {
     $container = \Drupal::getContainer();

src/PatternLibraryParser/TwigPatternLibraryParser.php

@@ -3,11 +3,16 @@
 namespace Drupal\patternkit\PatternLibraryParser;
 
 use Drupal\Component\Serialization\SerializationInterface;
+use Drupal\Core\Asset\Exception\InvalidLibraryFileException;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Theme\ThemeManagerInterface;
 use Drupal\patternkit\Pattern;
 use Drupal\patternkit\PatternEditorConfig;
 use Drupal\patternkit\PatternLibraryParserBase;
+use function dump;
+use function file_exists;
+use function get_call_stack;
+use function kint_trace;
 use function strlen;
 use Symfony\Component\Finder\Iterator\RecursiveDirectoryIterator;
 
@@ -115,16 +120,19 @@ public function fetchPatternAssets(Pattern $pattern,
    *   An array of parsed library data.
    *
    * @throws \Drupal\Core\Asset\Exception\InvalidLibraryFileException
-   *   Thrown when a parser exception got thrown.
+   *   Thrown when a parser exception was thrown.
    */
   public function parseLibraryInfo($library, $path, array $library_data = []): array {
-    $it = new RecursiveDirectoryIterator($path, \FilesystemIterator::KEY_AS_PATHNAME | \FilesystemIterator::CURRENT_AS_FILEINFO);
+    if (!file_exists($path)) {
+      throw new InvalidLibraryFileException("Path $path does not exist.");
+    }
+    $rdit = new RecursiveDirectoryIterator($path, \FilesystemIterator::KEY_AS_PATHNAME | \FilesystemIterator::CURRENT_AS_FILEINFO);
     $filter = ['json', 'twig'];
     $metadata = [];
     $components = [];
 
     /** @var \SplFileInfo $file */
-    foreach (new \RecursiveIteratorIterator($it) as $file) {
+    foreach (new \RecursiveIteratorIterator($rdit) as $file) {
       // Skip directories and non-files.
       if (!$file->isFile()) {
         continue;
@@ -153,7 +161,7 @@ public function parseLibraryInfo($library, $path, array $library_data = []): arr
     foreach ($components as $name => $data) {
       // If the component has a json file, create the pattern from it.
       if (!empty($data['json']) && $file_contents = file_get_contents($data['json'])) {
-        $pattern = $this->createPattern($name, $this->serializer::decode($file_contents) + $library_data);
+        $pattern = $this->createPattern($name, (array) $this->serializer::decode($file_contents) + $library_data);
         $pattern->name = $name;
         // URL is redundant for the twig based components, so we use it to
         // store namespace.
@@ -164,7 +172,7 @@ public function parseLibraryInfo($library, $path, array $library_data = []): arr
       else {
         // Create the pattern from defaults.
         $pattern = $this->createPattern($name,
-          (object) [
+          [
             '$schema'    => 'http =>//json-schema.org/draft-04/schema#',
             'category'   => 'atom',
             'title'      => $name,

src/PatternkitLibraryDiscovery.php

@@ -5,7 +5,9 @@
 use Drupal\Core\Asset\LibraryDiscovery;
 
 /**
- * The PatternkitLibraryDiscovery is meant to be an enhancement to Drupal Core
+ * Enhances core library handling.
+ *
+ * PatternkitLibraryDiscovery is meant to be an enhancement to Drupal Core
  * Library handling that allows for arbitrary libraries and loading via plugins.
  *
  * The existing library infrastructure is likely overcomplicated and could be
@@ -22,7 +24,11 @@
  */
 class PatternkitLibraryDiscovery extends LibraryDiscovery implements PatternkitLibraryDiscoveryInterface {
 
-  /** @var \Drupal\patternkit\PatternLibraryCollector */
+  /**
+   * Collects libraries in a cache-able manner and is destructible.
+   *
+   * @var \Drupal\patternkit\PatternLibraryCollector
+   */
   protected $collector;
 
   /**

src/PatternkitLibraryDiscoveryInterface.php

@@ -4,13 +4,19 @@
 
 use Drupal\Core\Asset\LibraryDiscoveryInterface;
 
+/**
+ * Allows for implementations of a Pattern Library Discovery service.
+ */
 interface PatternkitLibraryDiscoveryInterface extends LibraryDiscoveryInterface {
 
   /**
    * Returns an array of library assets keyed by library and file.
    *
-   * @return array
+   * @return \Drupal\patternkit\Pattern[]
    *   An array of library assets.
+   *
+   * @throws \Drupal\Core\Asset\Exception\IncompleteLibraryDefinitionException
+   * @throws \Drupal\Core\Asset\Exception\InvalidLibraryFileException
    */
   public function getAssets(): array;
 
@@ -23,12 +29,20 @@ public function getAssets(): array;
    * @param string $key
    *   The asset key.
    *
-   * @return mixed
+   * @return mixed|null
+   *   The specific asset requested or NULL if not found.
+   *
+   * @throws \Drupal\Core\Asset\Exception\IncompleteLibraryDefinitionException
+   * @throws \Drupal\Core\Asset\Exception\InvalidLibraryFileException
    */
   public function getLibraryAsset($key);
 
   /**
-   * @return \Drupal\patternkit\Pattern[]
+   * Returns an array of all libraries.
+   *
+   * @return array
+   *   All libraries as definitions, keyed by library name.
    */
   public function getLibraries(): array;
+
 }