@amazeelabs/silverback-gatsby 3.7.13

package/drupal/silverback_gatsby/src/MenuTreeStorageDecorator.php

@@ -0,0 +1,139 @@
+<?php
+
+namespace Drupal\silverback_gatsby;
+
+use Drupal\Core\Menu\MenuTreeParameters;
+use Drupal\Core\Menu\MenuTreeStorageInterface;
+use Drupal\silverback_gatsby\Plugin\Gatsby\Feed\MenuFeed;
+
+/**
+ * Decorates the menu tree storage and sends updates to Gatsby on modifications.
+ */
+class MenuTreeStorageDecorator implements MenuTreeStorageInterface {
+
+  /**
+   * @var \Drupal\Core\Menu\MenuTreeStorageInterface
+   */
+  protected MenuTreeStorageInterface $subject;
+
+  /**
+   * @var \Drupal\silverback_gatsby\GatsbyUpdateHandler
+   */
+  protected GatsbyUpdateHandler $updateHandler;
+
+  /**
+   * @param \Drupal\Core\Menu\MenuTreeStorageInterface $subject
+   *   The decorated menu tree storage service.
+   * @param \Drupal\silverback_gatsby\GatsbyUpdateHandler $updateHandler
+   *   A Gatsby update handler to send events to.
+   */
+  public function __construct(
+    MenuTreeStorageInterface $subject,
+    GatsbyUpdateHandler $updateHandler
+  ) {
+    $this->subject = $subject;
+    $this->updateHandler = $updateHandler;
+  }
+
+  /**
+   * Send updates after updating a menu item.
+   * {@inheritDoc}
+   */
+  public function save(array $definition) {
+    // Emit change events before save to detect if the menu item moved out of
+    // a certain level range.
+    $this->updateHandler->handle(MenuFeed::class, $definition['id']);
+    $this->subject->save($definition);
+    // Emit change events after save to update the range it is now in.
+    $this->updateHandler->handle(MenuFeed::class, $definition['id']);
+  }
+
+  /**
+   * Send updates before deleting a menu item.
+   * {@inheritDoc}
+   */
+  public function delete($id) {
+    // Delete update handler has to run before the actual delete operation,
+    // because afterwards its position in the tree is lost, and it's not possible
+    // to determine which layers are affected.
+    $this->updateHandler->handle(MenuFeed::class, $id);
+    $this->subject->delete($id);
+  }
+
+  // ======================================================================
+  // Untouched public interface.
+  // ======================================================================
+
+  public function maxDepth() {
+    return $this->subject->maxDepth();
+  }
+
+  public function resetDefinitions() {
+    return $this->subject->resetDefinitions();
+  }
+
+  public function rebuild(array $definitions) {
+    return $this->subject->rebuild($definitions);
+  }
+
+  public function load($id) {
+    return $this->subject->load($id);
+  }
+
+  public function loadMultiple(array $ids) {
+    return $this->subject->loadMultiple($ids);
+  }
+
+  public function loadByProperties(array $properties) {
+    return $this->subject->loadByProperties($properties);
+  }
+
+  public function loadByRoute(
+    $route_name,
+    array $route_parameters = [],
+    $menu_name = NULL
+  ) {
+    return $this->subject->loadByRoute($route_name, $route_parameters, $menu_name);
+  }
+
+  public function loadTreeData($menu_name, MenuTreeParameters $parameters) {
+    return $this->subject->loadTreeData($menu_name, $parameters);
+  }
+
+  public function loadAllChildren($id, $max_relative_depth = NULL) {
+    return $this->subject->loadAllChildren($id, $max_relative_depth);
+  }
+
+  public function getAllChildIds($id) {
+    return $this->subject->getAllChildIds($id);
+  }
+
+  public function loadSubtreeData($id, $max_relative_depth = NULL) {
+    return $this->subject->loadSubtreeData($id, $max_relative_depth);
+  }
+
+  public function getRootPathIds($id) {
+    return $this->subject->getRootPathIds($id);
+  }
+
+  public function getExpanded($menu_name, array $parents) {
+    return $this->subject->getExpanded($menu_name, $parents);
+  }
+
+  public function getSubtreeHeight($id) {
+    return $this->subject->getSubtreeHeight($id);
+  }
+
+  public function menuNameInUse($menu_name) {
+    return $this->subject->menuNameInUse($menu_name);
+  }
+
+  public function getMenuNames() {
+    return $this->subject->getMenuNames();
+  }
+
+  public function countMenuLinks($menu_name = NULL) {
+    return $this->subject->countMenuLinks($menu_name);
+  }
+
+}

package/drupal/silverback_gatsby/src/Plugin/FeedBase.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Plugin;
+
+use Drupal\Component\Plugin\PluginBase;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\graphql\GraphQL\ResolverBuilder;
+use Drupal\graphql\GraphQL\ResolverRegistryInterface;
+use Drupal\silverback_gatsby\GatsbyUpdate;
+use GraphQL\Language\AST\DocumentNode;
+
+/**
+ * Base class for Gatsby Data feeds.
+ */
+abstract class FeedBase extends PluginBase implements FeedInterface {
+
+  /**
+   * The GraphQL type this feed generates.
+   *
+   * @var string|mixed
+   */
+  protected string $typeName;
+
+  /**
+   * The name of a GraphQL field containing the URL path of a node.
+   *
+   * @var string|null
+   */
+  protected ?string $pathFieldName;
+
+  /**
+   * The name of a GraphQL field containing the template name for a node.
+   *
+   * @var string|null
+   */
+  protected ?string $templateFieldName;
+
+  /**
+   * Instance of a ResolverBuilder.
+   *
+   * @var \Drupal\graphql\GraphQL\ResolverBuilder
+   */
+  protected ResolverBuilder $builder;
+
+  /**
+   * FeedBase constructor.
+   *
+   * @param $config
+   * @param $plugin_id
+   * @param $plugin_definition
+   */
+  public function __construct($config, $plugin_id, $plugin_definition) {
+    parent::__construct($config, $plugin_id, $plugin_definition);
+    $this->builder = new ResolverBuilder();
+    $this->typeName = $config['typeName'];
+    $this->pathFieldName = $config['createPageFields']['isPath'] ?? NULL;
+    $this->templateFieldName = $config['createPageFields']['isTemplate'] ?? NULL;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getExtensionDefinition(DocumentNode $parentAst): string {
+    return '';
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function addExtensionResolvers(
+    ResolverRegistryInterface $registry,
+    ResolverBuilder $builder
+  ): void {}
+
+
+  public function getTypeName() : string {
+    return $this->typeName;
+  }
+
+  public function getSingleFieldName(): string {
+    return '_load' . $this->typeName;
+  }
+
+  public function getListFieldName(): string {
+    return '_query' . $this->typeName . 's';
+  }
+
+  public function info(): array {
+    return [
+      'typeName' => $this->getTypeName(),
+      'translatable' => $this->isTranslatable(),
+      'singleFieldName' => $this->getSingleFieldName(),
+      'listFieldName' => $this->getListFieldName(),
+      'pathFieldName' => $this->pathFieldName,
+      'templateFieldName' => $this->templateFieldName,
+    ];
+  }
+
+  /**
+   * Investigate the context of an update event and return its id if
+   * applicable.
+   *
+   * @param mixed $context
+   * @param \Drupal\Core\Session\AccountInterface|null $account
+   *
+   * @return string[]
+   *   A list of string id's to update.
+   */
+  abstract function getUpdateIds($context, ?AccountInterface $account): array;
+
+  /**
+   * {@inheritDoc}
+   */
+  public function investigateUpdate($context, ?AccountInterface $account) : array {
+    return array_map(
+      fn ($id) => new GatsbyUpdate($this->getTypeName(), $id),
+      $this->getUpdateIds($context, $account)
+    );
+  }
+
+}

package/drupal/silverback_gatsby/src/Plugin/FeedInterface.php

@@ -0,0 +1,132 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Plugin;
+
+use Drupal\Core\Session\AccountInterface;
+use Drupal\graphql\GraphQL\Resolver\ResolverInterface;
+use Drupal\graphql\GraphQL\ResolverBuilder;
+use Drupal\graphql\GraphQL\ResolverRegistryInterface;
+use GraphQL\Language\AST\DocumentNode;
+
+/**
+ * Interface FeedInterface
+ *
+ * Describes a single data-feed that is sent to Gatsby.
+ *
+ * @package Drupal\silverback_gatsby
+ */
+interface FeedInterface {
+
+  /**
+   * Retrieve feed meta information used by the GraphQL schema.
+   *
+   * @return array
+   */
+  public function info() : array;
+
+  /**
+   * Define extension schema definitions this Feed provides.
+   *
+   * @param \GraphQL\Language\AST\DocumentNode $parentAst
+   *
+   * @return string
+   */
+  public function getExtensionDefinition(DocumentNode $parentAst) : string;
+
+  /**
+   * Build resolvers for the defined schema definitions.
+   *
+   * @param \Drupal\graphql\GraphQL\ResolverRegistryInterface $registry
+   * @param \Drupal\graphql\GraphQL\ResolverBuilder $builder
+   */
+  public function addExtensionResolvers(ResolverRegistryInterface $registry, ResolverBuilder $builder) : void;
+
+  /**
+   * Decide if a type is translatable or not.
+   *
+   * @return bool
+   */
+  public function isTranslatable() : bool;
+
+  /**
+   * Investigate an arbitrary context value and produce a GatsbyUpdate if
+   * applicable.
+   *
+   * @param $context
+   * @param \Drupal\Core\Session\AccountInterface|null $account
+   *
+   * @return \Drupal\silverback_gatsby\GatsbyUpdate[]
+   */
+  public function investigateUpdate($context, ?AccountInterface $account) : array;
+
+  /**
+   * Resolve the parent value's "id" attribute.
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveId() : ResolverInterface;
+
+  /**
+   * Resolve the parent value's language association.
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveLangcode() : ResolverInterface;
+
+
+  /**
+   * Determine if the item is the default translation.
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveDefaultTranslation() : ResolverInterface;
+
+  /**
+   * Resolve a list of all available translations.
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveTranslations() : ResolverInterface;
+
+  /**
+   * Resolve a paginated list of all items of this type.
+   *
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $limit
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $offset
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveItems(ResolverInterface $limit, ResolverInterface $offset) : ResolverInterface;
+
+  /**
+   * Load a single item by ID.
+   *
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface $id
+   * @param \Drupal\graphql\GraphQL\Resolver\ResolverInterface|null $langcode
+   *
+   * @return \Drupal\graphql\GraphQL\Resolver\ResolverInterface
+   */
+  public function resolveItem(ResolverInterface $id, ?ResolverInterface $langcode = null) : ResolverInterface;
+
+
+  /**
+   * Retrieve the GraphQL type name this feed emits.
+   *
+   * @return string
+   */
+  public function getTypeName() : string;
+
+  /**
+   * Retrieve the field name to load a single item.
+   *
+   * @return string
+   */
+  public function getSingleFieldName() : string;
+
+  /**
+   * Retrieve the field name to fetch multiple items via pagination.
+   *
+   * @return string
+   */
+  public function getListFieldName() : string;
+}

package/drupal/silverback_gatsby/src/Plugin/FeedPluginManager.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Plugin;
+
+use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;
+use Drupal\Core\Plugin\DefaultPluginManager;
+
+/**
+ * Class FeedPluginManager
+ *
+ * @package Drupal\silverback_gatsby\Plugin
+ */
+class FeedPluginManager extends DefaultPluginManager {
+
+  protected function findDefinitions() {
+    $definitions = parent::findDefinitions();
+
+    // Attach the directive definition for each feed plugin so it is available
+    // along with the plugin definition.
+    foreach ($definitions as $id => $def) {
+      $module = \Drupal::moduleHandler()->getModule($def['provider']);
+      $path = 'graphql/' . $id . '.directive.graphqls';
+      $file = $module->getPath() . '/' . $path;
+
+      if (!file_exists($file)) {
+        throw new InvalidPluginDefinitionException(
+          $id,
+          sprintf('The module "%s" needs to have a directive definition "%s" in its folder for "%s" to be valid.',
+            $module->getName(), $path, $id));
+      }
+
+      $definitions[$id]['directive'] = file_get_contents($file);
+    }
+
+    return $definitions;
+  }
+
+
+}

package/drupal/silverback_gatsby/src/Plugin/Gatsby/Feed/EntityFeed.php

@@ -0,0 +1,252 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Plugin\Gatsby\Feed;
+
+use Drupal\content_translation\ContentTranslationManagerInterface;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\TranslatableInterface;
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\graphql\GraphQL\Resolver\ResolverInterface;
+use Drupal\graphql\GraphQL\ResolverBuilder;
+use Drupal\graphql\GraphQL\ResolverRegistryInterface;
+use Drupal\node\Entity\Node;
+use Drupal\path_alias\AliasManagerInterface;
+use Drupal\path_alias\Entity\PathAlias;
+use Drupal\silverback_gatsby\Plugin\FeedBase;
+use Drupal\silverback_gatsby\Plugin\GraphQL\DataProducer\GatsbyBuildId;
+use GraphQL\Language\AST\DocumentNode;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Feed plugin that creates Gatsby feeds based on Drupal entities.
+ *
+ * @GatsbyFeed(
+ *   id = "entity"
+ * )
+ */
+class EntityFeed extends FeedBase implements ContainerFactoryPluginInterface {
+
+  /**
+   * The target entity type.
+   *
+   * @var string
+   */
+  protected string $type;
+
+  /**
+   * The target entity bundle.
+   *
+   * @var string|null
+   */
+  protected ?string $bundle;
+
+  /**
+   * Indicates if Drupal access restrictions should be respected.
+   *
+   * Defaults to true.
+   *
+   * @var bool
+   */
+  protected bool $access;
+
+  /**
+   * @var \Drupal\content_translation\ContentTranslationManagerInterface|null
+   */
+  protected ?ContentTranslationManagerInterface $contentTranslationManager;
+
+  /**
+   * The path alias manager.
+   *
+   * @var \Drupal\path_alias\AliasManagerInterface
+   */
+  protected $pathAliasManager;
+
+  /**
+   * {@inheritDoc}
+   */
+  public static function create(
+    ContainerInterface $container,
+    array $configuration,
+    $plugin_id,
+    $plugin_definition
+  ) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->has('content_translation.manager') ? $container->get('content_translation.manager') : NULL,
+      $container->get('path_alias.manager')
+    );
+  }
+
+  public function __construct(
+    $config,
+    $plugin_id,
+    $plugin_definition,
+    ?ContentTranslationManagerInterface $contentTranslationManager,
+    AliasManagerInterface $path_alias_manager
+  ) {
+    $this->type = $config['type'];
+    $this->bundle = $config['bundle'] ?? NULL;
+    $this->access = $config['access'] ?? TRUE;
+    $this->contentTranslationManager = $contentTranslationManager;
+    $this->pathAliasManager = $path_alias_manager;
+
+    parent::__construct(
+      $config,
+      $plugin_id,
+      $plugin_definition
+    );
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function isTranslatable(): bool {
+    return $this->contentTranslationManager &&
+      $this->contentTranslationManager->isEnabled($this->type, $this->bundle);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getUpdateIds($context, ?AccountInterface $account) : array {
+
+    // Special case for path alias.
+    if ($context instanceof PathAlias) {
+      $path = $this->pathAliasManager->getPathByAlias($context->alias->value);
+      if (preg_match('/node\/(\d+)/', $path, $matches)) {
+        $node = isset($matches[1]) ? Node::load($matches[1]) : NULL;
+        if ($node) {
+          // See SLB-281 for details.
+          $context = $node;
+        }
+      }
+    }
+
+    if (
+      $context instanceof EntityInterface
+      && $context->getEntityTypeId() === $this->type
+      && ($this->bundle !== NULL && $context->bundle() === $this->bundle)
+      && (!$account || $context->access('view', $account))
+    ) {
+      if ($this->isTranslatable() && $context instanceof TranslatableInterface) {
+        return array_map(function (LanguageInterface $lang) use ($context) {
+          $translation = $context->getTranslation($lang->getId());
+          return GatsbyBuildId::build($context->uuid(), $translation->language()->getId());
+        }, $context->getTranslationLanguages());
+      }
+      return [$context->uuid()];
+    }
+    return [];
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveItem(ResolverInterface $id, ?ResolverInterface $langcode = NULL): ResolverInterface {
+    $resolver = $this->builder->produce('fetch_entity')
+      ->map('type', $this->builder->fromValue($this->type))
+      ->map('bundles', $this->builder->fromValue($this->bundle === NULL ? NULL : [$this->bundle]))
+      ->map('access', $this->builder->fromValue($this->access))
+      ->map('id', $id);
+    if ($this->isTranslatable() && $langcode) {
+      $resolver->map('language', $langcode);
+    }
+    return $resolver;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveItems(ResolverInterface $limit, ResolverInterface $offset): ResolverInterface {
+    return $this->builder->produce('list_entities')
+      ->map('type', $this->builder->fromValue($this->type))
+      ->map('bundle', $this->builder->fromValue($this->bundle))
+      ->map('access', $this->builder->fromValue($this->access))
+      ->map('offset', $this->builder->defaultValue(
+        $this->builder->fromArgument('offset'),
+        $this->builder->fromValue(0)
+      ))
+      ->map('limit', $this->builder->defaultValue(
+        $this->builder->fromArgument('limit'),
+        $this->builder->fromValue(10),
+      ));
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveId(): ResolverInterface {
+    return $this->builder->produce('entity_uuid')
+      ->map('entity', $this->builder->fromParent());
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveLangcode(): ResolverInterface {
+    return $this->builder->callback(
+      fn(TranslatableInterface $value) => $value->language()->getId()
+    );
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveDefaultTranslation(): ResolverInterface {
+    return $this->builder->callback(
+      fn(TranslatableInterface $value) => $value->isDefaultTranslation()
+    );
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function resolveTranslations(): ResolverInterface {
+    return $this->builder->defaultValue(
+      $this->builder->compose(
+        $this->builder->produce('entity_translations')->map('entity', $this->builder->fromParent()),
+        // entity_translations returns nulls for inaccessible translations. This
+        // does not match our schema. Filter nulls out.
+        $this->builder->callback(fn ($entities) => $entities ? array_filter($entities) : NULL)
+      ),
+      $this->builder->callback(fn ($value) => [$value])
+    );
+  }
+
+  /**
+   *
+   */
+  public function getExtensionDefinition(DocumentNode $parentAst): string {
+    $type = $this->typeName;
+    return "\nextend type Query { _load{$type}Revision(id: String!, revision: String!) : $type @deprecated }";
+  }
+
+  /**
+   *
+   */
+  public function addExtensionResolvers(
+    ResolverRegistryInterface $registry,
+    ResolverBuilder $builder
+  ): void {
+    $type = $this->typeName;
+    $idResolver = $this->isTranslatable()
+      ? $builder->produce('gatsby_extract_id')->map('id', $builder->fromArgument('id'))
+      : $builder->fromArgument('id');
+    $langResolver = $this->isTranslatable()
+      ? $builder->produce('gatsby_extract_langcode')->map('id', $builder->fromArgument('id'))
+      : $builder->fromValue(NULL);
+    $resolver = $this->builder->produce('fetch_entity')
+      ->map('type', $this->builder->fromValue($this->type))
+      ->map('bundles', $this->builder->fromValue($this->bundle === NULL ? NULL : [$this->bundle]))
+      ->map('access', $this->builder->fromValue($this->access))
+      ->map('id', $idResolver)
+      ->map('language', $langResolver)
+      ->map('revision_id', $builder->fromArgument('revision'));
+    $registry->addFieldResolver("Query", "_load{$type}Revision", $resolver);
+  }
+
+}