Issue #3275301 by erickbj: Support for route based memory limit policy constraints

memory_limit_policy.constraint.plugin.route:

  type: memory_limit_policy.constraint.plugin

  mapping:

    routes:

      type: sequence

      label: 'Routes'

name: Memory Limit Policy Route

description: A plugin to set memory limit policy based on the route.

package: Performance

type: module

core: 8.x

core_version_requirement: ^8 || ^9

dependencies:

  - memory_limit_policy:memory_limit_policy

<?php

namespace Drupal\memory_limit_policy_route\Plugin\MemoryLimitConstraint;

use Drupal\Core\Form\FormStateInterface;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

use Drupal\Core\Routing\AdminContext;

use Drupal\memory_limit_policy\MemoryLimitConstraintBase;

use Symfony\Component\DependencyInjection\ContainerInterface;

/**

 * Configure the memory limit based on route.

 *

 * @MemoryLimitConstraint(

 *   id = "admin_route",

 *   title = @Translation("Admin Route"),

 *   description = @Translation("Allows overriding memory limits for admin routes.")

 * )

 */

class AdminRoute extends MemoryLimitConstraintBase implements ContainerFactoryPluginInterface {

  /**

   * The route admin context to determine whether a route is an admin one.

   *

   * @var \Drupal\Core\Routing\AdminContext

   */

  protected $adminContext;

  /**

   * Constructs constraint plugin.

   *

   * @param array $configuration

   *   A configuration array containing information about the plugin instance.

   * @param string $plugin_id

   *   The plugin_id for the plugin instance.

   * @param mixed $plugin_definition

   *   The plugin implementation definition.

   * @param \Drupal\Core\Routing\AdminContext $admin_context

   *   The route admin context.

   */

  public function __construct(array $configuration, $plugin_id, $plugin_definition, AdminContext $admin_context) {

    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->adminContext = $admin_context;

  }

  /**

   * {@inheritdoc}

   */

  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    return new static(

      $configuration,

      $plugin_id,

      $plugin_definition,

      $container->get('router.admin_context')

    );

  }

  /**

   * {@inheritdoc}

   */

  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    return [

      '#type' => 'markup',

      '#markup' => '<p>' . $this->t('The admin routes constraint has no configuration options.') . '</p>',

    ];

  }

  /**

   * {@inheritdoc}

   */

  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // No configuration to be saved here.

  }

  /**

   * {@inheritdoc}

   */

  public function getSummary() {

    return $this->t('Applies to all admin routes.');

  }

  /**

   * {@inheritdoc}

   */

  public function evaluate() {

    return $this->adminContext->isAdminRoute();

  }

}

<?php

namespace Drupal\memory_limit_policy_route\Plugin\MemoryLimitConstraint;

use Drupal\Core\Form\FormStateInterface;

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

use Drupal\Core\Routing\CurrentRouteMatch;

use Drupal\Core\Routing\AdminContext;

use Drupal\memory_limit_policy\MemoryLimitConstraintBase;

use Symfony\Component\DependencyInjection\ContainerInterface;

/**

 * Configure the memory limit based on route.

 *

 * @MemoryLimitConstraint(

 *   id = "route",

 *   title = @Translation("Route"),

 *   description = @Translation("Provide a list of routes where the memory limit must be overridden.")

 * )

 */

class Route extends MemoryLimitConstraintBase implements ContainerFactoryPluginInterface {

  /**

   * Current route.

   *

   * @var \Drupal\Core\Routing\CurrentRouteMatch

   */

  protected $currentRoute;

  /**

   * The route admin context to determine whether a route is an admin one.

   *

   * @var \Drupal\Core\Routing\AdminContext

   */

  protected $adminContext;

  /**

   * Constructs constraint plugin.

   *

   * @param array $configuration

   *   A configuration array containing information about the plugin instance.

   * @param string $plugin_id

   *   The plugin_id for the plugin instance.

   * @param mixed $plugin_definition

   *   The plugin implementation definition.

   * @param \Drupal\Core\Routing\CurrentRouteMatch $current_route

   *   The current route.

   * @param \Drupal\Core\Routing\AdminContext $admin_context

   *   The route admin context.

   */

  public function __construct(array $configuration, $plugin_id, $plugin_definition, CurrentRouteMatch $current_route, AdminContext $admin_context) {

    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->currentRoute = $current_route;

    $this->adminContext = $admin_context;

  }

  /**

   * {@inheritdoc}

   */

  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    return new static(

      $configuration,

      $plugin_id,

      $plugin_definition,

      $container->get('current_route_match'),

      $container->get('router.admin_context')

    );

  }

  /**

   * {@inheritdoc}

   */

  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

    $form['routes'] = [

      '#type' => 'textarea',

      '#title' => $this->t('Routes'),

      '#description' => $this->t('Enter one route per line.'),

      '#default_value' => implode(PHP_EOL, $this->getConfiguration()['routes']) ?? '',

    ];

    return $form;

  }

  /**

   * {@inheritdoc}

   */

  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Transform textarea into list of values.

    $this->configuration['routes'] = array_filter(

      preg_split("/\r?\n/", $form_state->getValue('routes')),

        function ($route) {

          return trim($route);

        }

      );

  }

  /**

   * {@inheritdoc}

   */

  public function getSummary() {

    return $this->t('Routes: @routes', ['@routes' => implode(', ', $this->getConfiguration()['routes'])]);

  }

  /**

   * {@inheritdoc}

   */

  public function evaluate() {

    $configured_route_list = $this->getConfiguration()['routes'] ?? [];

    if (in_array($this->currentRoute->getRouteName(), $configured_route_list)) {

      return TRUE;

    }

    return parent::evaluate();

  }

}

   */

  public static function getSubscribedEvents() {

    // High priority for this subscriber to execute it soon enough.

    $events[KernelEvents::REQUEST][] = ['onRequest', 100];

    $events[KernelEvents::REQUEST][] = ['onRequest', -1];

    $events[KernelEvents::RESPONSE][] = ['onResponse'];

    return $events;

  }