ACP2E-546: Grid Custom view column position getting changed when switch between the view

Author: Anna Bukatar

app/code/Magento/Ui/Controller/Adminhtml/Bookmark/Save.php

@@ -17,7 +17,7 @@
 use Magento\Ui\Controller\Adminhtml\AbstractAction;
 
 /**
- * Class Save action
+ * Class Bookmark Save action
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
@@ -26,11 +26,11 @@ class Save extends AbstractAction implements HttpPostActionInterface
     /**
      * Identifier for current bookmark
      */
-    const CURRENT_IDENTIFIER = 'current';
+    public const CURRENT_IDENTIFIER = 'current';
 
-    const ACTIVE_IDENTIFIER = 'activeIndex';
+    public const ACTIVE_IDENTIFIER = 'activeIndex';
 
-    const VIEWS_IDENTIFIER = 'views';
+    public const VIEWS_IDENTIFIER = 'views';
 
     /**
      * @var BookmarkRepositoryInterface
@@ -180,7 +180,22 @@ protected function updateBookmark(BookmarkInterface $bookmark, $identifier, $tit
     protected function updateCurrentBookmark($identifier)
     {
         $bookmarks = $this->bookmarkManagement->loadByNamespace($this->_request->getParam('namespace'));
+        $currentConfig = null;
         foreach ($bookmarks->getItems() as $bookmark) {
+            if ($bookmark->getIdentifier() === self::CURRENT_IDENTIFIER) {
+                $current = $bookmark->getConfig();
+                $currentConfig = $current[self::CURRENT_IDENTIFIER];
+                break;
+            }
+        }
+
+        foreach ($bookmarks->getItems() as $bookmark) {
+            if ($bookmark->getCurrent() && $currentConfig !== null) {
+                $bookmarkConfig = $bookmark->getConfig();
+                $bookmarkConfig['views'][$bookmark->getIdentifier()]['data'] = $currentConfig;
+                $bookmark->setConfig($this->serializer->serialize($bookmarkConfig));
+            }
+
             if ($bookmark->getIdentifier() == $identifier) {
                 $bookmark->setCurrent(true);
             } else {

app/code/Magento/Ui/Test/Unit/Controller/Adminhtml/Bookmark/SaveTest.php

@@ -12,14 +12,17 @@
 use Magento\Framework\View\Element\UiComponentFactory;
 use Magento\Ui\Api\BookmarkManagementInterface;
 use Magento\Ui\Api\BookmarkRepositoryInterface;
+use Magento\Ui\Api\Data\BookmarkInterface;
 use Magento\Ui\Api\Data\BookmarkInterfaceFactory;
 use Magento\Ui\Controller\Adminhtml\Bookmark\Save;
 use Magento\Backend\App\Action\Context;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 /**
- * Save controller test.
+ * Bookmark Save controller test.
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class SaveTest extends TestCase
 {
@@ -111,4 +114,87 @@ public function testExecuteWontBeExecutedWhenNoUserIdInContext(): void
 
         $this->model->execute();
     }
+
+    /**
+     * Tests that on bookmark switch the previous bookmark config gets updated with the current bookmark config
+     * And that the selected bookmark is set as "current"
+     *
+     * @return void
+     */
+    public function testExecuteForCurrentBookmarkUpdate() : void
+    {
+        $updatedConfig = '{"views":{"bookmark1":{"data":{"data":["config"]}}}}';
+        $selectedIdentifier = 'bookmark2';
+
+        $this->userContext->method('getUserId')->willReturn(1);
+        $bookmark = $this->getMockForAbstractClass(BookmarkInterface::class);
+        $this->bookmarkFactory->expects($this->once())->method('create')->willReturn($bookmark);
+
+        $request = $this->getMockForAbstractClass(\Magento\Framework\App\RequestInterface::class);
+        $request->expects($this->atLeast(2))
+            ->method('getParam')
+            ->withConsecutive(['data'], ['namespace'])
+            ->willReturnOnConsecutiveCalls(
+                '{"' . Save::ACTIVE_IDENTIFIER. '":"' . $selectedIdentifier . '"}',
+                'product_listing'
+            );
+
+        $reflectionProperty = new \ReflectionProperty($this->model, '_request');
+        $reflectionProperty->setAccessible(true);
+        $reflectionProperty->setValue($this->model, $request);
+
+        $current = $this->createBookmark();
+        $bookmark1 = $this->createBookmark('bookmark1', '1', 'bookmark1_config');
+        $bookmark2 = $this->createBookmark($selectedIdentifier, '0', $selectedIdentifier .'_config');
+
+        $searchResult = $this->createMock(\Magento\Ui\Api\Data\BookmarkSearchResultsInterface::class);
+        $searchResult->expects($this->atLeastOnce())
+            ->method('getItems')
+            ->willReturn([$current, $bookmark1, $bookmark2]);
+        $this->bookmarkManagement->expects($this->once())->method('loadByNamespace')->willReturn($searchResult);
+        $bookmark1->expects($this->once())->method('setConfig')->with($updatedConfig);
+        $bookmark1->expects($this->once())->method('setCurrent')->with(false);
+        $bookmark2->expects($this->once())->method('setCurrent')->with(true);
+        $this->model->execute();
+    }
+
+    /**
+     * Creates a bookmark mock object
+     *
+     * @param string $identifier
+     * @param string $current
+     * @param string $config
+     * @return BookmarkInterface|MockObject
+     */
+    private function createBookmark(string $identifier = 'current', string $current = '0', string $config = 'config')
+    {
+        $bookmark = $this->getMockBuilder(BookmarkInterface::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['getCurrent', 'getIdentifier'])
+            ->getMockForAbstractClass();
+        $bookmark->expects($this->any())->method('getCurrent')->willReturn($current);
+        $bookmark->expects($this->any())->method('getIdentifier')->willReturn($identifier);
+        $configData = [
+            'views' => [
+                $identifier => [
+                    'data' => [
+                        $config
+                    ]
+                ]
+            ]
+        ];
+
+        if ($identifier === 'current') {
+            $configData = [
+                $identifier => [
+                    'data' => [
+                        $config
+                    ]
+                ]
+            ];
+        }
+
+        $bookmark->expects($this->any())->method('getConfig')->willReturn($configData);
+        return $bookmark;
+    }
 }

app/code/Magento/Ui/view/base/web/js/grid/controls/bookmarks/bookmarks.js

@@ -447,7 +447,6 @@ define([
          */
         saveState: function () {
             this.store('current');
-
             return this;
         },
 
@@ -553,7 +552,7 @@ define([
          */
         onActiveIndexChange: function () {
             this.activeView = this.getActiveView();
-
+            this.updateActiveView();
             this.store('activeIndex');
         },