graphql_compose-1.0.0-beta20/tests/src/Functional/Core/EntityCommentTest.php

<?php

declare(strict_types=1);

namespace Drupal\Tests\graphql_compose\Functional\Core;

use Drupal\Tests\graphql_compose\Functional\GraphQLComposeBrowserTestBase;
use Drupal\comment\CommentInterface;
use Drupal\comment\Entity\Comment;
use Drupal\comment\Tests\CommentTestTrait;
use Drupal\node\NodeInterface;

/**
 * Tests specific to GraphQL Compose entity type: Node.
 *
 * @group graphql_compose
 */
class EntityCommentTest extends GraphQLComposeBrowserTestBase {

  use CommentTestTrait;

  /**
   * The test node.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected NodeInterface $node;

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

  /**
   * {@inheritdoc}
   */
  protected function setUp(): void {
    parent::setUp();

    $this->createContentType([
      'type' => 'test',
      'name' => 'Test node type',
    ]);

    $this->addDefaultCommentField('node', 'test', 'comments');

    $this->node = $this->createNode([
      'type' => 'test',
      'title' => 'Test',
      'body' => [
        'value' => 'Test content',
        'format' => 'plain_text',
      ],
      'status' => 1,
    ]);

    $this->setEntityConfig('node', 'test', [
      'enabled' => TRUE,
      'query_load_enabled' => TRUE,
    ]);

    $this->setFieldConfig('node', 'test', 'comments', [
      'enabled' => TRUE,
    ]);

    $this->setEntityConfig('comment', 'comment', [
      'enabled' => TRUE,
      'comments_mutation_enabled' => TRUE,
      'edges_enabled' => TRUE,
    ]);

    $this->setFieldConfig('comment', 'comment', 'comment_body', [
      'enabled' => TRUE,
    ]);

  }

  /**
   * Create a comment for a node.
   *
   * @param \Drupal\node\NodeInterface $node
   *   The node to create a comment for.
   *
   * @return \Drupal\comment\CommentInterface
   *   The created comment.
   */
  protected function createComment(NodeInterface $node): CommentInterface {
    $payload = [
      'comment_type' => 'comment',
      'entity_type'  => 'node',
      'entity_id'    => $node->id(),
      'field_name'   => 'comments',
      'subject'      => 'Test subject',
      'comment_body' => [
        'value' => 'Test comment for ' . $node->id() . ' : ' . uniqid(),
        'format' => 'plain_text',
      ],
      'status' => TRUE,
    ];

    $comment = Comment::create($payload);
    $comment->save();

    return $comment;
  }

  /**
   * Create a comment for a node.
   *
   * @param \Drupal\comment\CommentInterface $comment
   *   The comment to create a reply for.
   * @param \Drupal\node\NodeInterface $node
   *   The node to create a comment for.
   *
   * @return \Drupal\comment\CommentInterface
   *   The created comment.
   */
  protected function createReply(CommentInterface $comment, NodeInterface $node): CommentInterface {
    $payload = [
      'comment_type' => 'comment',
      'entity_type'  => 'node',
      'entity_id'    => $node->id(),
      'field_name'   => 'comments',
      'subject'      => 'Test subject reply',
      'comment_body' => [
        'value' => 'Test reply to parent for ' . $node->id() . ' : ' . uniqid(),
        'format' => 'plain_text',
      ],
      'status' => TRUE,
      'pid' => $comment->id(),
    ];

    $comment = Comment::create($payload);
    $comment->save();

    return $comment;
  }

  /**
   * Check comments on a node.
   */
  public function testNodeCommentFieldRead() {

    $comment = $this->createComment($this->node);

    $query = <<<GQL
      query {
        node(id: "{$this->node->uuid()}") {
          ... on NodeTest {
            comments(first: 10) {
              nodes {
                id
                subject
                commentBody {
                  value
                }
                entityId
                entityType
                fieldName
              }
            }
          }
        }
      }
    GQL;

    // Try as anonymous.
    $content = $this->executeQuery($query);
    $this->assertNull($content['data']['node']['comments']);

    // Now try as user with permission.
    $privilegedUser = $this->createUser([
      'access comments',
      'access content',
      ...$this->graphqlPermissions,
    ]);
    $this->drupalLogin($privilegedUser);

    $content = $this->executeQuery($query);
    $firstComment = $content['data']['node']['comments']['nodes'][0];

    $this->assertEquals($comment->uuid(), $firstComment['id']);
    $this->assertEquals($comment->label(), $firstComment['subject']);
    $this->assertEquals($comment->comment_body->value, $firstComment['commentBody']['value']);
    $this->assertEquals($this->node->uuid(), $firstComment['entityId']);
    $this->assertEquals('node', $firstComment['entityType']);
    $this->assertEquals('comments', $firstComment['fieldName']);
  }

  /**
   * Check comment replies on a node.
   */
  public function testNodeCommentReplyFieldRead() {

    $comment = $this->createComment($this->node);
    $reply = $this->createReply($comment, $this->node);

    $query = <<<GQL
      query {
        node(id: "{$this->node->uuid()}") {
          ... on NodeTest {
            comments(first: 10) {
              nodes {
                id
                pid
                subject
                commentBody {
                  value
                }
                entityId
                entityType
                fieldName
              }
            }
          }
        }
      }
    GQL;

    // Now try as user with permission.
    $privilegedUser = $this->createUser([
      'access comments',
      'access content',
      ...$this->graphqlPermissions,
    ]);
    $this->drupalLogin($privilegedUser);

    $content = $this->executeQuery($query);

    $firstReply = $content['data']['node']['comments']['nodes'][1];
    $this->assertEquals($comment->uuid(), $firstReply['pid']);
    $this->assertEquals($reply->uuid(), $firstReply['id']);
  }

  /**
   * Check comments writable to a node.
   */
  public function testNodeCommentFieldWrite() {

    $mutation = <<<GQL
      mutation(\$data: CommentCommentInput!) {
        addCommentComment(data: \$data) {
          id
          subject
          commentBody {
            value
          }
        }
      }
    GQL;

    $data = [
      'entityType' => 'NodeTest',
      'entityId' => $this->node->uuid(),
      'commentBody' => 'This is a test',
    ];

    // Try as anonymous.
    $content = $this->executeQuery($mutation, ['data' => $data]);
    $this->assertSame(
      'You do not have permission to post comments.',
      $content['errors'][0]['message']
    );

    // Setup comment privileged user.
    $privilegedUser = $this->createUser([
      'post comments',
      'access comments',
      'skip comment approval',
      ...$this->graphqlPermissions,
    ]);

    $this->drupalLogin($privilegedUser);

    $content = $this->executeQuery($mutation, ['data' => $data]);

    $this->assertEquals(
      $data['commentBody'],
      $content['data']['addCommentComment']['commentBody']['value']
    );
  }

  /**
   * Check comments writable to a node.
   */
  public function testNodeCommentReplyFieldWrite() {

    $comment = $this->createComment($this->node);

    $mutation = <<<GQL
      mutation(\$data: CommentCommentInput!) {
        addCommentComment(data: \$data) {
          id
          pid
        }
      }
    GQL;

    $data = [
      'replyTo' => $comment->uuid(),
      'entityType' => 'NodeTest',
      'entityId' => $this->node->uuid(),
      'commentBody' => 'This is a test',
    ];

    // Setup comment privileged user.
    $privilegedUser = $this->createUser([
      'post comments',
      'access comments',
      'skip comment approval',
      ...$this->graphqlPermissions,
    ]);

    $this->drupalLogin($privilegedUser);

    $content = $this->executeQuery($mutation, ['data' => $data]);

    $this->assertEquals(
      $comment->uuid(),
      $content['data']['addCommentComment']['pid']
    );

    $this->assertNotEquals(
      $comment->uuid(),
      $content['data']['addCommentComment']['id']
    );
  }

}