Merge branch 'yireo:master' into master

Author: samicoman

.github/workflows/extdn-phpstan-pre-install.sh

@@ -6,8 +6,8 @@ composer require yireo/magento2-integration-test-helper --no-update
 
 composer config --no-plugins allow-plugins true
 
-composer require --dev phpstan/extension-installer --no-update
-composer require --dev bitexpert/phpstan-magento --no-update
+composer require --dev phpstan/extension-installer:^1.0 --no-update
+composer require --dev bitexpert/phpstan-magento:^0.32 --no-update
 
 composer require yireo/magento2-replace-bundled:^4.0 --no-update
 composer require yireo/magento2-replace-inventory:^4.0 --no-update

.module.ini

@@ -1,4 +1,5 @@
 EXTENSION_VENDOR="Yireo"
 EXTENSION_NAME="GoogleTagManager2"
 COMPOSER_NAME="yireo/magento2-googletagmanager2"
-PHP_VERSIONS=("7.4", "8.1", "8.2", "8.3")
+PHP_VERSIONS=("7.4", "8.1", "8.2", "8.3","8.4")
+PHPSTAN_LEVEL=2

CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.10.0] - 06 May 2025
+### Moved
+- Move Hyva Checkout compat into separate package
+ 
+### Fixed
+- Do not use custom product provider by default anymore
+
+## [3.9.18] - 23 April 2025
+### Fixed
+- PHP 8.4 compatibility issues
+
+## [3.9.17] - 17 March 2025
+### Fixed
+- Issue with js minify, script not loaded #269 @taoufiqaitali
+- Fix type error when event name is empty #259
+
+## [3.9.16] - 19 February 2025
+### Fixed
+- Make sure to apply Container URL to IFRAME URL as well #267 @rikwillems
+
 ## [3.9.15] - 6 January 2025
 ### Fixed
 - Subtract shipping discount amount from shipping amount #248

Config/Source/CustomerAttributes.php

@@ -1,5 +1,8 @@
 <?php declare(strict_types=1);
 
+// Disable PHPCS due to false positive in PHPCompatibility\Sniffs\NewClassesSniff
+// phpcs:disable
+
 namespace Yireo\GoogleTagManager2\Config\Source;
 
 use Magento\Eav\Api\AttributeRepositoryInterface;
@@ -52,10 +55,6 @@ public function toOptionArray(): array
         return $options;
     }
 
-    /**
-     * @param Attribute $attribute
-     * @return bool
-     */
     private function isAttributeDisplayedInFrontend(Attribute $attribute): bool
     {
         $forms = $attribute->getUsedInForms();

DataLayer/Mapper/CartItemDataMapper.php

@@ -17,6 +17,7 @@ class CartItemDataMapper
     private ProductProvider $productProvider;
     private PriceFormatter $priceFormatter;
     private ScopeConfigInterface $scopeConfig;
+    private bool $useProductProvider = false;
 
     /**
      * @param ProductDataMapper $productDataMapper
@@ -28,12 +29,14 @@ public function __construct(
         ProductDataMapper $productDataMapper,
         ProductProvider $productProvider,
         PriceFormatter $priceFormatter,
-        ScopeConfigInterface $scopeConfig
+        ScopeConfigInterface $scopeConfig,
+        bool $useProductProvider = false
     ) {
         $this->productDataMapper = $productDataMapper;
         $this->productProvider = $productProvider;
         $this->priceFormatter = $priceFormatter;
         $this->scopeConfig = $scopeConfig;
+        $this->useProductProvider = $useProductProvider;
     }
 
     /**
@@ -44,7 +47,12 @@ public function __construct(
     public function mapByCartItem(CartItem $cartItem): array
     {
         try {
-            $product = $this->productProvider->getBySku($cartItem->getSku());
+            if ($this->useProductProvider) {
+                $product = $this->productProvider->getBySku($cartItem->getSku());
+            } else {
+                $product = $cartItem->getProduct();
+            }
+
             $cartItemData = $this->productDataMapper->mapByProduct($product);
         } catch (NoSuchEntityException $e) {
             $cartItemData = [];

DataLayer/Mapper/ProductDataMapper.php

@@ -83,8 +83,10 @@ public function mapByProduct(ProductInterface $product): array
         }
 
         $productData['price'] = $this->priceFormatter->format((float) $product->getPriceInfo()->getPrice(FinalPrice::PRICE_CODE)->getValue());
-        if ($product->getCustomOption('simple_product') && $product->getCustomOption('simple_product')->getProduct()) {
-            $simpleProduct = $product->getCustomOption('simple_product')->getProduct();
+
+        $simpleProductOption = $product->getCustomOption('simple_product');
+        if ($simpleProductOption && method_exists($simpleProductOption, 'getProduct') && $simpleProductOption->getProduct()) {
+            $simpleProduct = $simpleProductOption->getProduct();
             $productData['price'] = $this->priceFormatter->format((float) $simpleProduct->getPriceInfo()->getPrice(FinalPrice::PRICE_CODE)->getValue());
         }
 

FAQ.md

@@ -8,6 +8,15 @@ First of all, make sure to upgrade to the latest version of this extension, befo
 
 When making use of Server-Side Tracking, make sure to customize the setting **Orders states for purchase event** (`order_states_for_purchase_event`) and to manually trigger the `purchase` event where needed.
 
+# The purchase event is fired when the order hasn't been completed yet
+The Yireo GoogleTagManager extension uses the core event `sales_order_place_after` to trigger the `purchase` event. And this event is passed on from the server-side (PHP) towards the client-side (JavaScript) whenever a page is hit again (for instance, the loading of the checkout success page) or whenever an AJAX call occurs. At this moment, it might be that the payment has not yet occurred, so that the order status is not yet complete, but still the `purchase` event is triggered. This is **not** a bug, this is where you step in as an integrator of this Yireo GoogleTagManager2 extension and your custom choice of PSPs.
+
+How do you want this to work? Firing the `purchase` event on the success page will often **not** work either: It could be that a payment is delayed, so that the PSP only notifies the Magento application of the payment (so that the order can be completed) *after* the customer has left the shop. A similar scenario pops up when you are placing an order in the Magento Admin Panel. In these scenarios, there no longer is a scenario where client-side tracking (via JavaScript in the frontend) can be used. Instead, the solution is server-side tracking.
+
+The Yireo GoogleTagManager2 extension does not offer server-side tracking as a functionality, but it does support it. Simply enable the setting **Server-Side Tracking**, configure the **Container URL** and select which order states should trigger the `purchase` event (most likely only the `complete` status).
+
+If you need any additional help, the company of [Yireo](https://www.yireo.com/) is happy to help out with a custom (paid) consult as well.
+
 # Does this extension work under PHP 8.2?
 Yes, version 3 does. Version 2 is no longer maintained, but you could use the following composer patch with `vaimo/composer-patches`:
 ```bash

MageWire/Checkout.php

@@ -31,7 +31,7 @@ public function afterSavePaymentInformationAndPlaceOrder(
         $cartId,
         $email,
         PaymentInterface $paymentMethod,
-        AddressInterface $billingAddress = null
+        ?AddressInterface $billingAddress = null
     ) {
         $cartId = $this->maskedQuoteIdToQuoteId->execute($cartId);
         $addPaymentInfoEventData = $this->addPaymentInfo
@@ -49,7 +49,7 @@ public function afterSavePaymentInformation(
         $cartId,
         $email,
         PaymentInterface $paymentMethod,
-        AddressInterface $billingAddress = null
+        ?AddressInterface $billingAddress = null
     ) {
         $cartId = $this->maskedQuoteIdToQuoteId->execute($cartId);
         $addPaymentInfoEventData = $this->addPaymentInfo