Issue #3494997 by s_leu, amateescu: Prevent loss of layout changes when...

Issue #3494997 by s_leu, amateescu: Prevent loss of layout changes when discarding changes in a different workspace or Live

core/modules/workspaces/src/WorkspacesLayoutTempstoreRepository.php

+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\workspaces;
+
+use Drupal\layout_builder\LayoutTempstoreRepository;
+use Drupal\layout_builder\SectionStorageInterface;
+
+/**
+ * Provides a mechanism for loading workspace-specific layout changes.
+ */
+class WorkspacesLayoutTempstoreRepository extends LayoutTempstoreRepository {
+
+  /**
+   * The workspace manager.
+   */
+  protected WorkspaceManagerInterface $workspaceManager;
+
+  /**
+   * Sets the workspace manager.
+   *
+   * @param \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager
+   *   The workspace manager service.
+   */
+  public function setWorkspacesManager(WorkspaceManagerInterface $workspace_manager): static {
+    $this->workspaceManager = $workspace_manager;
+    return $this;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getKey(SectionStorageInterface $section_storage): string {
+    $key = parent::getKey($section_storage);
+    // Suffix the layout tempstore key with a workspace ID when one is active.
+    if ($this->workspaceManager->hasActiveWorkspace()) {
+      $key .= '.workspace:' . $this->workspaceManager->getActiveWorkspace()->id();
+    }
+    return $key;
+  }
+
+}

core/modules/workspaces/src/WorkspacesServiceProvider.php

@@ -40,6 +40,14 @@ public function alter(ContainerBuilder $container) {
       }
     }
 
+    // Ensure that Layout Builder's tempstore is workspace-aware.
+    if ($container->hasDefinition('layout_builder.tempstore_repository')) {
+      $definition = $container->getDefinition('layout_builder.tempstore_repository');
+      $definition
+        ->setClass(WorkspacesLayoutTempstoreRepository::class)
+        ->addMethodCall('setWorkspacesManager', [new Reference('workspaces.manager')]);
+    }
+
     // Ensure that there's no active workspace while running database updates by
     // removing the relevant tag from all workspace negotiator services.
     if ($container->get('kernel') instanceof UpdateKernel) {

core/modules/workspaces/tests/src/FunctionalJavascript/WorkspacesLayoutBuilderIntegrationTest.php

@@ -7,6 +7,7 @@
 use Drupal\Tests\layout_builder\FunctionalJavascript\InlineBlockTestBase;
 use Drupal\Tests\system\Traits\OffCanvasTestTrait;
 use Drupal\Tests\workspaces\Functional\WorkspaceTestUtilities;
+use Drupal\user\UserInterface;
 use Drupal\workspaces\Entity\Workspace;
 
 /**
@@ -26,6 +27,11 @@ class WorkspacesLayoutBuilderIntegrationTest extends InlineBlockTestBase {
    */
   protected $defaultTheme = 'starterkit_theme';
 
+  /**
+   * The default user that is getting logged in during setup.
+   */
+  protected UserInterface $defaultUser;
+
   /**
    * {@inheritdoc}
    */
@@ -40,7 +46,7 @@ class WorkspacesLayoutBuilderIntegrationTest extends InlineBlockTestBase {
    */
   protected function setUp(): void {
     parent::setUp();
-    $this->drupalLogin($this->drupalCreateUser([
+    $this->defaultUser = $this->drupalCreateUser([
       'access contextual links',
       'configure any layout',
       'administer node display',
@@ -53,7 +59,8 @@ protected function setUp(): void {
       'administer site configuration',
       'administer nodes',
       'bypass node access',
-    ]));
+    ]);
+    $this->drupalLogin($this->defaultUser);
     $this->setupWorkspaceSwitcherBlock();
 
     // Enable layout builder.
@@ -180,4 +187,63 @@ public function testBlockDeletionInWorkspaces(): void {
     $assert_session->pageTextNotContains($workspace_block_content);
   }
 
+  /**
+   * Tests workspace specific layout tempstore data.
+   *
+   * @covers \Drupal\workspaces\WorkspacesLayoutTempstoreRepository::getKey
+   */
+  public function testWorkspacesLayoutTempstore(): void {
+    $assert_session = $this->assertSession();
+    $this->drupalGet('node/1');
+    $assert_session->pageTextContains('The DEFAULT block body');
+
+    $second_user = $this->drupalCreateUser([
+      'access contextual links',
+      'configure any layout',
+      'administer node display',
+      'administer node fields',
+      'create and edit custom blocks',
+      'administer blocks',
+      'administer content types',
+      'administer workspaces',
+      'view any workspace',
+      'administer site configuration',
+      'administer nodes',
+      'bypass node access',
+    ]);
+
+    $stage = Workspace::load('stage');
+    $this->switchToWorkspace($stage);
+
+    // Confirm the block can be edited.
+    $this->drupalGet('node/1/layout');
+    $workspace_block_body = 'The WS block body';
+    $this->configureInlineBlock('The DEFAULT block body', $workspace_block_body);
+
+    // Switch to another user and check the layout edit page in the live
+    // workspace and verify that the changes are not visible there. Switching
+    // the user automatically switches the workspace to Live.
+    $this->drupalLogin($second_user);
+    $this->drupalGet('node/1/layout');
+    $assert_session->pageTextNotContains($workspace_block_body);
+    $assert_session->pageTextContains('The DEFAULT block body');
+    $live_block_body = 'Live edit block body';
+    $this->configureInlineBlock('The DEFAULT block body', $live_block_body);
+    $assert_session->pageTextContains($live_block_body);
+    $assert_session->pageTextNotContains('The DEFAULT block body');
+    $this->drupalGet('node/1');
+    $assert_session->pageTextNotContains($live_block_body);
+    $assert_session->pageTextContains('The DEFAULT block body');
+
+    $this->drupalLogin($this->defaultUser);
+    $this->switchToWorkspace($stage);
+    $this->drupalGet('node/1/layout');
+    $assert_session->pageTextContains($workspace_block_body);
+    $assert_session->pageTextNotContains($live_block_body);
+    $assert_session->pageTextNotContains('The DEFAULT block body');
+    $this->drupalGet('node/1');
+    $assert_session->pageTextNotContains($workspace_block_body);
+    $assert_session->pageTextContains('The DEFAULT block body');
+  }
+
 }