PB-235: Story Bug for PB-107: Adding Condition Filter will Not Update Total until After Saving Edit Form & Reopening

 - fix static & integration failures

Author: cspruiell

app/code/Magento/PageBuilder/Model/Catalog/ProductTotals.php

@@ -14,7 +14,6 @@
 use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
 use Magento\CatalogInventory\Helper\Stock;
 use Magento\CatalogWidget\Model\Rule;
-use Magento\Framework\DB\Select;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Rule\Model\Condition\Combine;
 use Magento\Rule\Model\Condition\Sql\Builder;
@@ -123,35 +122,28 @@ private function getProductCollection(string $conditions): Collection
     }
 
     /**
-     * Retrieve product totals for collection
+     * Retrieve count of all disabled products
      *
-     * @param string $conditions
-     * @return array
-     * @throws LocalizedException
-     * @throws Zend_Db_Select_Exception
+     * @param Collection $baseCollection
+     * @return int number of disabled products
      */
-    public function getProductTotals(string $conditions): array
+    private function getDisabledCount(Collection $baseCollection): int
     {
-        /** @var Collection $collection */
-        $collection = $this->getProductCollection($conditions);
-
-        // Exclude any linked products, e.g. simple products assigned to a configurable, bundle or group
-        $collection->getSelect()->joinLeft(
-            ['super_link_table' => $collection->getTable('catalog_product_super_link')],
-            'super_link_table.product_id = e.entity_id',
-            ['product_id']
-        )->joinLeft(
-            ['link_table' => $collection->getTable('catalog_product_link')],
-            'link_table.product_id = e.entity_id',
-            ['product_id']
-        )->where('link_table.product_id IS NULL OR super_link_table.product_id IS NULL');
-
-        // Retrieve all disabled products
-        $disabledCollection = clone $collection;
+        /** @var Collection $disabledCollection */
+        $disabledCollection = clone $baseCollection;
         $disabledCollection->addAttributeToFilter('status', Status::STATUS_DISABLED);
+        return $disabledCollection->getSize();
+    }
 
-        // Retrieve all not visible individually products
-        $notVisibleCollection = clone $collection;
+    /**
+     * Retrieve count of all not visible individually products
+     *
+     * @param Collection $baseCollection
+     * @return int number of products not visible individually
+     */
+    private function getNotVisibleCount(Collection $baseCollection): int
+    {
+        $notVisibleCollection = clone $baseCollection;
         $notVisibleCollection->addAttributeToFilter('status', Status::STATUS_ENABLED);
         $notVisibleCollection->addAttributeToFilter(
             'visibility',
@@ -160,29 +152,70 @@ public function getProductTotals(string $conditions): array
                 Visibility::VISIBILITY_IN_SEARCH
             ]
         );
+        return $notVisibleCollection->getSize();
+    }
 
+    /**
+     * Retrieve count of all out of stock products
+     *
+     * @param Collection $baseCollection
+     * @return int number of out of stock products
+     * @throws Zend_Db_Select_Exception
+     */
+    private function getOutOfStockCount(Collection $baseCollection): int
+    {
         // Retrieve in stock products, then subtract them from the total
-        $outOfStockCollection = clone $collection;
+        $outOfStockCollection = clone $baseCollection;
         $this->stockFilter->addIsInStockFilterToCollection($outOfStockCollection);
         // Remove existing stock_status where condition from query
-        $outOfStockWhere = $outOfStockCollection->getSelect()->getPart(Select::WHERE);
+        $outOfStockWhere = $outOfStockCollection->getSelect()->getPart('where');
         $outOfStockWhere = array_filter(
             $outOfStockWhere,
             function ($whereCondition) {
                 return !stristr($whereCondition, 'stock_status');
             }
         );
-        $outOfStockCollection->getSelect()->setPart(Select::WHERE, $outOfStockWhere);
+        $outOfStockCollection->getSelect()->setPart('where', $outOfStockWhere);
         $outOfStockCollection->getSelect()->where(
             'stock_status_index.stock_status = ?',
             \Magento\CatalogInventory\Model\Stock\Status::STATUS_OUT_OF_STOCK
         );
+        return $outOfStockCollection->getSize();
+    }
+
+    /**
+     * Retrieve product totals for collection
+     *
+     * @param string $conditions
+     * @return array
+     * @throws LocalizedException
+     * @throws Zend_Db_Select_Exception
+     */
+    public function getProductTotals(string $conditions): array
+    {
+        /** @var Collection $collection */
+        $collection = $this->getProductCollection($conditions);
+
+        // Exclude any linked products, e.g. simple products assigned to a configurable, bundle or group
+        $collection->getSelect()->joinLeft(
+            ['super_link_table' => $collection->getTable('catalog_product_super_link')],
+            'super_link_table.product_id = e.entity_id',
+            ['product_id']
+        )->joinLeft(
+            ['link_table' => $collection->getTable('catalog_product_link')],
+            'link_table.product_id = e.entity_id',
+            ['product_id']
+        )->where('link_table.product_id IS NULL OR super_link_table.product_id IS NULL');
+
+        $disabledCount = $this->getDisabledCount($collection);
+        $notVisibleCount = $this->getNotVisibleCount($collection);
+        $outOfStockCount = $this->getOutOfStockCount($collection);
 
         return [
             'total' => $collection->getSize(),
-            'disabled' => $disabledCollection->getSize(),
-            'notVisible' => $notVisibleCollection->getSize(),
-            'outOfStock' => $outOfStockCollection->getSize(),
+            'disabled' => $disabledCount,
+            'notVisible' => $notVisibleCount,
+            'outOfStock' => $outOfStockCount,
         ];
     }
 }

dev/tests/integration/testsuite/Magento/PageBuilder/Model/Catalog/ProductTotalsTest.php

@@ -4,12 +4,19 @@
  * See COPYING.txt for license details.
  */
 
+declare(strict_types=1);
+
 namespace Magento\PageBuilder\Model\Catalog;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\TestFramework\Helper\Bootstrap;
+use Zend_Db_Select_Exception;
 
 /**
  * Class ProductTotalsTest
+ *
+ * @magentoAppIsolation enabled
+ * @magentoDataFixture Magento/PageBuilder/_files/product_totals/products.php
  */
 class ProductTotalsTest extends \PHPUnit\Framework\TestCase
 {
@@ -28,17 +35,19 @@ protected function setUp()
     }
 
     /**
-     * @param string condition
+     * @param array condition
      * @param int $expectedTotals
      * @dataProvider productDataProvider
+     * @throws LocalizedException
+     * @throws Zend_Db_Select_Exception
      */
     public function testProductTotals(
         $condition,
         $expectedTotals
     ) {
         $this->assertEquals(
-            array_values($this->productTotals->getProductTotals($condition)),
-            $expectedTotals
+            $expectedTotals,
+            array_values($this->productTotals->getProductTotals(json_encode($condition)))
         );
     }
 
@@ -61,8 +70,7 @@ public function productDataProvider()
                         'attribute' => 'category_ids',
                         'value' => '4'
                     ]
-                ],
-                [0, 0, 0, 0]
+                ], [0, 0, 0, 0]
             ],
             [ // #1 category with 4 products, 3 disabled, 3 not visible (but 2 not visible disabled)
                 ['1' => [
@@ -77,8 +85,7 @@ public function productDataProvider()
                         'attribute' => 'category_ids',
                         'value' => '3'
                     ]
-                ],
-                [8, 3, 1, 1]
+                ], [8, 3, 1, 1]
             ],
             [ // #2 sku with no matches
                 ['1' => [
@@ -93,8 +100,7 @@ public function productDataProvider()
                         'attribute' => 'sku',
                         'value' => 'shoes'
                     ]
-                ],
-                [0, 0, 0, 0]
+                ], [0, 0, 0, 0]
             ],
             [ // #3 sku with 2 matches, 1 disabled, 1 not visible, 1 out of stock
                 ['1' => [
@@ -109,8 +115,7 @@ public function productDataProvider()
                         'attribute' => 'sku',
                         'value' => 'not-visible-on-storefront, disabled-product, out-of-stock'
                     ]
-                ],
-                [3, 1, 1, 1]
+                ], [3, 1, 1, 1]
             ],
             [ // #4 condition with no matches
                 ['1' => [
@@ -125,8 +130,7 @@ public function productDataProvider()
                         'attribute' => 'price',
                         'value' => '10000'
                     ]
-                ],
-                [0, 0, 0, 0]
+                ], [0, 0, 0, 0]
             ],
             [ // #5 condition with 3 matches, 1 disabled, 1 not visible
                 ['1' => [
@@ -141,8 +145,7 @@ public function productDataProvider()
                         'attribute' => 'price',
                         'value' => '20'
                     ]
-                ],
-                [3, 1, 1, 0]
+                ], [3, 1, 1, 0]
             ],
         ];
     }