<?php

declare(strict_types=1);

namespace Drupal\Tests\system\Functional\Render;

use Drupal\Component\Utility\UrlHelper;
use Drupal\Tests\BrowserTestBase;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;

/**
 * Performs tests for the effects of the ajax_page_state query parameter.
 */
#[Group('Render')]
#[RunTestsInSeparateProcesses]
class AjaxPageStateTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = ['node', 'views'];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * User account with all available permissions.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $adminUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();
    // Create an administrator with all permissions.
    $this->adminUser = $this->drupalCreateUser(array_keys(\Drupal::service('user.permissions')
      ->getPermissions()));

    // Log in so there are more libraries to test for.
    $this->drupalLogin($this->adminUser);
  }

  /**
   * Default functionality without the param ajax_page_state[libraries].
   *
   * The libraries active-link and drupalSettings are loaded default from core
   * and available in code as scripts. Do this as the base test.
   */
  public function testLibrariesAvailable(): void {
    $this->drupalGet('node', []);
    // The active link library from core should be loaded.
    $this->assertSession()->responseContains('/core/misc/active-link.js');
    // The drupalSettings library from core should be loaded.
    $this->assertSession()->responseContains('/core/misc/drupalSettingsLoader.js');
  }

  /**
   * Give ajax_page_state[libraries]=core/drupalSettings to exclude the library.
   *
   * When called with ajax_page_state[libraries]=core/drupalSettings the library
   * should be excluded as it is already loaded. This should not affect other
   * libraries so test if active-link is still available.
   */
  public function testDrupalSettingsIsNotLoaded(): void {
    $this->drupalGet('node',
      [
        'query' =>
          [
            'ajax_page_state' => [
              'libraries' => UrlHelper::compressQueryParameter('core/drupalSettings'),
            ],
          ],
      ]
    );
    // The drupalSettings library from core should be excluded from loading.
    $this->assertSession()->responseNotContains('/core/misc/drupalSettingsLoader.js');

    // The active-link library from core should be loaded.
    $this->assertSession()->responseContains('/core/misc/active-link.js');
  }

  /**
   * Tests if multiple libraries can be excluded.
   *
   * The ajax_page_state[libraries] should be able to support multiple libraries
   * comma separated.
   */
  public function testMultipleLibrariesAreNotLoaded(): void {
    $this->drupalGet('node', [
      'query' => [
        'ajax_page_state' => [
          'libraries' => UrlHelper::compressQueryParameter('core/drupal,core/drupalSettings'),
        ],
      ],
    ]);
    $this->assertSession()->statusCodeEquals(200);
    // The drupal library from core should be excluded from loading.
    $this->assertSession()->responseNotContains('/core/misc/drupal.js');

    // The drupalSettings library from core should be excluded from loading.
    $this->assertSession()->responseNotContains('/core/misc/drupalSettingsLoader.js');

    $this->drupalGet('node');
    // The drupal library from core should be included in loading.
    $this->assertSession()->responseContains('/core/misc/drupal.js');

    // The drupalSettings library from core should be included in loading.
    $this->assertSession()->responseContains('/core/misc/drupalSettingsLoader.js');
  }

  /**
   * Tests that an invalid library name does not inject HTML.
   */
  public function testInvalidLibraryNameDoesNotInjectHtml(): void {
    // Display all errors and warnings.
    $this->config('system.logging')->set('error_level', ERROR_REPORTING_DISPLAY_ALL)->save();

    // A value without an extension/name separator is discarded before it can
    // reach the asset system, where the raw value would be embedded in an
    // error message.
    $this->drupalGet('node', [
      'query' => [
        'ajax_page_state' => [
          'libraries' => UrlHelper::compressQueryParameter('<b>foo'),
        ],
      ],
    ]);
    $this->assertSession()->statusCodeEquals(200);
    $this->assertSession()->responseNotContains('<b>foo');

    // A value with a separator but an unknown library name is resolved as
    // extension "core" and library "<b>foo", which does not exist and is
    // silently ignored, so it cannot generate error output either.
    $this->drupalGet('node', [
      'query' => [
        'ajax_page_state' => [
          'libraries' => UrlHelper::compressQueryParameter('core/<b>foo'),
        ],
      ],
    ]);
    $this->assertSession()->statusCodeEquals(200);
    $this->assertSession()->responseNotContains('<b>foo');
  }

}