Merge pull request #36 from packbackbooks/add-statement-batching

Add Statement Batching For PtOnlineSchemaChangeConnection

src/BatchableBlueprint.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Daursu\ZeroDowntimeMigration;
+
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Database\Connection;
+use Illuminate\Database\Schema\Grammars\Grammar;
+
+/**
+ * A variant of `Blueprint` that allows for connection types to define a `statements`
+ * method to process an array of SQL query strings at once. For example, pt-online-schema-change
+ * lets you pass multiple alter operations to be run on the cloned table.
+ */
+class BatchableBlueprint extends Blueprint
+{
+    public function build(Connection $connection, Grammar $grammar)
+    {
+        if (method_exists($connection, 'statements')) {
+            $statements = $this->toSql($connection, $grammar);
+            return !empty($statements) ? $connection->statements($statements) : null;
+        }
+
+        return parent::build($connection, $grammar);
+    }
+}

src/Connections/PtOnlineSchemaChangeConnection.php

@@ -13,20 +13,21 @@ class PtOnlineSchemaChangeConnection extends BaseConnection
      */
     public function statement($query, $bindings = [])
     {
-        $table = $this->extractTableFromQuery($query);
+        return $this->runQueries([$query]);
+    }
 
-        return $this->runProcess(array_merge(
-            [
-                'pt-online-schema-change',
-                $this->isPretending() ? '--dry-run' : '--execute',
-            ],
-            $this->getAdditionalParameters(),
-            [
-                '--alter',
-                $this->cleanQuery($query),
-                $this->getAuthString($table),
-            ]
-        ));
+    /**
+     * A custom connection method called by our custom schema builder to help batch
+     * operations on the cloned table.
+     *
+     * @see \Daursu\ZeroDowntimeMigration\BatchableBlueprint
+     *
+     * @param string[] $queries
+     * @return bool|int
+     */
+    public function statements($queries)
+    {
+        return $this->runQueries($queries);
     }
 
     /**
@@ -60,4 +61,31 @@ protected function maskSensitiveInformation(array $command): string
             return preg_replace('/('.preg_quote($this->getConfig('username'), '/').'),/', '*****,', $config);
         })->implode(' ');
     }
+
+    /**
+     * @param string[] $queries
+     * @return bool|int
+     */
+    protected function runQueries($queries)
+    {
+        $table = $this->extractTableFromQuery($queries[0]);
+
+        $cleanQueries = [];
+        foreach($queries as $query) {
+            $cleanQueries[] = $this->cleanQuery($query);
+        }
+
+        return $this->runProcess(array_merge(
+            [
+                'pt-online-schema-change',
+                $this->isPretending() ? '--dry-run' : '--execute',
+            ],
+            $this->getAdditionalParameters(),
+            [
+                '--alter',
+                implode(', ', $cleanQueries),
+                $this->getAuthString($table),
+            ]
+        ));
+    }
 }

src/ServiceProvider.php

@@ -6,7 +6,9 @@
 use Daursu\ZeroDowntimeMigration\Connections\PtOnlineSchemaChangeConnection;
 use Illuminate\Database\Connection;
 use Illuminate\Database\Connectors\MySqlConnector;
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\ServiceProvider as IlluminateServiceProvider;
+use ReflectionClass;
 
 class ServiceProvider extends IlluminateServiceProvider
 {
@@ -42,5 +44,9 @@ public function register()
         $this->app->bind('db.connector.gh-ost', function () {
             return new MySqlConnector;
         });
+
+        $this->app->bind(Blueprint::class, function ($app, $args = []) {
+            return new BatchableBlueprint(...$args);
+        });
     }
 }

tests/Unit/PtOnlineSchemaChangeConnectionTest.php

@@ -83,6 +83,26 @@ public function testItRemovesAlterTableStatementFromTheQuery()
         $connection->statement($query);
     }
 
+    public function testItConcatenatesMultipleStatements()
+    {
+        $queries = [
+            "alter table `users` add `middle_name` varchar(255)",
+            "alter table `users` drop foreign key `created_by_foreign`",
+        ];
+        $connection = $this->getConnectionWithMockedProcess();
+
+        $connection->expects($this->once())
+            ->method('runProcess')
+            ->with($this->callback(function ($command) {
+                $command = implode(' ', $command);
+                return Str::contains($command, '--alter add `middle_name` varchar(255), '.
+                    'drop foreign key `created_by_foreign`');
+            }))
+            ->willReturn(0);
+
+        $connection->statements($queries);
+    }
+
     public function testAdditionalOptionsAreLoadedIn()
     {
         $query = 'alter table `users` ADD `email` varchar(255)';