class GatsbyInstantPreview in Gatsby Live Preview & Incremental Builds 2.0.x

Defines a class to extend the default preview system with an instant preview.

Hierarchy

• class \Drupal\gatsby\GatsbyPreview
  • class \Drupal\gatsby_instantpreview\GatsbyInstantPreview

1 file declares its use of GatsbyInstantPreview

GatsbyEntityLogger.php in modules/gatsby_fastbuilds/src/GatsbyEntityLogger.php

1 string reference to 'GatsbyInstantPreview'

gatsby_instantpreview.services.yml in modules/gatsby_instantpreview/gatsby_instantpreview.services.yml

modules/gatsby_instantpreview/gatsby_instantpreview.services.yml

1 service uses GatsbyInstantPreview

gatsby.gatsby_instantpreview in modules/gatsby_instantpreview/gatsby_instantpreview.services.yml

Drupal\gatsby_instantpreview\GatsbyInstantPreview

File

modules/gatsby_instantpreview/src/GatsbyInstantPreview.php, line 19

Namespace

Drupal\gatsby_instantpreview

class GatsbyInstantPreview extends GatsbyPreview {

  /**
   * Drupal\jsonapi_extras\EntityToJsonApi definition.
   *
   * @var \Drupal\jsonapi_extras\EntityToJsonApi
   */
  private $entityToJsonApi;

  /**
   * Drupal\Core\Entity\EntityRepository definition.
   *
   * @var \Drupal\Core\Entity\EntityRepository
   */
  private $entityRepository;

  /**
   * Decorated service.
   *
   * @var \Drupal\gatsby\GatsbyPreview
   */
  private $innerService;

  /**
   * Constructs a new GatsbyInstantPreview object.
   */
  public function __construct(GatsbyPreview $inner_service, ClientInterface $http_client, ConfigFactoryInterface $config, EntityTypeManagerInterface $entity_type_manager, LoggerChannelFactoryInterface $logger, EntityToJsonApi $entity_to_json_api, EntityRepository $entity_repository) {
    $this->innerService = $inner_service;
    $this->entityToJsonApi = $entity_to_json_api;
    $this->entityRepository = $entity_repository;
    parent::__construct($http_client, $config, $entity_type_manager, $logger);
  }

  /**
   * Prepares Gatsby Data to send to the preview and build servers.
   *
   * By preparing the data in a separate step we prevent multiple requests from
   * being sent to the preview or incremental builds servers if multiple
   * Drupal entities are update/inserted/deleted in a single request.
   */
  public function gatsbyPrepareData(ContentEntityInterface $entity = NULL, string $action = 'update') {
    $json = $this
      ->getJson($entity);
    if (!$json) {
      return;
    }
    $json['id'] = $entity
      ->uuid();
    $json['action'] = $action;

    // If there is a secret key, we decode the json, add the key, then encode.
    $settings = $this->configFactory
      ->get('gatsby.settings');
    if ($settings
      ->get('secret_key')) {
      $json['secret'] = $settings
        ->get('secret_key');
    }
    $preview_url = $settings
      ->get('preview_callback_url');
    if ($preview_url) {
      $json = $this
        ->bundleData('preview', $preview_url, $json);
      $this
        ->updateData('preview', $preview_url, $json);
    }
    $incrementalbuild_url = $settings
      ->get('incrementalbuild_url');
    if (!$incrementalbuild_url) {
      return;
    }
    if ($settings
      ->get('build_published')) {
      if (!$entity instanceof NodeInterface || !$entity
        ->isPublished()) {
        return;
      }
      if (empty($json['data']['relationships'])) {
        return;
      }

      // Generate JSON for all related entities to send to Gatsby.
      $entity_data = [];
      $included_types = $settings
        ->get('preview_entity_types') ?: [];
      $this
        ->buildRelationshipJson($json['data']['relationships'], $entity_data, array_values($included_types));
      if (!empty($entity_data)) {

        // Remove the uuid keys from the array.
        $entity_data = array_values($entity_data);
        $original_data = $json['data'];
        $entity_data[] = $original_data;
        $json['data'] = $entity_data;
      }
    }
    $json = $this
      ->bundleData('incrementalbuild', $incrementalbuild_url, $json);
    $this
      ->updateData('incrementalbuild', $incrementalbuild_url, $json);
  }

  /**
   * Triggers the refreshing of Gatsby preview and incremental builds.
   */
  public function gatsbyPrepareDelete(ContentEntityInterface $entity = NULL) {
    $json = [
      'id' => $entity
        ->uuid(),
      'action' => 'delete',
      'type' => $entity
        ->getEntityType()
        ->id() . '--' . $entity
        ->bundle(),
      'attributes' => [
        'langcode' => $entity
          ->language()
          ->getId(),
        'drupal_internal__revision_id' => $entity
          ->getRevisionId(),
      ],
    ];
    $settings = $this->configFactory
      ->get('gatsby.settings');

    // The id and action are needed in a data array for batch processing.
    $json['data'] = $json;

    // If there is a secret key, add the key to the request.
    if ($settings
      ->get('secret_key')) {
      $json['secret'] = $settings
        ->get('secret_key');
    }
    $preview_url = $settings
      ->get('preview_callback_url');
    if ($preview_url) {
      $preview_json = $this
        ->bundleData('preview', $preview_url, $json);
      $this
        ->updateData('preview', $preview_url, $preview_json);
    }
    $incrementalbuild_url = $settings
      ->get('incrementalbuild_url');
    if ($incrementalbuild_url) {
      $json = $this
        ->bundleData('incrementalbuild', $incrementalbuild_url, $json);
      $this
        ->updateData('incrementalbuild', $incrementalbuild_url, $json);
    }
  }

  /**
   * Bundles entity JSON data so it can be passed in a single request.
   */
  public function bundleData($key, $url, $json) {
    $updated =& self::$updateData;

    // The first time this method is called our updated data array is
    // empty so we can just return the data we were given.
    if (empty($updated)) {
      return $json;
    }
    if (!empty($updated[$key][$url]['json'])) {
      if (!empty($updated[$key][$url]['json']['data']['type'])) {

        // If there is only one entity, convert it to an array.
        $json['data'] = [
          $updated[$key][$url]['json']['data'],
          $json['data'],
        ];
      }
      else {

        // Check to make sure this entity wasn't already added.
        foreach ($updated[$key][$url]['json']['data'] as $index => $entity) {
          if ($entity['id'] == $json['id']) {

            // Update the entity data if this entity was already.
            $updated[$key][$url]['json']['data'][$index] = $json['data'];
            $json['data'] = $updated[$key][$url]['json']['data'];
            return $json;
          }
        }

        // Add new entities to the updated json data array.
        $updated[$key][$url]['json']['data'][] = $json['data'];

        // Update our json data array with the updated entities.
        $json['data'] = $updated[$key][$url]['json']['data'];
      }
    }
    return $json;
  }

  /**
   * Builds an array of entity JSON data based on entity relationships.
   */
  public function buildRelationshipJson($relationships, &$entity_data, $included_types = []) {
    foreach ($relationships as $data) {
      if (empty($data['data'])) {
        continue;
      }
      $related_items = $data['data'];

      // Check if this is a single value field.
      if (!empty($data['data']['type'])) {
        $related_items = [
          $data['data'],
        ];
      }
      foreach ($related_items as $related_data) {

        // Add JSON if the entity type is one that should be sent to Gatsby.
        $entityType = !empty($related_data['type']) ? explode('--', $related_data['type']) : "";
        if (!empty($entityType) && (!$included_types || in_array($entityType[0], $included_types, TRUE))) {

          // Skip this entity if it's already been added to the data array.
          if (!empty($entity_data[$related_data['id']])) {
            continue;
          }
          $related_entity = $this->entityRepository
            ->loadEntityByUuid($entityType[0], $related_data['id']);

          // Make sure the related entity is a valid entity.
          if (empty($related_entity) || !$related_entity instanceof ContentEntityInterface) {
            continue;
          }
          $related_json = $this
            ->getJson($related_entity);
          if (!$related_json) {
            continue;
          }
          $entity_data[$related_data['id']] = $related_json['data'];

          // We need to traverse all related entities to get all relevant JSON.
          if (!empty($related_json['data']['relationships'])) {
            $this
              ->buildRelationshipJson($related_json['data']['relationships'], $entity_data, $included_types);
          }
        }
      }
    }
  }

  /**
   * Gets the JSON object for an entity.
   */
  public function getJson(ContentEntityInterface $entity) {
    try {
      return $this->entityToJsonApi
        ->normalize($entity);
    } catch (RouteNotFoundException $e) {
      return NULL;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GatsbyInstantPreview::$entityRepository	private	property	Drupal\Core\Entity\EntityRepository definition.
GatsbyInstantPreview::$entityToJsonApi	private	property	Drupal\jsonapi_extras\EntityToJsonApi definition.
GatsbyInstantPreview::$innerService	private	property	Decorated service.
GatsbyInstantPreview::buildRelationshipJson	public	function	Builds an array of entity JSON data based on entity relationships.
GatsbyInstantPreview::bundleData	public	function	Bundles entity JSON data so it can be passed in a single request.
GatsbyInstantPreview::gatsbyPrepareData	public	function	Prepares Gatsby Data to send to the preview and build servers. Overrides GatsbyPreview::gatsbyPrepareData
GatsbyInstantPreview::gatsbyPrepareDelete	public	function	Triggers the refreshing of Gatsby preview and incremental builds. Overrides GatsbyPreview::gatsbyPrepareDelete
GatsbyInstantPreview::getJson	public	function	Gets the JSON object for an entity.
GatsbyInstantPreview::__construct	public	function	Constructs a new GatsbyInstantPreview object. Overrides GatsbyPreview::__construct
GatsbyPreview::$configFactory	protected	property	Config Interface for accessing site configuration.
GatsbyPreview::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManagerInterface definition.
GatsbyPreview::$httpClient	protected	property	GuzzleHttp\ClientInterface definition.
GatsbyPreview::$logger	protected	property	Drupal\Core\Logger\LoggerChannelFactoryInterface definition.
GatsbyPreview::$updateData	public static	property	Tracks data changes that should be sent to Gatsby.
GatsbyPreview::gatsbyUpdate	public	function	Triggers the refreshing of Gatsby preview and incremental builds.
GatsbyPreview::isConfigured	public	function	Returns true if a preview server or build server URL is configured.
GatsbyPreview::isPreviewEntity	public	function	Verify the entity is selected to sync to the Gatsby site.
GatsbyPreview::triggerRefresh	public	function	Triggers Gatsby refresh endpoint.
GatsbyPreview::updateData	public	function	Updates Gatsby Data array.