commerce_google_tag_manager-8.x-2.0-beta1/tests/src/Functional/ProductDetailViewsTest.php

<?php

namespace Drupal\Tests\commerce_google_tag_manager\Functional;

use Drupal\Tests\commerce\Functional\CommerceBrowserTestBase;
use Drupal\commerce_price\Price;
use Drupal\commerce_product\Entity\Product;
use Drupal\commerce_product\Entity\ProductVariation;
use Drupal\Tests\commerce_google_tag_manager\Traits\DeprecationSuppressionTrait;

/**
 * @coversDefaultClass \Drupal\commerce_google_tag_manager\EventSubscriber\CommerceEventsSubscriber
 *
 * @group commerce
 * @group commerce_google_tag_manager
 * @group commerce_google_tag_manager_functional
 */
class ProductDetailViewsTest extends CommerceBrowserTestBase {
  use DeprecationSuppressionTrait;

  /**
   * The temp store holding the Enhanced Ecommerce event data.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  private $tempStore;

  /**
   * The product to test against.
   *
   * @var \Drupal\commerce_product\Entity\
   */
  protected $product;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'commerce_product',
    'google_tag',
    'commerce_google_tag_manager',
  ];

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

    $this->tempStore = $this->container->get('tempstore.private')->get('commerce_google_tag_manager');

    $this->product = Product::create([
      'type'  => 'default',
      'title' => 'Lorem Ipsum',
    ]);
    $this->product->save();

    $variation = ProductVariation::create([
      'type'   => 'default',
      'sku'    => 'lorem-ipsum-120',
      'title'  => 'Lorem Ipsum',
      'price'  => new Price('120.00', 'USD'),
      'status' => TRUE,
    ]);

    $this->product->addVariation($variation)->save();
  }

  /**
   * @covers ::trackProductView
   */
  public function testProductDetailViews() {
    $this->drupalGet($this->product->toUrl()->toString());
    $this->assertSession()->statusCodeEquals(200);

    $events = $this->tempStore->get('events');
    $this->assertSame([
      'f8e84d8ee071e2fb885d0dc755dd73ab' => [
        'event' => 'productDetailViews',
        'ecommerce' => [
          'detail' => [
            'actionField' => [
              'list' => '',
            ],
            'products' => [
              0 => [
                'name'    => 'Lorem Ipsum',
                'id'      => '1',
                'price'   => '120.00',
                'variant' => 'Lorem Ipsum',
              ],
            ],
          ],
        ],
      ],
    ], $events);
  }

  /**
   * @covers ::trackProductView
   *
   * Test that the module does not track the productDetailViews event if
   * no default variation exists.
   */
  public function testMissingDefaultVariation() {
    $this->product->variations = [];
    $this->product->save();

    $this->drupalGet($this->product->toUrl()->toString());
    $this->assertSession()->statusCodeEquals(200);

    $events = $this->tempStore->get('events');
    $this->assertNull($events);
  }

  /**
   * @covers ::trackProductView
   *
   * Ensure caching of product view don't prevent event to be fired.
   */
  public function testCachability() {
    // Login as a normal user for cachability.
    $normalUser = $this->drupalCreateUser();
    $this->drupalLogin($normalUser);

    // Ensure the storage is empty before any navigation occurs.
    $events = $this->tempStore->get('events');
    $this->assertEmpty($events);

    $this->drupalGet($this->product->toUrl()->toString());
    $events = $this->tempStore->get('events');
    $this->assertSame([
      'f8e84d8ee071e2fb885d0dc755dd73ab' => [
        'event' => 'productDetailViews',
        'ecommerce' => [
          'detail' => [
            'actionField' => [
              'list' => '',
            ],
            'products' => [
              0 => [
                'name'    => 'Lorem Ipsum',
                'id'      => '1',
                'price'   => '120.00',
                'variant' => 'Lorem Ipsum',
              ],
            ],
          ],
        ],
      ],
    ], $events);

    // Reset the event storage.
    $this->tempStore->set('events', NULL);

    // Reload the same page a second time to ensure the event will be fired.
    $this->drupalGet($this->product->toUrl()->toString());
    $events = $this->tempStore->get('events');
    $this->assertSame([
      'f8e84d8ee071e2fb885d0dc755dd73ab' => [
        'event' => 'productDetailViews',
        'ecommerce' => [
          'detail' => [
            'actionField' => [
              'list' => '',
            ],
            'products' => [
              0 => [
                'name'    => 'Lorem Ipsum',
                'id'      => '1',
                'price'   => '120.00',
                'variant' => 'Lorem Ipsum',
              ],
            ],
          ],
        ],
      ],
    ], $events);

  }

}