CommentFieldsTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\comment\Functional;

use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\field\Entity\FieldConfig;
use Drupal\comment\Entity\CommentType;

/**
 * Tests fields on comments.
 *
 * @group comment
 */
class CommentFieldsTest extends CommentTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests that the default 'comment_body' field is correctly added.
     */
    public function testCommentDefaultFields() : void {
        // Do not make assumptions on default node types created by the test
        // installation profile, and create our own.
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type');
        // Check that the 'comment_body' field is present on the comment bundle.
        $field = FieldConfig::loadByName('comment', 'comment', 'comment_body');
        $this->assertNotEmpty($field, 'The comment_body field is added when a comment bundle is created');
        $field->delete();
        // Check that the 'comment_body' field is not deleted since it is persisted
        // even if it has no fields.
        $field_storage = FieldStorageConfig::loadByName('comment', 'comment_body');
        $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
        // Create a new content type.
        $type_name = 'test_node_type_2';
        $this->drupalCreateContentType([
            'type' => $type_name,
        ]);
        $this->addDefaultCommentField('node', $type_name);
        // Check that the 'comment_body' field exists and has an instance on the
        // new comment bundle.
        $field_storage = FieldStorageConfig::loadByName('comment', 'comment_body');
        $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
        $field = FieldConfig::loadByName('comment', 'comment', 'comment_body');
        $this->assertTrue(isset($field), "The comment_body field is present for comments on type {$type_name}");
        // Test adding a field that defaults to CommentItemInterface::CLOSED.
        $this->addDefaultCommentField('node', 'test_node_type', 'who_likes_ponies', CommentItemInterface::CLOSED, 'who_likes_ponies');
        $field = FieldConfig::load('node.test_node_type.who_likes_ponies');
        $this->assertEquals(CommentItemInterface::CLOSED, $field->getDefaultValueLiteral()[0]['status']);
    }
    
    /**
     * Tests that you can remove a comment field.
     */
    public function testCommentFieldDelete() : void {
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type');
        // We want to test the handling of removing the primary comment field, so we
        // ensure there is at least one other comment field attached to a node type
        // so that comment_entity_load() runs for nodes.
        $this->addDefaultCommentField('node', 'test_node_type', 'comment2');
        // Create a sample node.
        $node = $this->drupalCreateNode([
            'title' => 'Baloney',
            'type' => 'test_node_type',
        ]);
        $this->drupalLogin($this->webUser);
        $this->drupalGet('node/' . $node->nid->value);
        $elements = $this->cssSelect('.comment-form');
        $this->assertCount(2, $elements, 'There are two comment fields on the node.');
        // Delete the first comment field.
        FieldStorageConfig::loadByName('node', 'comment')->delete();
        $this->drupalGet('node/' . $node->nid->value);
        $elements = $this->cssSelect('.comment-form');
        $this->assertCount(1, $elements, 'There is one comment field on the node.');
    }
    
    /**
     * Tests link building with non-default comment field names.
     */
    public function testCommentFieldLinksNonDefaultName() : void {
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type', 'comment2');
        $web_user2 = $this->drupalCreateUser([
            'access comments',
            'post comments',
            'create article content',
            'edit own comments',
            'skip comment approval',
            'access content',
        ]);
        // Create a sample node.
        $node = $this->drupalCreateNode([
            'title' => 'Baloney',
            'type' => 'test_node_type',
        ]);
        // Go to the node first so that web_user2 see new comments.
        $this->drupalLogin($web_user2);
        $this->drupalGet($node->toUrl());
        $this->drupalLogout();
        // Test that buildCommentedEntityLinks() does not break when the 'comment'
        // field does not exist. Requires at least one comment.
        $this->drupalLogin($this->webUser);
        $this->postComment($node, 'Here is a comment', '', NULL, 'comment2');
        $this->drupalLogout();
        $this->drupalLogin($web_user2);
        // We want to check the attached drupalSettings of
        // \Drupal\comment\CommentLinkBuilder::buildCommentedEntityLinks. Therefore
        // we need a node listing, let's use views for that.
        $this->container
            ->get('module_installer')
            ->install([
            'views',
        ], TRUE);
        $this->drupalGet('node');
        $link_info = $this->getDrupalSettings()['comment']['newCommentsLinks']['node']['comment2']['2'];
        $this->assertSame(1, $link_info['new_comment_count']);
        $this->assertSame($node->toUrl('canonical', [
            'fragment' => 'new',
        ])
            ->toString(), $link_info['first_new_comment_link']);
    }
    
    /**
     * Tests creating a comment field through the interface.
     */
    public function testCommentFieldCreate() : void {
        // Create user who can administer user fields.
        $user = $this->drupalCreateUser([
            'administer user fields',
        ]);
        $this->drupalLogin($user);
        // Create comment field in account settings.
        $edit = [
            'new_storage_type' => 'comment',
        ];
        $this->drupalGet('admin/config/people/accounts/fields/add-field');
        $this->submitForm($edit, 'Continue');
        $edit = [
            'label' => 'User comment',
            'field_name' => 'user_comment',
        ];
        $this->submitForm($edit, 'Continue');
        // Try to save the comment field without selecting a comment type.
        $edit = [];
        $this->submitForm($edit, 'Update settings');
        // We should get an error message.
        $this->assertSession()
            ->pageTextContains('The submitted value in the Comment type element is not allowed.');
        // Create a comment type for users.
        $bundle = CommentType::create([
            'id' => 'user_comment_type',
            'label' => 'user_comment_type',
            'description' => '',
            'target_entity_type_id' => 'user',
        ]);
        $bundle->save();
        // Select a comment type and try to save again.
        $edit = [
            'field_storage[subform][settings][comment_type]' => 'user_comment_type',
        ];
        $this->drupalGet('admin/config/people/accounts/add-field/user/field_user_comment');
        $this->submitForm($edit, 'Update settings');
        // We shouldn't get an error message.
        $this->assertSession()
            ->pageTextNotContains('The submitted value in the Comment type element is not allowed.');
        // Try to save the comment field with "Comments per page"
        // setting value as zero.
        $edit = [
            'settings[per_page]' => 0,
        ];
        $this->drupalGet('admin/config/people/accounts/add-field/user/field_user_comment');
        $this->submitForm($edit, 'Save settings');
        $this->assertSession()
            ->statusMessageContains('Saved User comment configuration.', 'status');
    }

}