ChainedPlaceholderStrategyTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\Render\Placeholder;

use Drupal\Core\Render\Placeholder\ChainedPlaceholderStrategy;
use Drupal\Tests\UnitTestCase;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;
use Prophecy\Prophet;

/**
 * Tests Drupal\Core\Render\Placeholder\ChainedPlaceholderStrategy.
 */
class ChainedPlaceholderStrategyTest extends UnitTestCase {
  
  /**
   * Tests process placeholders.
   *
   * @legacy-covers ::addPlaceholderStrategy
   * @legacy-covers ::processPlaceholders
   */
  public function testProcessPlaceholders($strategies, $placeholders, $result) : void {
    $chained_placeholder_strategy = new ChainedPlaceholderStrategy();
    foreach ($strategies as $strategy) {
      $chained_placeholder_strategy->addPlaceholderStrategy($strategy);
    }
    $this->assertEquals($result, $chained_placeholder_strategy->processPlaceholders($placeholders));
  }
  
  /**
   * Provides a list of render strategies, placeholders and results.
   *
   * @return array
   *   An array of render strategies, placeholders and results.
   */
  public static function providerProcessPlaceholders() : array {
    $prophet = new Prophet();
    $data = [];
    // Fake Single Flush strategy.
    $placeholders = [
      '67890' => [
        '#markup' => 'special-placeholder',
      ],
    ];
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->willReturn($placeholders);
    $single_flush_strategy = $prophecy->reveal();
    $data['fake single flush strategy'] = [
      [
        $single_flush_strategy,
      ],
      $placeholders,
      $placeholders,
    ];
    // Fake ESI strategy.
    $placeholders = [
      '12345' => [
        '#markup' => 'special-placeholder-for-esi',
      ],
    ];
    $result = [
      '12345' => [
        '#markup' => '<esi:include src="/fragment/12345" />',
      ],
    ];
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->willReturn($result);
    $esi_strategy = $prophecy->reveal();
    $data['fake esi strategy'] = [
      [
        $esi_strategy,
      ],
      $placeholders,
      $result,
    ];
    // ESI + SingleFlush strategy (ESI replaces all).
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->willReturn($result);
    $esi_strategy = $prophecy->reveal();
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->shouldNotBeCalled();
    $prophecy->processPlaceholders($result)
      ->shouldNotBeCalled();
    $prophecy->processPlaceholders([])
      ->shouldNotBeCalled();
    $single_flush_strategy = $prophecy->reveal();
    $data['fake esi and single_flush strategy - esi replaces all'] = [
      [
        $esi_strategy,
        $single_flush_strategy,
      ],
      $placeholders,
      $result,
    ];
    // ESI + SingleFlush strategy (mixed).
    $placeholders = [
      '12345' => [
        '#markup' => 'special-placeholder-for-ESI',
      ],
      '67890' => [
        '#markup' => 'special-placeholder',
      ],
      'foo' => [
        '#markup' => 'bar',
      ],
    ];
    $esi_result = [
      '12345' => [
        '#markup' => '<esi:include src="/fragment/12345" />',
      ],
    ];
    $normal_result = [
      '67890' => [
        '#markup' => 'special-placeholder',
      ],
      'foo' => [
        '#markup' => 'bar',
      ],
    ];
    $result = $esi_result + $normal_result;
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->willReturn($esi_result);
    $esi_strategy = $prophecy->reveal();
    $prophecy = $prophet->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($normal_result)
      ->willReturn($normal_result);
    $single_flush_strategy = $prophecy->reveal();
    $data['fake esi and single_flush strategy - mixed'] = [
      [
        $esi_strategy,
        $single_flush_strategy,
      ],
      $placeholders,
      $result,
    ];
    return $data;
  }
  
  /**
   * Tests process placeholders no strategies.
   */
  public function testProcessPlaceholdersNoStrategies() : void {
    // Placeholders but no strategies defined.
    $placeholders = [
      'assert-me' => [
        '#markup' => 'I-am-a-llama-that-will-lead-to-an-assertion-by-the-chained-placeholder-strategy.',
      ],
    ];
    $chained_placeholder_strategy = new ChainedPlaceholderStrategy();
    $this->expectException(\AssertionError::class);
    $this->expectExceptionMessage('At least one placeholder strategy must be present; by default the fallback strategy \\Drupal\\Core\\Render\\Placeholder\\SingleFlushStrategy is always present.');
    $chained_placeholder_strategy->processPlaceholders($placeholders);
  }
  
  /**
   * Tests process placeholders with rogue placeholder strategy.
   */
  public function testProcessPlaceholdersWithRoguePlaceholderStrategy() : void {
    // Placeholders but no strategies defined.
    $placeholders = [
      'assert-me' => [
        '#markup' => 'llama',
      ],
    ];
    $result = [
      'assert-me' => [
        '#markup' => 'llama',
      ],
      'new-placeholder' => [
        '#markup' => 'rogue llama',
      ],
    ];
    $prophecy = $this->prophesize('\\Drupal\\Core\\Render\\Placeholder\\PlaceholderStrategyInterface');
    $prophecy->processPlaceholders($placeholders)
      ->willReturn($result);
    $rogue_strategy = $prophecy->reveal();
    $chained_placeholder_strategy = new ChainedPlaceholderStrategy();
    $chained_placeholder_strategy->addPlaceholderStrategy($rogue_strategy);
    $this->expectException(\AssertionError::class);
    $this->expectExceptionMessage('Processed placeholders must be a subset of all placeholders.');
    $chained_placeholder_strategy->processPlaceholders($placeholders);
  }

}