@amazeelabs/silverback-gatsby 3.7.13

package/drupal/silverback_gatsby/src/GatsbyUpdateTrigger.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Drupal\silverback_gatsby;
+
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Messenger\MessengerInterface;
+use GuzzleHttp\Client;
+
+class GatsbyUpdateTrigger implements GatsbyUpdateTriggerInterface {
+
+  /**
+   * @var \Drupal\silverback_gatsby\GatsbyUpdate[][]
+   */
+  protected array $updates = [];
+
+  protected Client $httpClient;
+  protected EntityTypeManagerInterface $entityTypeManager;
+  protected MessengerInterface $messenger;
+
+  public function __construct(
+    Client $httpClient,
+    MessengerInterface $messenger,
+    EntityTypeManagerInterface $entityTypeManager
+  ) {
+    $this->httpClient = $httpClient;
+    $this->messenger = $messenger;
+    $this->entityTypeManager = $entityTypeManager;
+  }
+
+  protected function getWebhook($server_id) {
+    $server = $this->entityTypeManager
+      ->getStorage('graphql_server')
+      ->load($server_id);
+    $schema_id = $server->get('schema');
+    if (isset($server->get('schema_configuration')[$schema_id]['update_webhook'])) {
+      return $server->get('schema_configuration')[$schema_id]['update_webhook'];
+    }
+    return NULL;
+  }
+
+  public function trigger(string $server, GatsbyUpdate $update): void {
+    // Make sure the shutdown function is registered only once.
+    if (!$this->updates) {
+      drupal_register_shutdown_function([$this, 'sendUpdates']);
+    }
+    if ($url = $this->getWebhook($server)) {
+      $this->updates[$url][] = $update;
+    }
+  }
+
+  public function sendUpdates(): void {
+    foreach ($this->updates as $url => $updates) {
+      try {
+        $this->httpClient->post($url, [
+          'json' => array_map(fn ($update) => [
+            'type' => $update->type,
+            'id' => $update->id,
+          ], $updates),
+          // It can happen that a request hangs for too long time.
+          'timeout' => 2,
+        ]);
+      } catch (\Exception $exc) {
+        $this->messenger->addError('Could not send build notification to server "' . $url . '".');
+        $this->messenger->addError($exc->getMessage());
+      }
+    }
+  }
+
+}

package/drupal/silverback_gatsby/src/GatsbyUpdateTriggerInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Drupal\silverback_gatsby;
+
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
+interface GatsbyUpdateTriggerInterface {
+
+  /**
+   * Trigger an update for a given server with a type name and entity id.
+   *
+   * @param string $server
+   *   The server id.
+   * @param \Drupal\silverback_gatsby\GatsbyUpdate $update
+   */
+  public function trigger(string $server, GatsbyUpdate $update) : void;
+
+  /**
+   * Send out notifications about potential updates to all Gatsby servers.
+   */
+  public function sendUpdates() : void;
+}

package/drupal/silverback_gatsby/src/GraphQL/Build.php

@@ -0,0 +1,235 @@
+<?php
+
+namespace Drupal\silverback_gatsby\GraphQL;
+
+use Drupal\Component\Plugin\ConfigurableInterface;
+use Drupal\Core\Ajax\AjaxResponse;
+use Drupal\Core\Ajax\HtmlCommand;
+use Drupal\Core\Entity\EntityForm;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Form\SubformState;
+use Drupal\Core\Plugin\PluginFormInterface;
+use Drupal\Core\Session\AccountProxyInterface;
+use Drupal\graphql\Plugin\SchemaPluginManager;
+use Drupal\silverback_gatsby\GatsbyBuildTriggerInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Gatsby build specific configuration of the schema.
+ *
+ * @package Drupal\silverback_gatsby\GraphQL
+ */
+class Build extends EntityForm {
+
+  /**
+   * The schema plugin manager.
+   *
+   * @var \Drupal\graphql\Plugin\SchemaPluginManager
+   */
+  protected $schemaManager;
+
+  /**
+   * The Gatsby update trigger.
+   *
+   * @var \Drupal\silverback_gatsby\GatsbyBuildTriggerInterface
+   */
+  protected $buildTrigger;
+
+  /**
+   * The current user.
+   *
+   * @var \Drupal\Core\Session\AccountProxyInterface
+   */
+  protected $currentUser;
+
+  /**
+   * ServerForm constructor.
+   *
+   * @param \Drupal\graphql\Plugin\SchemaPluginManager $schemaManager
+   *   The schema plugin manager.
+   *
+   * @codeCoverageIgnore
+   */
+  public function __construct(
+    SchemaPluginManager $schemaManager,
+    GatsbyBuildTriggerInterface $buildTrigger,
+    AccountProxyInterface $currentUser
+  ) {
+    $this->schemaManager = $schemaManager;
+    $this->buildTrigger = $buildTrigger;
+    $this->currentUser = $currentUser;
+  }
+
+  /**
+   * {@inheritdoc}
+   *
+   * @codeCoverageIgnore
+   */
+  public static function create(ContainerInterface $container): self {
+    return new static(
+      $container->get('plugin.manager.graphql.schema'),
+      $container->get('silverback_gatsby.build_trigger'),
+      $container->get('current_user')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(
+    array $form,
+    FormStateInterface $form_state
+  ) {
+    /** @var \Drupal\graphql\Entity\ServerInterface $server */
+    $server = $this->entity;
+    $schema = $server->get('schema');
+    $enabled = (bool) $this->entity->get('schema_configuration')[$schema]['extensions']['silverback_gatsby'];
+    if (!$enabled) {
+      $form['message'] = [
+        '#type' => 'html_tag',
+        '#tag' => 'p',
+        '#value' => $this->t('The Gatsby extension is not enabled for this schema.'),
+      ];
+      return $form;
+    }
+
+    $form = parent::buildForm($form, $form_state);
+
+    $form['trigger_build'] = [
+      '#type' => 'button',
+      '#value' => $this->t('Gatsby Build'),
+      '#required' => FALSE,
+      '#ajax' => [
+        'callback' => [$this, 'gatsbyBuild'],
+      ],
+      '#suffix' => '<span class="gatsby-build-message"></span>',
+    ];
+
+
+    $form['actions']['#access'] = $this->currentUser->hasPermission('administer graphql configuration');
+    $form['schema_configuration'] = [
+      '#type' => 'container',
+      '#access' => $this->currentUser->hasPermission('administer graphql configuration'),
+      '#prefix' => '<div id="edit-schema-configuration-plugin-wrapper">',
+      '#suffix' => '</div>',
+      '#tree' => TRUE,
+    ];
+
+    /** @var \Drupal\graphql\Plugin\SchemaPluginInterface $instance */
+    $instance = $schema ? $this->schemaManager->createInstance($schema) : NULL;
+    if ($instance instanceof PluginFormInterface && $instance instanceof ConfigurableInterface) {
+      $configuration = $server->get('schema_configuration');
+      $form['schema_configuration'][$schema] = [
+        '#type' => 'fieldset',
+        '#title' => $this->t('Build configuration'),
+        '#tree' => TRUE,
+      ];
+
+      $buildSettings['build_trigger_on_save'] = [
+        '#type' => 'checkbox',
+        '#required' => FALSE,
+        '#title' => $this->t('Trigger a build on entity save.'),
+        '#description' => $this->t('If not checked, make sure to have an alternate build method (cron, manual).'),
+        '#default_value' => $configuration[$schema]['build_trigger_on_save'] ?? '',
+      ];
+      $buildSettings['build_webhook'] = [
+        '#type' => 'textfield',
+        '#required' => FALSE,
+        '#title' => $this->t('Build webhook'),
+        '#description' => $this->t('A webhook that will be notified when content changes relevant to this server happen.'),
+        '#default_value' => $configuration[$schema]['build_webhook'] ?? '',
+      ];
+      $buildSettings['update_webhook'] = [
+        '#type' => 'textfield',
+        '#required' => FALSE,
+        '#title' => $this->t('Update webhook'),
+        '#description' => $this->t('A webhook to notify clients about realtime data updates.'),
+        '#default_value' => $configuration[$schema]['update_webhook'] ?? '',
+      ];
+      $buildSettings['build_url'] = [
+        '#type' => 'url',
+        '#required' => FALSE,
+        '#title' => $this->t('Build url'),
+        '#description' => $this->t('The frontend url that is the result of the build. With the scheme and without a trailing slash (https://www.example.com).'),
+        '#default_value' => $configuration[$schema]['build_url'] ?? '',
+      ];
+      $buildSettings['build_url_netlify_password'] = [
+        '#type' => 'textfield',
+        '#required' => FALSE,
+        '#title' => $this->t('Netlify password for "Build url"'),
+        '#description' => $this->t('If "Build url" is hosted on Netlify and is password protected.'),
+        '#default_value' => $configuration[$schema]['build_url_netlify_password'] ?? '',
+      ];
+
+      /** @var \Drupal\graphql\Form\ServerForm $formObject */
+      $formObject = $form_state->getFormObject();
+      /** @var \Drupal\graphql\Entity\Server $server */
+      $server = $formObject->getEntity();
+
+      $buildSettings['user'] = [
+        '#type' => 'select',
+        '#options' => ['' => $this->t('- None -')],
+        '#title' => $this->t('Notification user'),
+        '#description' => $this->t('Only changes visible to this user will trigger build updates.'),
+        '#default_value' => $configuration[$schema]['user'] ?? '',
+        '#states'=> [
+          'required' => [
+            ':input[name="schema_configuration[' . $server->schema . '][extensions][silverback_gatsby]"]' => ['checked' => TRUE],
+          ],
+        ],
+      ];
+      $users = [];
+      /** @var \Drupal\user\UserInterface $user */
+      foreach ($this->entityTypeManager->getStorage('user')->loadMultiple() as $user) {
+        $users[$user->uuid()] = $user->getAccountName() === '' ? 'Anonymous' : $user->getAccountName();
+      }
+      natcasesort($users);
+      $buildSettings['user']['#options'] += $users;
+      $form['schema_configuration'][$schema] += $buildSettings;
+    }
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildEntity(array $form, FormStateInterface $form_state) {
+    $entity = clone $this->entity;
+    $entity->schema_configuration[$entity->schema] = array_merge($entity->schema_configuration[$entity->schema], $form_state->getValue('schema_configuration')[$entity->schema]);
+    return $entity;
+  }
+
+  /**
+   * Gatsby build.
+   *
+   * @param array $form
+   *   An associative array containing the structure of the form.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   The current state of the form.
+   *
+   * @return \Drupal\Core\Ajax\AjaxResponse
+   *   AjaxResponse.
+   */
+  public function gatsbyBuild(array $form, FormStateInterface $form_state) {
+    $response = new AjaxResponse();
+    $buildMessage = $this->buildTrigger->triggerLatestBuild($this->entity->id());
+    $response->addCommand(new HtmlCommand('.gatsby-build-message', $buildMessage));
+    return $response;
+  }
+
+  /**
+   * {@inheritdoc}
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
+   */
+  public function save(array $form, FormStateInterface $form_state) {
+    $save_result = parent::save($form, $form_state);
+    $this->messenger()->addMessage($this->t('Saved the %label server.', [
+      '%label' => $this->entity->label(),
+    ]));
+
+    $form_state->setRedirect('entity.graphql_server.collection');
+    return $save_result;
+  }
+
+}

package/drupal/silverback_gatsby/src/GraphQL/ComposableSchema.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Drupal\silverback_gatsby\GraphQL;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Core\Cache\CacheBackendInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\graphql\Plugin\SchemaExtensionPluginManager;
+use Drupal\graphql_directives\DirectivePrinter;
+use Drupal\graphql_directives\Plugin\GraphQL\Schema\DirectableSchema;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * @deprecated Use \Drupal\graphql_directives\Plugin\GraphQL\Schema\DirectableSchema instead.
+ *
+ * @package Drupal\silverback_gatsby\GraphQL
+ */
+class ComposableSchema extends DirectableSchema {
+
+  protected EntityTypeManagerInterface $entityTypeManager;
+  protected RouteMatchInterface $routeMatch;
+
+  public function __construct(
+    array $configuration,
+    $pluginId,
+    array $pluginDefinition,
+    CacheBackendInterface $astCache,
+    ModuleHandlerInterface $moduleHandler,
+    SchemaExtensionPluginManager $extensionManager,
+    ?PluginManagerInterface $directiveManager,
+    ?DirectivePrinter $directivePrinter,
+    EntityTypeManagerInterface $entityTypeManager,
+    RouteMatchInterface $routeMatch,
+    array $config
+  ) {
+    parent::__construct(
+      $configuration,
+      $pluginId,
+      $pluginDefinition,
+      $astCache,
+      $moduleHandler,
+      $extensionManager,
+      $directiveManager,
+      $directivePrinter,
+      $config,
+    );
+    $this->entityTypeManager = $entityTypeManager;
+    $this->routeMatch = $routeMatch;
+  }
+
+  public static function create(
+    ContainerInterface $container,
+    array $configuration,
+    $plugin_id,
+    $plugin_definition
+  ) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('cache.graphql.ast'),
+      $container->get('module_handler'),
+      $container->get('plugin.manager.graphql.schema_extension'),
+      $container->get('graphql_directives.manager'),
+      $container->get('graphql_directives.printer'),
+      $container->get('entity_type.manager'),
+      $container->get('current_route_match'),
+      $container->getParameter('graphql.config')
+    );
+  }
+}

package/drupal/silverback_gatsby/src/LocaleStorageDecorator.php

@@ -0,0 +1,181 @@
+<?php
+
+namespace Drupal\silverback_gatsby;
+
+use Drupal\locale\StringContextInterface;
+use Drupal\locale\StringStorageInterface;
+use Drupal\silverback_gatsby\Plugin\Gatsby\Feed\StringTranslationFeed;
+use Drupal\silverback_gatsby\Plugin\Gatsby\Feed\TranslatableStringFeed;
+
+class LocaleStorageDecorator implements StringStorageInterface, StringContextInterface {
+
+  /**
+   * @var \Drupal\locale\StringStorageInterface
+   */
+  protected StringStorageInterface $subject;
+
+  /**
+   * @var \Drupal\silverback_gatsby\GatsbyUpdateHandler
+   */
+  protected GatsbyUpdateHandler $updateHandler;
+
+  /**
+   * @param \Drupal\locale\StringStorageInterface $subject
+   *   The decorated locale storage service.
+   */
+  public function __construct(
+    StringStorageInterface $subject
+  ) {
+    $this->subject = $subject;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getStrings(array $conditions = [], array $options = []) {
+    $strings = $this->subject->getStrings($conditions, $options);
+    $this->updateStringsStorage($strings);
+    return $strings;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getTranslations(array $conditions = [], array $options = []) {
+    $translations = $this->subject->getTranslations($conditions, $options);
+    $this->updateStringsStorage($translations);
+    return $translations;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getLocations(array $conditions = []) {
+    return $this->subject->getLocations($conditions);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function findString(array $conditions) {
+    $string = $this->subject->findString($conditions);
+    if (!empty($string)) {
+      $string->setStorage($this);
+    }
+    return $string;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function findTranslation(array $conditions) {
+    $translation = $this->subject->findTranslation($conditions);
+    if (!empty($translation)) {
+      $translation->setStorage($this);
+    }
+    return $translation;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function save($string) {
+    $this->subject->save($string);
+    $string->setStorage($this);
+    // For now, we only track strings which have a context, for performance
+    // reasons.
+    if (!empty($string->context)) {
+      $this->getGatsbyUpdateHandler()->handle(StringTranslationFeed::class, $string);
+      $this->getGatsbyUpdateHandler()->handle(TranslatableStringFeed::class, $string);
+    }
+    return $this;
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function delete($string) {
+    // This does not need to trigger a gatsby update handler event since it
+    // seems that removing a translation (which means just setting its value to
+    // nothing) triggers the save method as well.
+    return $this->subject->delete($string);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function deleteStrings($conditions) {
+    return $this->subject->deleteStrings($conditions);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function deleteTranslations($conditions) {
+    return $this->subject->deleteTranslations($conditions);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function countStrings() {
+    return $this->subject->countStrings();
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function countTranslations() {
+    return $this->subject->countTranslations();
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function createString($values = []) {
+    return $this->subject->createString($values + ['storage' => $this]);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function createTranslation($values = []) {
+    return $this->subject->createTranslation($values + ['storage' => $this]);
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getContexts(): array {
+    if ($this->subject instanceof StringContextInterface) {
+      return $this->subject->getContexts();
+    }
+    return [];
+  }
+
+  /**
+   * Get a gatsby update handler service. We need to instantiate this here to
+   * prevent a circular dependency issue for entity_type.manager: twig ->
+   * twig.extension -> date.formatter -> entity_type.manager ->
+   * string_translation -> string_translator.locale.lookup -> locale.storage ->
+   * silverback_gatsby.update_handler
+   */
+  protected function getGatsbyUpdateHandler() {
+    if (!isset($this->updateHandler)) {
+      $this->updateHandler = \Drupal::getContainer()->get('silverback_gatsby.update_handler');
+    }
+    return $this->updateHandler;
+  }
+
+  /**
+   * Updates the storage reference of a set of strings.
+   * @param \Drupal\locale\StringInterface[] $strings
+   */
+  protected function updateStringsStorage(array $strings) {
+    if (!empty($strings)) {
+      foreach ($strings as $string) {
+        $string->setStorage($this);
+      }
+    }
+  }
+}