function MediaPreviewTest::testErrorMessages

Tests that failed media embed preview requests inform the end user.

File

core/modules/ckeditor5/tests/src/FunctionalJavascript/MediaPreviewTest.php, line 22

Class

MediaPreviewTest

@coversDefaultClass \Drupal\ckeditor5\Plugin\CKEditor5Plugin\Media[[api-linebreak]] @group ckeditor5 @group #slow @internal

Namespace

Code

public function testErrorMessages() : void {
  // This test currently frequently causes the SQLite database to lock, so
  // skip the test on SQLite until the issue can be resolved.
  // @todo https://www.drupal.org/project/drupal/issues/3273626
  if (Database::getConnection()->driver() === 'sqlite') {
    $this->markTestSkipped('Test frequently causes a locked database on SQLite');
  }
  // Assert that a request to the `media.filter.preview` route that does not
  // result in a 200 response (due to server error or network error) is
  // handled in the JavaScript by displaying the expected error message.
  // @see core/modules/media/js/media_embed_ckeditor.theme.js
  // @see js/ckeditor5_plugins/drupalMedia/src/drupalmediaediting.js
  $this->container
    ->get('state')
    ->set('test_media_filter_controller_throw_error', TRUE);
  $this->drupalGet($this->host
    ->toUrl('edit-form'));
  $this->waitForEditor();
  $assert_session = $this->assertSession();
  $assert_session->waitForElementVisible('css', '.ck-widget.drupal-media');
  $this->assertEmpty($assert_session->waitForElementVisible('css', 'img[src*="image-test.png"]', 1000));
  $assert_session->elementNotExists('css', '.ck-widget.drupal-media .media');
  $this->assertNotEmpty($assert_session->waitForText('An error occurred while trying to preview the media. Save your work and reload this page.'));
  // Now assert that the error doesn't appear when the override to force an
  // error is removed.
  $this->container
    ->get('state')
    ->set('test_media_filter_controller_throw_error', FALSE);
  $this->getSession()
    ->reload();
  $this->waitForEditor();
  $this->assertNotEmpty($assert_session->waitForElementVisible('css', 'img[src*="image-test.png"]'));
  // There's a second kind of error message that comes from the back end
  // that happens when the media uuid can't be converted to a media preview.
  // In this case, the error will appear in a the themeable
  // media-embed-error.html template.  We have a hook altering the css
  // classes to test the twig template is working properly and picking up our
  // extra class.
  // @see \Drupal\media\Plugin\Filter\MediaEmbed::renderMissingMediaIndicator()
  // @see core/modules/media/templates/media-embed-error.html.twig
  // @see media_test_embed_preprocess_media_embed_error()
  $original_value = $this->host->body->value;
  $this->host->body->value = str_replace($this->media
    ->uuid(), 'invalid_uuid', $original_value);
  $this->host
    ->save();
  $this->drupalGet($this->host
    ->toUrl('edit-form'));
  $this->waitForEditor();
  $this->assertNotEmpty($assert_session->waitForElement('css', '.ck-widget.drupal-media .this-error-message-is-themeable'));
  // Test when using the starterkit_theme theme, an additional class is added
  // to the error, which is supported by
  // stable9/templates/content/media-embed-error.html.twig.
  $this->assertTrue($this->container
    ->get('theme_installer')
    ->install([
    'starterkit_theme',
  ]));
  $this->config('system.theme')
    ->set('default', 'starterkit_theme')
    ->save();
  $this->drupalGet($this->host
    ->toUrl('edit-form'));
  $this->waitForEditor();
  $this->assertNotEmpty($assert_session->waitForElement('css', '.ck-widget.drupal-media .this-error-message-is-themeable'));
  // Test that restoring a valid UUID results in the media embed preview
  // displaying.
  $this->host->body->value = $original_value;
  $this->host
    ->save();
  $this->drupalGet($this->host
    ->toUrl('edit-form'));
  $this->waitForEditor();
  $this->assertNotEmpty($assert_session->waitForElementVisible('css', 'img[src*="image-test.png"]'));
  $assert_session->elementNotExists('css', '.ck-widget.drupal-media .this-error-message-is-themeable');
}