OXDEV-5088 Cover more temporary active product cases

AshrafOxid · AshrafOxid · commit 136c1f74d147 · 2024-02-06T09:44:11.000+01:00
diff --git a/CHANGELOG-8.0.md b/CHANGELOG-8.0.md
@@ -6,6 +6,7 @@
 - Admin directory is not removed from the url in `ViewConfig::getModuleUrl` anymore [PR-817](https://github.com/OXID-eSales/oxideshop_ce/pull/817)
 - Reset created product "sold" counter during Copying of the product [PR-913](https://github.com/OXID-eSales/oxideshop_ce/pull/913)
 - `ModuleConfigurationValidatorInterface` is not optional anymore in the module activation service.
+- The visibility of time-activated products has changed, products with an undefined end date appear in the shop for an unlimited period of time
 
 ### Removed
 - Remove console classes from the Internal namespace: `Executor`, `ExecutorInterface`, `CommandsProvider`, `CommandsProviderInterface`
diff --git a/source/Application/Controller/Admin/ArticleList.php b/source/Application/Controller/Admin/ArticleList.php
@@ -85,6 +85,7 @@ public function render()
 
         return "article_list";
     }
+
     /**
      * Returns array of fields which may be used for product data search
      *
@@ -305,7 +306,7 @@ private function setIsActiveFieldForProductsInList(ListModel $productList): void
 
             if ($useTimeCheck) {
                 $product->hasActiveTimeRange = $product->hasProductValidTimeRange();
-                $product->isActiveNow = $product->isProductActive($now);
+                $product->isActiveNow = $product->isProductTemporaryActive($now);
             }
             $productList[$key] = $product;
         }
diff --git a/source/Application/Model/Article.php b/source/Application/Model/Article.php
@@ -557,19 +557,17 @@ public function setId($sId = null)
      */
     public function getActiveCheckQuery($blForceCoreTable = null)
     {
-        $sTable = $this->getViewName($blForceCoreTable);
+        $viewName = $this->getViewName($blForceCoreTable);
 
-        // check if article is still active
-        $sQ = " $sTable.oxactive = 1 ";
+        $query = " $viewName.oxactive = 1 ";
 
-        $sQ .= " and $sTable.oxhidden = 0 ";
+        $query .= " and $viewName.oxhidden = 0 ";
 
-        // enabled time range check ?
         if (Registry::getConfig()->getConfigParam('blUseTimeCheck')) {
-            $sQ = $this->addSqlActiveRangeSnippet($sQ, $sTable);
+            $query = $this->addSqlActiveRangeSnippet($query, $viewName);
         }
 
-        return $sQ;
+        return $query;
     }
 
     /**
@@ -1029,6 +1027,21 @@ public function setRangePrice($blIsRangePrice = true)
         return $this->_blIsRangePrice = $blIsRangePrice;
     }
 
+    public function isProductTemporaryActive(): bool
+    {
+        $activeFrom = $this->oxarticles__oxactivefrom->value;
+        $activeTo = $this->oxarticles__oxactiveto->value;
+        $now = Registry::getUtilsDate()->getTime();
+
+        if (!$this->hasProductValidTimeRange()) {
+            return false;
+        }
+
+        return (Registry::getUtilsDate()->isEmptyDate($activeTo) || strtotime($activeTo) >= $now)
+            && (Registry::getUtilsDate()->isEmptyDate($activeFrom) || strtotime($activeFrom) <= $now);
+    }
+
+
     /**
      * Checks if article has visible status. Returns TRUE if its visible
      *
@@ -1038,19 +1051,16 @@ public function isVisible()
     {
         // admin preview mode
         if (($blCanPreview = Registry::getUtils()->canPreview()) !== null) {
+
             return $blCanPreview;
         }
 
-        // active ?
-        $sNow = date('Y-m-d H:i:s');
+        $blUseTimeCheck = Registry::getConfig()->getConfigParam('blUseTimeCheck');
         if (
-            !$this->oxarticles__oxactive->value &&
-            (
-                !Registry::getConfig()->getConfigParam('blUseTimeCheck') ||
-                $this->oxarticles__oxactivefrom->value > $sNow ||
-                $this->oxarticles__oxactiveto->value < $sNow
-            )
+            !$this->oxarticles__oxactive->value
+            && (($blUseTimeCheck && !$this->isProductTemporaryActive()) || !$blUseTimeCheck)
         ) {
+
             return false;
         }
 
@@ -1062,6 +1072,7 @@ public function isVisible()
                 $iOnStock += $session->getBasketReservations()->getReservedAmount($this->getId());
             }
             if ($iOnStock <= 0) {
+
                 return false;
             }
         }
@@ -4042,13 +4053,6 @@ public function isProductAlwaysActive(): bool
         return !empty($this->oxarticles__oxactive->value);
     }
 
-    public function isProductActive(string $date): bool
-    {
-        return $this->hasProductValidTimeRange()
-            && $this->oxarticles__oxactivefrom->value <= $date
-            && $this->oxarticles__oxactiveto->value >= $date;
-    }
-
     /**
      * Applies VAT to article
      *
@@ -5270,4 +5274,20 @@ protected function updateManufacturerBeforeLoading($oManufacturer)
     {
         $oManufacturer->setReadOnly(true);
     }
+
+    protected function addSqlActiveRangeSnippet($query, $tableName): string
+    {
+        $dateUtils = Registry::getUtilsDate();
+        $secondsToRoundForQueryCache = $this->getSecondsToRoundForQueryCache();
+        $dateNow = $dateUtils->getRoundedRequestDateDBFormatted($secondsToRoundForQueryCache);
+        $defaultDBDate = $dateUtils->formatDBDate('-');
+
+        $activeToCondition = "$tableName.oxactivefrom <= '$dateNow' AND " .
+            "$tableName.oxactivefrom != '$defaultDBDate' AND $tableName.oxactiveto = '$defaultDBDate'";
+        $activeFromToCondition = "$tableName.oxactivefrom <= '$dateNow' AND $tableName.oxactiveto >= '$dateNow'";
+
+        $query = $query ? " $query or " : '';
+
+        return " ( $query (($activeToCondition) OR ($activeFromToCondition)) )";
+    }
 }
diff --git a/tests/Codeception/Acceptance/Admin/ProductListStatusTestCest.php b/tests/Codeception/Acceptance/Admin/ProductListStatusTestCest.php
@@ -10,13 +10,13 @@
 namespace Acceptance\Admin;
 
 use Codeception\Attribute\Group;
+use DateTime;
 use OxidEsales\EshopCommunity\Tests\Codeception\Support\AcceptanceTester;
 
 #[Group('admin', 'product')]
 final class ProductListStatusTestCest
 {
-    private string $temporaryActiveProductID = '1003';
-    private string $temporaryInactiveProductID = '1004';
+    private string $productID = '1000';
 
     public function _before(AcceptanceTester $I): void
     {
@@ -32,7 +32,19 @@ public function checkProductsStatuses(AcceptanceTester $I): void
 
         $I->expect('the given product is active in the list');
 
-        $productList->filterByProductNumber($this->temporaryActiveProductID);
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => (new DateTime())->modify('-1 day')->format('Y-m-d 00:00:00'),
+                'OXACTIVETO' => (new DateTime())->modify('+1 day')->format('Y-m-d 00:00:00')
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $productList->filterByProductNumber($this->productID);
 
         $I->assertStringContainsString(
             'temp-active',
@@ -41,7 +53,19 @@ public function checkProductsStatuses(AcceptanceTester $I): void
 
         $I->expect('the given product is not active in the list');
 
-        $productList->filterByProductNumber($this->temporaryInactiveProductID);
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => (new DateTime())->modify('+1 day')->format('Y-m-d 00:00:00'),
+                'OXACTIVETO' => (new DateTime())->modify('+2 day')->format('Y-m-d 00:00:00')
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $productList->filterByProductNumber($this->productID);
 
         $I->assertStringContainsString(
             'temp-inactive',
diff --git a/tests/Codeception/Acceptance/ProductStatusTestCest.php b/tests/Codeception/Acceptance/ProductStatusTestCest.php
@@ -0,0 +1,126 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace Acceptance;
+
+use Codeception\Attribute\Group;
+use Codeception\Util\Fixtures;
+use DateTime;
+use OxidEsales\EshopCommunity\Tests\Codeception\Support\AcceptanceTester;
+
+#[Group('product')]
+final class ProductStatusTestCest
+{
+    private string $productID = '1000';
+    private array $productData;
+
+    public function _before(AcceptanceTester $I): void
+    {
+        $I->updateConfigInDatabase('blUseTimeCheck', true, 'bool');
+        $product = $this->getProductData($this->productID);
+        $this->productData = [
+            'title' => $product['OXTITLE_1'],
+            'description' => $product['OXSHORTDESC_1'],
+            'price' => $product['OXPRICE']
+        ];
+    }
+
+    public function checkProductsTemporaryActiveStatus(AcceptanceTester $I): void
+    {
+        $I->wantToTest('Product active in list');
+
+        $homePage = $I->openShop();
+
+        $I->amGoingTo('Test product temporary active in the list with empty activeto');
+
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => (new DateTime())->modify('-1 day')->format('Y-m-d 00:00:00'),
+                'OXACTIVETO' => '0000-00-00 00:00:00'
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $I->expect('Product is shown');
+        $productList = $homePage->searchFor($this->productID);
+        $productList->seeProductData($this->productData);
+
+
+        $I->amGoingTo('Test product temporary active in the list with empty activefrom');
+
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => '0000-00-00 00:00:00',
+                'OXACTIVETO' => (new DateTime())->modify('+1 day')->format('Y-m-d 00:00:00')
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $I->expect('Product is shown');
+        $productList = $homePage->searchFor($this->productID);
+        $productList->seeProductData($this->productData);
+    }
+
+    public function checkProductsTemporaryNotActiveStatus(AcceptanceTester $I): void
+    {
+        $I->wantToTest('Product not active in list');
+
+        $homePage = $I->openShop();
+
+        $I->amGoingTo('Test product temporary inactive in the list with empty activeto');
+
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => (new DateTime())->modify('+1 day')->format('Y-m-d 00:00:00'),
+                'OXACTIVETO' => '0000-00-00 00:00:00'
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $I->expect('Product is not shown in case 1');
+        $productList = $homePage->searchFor($this->productID);
+        $productList->dontSeeProductData($this->productData);
+
+
+        $I->amGoingTo('Test product temporary inactive in the list with empty activefrom');
+
+        $I->updateInDatabase(
+            'oxarticles',
+            [
+                'OXACTIVE' => false,
+                'OXACTIVEFROM' => '0000-00-00 00:00:00',
+                'OXACTIVETO' => (new DateTime())->modify('-1 day')->format('Y-m-d 00:00:00')
+            ],
+            [
+                'OXID' => $this->productID
+            ]
+        );
+
+        $I->expect('Product is not shown in case 2');
+        $productList = $homePage->searchFor($this->productID);
+        $productList->dontSeeProductData($this->productData);
+    }
+
+    private function getProductData(string $productID): array
+    {
+        return Fixtures::get(sprintf('product-%s', $productID));
+    }
+}
diff --git a/tests/Codeception/Support/Data/dump.sql b/tests/Codeception/Support/Data/dump.sql
@@ -9,11 +9,6 @@ REPLACE INTO `oxarticles` (`OXID`,   `OXSHOPID`,   `OXPARENTID`, `OXACTIVE`, `OX
                           (  '1001',          1,           '',          1,     '1001', '[DE 1] Test product 1 šÄßüл', 'Test product 1 short desc [DE]',       100,          0,          0,          0,        150,           '',                0,      10,          0,         0,             1,              '',                  '', '2030-01-01', '2008-02-04', '2008-02-04 17:35:49',          0,         0,          0,   'search1001',            1,                        '',            0,            0,            '',             100,               0,                        '',                '', 'Test product 1 [EN] šÄßüл', 'Test product 1 short desc [EN] šÄßüл',      'šÄßüл1001',           '',                    '',                        '',        0, 'testdistributor', 'testmanufacturer',              0,              1,          'WEEK'),
                           ('10014',  1, '',            1,         '10014',    '13 DE product šÄßüл',         '14 DE description',              1.6,       0,          0,          0,          0,         '',            0,                NULL,    0,          0,         1,            '',              '',                  '0000-00-00', '2008-04-03', '2008-04-03 12:50:20', 0,          0,         0,         '',              1,           'size[DE] | color | type', 0,            12,          '',             15,               25,                   'size[EN] | color | type', '',                '14 EN product šÄßüл',       '13 EN description šÄßüл',              '',               '',           '',                    '',                         0,       '',                '',                  0,              0,             '');
 
-REPLACE INTO `oxarticles` (`OXID`, `OXSHOPID`, `OXPARENTID`, `OXACTIVE`, `OXARTNUM`, `OXTITLE`,                     `OXSHORTDESC`,                   `OXPRICE`, `OXPRICEA`, `OXPRICEB`, `OXPRICEC`, `OXTPRICE`, `OXUNITNAME`, `OXUNITQUANTITY`, `OXVAT`, `OXWEIGHT`, `OXSTOCK`, `OXSTOCKFLAG`, `OXSTOCKTEXT`,   `OXNOSTOCKTEXT`,     `OXDELIVERY`, `OXINSERT`,   `OXTIMESTAMP`,        `OXLENGTH`, `OXWIDTH`, `OXHEIGHT`, `OXSEARCHKEYS`, `OXISSEARCH`, `OXVARNAME`,             `OXVARSTOCK`, `OXVARCOUNT`, `OXVARSELECT`, `OXVARMINPRICE`, `OXVARMAXPRICE`, `OXVARNAME_1`,             `OXVARSELECT_1`,   `OXTITLE_1`,                 `OXSHORTDESC_1`,                        `OXSEARCHKEYS_1`, `OXBUNDLEID`, `OXSTOCKTEXT_1`,       `OXNOSTOCKTEXT_1`,                       `OXSORT`, `OXVENDORID`,      `OXMANUFACTURERID`, `OXMINDELTIME`, `OXMAXDELTIME`, `OXDELTIMEUNIT`,`OXACTIVEFROM`,       `OXACTIVETO`) VALUES
-                         ('1003',       1,           '',            0,         '1003',     '[DE 4] Test product 3 šÄßüл', 'Test product 3 short desc [DE]', 50,        35,         45,         55,         0,         'kg',          2,                NULL,    2,          15,        1,            'In stock [DE]', 'Out of stock [DE]', '0000-00-00', '2008-02-04', '2008-02-04 17:07:29', 1,          2,         2,         'search1003',    1,           '',                       0,            0,           '',             50,                0,                '',                        '',                'Test product 3 [EN] šÄßüл', 'Test product 3 short desc [EN] šÄßüл',                '',      'oxarticle',  'In stock [EN] šÄßüл', 'Out of stock [EN] šÄßüл', 0,       'testdistributor', 'testmanufacturer',       1,              1,             'DAY',now() - interval 1 day,now() + interval 1 day),
-                         ('1004',       1,           '',            0,         '1004',     '[DE 1] Test product 4 šÄßüл', 'Test product 4 short desc [DE]', 100,       0,          0,          0,          150,       '',            0,                10,      0,          0,         1,            '',              '',                  '2030-01-01', '2008-02-04', '2008-02-04 17:35:43', 0,          0,         0,         'search1004',    1,          '',                        0,            0,           '',             100,               0,                '',                        '',                'Test product 4 [EN] šÄßüл', 'Test product 4 short desc [EN] šÄßüл',                '',      'oxarticle',  '',                    '',                        0,       'testdistributor', 'testmanufacturer',       0,              1,             'WEEK',now() + interval 1 day,now() + interval 2 day),
-                         ('1005',       1,           '',            0,         '1005',     '[DE 2] Test product 5 šÄßüл', 'Test product 5 short desc [DE]', 55,        0,          0,          0,          0,         '',            0,                NULL,    0,          0,         1,            'In stock [DE]', 'Out of stock [DE]', '0000-00-00', '2008-02-04', '2008-02-04 17:27:47', 0,          0,         0,         'search1005',    1,          'variants [DE]',           10,           2,           '',             55,                67,               'variants [EN] šÄßüл',     '',                'Test product 5 [EN] šÄßüл', 'Test product 5 short desc [EN] šÄßüл',                '',      'oxarticle',  'In stock [EN] šÄßüл', 'Out of stock [EN] šÄßüл', 0,       'testdistributor', 'testmanufacturer',       1,              1,             'MONTH','0000-00-00 00:00:00' ,'0000-00-00 00:00:00');
-
 #demodata for multidimensional variants
 REPLACE INTO `oxarticles` (`OXID`,    `OXSHOPID`,   `OXPARENTID`, `OXACTIVE`, `OXARTNUM`, `OXPRICE`, `OXSTOCK`, `OXSTOCKFLAG`, `OXINSERT`,   `OXTIMESTAMP`,         `OXVARSELECT`,               `OXVARSELECT_1`,        `OXSUBCLASS`, `OXSORT`) VALUES
 ('1001432', 1, '10014',       1,         '10014-3-2', 15,        3,         1,            '2008-04-03', '2008-04-03 12:50:20', 'M | black | material [DE]', 'L | black | material', 'oxarticle',   3002),
diff --git a/tests/Codeception/Support/Data/product.php b/tests/Codeception/Support/Data/product.php
diff --git a/tests/Integration/Application/Model/ArticleTest.php b/tests/Integration/Application/Model/ArticleTest.php

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ public function render()`
`85`	`85`
`86`	`86`	`return "article_list";`
`87`	`87`	`}`
	`88`	`+`
`88`	`89`	`/**`
`89`	`90`	`* Returns array of fields which may be used for product data search`
`90`	`91`	`*`
`@@ -305,7 +306,7 @@ private function setIsActiveFieldForProductsInList(ListModel $productList): void`
`305`	`306`
`306`	`307`	`if ($useTimeCheck) {`
`307`	`308`	`$product->hasActiveTimeRange = $product->hasProductValidTimeRange();`
`308`		`- $product->isActiveNow = $product->isProductActive($now);`
	`309`	`+ $product->isActiveNow = $product->isProductTemporaryActive($now);`
`309`	`310`	`}`
`310`	`311`	`$productList[$key] = $product;`
`311`	`312`	`}`