🔃 [Magento Community Engineering] Community Contributions - 2.4-develop

Accepted Community Pull Requests:
 - #29205: #29174 Add save_rewrites_history to categories via API (by @amenk)
 - #28177: Add collapsible nav in customer account theme blank (by @mrtuvn)
 - #30217: MFTF: Replace repetitive actions with Action Groups in AdminUpdateStoreGroupAcceptAlertAndVerifyStoreViewFormTest, AdminUpdateStoreGroupAndVerifyStoreViewFormTest and AdminUpdateStoreViewTest (by @kate-kyzyma)
 - #28676: BUG - Prevent Magento from Creating incorrect URLs for category/products when Store View has modified URL keys (by @BarnyShergold)
 - #30172: fixing arguments for method in getStatusByState (by @sarron93)
 - #30108: improve visual counter review with parentheses in blank theme (by @mrtuvn)
 - #27077: Update FlushCacheByTags to use after plugins instead of around plugins (by @navarr)
 - #27581: Refactor moveFileFromTmp to not use a static method call (by @dmanners)
 - #28516: Rewrote Magento\Framework\DB\Adapter\Pdo\Mysql->isTableExists (by @jonashrem)
 - #27939: magento/magento2#: Remove a redundant getMappedNums from a loop (by @atwixfirster)


Fixed GitHub Issues:
 - #29174: Category API should support save_rewrites_history for consistency reasons (reported by @amenk) has been fixed in #29205 by @amenk in 2.4-develop branch
   Related commits:
     1. 5307bad
     2. 00176f5
     3. 4c99f0d
     4. f0ba72a
     5. 0f983b2
     6. 7f380b6
     7. 3361e72
     8. 79c54ae
     9. 99da072
     10. f61a27a
     11. 25111f0
     12. c7822ff
     13. df69e82
     14. 6fde4ba
     15. 9f81b49
     16. 9583212
     17. 1ad4482

 - #30240: [Issue] #29174 Add save_rewrites_history to categories via API (reported by @m2-assistant[bot]) has been fixed in #29205 by @amenk in 2.4-develop branch
   Related commits:
     1. 5307bad
     2. 00176f5
     3. 4c99f0d
     4. f0ba72a
     5. 0f983b2
     6. 7f380b6
     7. 3361e72
     8. 79c54ae
     9. 99da072
     10. f61a27a
     11. 25111f0
     12. c7822ff
     13. df69e82
     14. 6fde4ba
     15. 9f81b49
     16. 9583212
     17. 1ad4482

 - #30237: [Issue] Add collapsible nav in customer account theme blank (reported by @m2-assistant[bot]) has been fixed in #28177 by @mrtuvn in 2.4-develop branch
   Related commits:
     1. b351d50
     2. 2b9b090

 - #28633: URL Regeneration Fails on Store-Level URL Keys - Products (reported by @BarnyShergold) has been fixed in #28676 by @BarnyShergold in 2.4-develop branch
   Related commits:
     1. 3409af0
     2. a6d1976
     3. ac1ac06
     4. e100822
     5. d59d740
     6. 0097625
     7. 7ee8e09
     8. 54457b4
     9. aea1d8e
     10. 5d9ce4d
     11. 87a4fd9
     12. ec3e6da
     13. 7a6a740
     14. 7f41733
     15. 4b9f004

 - #30173: [Issue] fixing arguments for method in getStatusByState (reported by @m2-assistant[bot]) has been fixed in #30172 by @sarron93 in 2.4-develop branch
   Related commits:
     1. 238ce85
     2. 0873cf1

 - #29558: [Issue] Update FlushCacheByTags to use after plugins instead of around plugins (reported by @m2-assistant[bot]) has been fixed in #27077 by @navarr in 2.4-develop branch
   Related commits:
     1. 86d8b9b
     2. 46c09c6
     3. 2ef99f9
     4. e8c63a7
     5. b7c9c19
     6. 5734a6c
     7. 13673b2
     8. 6b5a983

 - #29598: [Issue] Refactor moveFileFromTmp to not use a static method call (reported by @m2-assistant[bot]) has been fixed in #27581 by @dmanners in 2.4-develop branch
   Related commits:
     1. c3d14d1
     2. f2f88a4
     3. 25a9bdf
     4. 7a92462
     5. b1676da
     6. 69aa7bf
     7. e4d45a8
     8. 05abef2
     9. 5c31521
     10. 988f31b
     11. 84b22c1

 - #29662: [Issue] Rewrote Magento\Framework\DB\Adapter\Pdo\Mysql->isTableExists (reported by @m2-assistant[bot]) has been fixed in #28516 by @jonashrem in 2.4-develop branch
   Related commits:
     1. 2d67fdd
     2. c77a8f5
     3. 4876d4e
     4. 54a39d5
     5. 94006bd
     6. 582cff8
     7. 67c7234
     8. aad9480
     9. b597c7a

 - #30031: [Issue] magento/magento2#: Remove a redundant getMappedNums from a loop (reported by @m2-assistant[bot]) has been fixed in #27939 by @atwixfirster in 2.4-develop branch
   Related commits:
     1. 1c87648
     2. cd9e834
     3. c68c447
     4. d2bc662
     5. 862609f
     6. 740ce6b
     7. e113e37
     8. 814cf2b
     9. d240573
     10. 1bb4814
     11. 033401b

Author: magento-engcom-team

app/code/Magento/Catalog/Model/ImageUploader.php

@@ -5,114 +5,116 @@
  */
 namespace Magento\Catalog\Model;
 
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\File\Uploader;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\File\Name;
+use Magento\Framework\Filesystem;
+use Magento\Framework\Filesystem\Directory\WriteInterface;
+use Magento\MediaStorage\Helper\File\Storage\Database;
+use Magento\MediaStorage\Model\File\UploaderFactory;
+use Magento\Store\Model\StoreManagerInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Catalog image uploader
  */
 class ImageUploader
 {
     /**
-     * Core file storage database
-     *
-     * @var \Magento\MediaStorage\Helper\File\Storage\Database
+     * @var Database
      */
     protected $coreFileStorageDatabase;
 
     /**
-     * Media directory object (writable).
-     *
-     * @var \Magento\Framework\Filesystem\Directory\WriteInterface
+     * @var WriteInterface
      */
     protected $mediaDirectory;
 
     /**
-     * Uploader factory
-     *
-     * @var \Magento\MediaStorage\Model\File\UploaderFactory
+     * @var UploaderFactory
      */
     private $uploaderFactory;
 
     /**
-     * Store manager
-     *
-     * @var \Magento\Store\Model\StoreManagerInterface
+     * @var StoreManagerInterface
      */
     protected $storeManager;
 
     /**
-     * @var \Psr\Log\LoggerInterface
+     * @var LoggerInterface
      */
     protected $logger;
 
     /**
-     * Base tmp path
-     *
      * @var string
      */
     protected $baseTmpPath;
 
     /**
-     * Base path
-     *
      * @var string
      */
     protected $basePath;
 
     /**
-     * Allowed extensions
-     *
      * @var string
      */
     protected $allowedExtensions;
 
     /**
-     * List of allowed image mime types
-     *
      * @var string[]
      */
     private $allowedMimeTypes;
 
     /**
-     * ImageUploader constructor
+     * @var Name
+     */
+    private $fileNameLookup;
+
+    /**
+     * ImageUploader constructor.
      *
-     * @param \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase
-     * @param \Magento\Framework\Filesystem $filesystem
-     * @param \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory
-     * @param \Magento\Store\Model\StoreManagerInterface $storeManager
-     * @param \Psr\Log\LoggerInterface $logger
+     * @param Database $coreFileStorageDatabase
+     * @param Filesystem $filesystem
+     * @param UploaderFactory $uploaderFactory
+     * @param StoreManagerInterface $storeManager
+     * @param LoggerInterface $logger
      * @param string $baseTmpPath
      * @param string $basePath
      * @param string[] $allowedExtensions
      * @param string[] $allowedMimeTypes
+     * @param Name|null $fileNameLookup
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
-        \Magento\MediaStorage\Helper\File\Storage\Database $coreFileStorageDatabase,
-        \Magento\Framework\Filesystem $filesystem,
-        \Magento\MediaStorage\Model\File\UploaderFactory $uploaderFactory,
-        \Magento\Store\Model\StoreManagerInterface $storeManager,
-        \Psr\Log\LoggerInterface $logger,
+        Database $coreFileStorageDatabase,
+        Filesystem $filesystem,
+        UploaderFactory $uploaderFactory,
+        StoreManagerInterface $storeManager,
+        LoggerInterface $logger,
         $baseTmpPath,
         $basePath,
         $allowedExtensions,
-        $allowedMimeTypes = []
+        $allowedMimeTypes = [],
+        Name $fileNameLookup = null
     ) {
         $this->coreFileStorageDatabase = $coreFileStorageDatabase;
-        $this->mediaDirectory = $filesystem->getDirectoryWrite(\Magento\Framework\App\Filesystem\DirectoryList::MEDIA);
+        $this->mediaDirectory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
         $this->uploaderFactory = $uploaderFactory;
         $this->storeManager = $storeManager;
         $this->logger = $logger;
         $this->baseTmpPath = $baseTmpPath;
         $this->basePath = $basePath;
         $this->allowedExtensions = $allowedExtensions;
         $this->allowedMimeTypes = $allowedMimeTypes;
+        $this->fileNameLookup = $fileNameLookup ?? ObjectManager::getInstance()->get(Name::class);
     }
 
     /**
      * Set base tmp path
      *
      * @param string $baseTmpPath
-     *
      * @return void
      */
     public function setBaseTmpPath($baseTmpPath)
@@ -124,7 +126,6 @@ public function setBaseTmpPath($baseTmpPath)
      * Set base path
      *
      * @param string $basePath
-     *
      * @return void
      */
     public function setBasePath($basePath)
@@ -136,7 +137,6 @@ public function setBasePath($basePath)
      * Set allowed extensions
      *
      * @param string[] $allowedExtensions
-     *
      * @return void
      */
     public function setAllowedExtensions($allowedExtensions)
@@ -179,7 +179,6 @@ public function getAllowedExtensions()
      *
      * @param string $path
      * @param string $imageName
-     *
      * @return string
      */
     public function getFilePath($path, $imageName)
@@ -194,7 +193,7 @@ public function getFilePath($path, $imageName)
      * @param bool $returnRelativePath
      * @return string
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function moveFileFromTmp($imageName, $returnRelativePath = false)
     {
@@ -203,7 +202,7 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
 
         $baseImagePath = $this->getFilePath(
             $basePath,
-            Uploader::getNewFileName(
+            $this->fileNameLookup->getNewFileName(
                 $this->mediaDirectory->getAbsolutePath(
                     $this->getFilePath($basePath, $imageName)
                 )
@@ -222,10 +221,7 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
             );
         } catch (\Exception $e) {
             $this->logger->critical($e);
-            throw new \Magento\Framework\Exception\LocalizedException(
-                __('Something went wrong while saving the file(s).'),
-                $e
-            );
+            throw new LocalizedException(__('Something went wrong while saving the file(s).'), $e);
         }
 
         return $returnRelativePath ? $baseImagePath : $imageName;
@@ -235,10 +231,9 @@ public function moveFileFromTmp($imageName, $returnRelativePath = false)
      * Checking file for save and save it to tmp dir
      *
      * @param string $fileId
-     *
      * @return string[]
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
     public function saveFileToTmpDir($fileId)
     {
@@ -249,15 +244,13 @@ public function saveFileToTmpDir($fileId)
         $uploader->setAllowedExtensions($this->getAllowedExtensions());
         $uploader->setAllowRenameFiles(true);
         if (!$uploader->checkMimeType($this->allowedMimeTypes)) {
-            throw new \Magento\Framework\Exception\LocalizedException(__('File validation failed.'));
+            throw new LocalizedException(__('File validation failed.'));
         }
         $result = $uploader->save($this->mediaDirectory->getAbsolutePath($baseTmpPath));
         unset($result['path']);
 
         if (!$result) {
-            throw new \Magento\Framework\Exception\LocalizedException(
-                __('File can not be saved to the destination folder.')
-            );
+            throw new LocalizedException(__('File can not be saved to the destination folder.'));
         }
 
         /**
@@ -277,7 +270,7 @@ public function saveFileToTmpDir($fileId)
                 $this->coreFileStorageDatabase->saveFile($relativePath);
             } catch (\Exception $e) {
                 $this->logger->critical($e);
-                throw new \Magento\Framework\Exception\LocalizedException(
+                throw new LocalizedException(
                     __('Something went wrong while saving the file(s).'),
                     $e
                 );

app/code/Magento/CatalogUrlRewrite/Model/ProductScopeRewriteGenerator.php

@@ -6,6 +6,7 @@
 namespace Magento\CatalogUrlRewrite\Model;
 
 use Magento\Catalog\Api\CategoryRepositoryInterface;
+use Magento\Catalog\Api\Data\CategoryInterface;
 use Magento\Catalog\Model\Category;
 use Magento\Catalog\Model\Product;
 use Magento\CatalogUrlRewrite\Model\Product\AnchorUrlRewriteGenerator;
@@ -15,12 +16,14 @@
 use Magento\CatalogUrlRewrite\Service\V1\StoreViewService;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\UrlRewrite\Model\MergeDataProviderFactory;
 
 /**
- * Class ProductScopeRewriteGenerator
+ * Generates Product/Category URLs for different scopes
+ *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ProductScopeRewriteGenerator
@@ -174,7 +177,6 @@ public function generateForSpecificStoreView($storeId, $productCategories, Produ
                 continue;
             }
 
-            // category should be loaded per appropriate store if category's URL key has been changed
             $categories[] = $this->getCategoryWithOverriddenUrlKey($storeId, $category);
         }
 
@@ -240,9 +242,15 @@ public function isCategoryProperForGenerating(Category $category, $storeId)
      * Checks if URL key has been changed for provided category and returns reloaded category,
      * in other case - returns provided category.
      *
+     * Category should be loaded per appropriate store at all times. This is because whilst the URL key on the
+     * category in focus might be unchanged, parent category URL keys might be. If the category store ID
+     * and passed store ID are the same then return current category as it is correct but may have changed in memory
+     *
      * @param int $storeId
      * @param Category $category
-     * @return Category
+     *
+     * @return CategoryInterface
+     * @throws NoSuchEntityException
      */
     private function getCategoryWithOverriddenUrlKey($storeId, Category $category)
     {
@@ -252,9 +260,10 @@ private function getCategoryWithOverriddenUrlKey($storeId, Category $category)
             Category::ENTITY
         );
 
-        if (!$isUrlKeyOverridden) {
+        if (!$isUrlKeyOverridden && $storeId === $category->getStoreId()) {
             return $category;
         }
+
         return $this->categoryRepository->get($category->getEntityId(), $storeId);
     }
 

app/code/Magento/CatalogUrlRewrite/Plugin/Model/CategorySetSaveRewriteHistory.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogUrlRewrite\Plugin\Model;
+
+use Magento\Catalog\Model\Category;
+use Magento\Framework\Webapi\Rest\Request as RestRequest;
+use Magento\CatalogUrlRewrite\Model\CategoryUrlRewriteGenerator;
+
+class CategorySetSaveRewriteHistory
+{
+    private const SAVE_REWRITES_HISTORY = 'save_rewrites_history';
+
+    /**
+     * @var RestRequest
+     */
+    private $request;
+
+    /**
+     * @param RestRequest $request
+     */
+    public function __construct(RestRequest $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Add 'save_rewrites_history' param to the category for list
+     *
+     * @param CategoryUrlRewriteGenerator $subject
+     * @param Category $category
+     * @param bool $overrideStoreUrls
+     * @param int|null $rootCategoryId
+     * @return array
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function beforeGenerate(
+        CategoryUrlRewriteGenerator $subject,
+        Category $category,
+        bool $overrideStoreUrls = false,
+        ?int $rootCategoryId = null
+    ) {
+        $requestBodyParams = $this->request->getBodyParams();
+
+        if ($this->isCustomAttributesExists($requestBodyParams, CategoryUrlRewriteGenerator::ENTITY_TYPE)) {
+            foreach ($requestBodyParams[CategoryUrlRewriteGenerator::ENTITY_TYPE]['custom_attributes'] as $attribute) {
+                if ($attribute['attribute_code'] === self::SAVE_REWRITES_HISTORY) {
+                    $category->setData(self::SAVE_REWRITES_HISTORY, (bool)$attribute['value']);
+                }
+            }
+        }
+
+        return [$category, $overrideStoreUrls, $rootCategoryId];
+    }
+
+    /**
+     * Check is any custom options exists in data
+     *
+     * @param array $requestBodyParams
+     * @param string $entityCode
+     * @return bool
+     */
+    private function isCustomAttributesExists(array $requestBodyParams, string $entityCode): bool
+    {
+        return !empty($requestBodyParams[$entityCode]['custom_attributes']);
+    }
+}