ParagraphsLibraryItemTest.php

<?php

namespace Drupal\Tests\paragraphs_library\Functional;

use Drupal\node\Entity\Node;
use Drupal\paragraphs\Entity\Paragraph;
use Drupal\paragraphs\Entity\ParagraphsType;
use Drupal\Tests\BrowserTestBase;
use Drupal\Tests\field_ui\Traits\FieldUiTestTrait;
use Drupal\Tests\paragraphs\FunctionalJavascript\ParagraphsTestBaseTrait;
use Drupal\Tests\paragraphs\Traits\ParagraphsCoreVersionUiTestTrait;

/**
 * Tests the functionality of the Paragraphs Library.
 *
 * @group paragraphs_library
 */
class ParagraphsLibraryItemTest extends BrowserTestBase {
  use ParagraphsTestBaseTrait, FieldUiTestTrait, ParagraphsCoreVersionUiTestTrait;

  /**
   * Modules to be enabled.
   *
   * @var string[]
   */
  protected static $modules = [
    'node',
    'paragraphs_library',
    'block',
    'field_ui',
  ];

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

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this
      ->addParagraphedContentType('paragraphed_test', 'field_paragraphs');
    $this
      ->addParagraphsType('text');
    $this
      ->addFieldtoParagraphType('text', 'field_text', 'text');
    $this
      ->addParagraphsType('paragraphs_container');
    $this
      ->addParagraphsField('paragraphs_container', 'paragraphs_container_paragraphs', 'paragraph');
    $admin = $this
      ->drupalCreateUser([
      'create paragraphed_test content',
      'edit any paragraphed_test content',
      'view paragraphed_test revisions',
      'administer paragraphs library',
    ]);
    $this
      ->drupalLogin($admin);
    $this
      ->placeDefaultBlocks();
  }

  /**
   * Tests the library items permissions in different scenarios.
   */
  public function testLibraryItemsAccessControl() {

    // Login as a user with create paragraph library item permission.
    $role = $this
      ->createRole([
      'create paragraph library item',
    ]);
    $user = $this
      ->createUser([]);
    $user
      ->addRole($role);
    $user
      ->save();
    $this
      ->drupalLogin($user);

    // Add a new library item.
    $this
      ->drupalGet('admin/content/paragraphs/add/default');
    $this
      ->getSession()
      ->getPage()
      ->pressButton('Add text');
    $edit = [
      'label[0][value]' => 'Library item',
      'paragraphs[0][subform][field_text][0][value]' => 'Item content',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('Paragraph Library item has been created');

    // Assert a user has no access to the global library overview page.
    $this
      ->assertSession()
      ->statusCodeEquals(403);
    $matched_library_items = $this->container
      ->get('entity_type.manager')
      ->getStorage('paragraphs_library_item')
      ->loadByProperties([
      'label' => 'Library item',
    ]);
    $library_item = reset($matched_library_items);
    $library_item_id = $library_item
      ->id();

    // Assert a regular user has no edit and delete access.
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'edit');
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'delete');

    // Add edit paragraph library item permission.
    user_role_grant_permissions($role, [
      'edit paragraph library item',
    ]);
    $this
      ->assertLibraryItemAccess($library_item_id, 200, 'edit');
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'delete');

    // Enable granular permissions and make sure a user can not edit the library
    // item anymore due to missing edit permission for target paragraph type.
    $this->container
      ->get('module_installer')
      ->install([
      'paragraphs_type_permissions',
    ]);
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'edit');
    user_role_grant_permissions($role, [
      'update paragraph content text',
    ]);
    $this
      ->assertLibraryItemAccess($library_item_id, 200, 'edit');
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'delete');
    user_role_revoke_permissions($role, [
      'create paragraph library item',
      'edit paragraph library item',
    ]);
    user_role_grant_permissions($role, [
      'administer paragraphs library',
    ]);
    $this
      ->assertLibraryItemAccess($library_item_id, 200, 'edit');

    // User has no delete access due to missing delete permission for the target
    // paragraph type.
    $this
      ->assertLibraryItemAccess($library_item_id, 403, 'delete');
    user_role_grant_permissions($role, [
      'delete paragraph content text',
    ]);
    $this
      ->assertLibraryItemAccess($library_item_id, 200, 'delete');
  }

  /**
   * Asserts HTTP response codes for library item operations.
   */
  protected function assertLibraryItemAccess($library_item_id, $response_code, $operation) {
    $this
      ->drupalGet("admin/content/paragraphs/{$library_item_id}/{$operation}");
    $this
      ->assertSession()
      ->statusCodeEquals($response_code);
  }

  /**
   * Check that conversion to and from library items does not have side effects.
   */
  public function testNoConversionSideEffects() {

    // Create a text paragraph.
    $text_paragraph = Paragraph::create([
      'type' => 'text',
      'field_text' => [
        'value' => 'Test text 1',
        'format' => 'plain_text',
      ],
    ]);
    $text_paragraph
      ->save();

    // Create a container that contains the text paragraph.
    $container_paragraph = Paragraph::create([
      'type' => 'paragraphs_container',
      'paragraphs_container_paragraphs' => [
        $text_paragraph,
      ],
    ]);
    $container_paragraph
      ->save();

    // Add a node with the paragraphs.
    $node = Node::create([
      'type' => 'paragraphed_test',
      'title' => 'Test Node',
      'field_paragraphs' => [
        $container_paragraph,
      ],
    ]);
    $node
      ->save();

    // Enable conversion to library item.
    ParagraphsType::load('paragraphs_container')
      ->setThirdPartySetting('paragraphs_library', 'allow_library_conversion', TRUE)
      ->save();

    // Convert the container to a library item.
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([], 'Promote to library');
    $this
      ->submitForm([], 'Save');

    // Check that the child text paragraph is present in the node.
    $this
      ->assertSession()
      ->pageTextContains('Test text 1');
    $node = $this
      ->drupalGetNodeByTitle('Test Node');

    /** @var \Drupal\paragraphs_library\LibraryItemInterface $library_item */
    $library_item = $node
      ->get('field_paragraphs')->entity
      ->get('field_reusable_paragraph')->entity;

    // Remove the child text paragraph from the library item.
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id() . '/edit');
    $this
      ->getSession()
      ->getPage()
      ->fillField('Label', 'Test Library Item');
    $this
      ->getSession()
      ->getPage()
      ->findButton('paragraphs_0_subform_paragraphs_container_paragraphs_0_remove')
      ->press();
    $this
      ->submitForm([], 'Save');

    // Check that the child text paragraph is no longer present in the
    // library item or the node.
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id());
    $this
      ->assertSession()
      ->pageTextNotContains('Test text 1');
    $this
      ->drupalGet('/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextNotContains('Test text 1');

    // View the second-to-last revision.
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/revisions');
    $this
      ->getSession()
      ->getPage()
      ->find('css', '.node-revision-table')
      ->find('xpath', '(//tbody//tr)[2]//a')
      ->click();
    $revision_url = $this
      ->getSession()
      ->getCurrentUrl();
    $this
      ->assertStringContainsString('/node/' . $node
      ->id() . '/revisions/', $revision_url);
    $this
      ->assertStringContainsString('view', $revision_url);

    // Check that the child text paragraph is still present in this revision.
    $this
      ->assertSession()
      ->pageTextContains('Test text 1');

    // Add a new text paragraph to the library item.
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id() . '/edit');
    $this
      ->submitForm([], 'Add text');
    $this
      ->getSession()
      ->getPage()
      ->fillField('field_text', 'Test text 2');
    $this
      ->submitForm([], 'Save');

    // Check that the child text paragraph is present in the library item and
    // the node.
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Test text 2');
    $this
      ->drupalGet('/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Test text 2');

    // Convert the library item in the node back to a container paragraph and
    // delete it.
    $this
      ->drupalGet('/node/' . $node
      ->id() . '/edit');
    $this
      ->submitForm([], 'Unlink from library');
    $this
      ->getSession()
      ->getPage()
      ->findButton('field_paragraphs_0_subform_paragraphs_container_paragraphs_0_remove')
      ->press();
    $this
      ->submitForm([], 'Save');

    // Check that the child text paragraph is no longer present in the node but
    // still present in the library item.
    $this
      ->drupalGet('/node/' . $node
      ->id());
    $this
      ->assertSession()
      ->pageTextNotContains('Test text 2');
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('Test text 2');
  }

  /**
   * Test that usage tab are presented for library item.
   */
  public function testLibraryItemUsageTab() {
    $admin = $this
      ->drupalCreateUser([
      'create paragraphed_test content',
      'edit any paragraphed_test content',
      'administer paragraphs library',
      'delete all revisions',
      'revert all revisions',
      'administer content types',
      'administer node fields',
      'administer paragraphs types',
      'administer node form display',
      'administer paragraph fields',
      'administer paragraph form display',
      'access entity usage statistics',
    ]);
    $this
      ->drupalLogin($admin);
    $this
      ->addParagraphsType('test_content');
    $this
      ->addParagraphsType('nested_paragraph');
    $this
      ->fieldUIAddNewField('admin/structure/paragraphs_type/test_content', 'paragraphs_text', 'Test content', 'text_long', [], []);

    // Add nested paragraph field.
    $this
      ->fieldUIAddNewField('admin/structure/paragraphs_type/nested_paragraph', 'err_field', 'Nested', 'field_ui:entity_reference_revisions:paragraph', [
      'settings[target_type]' => 'paragraph',
      'cardinality' => '-1',
    ], []);

    // Add nested paragraph directly in library.
    $this
      ->drupalGet('admin/content/paragraphs/add/default');
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();
    $page
      ->pressButton('Add nested_paragraph');
    $page
      ->find('css', '.paragraphs-subform')
      ->pressButton('Add test_content');
    $edit = [
      'label[0][value]' => 'Test usage nested paragraph',
      'paragraphs[0][subform][field_err_field][0][subform][field_paragraphs_text][0][value]' => 'Example text for revision in nested paragraph.',
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('Paragraph Test usage nested paragraph has been created.');

    // Create content with referenced paragraph.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page
      ->pressButton('Add From library');
    $edit = [
      'title[0][value]' => 'Test content',
      'field_paragraphs[0][subform][field_reusable_paragraph][0][target_id]' => 'Test usage nested paragraph',
    ];
    $this
      ->submitForm($edit, 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Test content');

    // Check Usage tab.
    $this
      ->drupalGet('admin/content/paragraphs');
    $this
      ->clickLink('Test usage nested paragraph');
    $this
      ->clickLink('Usage');
    $assert_session
      ->pageTextContains('Entity usage information for Test usage nested paragraph');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(1)', 'Test content &gt; field_paragraphs');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(2)', 'Paragraph');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(3)', 'English');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(4)', 'Reusable paragraph');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(5)', 'Published');

    // Assert breadcrumb.
    $assert_session
      ->elementContains('css', '.breadcrumb ol li:nth-child(1)', 'Home');
    $assert_session
      ->elementContains('css', '.breadcrumb ol li:nth-child(2)', 'Paragraphs library');
    $assert_session
      ->elementContains('css', '.breadcrumb ol li:nth-child(3)', 'Test usage nested paragraph');

    // Unlink library item and check usage tab.
    $node = $this
      ->drupalGetNodeByTitle('Test content');
    $this
      ->drupalGet($node
      ->toUrl('edit-form'));
    $this
      ->submitForm([], 'Unlink from library');
    $this
      ->submitForm([
      'revision' => TRUE,
    ], 'Save');

    // Check Usage tab.
    $this
      ->drupalGet('admin/content/paragraphs');
    $this
      ->clickLink('Test usage nested paragraph');
    $this
      ->clickLink('Usage');
    $assert_session
      ->pageTextContains('Entity usage information for Test usage nested paragraph');

    // Assert there is a row here indicating that the host node references the
    // paragraph in a non-default revision.
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(1)', 'Test content &gt; field_paragraphs (previous revision)');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(2)', 'Paragraph');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(3)', 'English');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(4)', 'Reusable paragraph');
    $assert_session
      ->elementContains('css', 'table tbody tr td:nth-child(5)', 'Published');
  }

  /**
   * Test if the usage warning message shows up, when deleting a library item.
   */
  public function testLibraryItemDeleteWarningMessage() {
    $page = $this
      ->getSession()
      ->getPage();
    $assert_session = $this
      ->assertSession();

    // Create a paragraph in the library.
    $this
      ->drupalGet('admin/content/paragraphs/add/default');
    $page
      ->pressButton('Add text');
    $edit = [
      'label[0][value]' => 'Test usage warning message',
      'paragraphs[0][subform][field_text][0][value]' => 'Example text.',
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('Paragraph Test usage warning message has been created.');

    // Create content with referenced paragraph.
    $this
      ->drupalGet('node/add/paragraphed_test');
    $page
      ->pressButton('Add From library');
    $edit = [
      'title[0][value]' => 'Test content',
      'field_paragraphs[0][subform][field_reusable_paragraph][0][target_id]' => 'Test usage warning message',
    ];
    $this
      ->submitForm($edit, 'Save');
    $node = $this
      ->drupalGetNodeByTitle('Test content');
    $library_item = $node
      ->get('field_paragraphs')->entity
      ->get('field_reusable_paragraph')->entity;

    // Check if there is a warning message on the delete form.
    $this
      ->drupalGet('/admin/content/paragraphs/' . $library_item
      ->id() . '/delete');
    $assert_session
      ->pageTextContains('There are recorded usages of this entity.');
  }

}