Issue #3093879 by amateescu, catch: Ensure that there's no active workspace...

Issue #3093879 by amateescu, catch: Ensure that there's no active workspace while running database updates

(cherry picked from commit 528ab050)

core/modules/workspaces/src/WorkspacesServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Drupal\Core\DependencyInjection\ContainerBuilder;
 use Drupal\Core\DependencyInjection\ServiceProviderBase;
+use Drupal\Core\Update\UpdateKernel;
 use Symfony\Component\DependencyInjection\Reference;
 
 /**
@@ -24,6 +25,16 @@ public function alter(ContainerBuilder $container) {
     $container->getDefinition('path_alias.repository')
       ->setClass(WorkspacesAliasRepository::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) {
+      foreach ($container->getDefinitions() as $id => $definition) {
+        if ($definition->hasTag('workspace_negotiator')) {
+          $definition->clearTag('workspace_negotiator');
+        }
+      }
+    }
   }
 
 }

core/modules/workspaces/tests/modules/workspace_update_test/src/Negotiator/TestWorkspaceNegotiator.php

+<?php
+
+namespace Drupal\workspace_update_test\Negotiator;
+
+use Drupal\workspaces\Entity\Workspace;
+use Drupal\workspaces\Negotiator\WorkspaceNegotiatorInterface;
+use Drupal\workspaces\WorkspaceInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Defines a workspace negotiator used for testing.
+ */
+class TestWorkspaceNegotiator implements WorkspaceNegotiatorInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function applies(Request $request) {
+    return TRUE;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getActiveWorkspace(Request $request) {
+    return Workspace::create(['id' => 'test', 'label' => 'Test']);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setActiveWorkspace(WorkspaceInterface $workspace) {
+    // Nothing to do here.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function unsetActiveWorkspace() {
+    // Nothing to do here.
+  }
+
+}

core/modules/workspaces/tests/modules/workspace_update_test/workspace_update_test.info.yml

+name: 'Workspace Update Test'
+type: module
+description: 'Provides supporting code for testing workspaces during database updates.'
+package: Testing
+version: VERSION
+core: 8.x
+dependencies:
+  - drupal:workspaces

core/modules/workspaces/tests/modules/workspace_update_test/workspace_update_test.post_update.php

+<?php
+
+/**
+ * @file
+ * Post update functions for the Workspace Update Test module.
+ */
+
+/**
+ * Checks the active workspace during database updates.
+ */
+function workspace_update_test_post_update_check_active_workspace() {
+  \Drupal::state()->set('workspace_update_test.has_active_workspace', \Drupal::service('workspaces.manager')->hasActiveWorkspace());
+}

core/modules/workspaces/tests/modules/workspace_update_test/workspace_update_test.services.yml

+services:
+  workspace_update_test.negotiator.test:
+    class: Drupal\workspace_update_test\Negotiator\TestWorkspaceNegotiator
+    tags:
+      - { name: workspace_negotiator, priority: 0 }

core/modules/workspaces/tests/src/Functional/Update/WorkspacesUpdateTest.php

@@ -18,7 +18,7 @@ class WorkspacesUpdateTest extends UpdatePathTestBase {
   /**
    * {@inheritdoc}
    */
-  protected static $modules = ['workspaces'];
+  protected static $modules = ['workspaces', 'workspace_update_test'];
 
   /**
    * {@inheritdoc}
@@ -127,4 +127,33 @@ public function testWorkspaceParentField() {
     $this->assertNull($form_display->getComponent('parent'));
   }
 
+  /**
+   * Tests that there is no active workspace during database updates.
+   */
+  public function testActiveWorkspaceDuringUpdate() {
+    /** @var \Drupal\workspaces\WorkspaceManagerInterface $workspace_manager */
+    $workspace_manager = \Drupal::service('workspaces.manager');
+
+    // Check that we have an active workspace before running the updates.
+    $this->assertTrue($workspace_manager->hasActiveWorkspace());
+    $this->assertEquals('test', $workspace_manager->getActiveWorkspace()->id());
+
+    $this->runUpdates();
+
+    // Check that we didn't have an active workspace while running the updates.
+    // @see workspace_update_test_post_update_check_active_workspace()
+    $this->assertFalse(\Drupal::state()->get('workspace_update_test.has_active_workspace'));
+
+    // Check that we have an active workspace after running the updates.
+    $this->assertTrue($workspace_manager->hasActiveWorkspace());
+    $this->assertEquals('test', $workspace_manager->getActiveWorkspace()->id());
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function replaceUser1() {
+    // Do not replace the user from our dump.
+  }
+
 }