class CommentNewIndicatorTest

Same name in other branches
  1. 9 core/modules/comment/tests/src/Functional/CommentNewIndicatorTest.php \Drupal\Tests\comment\Functional\CommentNewIndicatorTest
  2. 8.9.x core/modules/comment/tests/src/Functional/CommentNewIndicatorTest.php \Drupal\Tests\comment\Functional\CommentNewIndicatorTest
  3. 11.x core/modules/comment/tests/src/Functional/CommentNewIndicatorTest.php \Drupal\Tests\comment\Functional\CommentNewIndicatorTest

Tests the 'new' indicator posted on comments.

@group comment

Hierarchy

Expanded class hierarchy of CommentNewIndicatorTest

File

core/modules/comment/tests/src/Functional/CommentNewIndicatorTest.php, line 18

Namespace

Drupal\Tests\comment\Functional
View source
class CommentNewIndicatorTest extends CommentTestBase {
    
    /**
     * Use the main node listing to test rendering on teasers.
     *
     * @var array
     *
     * @todo Remove this dependency.
     */
    protected static $modules = [
        'views',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Get node "x new comments" metadata from the server for the current user.
     *
     * @param array $node_ids
     *   An array of node IDs.
     *
     * @return \Psr\Http\Message\ResponseInterface
     *   The HTTP response.
     */
    protected function renderNewCommentsNodeLinks(array $node_ids) {
        $client = $this->getHttpClient();
        $url = Url::fromRoute('comment.new_comments_node_links');
        return $client->request('POST', $this->buildUrl($url), [
            'cookies' => $this->getSessionCookies(),
            'http_errors' => FALSE,
            'form_params' => [
                'node_ids' => $node_ids,
                'field_name' => 'comment',
            ],
        ]);
    }
    
    /**
     * Tests new comment marker.
     */
    public function testCommentNewCommentsIndicator() : void {
        // Test if the right links are displayed when no comment is present for the
        // node.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('node');
        $this->assertSession()
            ->linkNotExists('0 comments');
        $this->assertSession()
            ->linkExists('Read more');
        // Verify the data-history-node-last-comment-timestamp attribute, which is
        // used by the drupal.node-new-comments-link library to determine whether
        // a "x new comments" link might be necessary or not. We do this in
        // JavaScript to prevent breaking the render cache.
        $this->assertSession()
            ->elementNotExists('xpath', '//*[@data-history-node-last-comment-timestamp]');
        // Create a new comment. This helper function may be run with different
        // comment settings so use $comment->save() to avoid complex setup.
        
        /** @var \Drupal\comment\CommentInterface $comment */
        $comment = Comment::create([
            'cid' => NULL,
            'entity_id' => $this->node
                ->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'pid' => 0,
            'uid' => $this->loggedInUser
                ->id(),
            'status' => CommentInterface::PUBLISHED,
            'subject' => $this->randomMachineName(),
            'hostname' => '127.0.0.1',
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            'comment_body' => [
                LanguageInterface::LANGCODE_NOT_SPECIFIED => [
                    $this->randomMachineName(),
                ],
            ],
        ]);
        $comment->save();
        $this->drupalLogout();
        // Log in with 'web user' and check comment links.
        $this->drupalLogin($this->webUser);
        $this->drupalGet('node');
        // Verify the data-history-node-last-comment-timestamp attribute. Given its
        // value, the drupal.node-new-comments-link library would determine that the
        // node received a comment after the user last viewed it, and hence it would
        // perform an HTTP request to render the "new comments" node link.
        $this->assertSession()
            ->elementsCount('xpath', '//*[@data-history-node-last-comment-timestamp="' . $comment->getChangedTime() . '"]', 1);
        $this->assertSession()
            ->elementsCount('xpath', '//*[@data-history-node-field-name="comment"]', 1);
        // The data will be pre-seeded on this particular page in drupalSettings, to
        // avoid the need for the client to make a separate request to the server.
        $settings = $this->getDrupalSettings();
        $this->assertEquals([
            'lastReadTimestamps' => [
                1 => 0,
            ],
        ], $settings['history']);
        $this->assertEquals([
            'newCommentsLinks' => [
                'node' => [
                    'comment' => [
                        1 => [
                            'new_comment_count' => 1,
                            'first_new_comment_link' => Url::fromRoute('entity.node.canonical', [
                                'node' => 1,
                            ])->setOptions([
                                'fragment' => 'new',
                            ])
                                ->toString(),
                        ],
                    ],
                ],
            ],
        ], $settings['comment']);
        // Pretend the data was not present in drupalSettings, i.e. test the
        // separate request to the server.
        $response = $this->renderNewCommentsNodeLinks([
            $this->node
                ->id(),
        ]);
        $this->assertSame(200, $response->getStatusCode());
        $json = Json::decode($response->getBody());
        $expected = [
            $this->node
                ->id() => [
                'new_comment_count' => 1,
                'first_new_comment_link' => $this->node
                    ->toUrl('canonical', [
                    'fragment' => 'new',
                ])
                    ->toString(),
            ],
        ];
        $this->assertSame($expected, $json);
        // Failing to specify node IDs for the endpoint should return a 404.
        $response = $this->renderNewCommentsNodeLinks([]);
        $this->assertSame(404, $response->getStatusCode());
        // Accessing the endpoint as the anonymous user should return a 403.
        $this->drupalLogout();
        $response = $this->renderNewCommentsNodeLinks([
            $this->node
                ->id(),
        ]);
        $this->assertSame(403, $response->getStatusCode());
        $response = $this->renderNewCommentsNodeLinks([]);
        $this->assertSame(403, $response->getStatusCode());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentNewIndicatorTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentNewIndicatorTest::$modules protected static property Use the main node listing to test rendering on teasers. Overrides CommentTestBase::$modules
CommentNewIndicatorTest::renderNewCommentsNodeLinks protected function Get node "x new comments" metadata from the server for the current user.
CommentNewIndicatorTest::testCommentNewCommentsIndicator public function Tests new comment marker.
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$node protected property A test node to which comments will be posted.
CommentTestBase::$webUser protected property A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable protected function Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists protected function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment type (bundle).
CommentTestBase::deleteComment protected function Deletes a comment.
CommentTestBase::getUnapprovedComment protected function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation protected function Performs the specified operation on the specified comment.
CommentTestBase::postComment protected function Posts a comment.
CommentTestBase::setCommentAnonymous protected function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm protected function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview protected function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings protected function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage protected function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject protected function Sets the value governing whether the subject field should be enabled.
CommentTestBase::setUp protected function Overrides BrowserTestBase::setUp 14
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.