OEmbedFormatterTest.php

<?php

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

use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\media\Entity\Media;
use Drupal\media_test_oembed\Controller\ResourceController;
use Drupal\media_test_oembed\UrlResolver;
use Drupal\Tests\media\Functional\MediaFunctionalTestBase;
use Drupal\Tests\media\Traits\OEmbedTestTrait;
// cspell:ignore Schipulcon

/**
 * @covers \Drupal\media\Plugin\Field\FieldFormatter\OEmbedFormatter
 *
 * @group media
 * @group #slow
 */
class OEmbedFormatterTest extends MediaFunctionalTestBase {
    use OEmbedTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
        'link',
        'media_test_oembed',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->lockHttpClientToFixtures();
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
    }
    
    /**
     * Data provider for testRender().
     *
     * @see ::testRender()
     *
     * @return array
     */
    public static function providerRender() {
        return [
            'Vimeo video' => [
                'https://vimeo.com/7073899',
                'video_vimeo.json',
                [],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899',
                        'width' => '480',
                        'height' => '360',
                        'title' => 'Drupal Rap Video - Schipulcon09',
                        'loading' => 'lazy',
                        // cSpell:disable-next-line
'allowtransparency' => NULL,
                        'frameborder' => NULL,
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Vimeo video, resized' => [
                'https://vimeo.com/7073899',
                'video_vimeo-resized.json',
                [
                    'max_width' => '100',
                    'max_height' => '100',
                ],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899&max_width=100&max_height=100',
                        'width' => '100',
                        'height' => '67',
                        'title' => 'Drupal Rap Video - Schipulcon09',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Vimeo video, no title' => [
                'https://vimeo.com/7073899',
                'video_vimeo-no-title.json',
                [],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//vimeo.com/7073899',
                        'width' => '480',
                        'height' => '360',
                        'title' => NULL,
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'tweet' => [
                'https://twitter.com/drupaldevdays/status/935643039741202432',
                'rich_twitter.json',
                [
                    // The tweet resource does not specify a height, so the formatter
                    // should default to the configured maximum height.
'max_height' => 360,
                    'loading' => [
                        'attribute' => 'eager',
                    ],
                ],
                [
                    'iframe' => [
                        'src' => '/media/oembed?url=https%3A//twitter.com/drupaldevdays/status/935643039741202432',
                        'width' => '550',
                        'height' => '360',
                        'loading' => 'eager',
                    ],
                ],
                'self_closing' => TRUE,
            ],
            'Flickr photo' => [
                'https://www.flickr.com/photos/amazeelabs/26497866357',
                'photo_flickr.json',
                [],
                [
                    'img' => [
                        'src' => '/core/misc/druplicon.png',
                        'width' => '88',
                        'height' => '100',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => FALSE,
            ],
            'Flickr photo (no dimensions)' => [
                'https://www.flickr.com/photos/amazeelabs/26497866357',
                'photo_flickr_no_dimensions.json',
                [],
                [
                    'img' => [
                        'src' => '/core/misc/druplicon.png',
                        'loading' => 'lazy',
                    ],
                ],
                'self_closing' => FALSE,
            ],
        ];
    }
    
    /**
     * Tests that oEmbed media types' display can be configured correctly.
     */
    public function testDisplayConfiguration() : void {
        $account = $this->drupalCreateUser([
            'administer media display',
        ]);
        $this->drupalLogin($account);
        $media_type = $this->createMediaType('oembed:video');
        $this->drupalGet('/admin/structure/media/manage/' . $media_type->id() . '/display');
        $assert = $this->assertSession();
        $assert->statusCodeEquals(200);
        // Test that the formatter doesn't try to check applicability for fields
        // which do not have a specific target bundle.
        // @see https://www.drupal.org/project/drupal/issues/2976795.
        $assert->pageTextNotContains('Can only flip STRING and INTEGER values!');
    }
    
    /**
     * Tests the oEmbed field formatter.
     *
     * @param string $url
     *   The canonical URL of the media asset to test.
     * @param string $resource_url
     *   The oEmbed resource URL of the media asset to test.
     * @param array $formatter_settings
     *   Settings for the oEmbed field formatter.
     * @param array $selectors
     *   An array of arrays. Each key is a CSS selector targeting an element in
     *   the rendered output, and each value is an array of attributes, keyed by
     *   name, that the element is expected to have.
     * @param bool $self_closing
     *   Indicator if the HTML element is self closing i.e. <p/> vs <p></p>.
     *
     * @dataProvider providerRender
     */
    public function testRender($url, $resource_url, array $formatter_settings, array $selectors, bool $self_closing) : void {
        $account = $this->drupalCreateUser([
            'view media',
        ]);
        $this->drupalLogin($account);
        $media_type = $this->createMediaType('oembed:video');
        $source = $media_type->getSource();
        $source_field = $source->getSourceFieldDefinition($media_type);
        EntityViewDisplay::create([
            'targetEntityType' => 'media',
            'bundle' => $media_type->id(),
            'mode' => 'full',
            'status' => TRUE,
        ])
            ->removeComponent('thumbnail')
            ->setComponent($source_field->getName(), [
            'type' => 'oembed',
            'settings' => $formatter_settings,
        ])
            ->save();
        $this->hijackProviderEndpoints();
        ResourceController::setResourceUrl($url, $this->getFixturesDirectory() . '/' . $resource_url);
        UrlResolver::setEndpointUrl($url, $resource_url);
        $entity = Media::create([
            'bundle' => $media_type->id(),
            $source_field->getName() => $url,
        ]);
        $entity->save();
        $this->drupalGet($entity->toUrl());
        $assert = $this->assertSession();
        $assert->statusCodeEquals(200);
        foreach ($selectors as $selector => $attributes) {
            $element = $assert->elementExists('css', $selector);
            if ($self_closing) {
                self::assertStringContainsString("</{$selector}", $element->getParent()
                    ->getHtml());
            }
            foreach ($attributes as $attribute => $value) {
                if (isset($value)) {
                    $this->assertStringContainsString($value, $element->getAttribute($attribute));
                }
                else {
                    $this->assertFalse($element->hasAttribute($attribute));
                }
            }
        }
    }

}