class JsonBlueprintDenormalizer in Subrequests 3.x

Denormalizer that builds the blueprint based on the incoming blueprint.

Hierarchy

• class \Drupal\subrequests\Normalizer\JsonBlueprintDenormalizer implements \Symfony\Component\Serializer\Normalizer\DenormalizerInterface, \Symfony\Component\Serializer\SerializerAwareInterface

2 files declare their use of JsonBlueprintDenormalizer

BlueprintManagerTest.php in tests/src/Unit/Blueprint/BlueprintManagerTest.php

JsonBlueprintDenormalizerTest.php in tests/src/Unit/Normalizer/JsonBlueprintDenormalizerTest.php

1 string reference to 'JsonBlueprintDenormalizer'

subrequests.services.yml in ./subrequests.services.yml

subrequests.services.yml

1 service uses JsonBlueprintDenormalizer

subrequests.denormalizer.blueprint.json in ./subrequests.services.yml

Drupal\subrequests\Normalizer\JsonBlueprintDenormalizer

File

src/Normalizer/JsonBlueprintDenormalizer.php, line 20

Namespace

Drupal\subrequests\Normalizer

class JsonBlueprintDenormalizer implements DenormalizerInterface, SerializerAwareInterface {

  /**
   * @var \Symfony\Component\Serializer\Serializer
   */
  protected $serializer;

  /**
   * The Subrequests logger channel.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The schema validator.
   *
   * This property will only be set if the validator library is available.
   *
   * @var \JsonSchema\Validator|null
   */
  protected $validator;
  public function __construct(LoggerInterface $logger) {
    $this->logger = $logger;
  }

  /**
   * Sets the validator service if available.
   */
  public function setValidator(Validator $validator = NULL) {
    if ($validator) {
      $this->validator = $validator;
    }
    elseif (class_exists(Validator::class)) {
      $this->validator = new Validator();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setSerializer(SerializerInterface $serializer) {
    if (!is_a($serializer, Serializer::class)) {
      throw new \ErrorException('Serializer is unable to normalize or denormalize.');
    }
    $this->serializer = $serializer;
  }

  /**
   * {@inheritdoc}
   */
  public function denormalize($data, $class, $format = NULL, array $context = []) {
    $this
      ->doValidateInput($data);
    $data = array_map([
      $this,
      'fillDefaults',
    ], $data);
    $subrequests = array_map(function ($item) {
      return new Subrequest($item);
    }, $data);
    return $this
      ->buildExecutionSequence($subrequests);
  }

  /**
   * {@inheritdoc}
   */
  public function supportsDenormalization($data, $type, $format = NULL) {
    return $format === 'json' && $type === SubrequestsTree::class && is_array($data) && !static::arrayIsKeyed($data);
  }

  /**
   * Check if an array is keyed.
   *
   * @param array $input
   *   The input array to check.
   *
   * @return bool
   *   True if the array is keyed.
   */
  protected static function arrayIsKeyed(array $input) {
    $keys = array_keys($input);

    // If the array does not start at 0, it is not numeric.
    if ($keys[0] !== 0) {
      return TRUE;
    }

    // If there is a non-numeric key, the array is not numeric.
    $numeric_keys = array_filter($keys, 'is_numeric');
    if (count($keys) != count($numeric_keys)) {
      return TRUE;
    }

    // If the keys are not following the natural numbers sequence, then it is
    // not numeric.
    for ($index = 1; $index < count($keys); $index++) {
      if ($keys[$index] - $keys[$index - 1] !== 1) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Fill the defaults.
   *
   * @param array $raw_item
   *   The object to turn into a Subrequest input.
   *
   * @return array
   *   The complete Subrequest.
   */
  protected function fillDefaults($raw_item) {
    if (empty($raw_item['requestId'])) {
      $uuid = new Php();
      $raw_item['requestId'] = $uuid
        ->generate();
    }
    if (!isset($raw_item['body'])) {
      $raw_item['body'] = NULL;
    }
    elseif (!empty($raw_item['body'])) {
      $raw_item['body'] = Json::decode($raw_item['body']);
    }
    $raw_item['headers'] = !empty($raw_item['headers']) ? $raw_item['headers'] : [];
    $raw_item['waitFor'] = !empty($raw_item['waitFor']) ? $raw_item['waitFor'] : [
      '<ROOT>',
    ];
    $raw_item['_resolved'] = FALSE;

    // Detect if there is an encoded token. If so, then decode the URI.
    if (!empty($raw_item['uri']) && strpos($raw_item['uri'], '%7B%7B') !== FALSE && strpos($raw_item['uri'], '%7D%7D') !== FALSE) {
      $raw_item['uri'] = urldecode($raw_item['uri']);
    }
    return $raw_item;
  }

  /**
   * Wraps validation in an assert to prevent execution in production.
   *
   * @see self::validateInput
   */
  public function doValidateInput($input) {
    if (PHP_MAJOR_VERSION >= 7 || assert_options(ASSERT_ACTIVE)) {
      assert($this
        ->validateInput($input), 'A Subrequests blueprint failed validation (see the logs for details). Please report this in the issue queue on drupal.org');
    }
  }

  /**
   * Validates the consumers's blueprint against the subrequests payload format.
   *
   * @param mixed $input
   *   The blueprint sent by the consumer.
   *
   * @return bool
   *   FALSE if the input failed validation, otherwise TRUE.
   */
  protected function validateInput($input) {

    // If the validator isn't set, then the validation library is not installed.
    if (!$this->validator) {
      return TRUE;
    }
    $schema_path = dirname(dirname(__DIR__)) . '/schema.json';
    $this->validator
      ->validate($input, (object) [
      '$ref' => 'file://' . $schema_path,
    ]);
    if (!$this->validator
      ->isValid()) {

      // Log any potential errors.
      $this->logger
        ->debug('Consumer\'s blueprint failed validation: @data', [
        '@data' => Json::encode($input),
      ]);
      $this->logger
        ->debug('Validation errors: @errors', [
        '@errors' => Json::encode($this->validator
          ->getErrors()),
      ]);
    }
    return $this->validator
      ->isValid();
  }

  /**
   * Builds the execution sequence.
   *
   * Builds an array where each position contains the IDs of the requests to be
   * executed. All the IDs in the same position in the sequence can be executed
   * in parallel.
   *
   * @param \Drupal\subrequests\Subrequest[] $parsed
   *   The parsed requests.
   *
   * @return SubrequestsTree
   *   The sequence of IDs grouped by execution order.
   */
  public function buildExecutionSequence(array $parsed) {
    $sequence = new SubrequestsTree();
    $rooted_reqs = array_filter($parsed, function (Subrequest $item) {
      return $item->waitFor === [
        '<ROOT>',
      ];
    });
    $sequence
      ->stack($rooted_reqs);
    $subreqs_with_unresolved_deps = array_values(array_filter($parsed, function (Subrequest $item) {
      return $item->waitFor !== [
        '<ROOT>',
      ];
    }));
    $dependency_is_resolved = function (Subrequest $item) use ($sequence) {
      return empty(array_diff($item->waitFor, $sequence
        ->allIds()));
    };
    while (count($subreqs_with_unresolved_deps)) {
      $no_deps = array_filter($subreqs_with_unresolved_deps, $dependency_is_resolved);
      if (empty($no_deps)) {
        throw new BadRequestHttpException('Waiting for unresolvable request. Abort.');
      }
      $sequence
        ->stack($no_deps);
      $subreqs_with_unresolved_deps = array_diff($subreqs_with_unresolved_deps, $no_deps);
    }
    return $sequence;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
JsonBlueprintDenormalizer::$logger	protected	property	The Subrequests logger channel.
JsonBlueprintDenormalizer::$serializer	protected	property
JsonBlueprintDenormalizer::$validator	protected	property	The schema validator.
JsonBlueprintDenormalizer::arrayIsKeyed	protected static	function	Check if an array is keyed.
JsonBlueprintDenormalizer::buildExecutionSequence	public	function	Builds the execution sequence.
JsonBlueprintDenormalizer::denormalize	public	function
JsonBlueprintDenormalizer::doValidateInput	public	function	Wraps validation in an assert to prevent execution in production.
JsonBlueprintDenormalizer::fillDefaults	protected	function	Fill the defaults.
JsonBlueprintDenormalizer::setSerializer	public	function
JsonBlueprintDenormalizer::setValidator	public	function	Sets the validator service if available.
JsonBlueprintDenormalizer::supportsDenormalization	public	function
JsonBlueprintDenormalizer::validateInput	protected	function	Validates the consumers's blueprint against the subrequests payload format.
JsonBlueprintDenormalizer::__construct	public	function