Fix #3634. updatedb with long-running updates can end in "MySQL went away" error (#3655)

Also simplify UpdateDB tests a bit.

Author: weitzman

src/Commands/core/UpdateDBCommands.php

@@ -16,6 +16,8 @@ class UpdateDBCommands extends DrushCommands
 {
     protected $cache_clear;
 
+    protected $maintenanceModeOriginalState;
+
     /**
      * Apply any database updates required (as with running update.php).
      *
@@ -386,10 +388,10 @@ public function updateBatch($options)
         ];
         batch_set($batch);
 
-        $maintenance_mode_original_state = \Drupal::service('state')->get('system.maintenance_mode');
+        // See updateFinished() for the restore of maint mode.
+        $this->maintenanceModeOriginalState = \Drupal::service('state')->get('system.maintenance_mode');
         \Drupal::service('state')->set('system.maintenance_mode', true);
         $result = drush_backend_batch_process('updatedb:batch-process');
-        \Drupal::service('state')->set('system.maintenance_mode', $maintenance_mode_original_state);
 
         $success = false;
         if (!is_array($result)) {
@@ -468,7 +470,7 @@ public function cacheRebuild()
     }
 
     /**
-     * Batch update callback, clears the cache if needed.
+     * Batch update callback, clears the cache if needed, and restores maint mode.
      *
      * @see \Drupal\system\Controller\DbUpdateController::batchFinished()
      * @see \Drupal\system\Controller\DbUpdateController::results()
@@ -484,6 +486,8 @@ public function updateFinished($success, $results, $operations)
         } else {
             drupal_flush_all_caches();
         }
+
+        \Drupal::service('state')->set('system.maintenance_mode', $this->maintenanceModeOriginalState);
     }
 
     /**
@@ -587,10 +591,11 @@ public function entityUpdatesMain()
                 'finished' => [$this, 'updateFinished'],
             ];
             batch_set($batch);
-            $maintenance_mode_original_state = \Drupal::service('state')->get('system.maintenance_mode');
+
+            // See updateFinished() for the restore of maint mode.
+            $this->maintenanceModeOriginalState = \Drupal::service('state')->get('system.maintenance_mode');
             \Drupal::service('state')->set('system.maintenance_mode', true);
             drush_backend_batch_process();
-            \Drupal::service('state')->set('system.maintenance_mode', $maintenance_mode_original_state);
         } else {
             $this->logger()->success(dt("No entity schema updates required"));
         }

tests/UpdateDBTest.php

@@ -54,8 +54,6 @@ public function testFailedUpdate()
         $sites = $this->setUpDrupal(1, true);
         $options = [
             'yes' => null,
-            'root' => $this->webroot(),
-            'uri' => key($sites),
         ];
         $this->setupModulesForTests(['woot'], Path::join(__DIR__, 'resources/modules/d8'));
         $this->drush('pm-enable', ['woot'], $options);
@@ -105,11 +103,9 @@ public function testFailedUpdate()
      */
     public function testFailedPostUpdate()
     {
-        $sites = $this->setUpDrupal(1, true);
+        $this->setUpDrupal(1, true);
         $options = [
             'yes' => null,
-            'root' => $this->webroot(),
-            'uri' => key($sites),
         ];
         $this->setupModulesForTests(['woot'], Path::join(__DIR__, 'resources/modules/d8'));
         $this->drush('pm-enable', ['woot'], $options);
@@ -168,11 +164,8 @@ public function testFailedPostUpdate()
     public function testUpdateModuleWithServiceDependency()
     {
         $root = $this->webroot();
-        $sites = $this->setUpDrupal(1, true);
+        $this->setUpDrupal(1, true);
         $options = [
-            'yes' => null,
-            'root' => $root,
-            'uri' => key($sites),
             'include' => __DIR__,
         ];
         $this->setupModulesForTests(['woot'], Path::join(__DIR__, 'resources/modules/d8'));
@@ -217,11 +210,9 @@ class: Drupal\woot\DependingService
      */
     public function testSuccessfulUpdate()
     {
-        $sites = $this->setUpDrupal(1, true);
+        $this->setUpDrupal(1, true);
         $options = [
             'yes' => null,
-            'root' => $this->webroot(),
-            'uri' => key($sites),
         ];
         $this->setupModulesForTests(['woot'], Path::join(__DIR__, 'resources/modules/d8'));
         $this->drush('pm-enable', ['woot'], $options);