@amazeelabs/silverback-gatsby 3.7.13

package/drupal/silverback_gatsby/silverback_gatsby.install

@@ -0,0 +1,180 @@
+<?php
+/**
+ * Implements hook_schema().
+ */
+function silverback_gatsby_schema() {
+  $schema['gatsby_update_log'] = [
+    'description' => 'Table that contains logs of all system events.',
+    'fields' => [
+      'id' => [
+        'type' => 'serial',
+        'not null' => TRUE,
+        'description' => 'Primary Key: Unique update id.',
+      ],
+      'server' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the related GraphQL server.',
+      ],
+      'type' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The GraphQL type that changed.',
+      ],
+      'object_id' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the Graph object that changed.',
+      ],
+      'uid' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'The {users}.uid of the user who triggered the update.',
+      ],
+      'timestamp' => [
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'Unix timestamp when the update happened.',
+      ],
+    ],
+    'primary key' => ['id'],
+    'indexes' => [
+      'server' => ['server'],
+      'object_id' => ['object_id'],
+    ],
+  ];
+
+  return $schema;
+}
+
+/**
+ * Add index to "server" field on the "gatsby_update_log" database table.
+ */
+function silverback_gatsby_update_8001() {
+  $table = 'gatsby_update_log';
+  $tableSpec = [
+    'description' => 'Table that contains logs of all system events.',
+    'fields' => [
+      'id' => [
+        'type' => 'serial',
+        'not null' => TRUE,
+        'description' => 'Primary Key: Unique update id.',
+      ],
+      'server' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the related GraphQL server.',
+      ],
+      'type' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The GraphQL type that changed.',
+      ],
+      'object_id' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the Graph object that changed.',
+      ],
+      'uid' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'The {users}.uid of the user who triggered the update.',
+      ],
+      'timestamp' => [
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'Unix timestamp when the update happened.',
+      ],
+    ],
+    'primary key' => ['id'],
+    'indexes' => [
+      'server' => ['server'],
+    ],
+  ];
+  $index = 'server';
+  $indexFields = ['server'];
+  $schema = \Drupal::database()->schema();
+  if (!$schema->indexExists($table, $index)) {
+    $schema->addIndex($table, $index, $indexFields, $tableSpec);
+  }
+}
+
+/**
+ * Add index to "object_id" field on the "gatsby_update_log" database table.
+ */
+function silverback_gatsby_update_8002() {
+  $table = 'gatsby_update_log';
+  $tableSpec = [
+    'description' => 'Table that contains logs of all system events.',
+    'fields' => [
+      'id' => [
+        'type' => 'serial',
+        'not null' => TRUE,
+        'description' => 'Primary Key: Unique update id.',
+      ],
+      'server' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the related GraphQL server.',
+      ],
+      'type' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The GraphQL type that changed.',
+      ],
+      'object_id' => [
+        'type' => 'varchar_ascii',
+        'length' => 64,
+        'not null' => TRUE,
+        'default' => '',
+        'description' => 'The id of the Graph object that changed.',
+      ],
+      'uid' => [
+        'type' => 'int',
+        'unsigned' => TRUE,
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'The {users}.uid of the user who triggered the update.',
+      ],
+      'timestamp' => [
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => 'Unix timestamp when the update happened.',
+      ],
+    ],
+    'primary key' => ['id'],
+    'indexes' => [
+      'server' => ['server'],
+      'object_id' => ['object_id'],
+    ],
+  ];
+  $index = 'object_id';
+  $indexFields = ['object_id'];
+  $schema = \Drupal::database()->schema();
+  if (!$schema->indexExists($table, $index)) {
+    $schema->addIndex($table, $index, $indexFields, $tableSpec);
+  }
+}

package/drupal/silverback_gatsby/silverback_gatsby.links.task.yml

@@ -0,0 +1,6 @@
+entity.graphql_server.build_form:
+  route_name: entity.graphql_server.build_form
+  base_route: entity.graphql_server.edit_form
+  title: Build
+  title_context: silverback_gatsby
+  weight: -1

package/drupal/silverback_gatsby/silverback_gatsby.module

@@ -0,0 +1,119 @@
+<?php
+
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\silverback_gatsby\Plugin\Gatsby\Feed\EntityFeed;
+use Drupal\user\UserInterface;
+
+
+function _silverback_gatsby_entity_event(EntityInterface $entity) {
+  /** @var \Drupal\silverback_gatsby\GatsbyUpdateHandler $updateHandler */
+  $updateHandler = \Drupal::service('silverback_gatsby.update_handler');
+  $updateHandler->handle(EntityFeed::class, $entity);
+
+  if (\Drupal::hasService('entity_usage.usage')) {
+    /** @var \Drupal\entity_usage\EntityUsage $entityUsage */
+    $entityUsage = \Drupal::service('entity_usage.usage');
+    foreach ($entityUsage->listSources($entity) as $sourceEntityType => $sources) {
+      $entities = \Drupal::entityTypeManager()
+        ->getStorage($sourceEntityType)
+        ->loadMultiple(array_keys($sources));
+      foreach ($entities as $source) {
+        $updateHandler->handle(EntityFeed::class, $source);
+      }
+    }
+  }
+}
+
+/**
+ * Implements hook_entity_insert().
+ */
+function silverback_gatsby_entity_insert(EntityInterface $entity) {
+  _silverback_gatsby_entity_event($entity);
+}
+
+/**
+ * Implements hook_entity_presave().
+ */
+function silverback_gatsby_entity_presave(EntityInterface $entity) {
+  if (!empty($entity->original)) {
+    _silverback_gatsby_entity_event($entity->original);
+  }
+}
+
+/**
+ * Implements hook_entity_update().
+ */
+function silverback_gatsby_entity_update(EntityInterface $entity) {
+  \Drupal::entityTypeManager()
+    ->getAccessControlHandler($entity->getEntityTypeId())
+    ->resetCache();
+  _silverback_gatsby_entity_event($entity);
+}
+
+/**
+ * Implements hook_entity_predelete().
+ */
+function silverback_gatsby_entity_predelete(EntityInterface $entity) {
+  _silverback_gatsby_entity_event($entity);
+}
+
+/**
+ * Implements hook_module_implements_alter().
+ */
+function silverback_gatsby_module_implements_alter(&$implementations, $hook) {
+  // Act before entity_usage module.
+  if (in_array($hook, ['entity_insert', 'entity_update', 'entity_predelete'], TRUE)) {
+    $implementations = [
+      'silverback_gatsby' => $implementations['silverback_gatsby'],
+    ] + $implementations;
+  }
+}
+
+/**
+ * Implements hook_entity_type_alter().
+ */
+function silverback_gatsby_entity_type_alter(array &$entity_types) {
+  /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
+  foreach ($entity_types as $entity_type) {
+    if ($entity_type->id() === 'graphql_server') {
+      if (!$entity_type->hasHandlerClass('build')) {
+        $entity_type->setHandlerClass(
+          'build',
+          Drupal\silverback_gatsby\GraphQL\Build::class
+        );
+      }
+      if (!$entity_type->getFormClass('build')) {
+        $entity_type->setFormClass(
+          'build',
+          Drupal\silverback_gatsby\GraphQL\Build::class
+        );
+      }
+    }
+  }
+}
+
+/**
+ * Implements hook_user_login().
+ */
+function silverback_gatsby_user_login(UserInterface $account) {
+  // Write a javascript-accessible cookie that tells the frontend if the user is
+  // authenticated, so it can make additional requests based on that information.
+  $opts = \Drupal::getContainer()->getParameter('session.storage.options');
+  if (isset($opts['cookie_domain'])) {
+    $expires = isset($opts['cookie_lifetime'])
+      ? \Drupal::time()->getRequestTime() + $opts['cookie_lifetime']
+      : 0;
+    setcookie('drupal_user', $account->id(), $expires, '/', $opts['cookie_domain'], false, false);
+  }
+}
+
+/**
+ * Implements hook_user_logout().
+ */
+function silverback_gatsby_user_logout() {
+  // Unset the frontend user-indicator cookie.
+  unset($_COOKIE['drupal_user']);
+  $opts = \Drupal::getContainer()->getParameter('session.storage.options');
+  $expires = \Drupal::time()->getRequestTime() - 3600;
+  setcookie('drupal_user', '', $expires, '/', $opts['cookie_domain'] ?? '', false, false);
+}

package/drupal/silverback_gatsby/silverback_gatsby.permissions.yml

@@ -0,0 +1,8 @@
+view publisher status:
+  title: 'View Publisher status'
+trigger a gatsby build:
+  title: 'Trigger a Gatsby Build'
+access publisher:
+  title: 'Access Publisher'
+fetch any autosaved entity:
+  title: 'Fetch any autosaved entity'

package/drupal/silverback_gatsby/silverback_gatsby.post_update.php

@@ -0,0 +1,15 @@
+<?php
+
+use Drupal\user\Entity\Role;
+
+/**
+ * Introduce "view publisher status" permission.
+ */
+function silverback_gatsby_post_update_introduce_view_publisher_status_permission(&$sandbox): void {
+  foreach (Role::loadMultiple() as $role) {
+    // The status was visible for everyone who could see the toolbar.
+    if ($role->hasPermission('access toolbar')) {
+      $role->grantPermission('view publisher status')->save();
+    }
+  }
+}

package/drupal/silverback_gatsby/silverback_gatsby.routing.yml

@@ -0,0 +1,28 @@
+entity.graphql_server.build_form:
+  path: '/admin/config/graphql/servers/build/{graphql_server}'
+  defaults:
+    _entity_form: 'graphql_server.build'
+    _title: 'Build'
+    _title_context: silverback_gatsby
+  requirements:
+    _permission: 'administer graphql configuration+trigger a gatsby build'
+  options:
+    _admin_route: TRUE
+silverback_gatsby.build:
+  path: '/silverback_gatsby/ajax/build'
+  defaults:
+    _controller: '\Drupal\silverback_gatsby\Controller\BuildController::build'
+  requirements:
+    _permission: 'trigger a gatsby build'
+publisher.access:
+  path: '/publisher/access'
+  defaults:
+    _controller: '\Drupal\silverback_gatsby\Controller\PublisherController::hasAccess'
+  methods: [POST]
+  requirements:
+    # Required for the refresh token.
+    _access: 'TRUE'
+    _format: 'json'
+  options:
+    _auth: ['oauth2']
+    no_cache: TRUE

package/drupal/silverback_gatsby/silverback_gatsby.services.yml

@@ -0,0 +1,50 @@
+services:
+  silverback_gatsby.feed_manager:
+    class: Drupal\silverback_gatsby\Plugin\FeedPluginManager
+    arguments:
+      - 'Plugin/Gatsby/Feed'
+      - '@container.namespaces'
+      - '@module_handler'
+      - '\Drupal\silverback_gatsby\Plugin\FeedInterface'
+      - '\Drupal\silverback_gatsby\Annotation\GatsbyFeed'
+
+  silverback_gatsby.build_trigger:
+    class: Drupal\silverback_gatsby\GatsbyBuildTrigger
+    arguments:
+      - '@http_client'
+      - '@messenger'
+      - '@entity_type.manager'
+
+  silverback_gatsby.update_trigger:
+    class: Drupal\silverback_gatsby\GatsbyUpdateTrigger
+    arguments:
+      - '@http_client'
+      - '@messenger'
+      - '@entity_type.manager'
+
+  silverback_gatsby.update_tracker:
+    class: Drupal\silverback_gatsby\GatsbyUpdateTracker
+    arguments:
+      ['@database', '@current_user', '@silverback_gatsby.build_trigger']
+
+  silverback_gatsby.update_handler:
+    class: Drupal\silverback_gatsby\GatsbyUpdateHandler
+    arguments:
+      - '@entity_type.manager'
+      - '@silverback_gatsby.update_tracker'
+      - '@silverback_gatsby.update_trigger'
+
+  silverback_gatsby.menu_tree_storage:
+    class: Drupal\silverback_gatsby\MenuTreeStorageDecorator
+    decorates: menu.tree_storage
+    public: false
+    arguments:
+      [
+        '@silverback_gatsby.menu_tree_storage.inner',
+        '@silverback_gatsby.update_handler',
+      ]
+
+  silverback_gatsby.reverse_proxy_middleware:
+    class: Drupal\silverback_gatsby\SilverbackReverseProxyMiddleware
+    tags:
+      - { name: http_middleware, priority: 500 }

package/drupal/silverback_gatsby/src/Annotation/GatsbyFeed.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Annotation;
+
+use Doctrine\Common\Annotations\AnnotationException;
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Annotation for Gatsby GraphQL data feeds.
+ *
+ * @Annotation
+ * @codeCoverageIgnore
+ */
+class GatsbyFeed extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * It also serves as the handle for the GraphQL directive.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * Feed constructor.
+   *
+   * @param mixed $values
+   *   The plugin annotation values.
+   *
+   * @throws \Doctrine\Common\Annotations\AnnotationException
+   *   In case of missing required values.
+   */
+  public function __construct($values) {
+    if (!array_key_exists('id', $values) || !$values['id']) {
+      throw new AnnotationException('The plugin is missing an "id" property.');
+    }
+    parent::__construct($values);
+  }
+
+}

package/drupal/silverback_gatsby/src/Commands/SilverbackGatsbyCommands.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Commands;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\graphql_directives\Plugin\GraphQL\Schema\DirectableSchema;
+use Drupal\silverback_gatsby\GatsbyBuildTriggerInterface;
+use Drush\Commands\DrushCommands;
+use GraphQL\Language\Printer;
+
+/**
+ * A Drush commandfile.
+ *
+ * In addition to this file, you need a drush.services.yml
+ * in root of your module, and a composer.json file that provides the name
+ * of the services file to use.
+ *
+ * See these files for an example of injecting Drupal services:
+ *   - http://cgit.drupalcode.org/devel/tree/src/Commands/DevelCommands.php
+ *   - http://cgit.drupalcode.org/devel/tree/drush.services.yml
+ */
+class SilverbackGatsbyCommands extends DrushCommands {
+
+  protected EntityTypeManagerInterface $entityTypeManager;
+  protected PluginManagerInterface $schemaPluginManager;
+  protected GatsbyBuildTriggerInterface $buildTrigger;
+
+  public function __construct(
+    EntityTypeManagerInterface $entityTypeManager,
+    PluginManagerInterface $schemaPluginManager,
+    GatsbyBuildTriggerInterface $buildTrigger
+  ) {
+    parent::__construct();
+    $this->entityTypeManager = $entityTypeManager;
+    $this->schemaPluginManager = $schemaPluginManager;
+    $this->buildTrigger = $buildTrigger;
+  }
+
+  /**
+   * Export composable schema definitions.
+   *
+   * @param string $folder
+   *   Folder path to store the exported schema in.
+   *
+   * @command silverback-gatsby:schema-export
+   * @aliases sgse
+   */
+  public function schemaExport($folder = '../generated') {
+    if (!is_dir($folder)) {
+      mkdir($folder, 0777, true);
+    }
+    $servers = $this->entityTypeManager->getStorage('graphql_server')->loadMultiple();
+    foreach ($servers as $server) {
+      /** @var $server \Drupal\graphql\Entity\Server */
+      $config = $server->get('schema_configuration');
+      /** @var \Drupal\graphql\Plugin\SchemaPluginInterface $schema */
+      $schema = $this->schemaPluginManager->createInstance($server->schema, $config[$server->schema]);
+      if (!$schema instanceof DirectableSchema) {
+        continue;
+      }
+      $path = $folder . '/' . $server->id() . '.composed.graphqls';
+      $this->logger->success(dt('Writing definition of %id to %path', [
+        '%id' => $server->id(),
+        '%path' => $path,
+      ]));
+      $extensions = $schema->getExtensions();
+      $schemaDocument = $schema->getSchemaDocument($extensions);
+      $extensionDocument = $schema->getExtensionDocument($extensions);
+      file_put_contents($path, implode("\n", [
+        Printer::doPrint($schemaDocument),
+        Printer::doPrint($extensionDocument),
+      ]));
+    }
+  }
+
+  /**
+   * Trigger a Gatsby build for a given GraphQL server.
+   *
+   * @param string $server
+   *   The server id.
+   *
+   * @option force
+   *   Force a build even if the frontend is already up-to-date.
+   *
+   * @command silverback-gatsby:build
+   * @aliases sgb
+   * @usage silverback-gatsby:build [server_id]
+   */
+  public function triggerBuild($server, $options = ['force' => FALSE]) {
+    if ($options['force']) {
+      /** @var \Drupal\silverback_gatsby\GatsbyUpdateTrackerInterface $updateTracker */
+      $updateTracker = \Drupal::service('silverback_gatsby.update_tracker');
+      $latestBuildId = $updateTracker->latestBuild($server);
+      $this->buildTrigger->trigger($server, $latestBuildId);
+    }
+    else {
+      $this->buildTrigger->triggerLatestBuild($server);
+    }
+  }
+
+}

package/drupal/silverback_gatsby/src/Controller/BuildController.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+use Drupal\Core\Ajax\AjaxResponse;
+use Drupal\Core\Ajax\AlertCommand;
+use Drupal\silverback_gatsby\GatsbyBuildTriggerInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+class BuildController extends ControllerBase {
+
+  protected GatsbyBuildTriggerInterface $buildTrigger;
+
+  /**
+   * Constructs a BuildController object.
+   *
+   * @param \Drupal\silverback_gatsby\GatsbyBuildTriggerInterface $buildTrigger
+   */
+  public function __construct(GatsbyBuildTriggerInterface $buildTrigger) {
+    $this->buildTrigger = $buildTrigger;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    return new static(
+      $container->get('silverback_gatsby.build_trigger'),
+    );
+  }
+
+  /**
+   * Triggers a Gatsby build for the default GraphQL server.
+   *
+   * @return \Drupal\Core\Ajax\AjaxResponse
+   */
+  public function build() {
+    $response = new AjaxResponse();
+    $message = $this->buildTrigger->triggerDefaultServerLatestBuild();
+    $response->addCommand(new AlertCommand($message));
+    return $response;
+  }
+
+}

package/drupal/silverback_gatsby/src/Controller/PublisherController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\silverback_gatsby\Controller;
+
+use Drupal\Core\Controller\ControllerBase;
+use Drupal\user\Entity\User;
+use Symfony\Component\HttpFoundation\JsonResponse;
+
+class PublisherController extends ControllerBase {
+
+  /**
+   * Checks if the current user has access to Publisher.
+   */
+  public function hasAccess() {
+    // This is the TokenAuthUser.
+    // The Publisher role is not assigned to the user,
+    // it is only used to scope the consumer.
+    /** @var \Drupal\Core\Session\AccountProxyInterface $user */
+    $userAccount = $this->currentUser();
+    // Verify permission against User entity.
+    $userEntity = User::load($userAccount->id());
+    if ($userEntity->hasPermission('access publisher')) {
+      return new JsonResponse([
+        'access' => TRUE,
+      ], 200);
+    }
+    else {
+      return new JsonResponse([
+        'access' => FALSE,
+      ], 403);
+    }
+  }
+
+}

package/drupal/silverback_gatsby/src/Directives.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Drupal\silverback_gatsby;
+
+use Drupal\graphql\GraphQL\Resolver\ResolverInterface;
+use Drupal\graphql\GraphQL\ResolverBuilder;
+
+/**
+ * Custom directives for silverback compatibility.
+ */
+class Directives {
+
+  /**
+   * Retrieve image properties.
+   */
+  public static function imageProps(ResolverBuilder $builder) : ResolverInterface {
+    return $builder->produce('image_props')
+      ->map('entity', $builder->fromParent());
+  }
+
+  /**
+   * Attach focal point information to image properties.
+   */
+  public static function focalPoint(ResolverBuilder $builder) : ResolverInterface {
+    return $builder->produce('focal_point')
+      ->map('image_props', $builder->fromParent());
+  }
+
+  /**
+   * Fetch an entity.
+   */
+  public static function fetchEntity(ResolverBuilder $builder): ResolverInterface {
+    $resolver = $builder->produce('fetch_entity')
+      ->map('type', $builder->fromArgument('type'))
+      ->map('id', $builder->fromArgument('id'));
+
+    $argsMap = [
+      'revision_id' => 'rid',
+      'language' => 'language',
+      'access_operation' => 'operation',
+      'load_latest_revision' => 'loadLatestRevision',
+    ];
+    foreach ($argsMap as $argParameter => $argField) {
+      if ($op = $builder->fromArgument($argField)) {
+        $resolver->map($argParameter, $op);
+      }
+    }
+    return $resolver;
+  }
+
+}