refactor time measurement for cli commands; improve cli output

Author: Gaetano Giunta

TODO.md

@@ -1,6 +1,7 @@
 - worker: improve sql execution cmd:
   + allow it to take sql snippet from file
   + allow it to pick a set of desired servers
+  + disallow execution of commands that are part of the db client instead of being sent to the server, such as eg. 'use db'
 
 - worker: improve profile of 'user' account (esp: add APP_ENV and APP_DEBUG env vars)
 

app/src/API/Interfaces/TimedExecutor.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Db3v4l\API\Interfaces;
+
+interface TimedExecutor
+{
+    /**
+     * Returns time/memory/cpu consumption of last execution
+     * @return array
+     */
+    public function getTimingData();
+}

app/src/Command/SqlExecute.php

@@ -5,11 +5,12 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputOption;
-use Db3v4l\Util\Process;
 use Symfony\Component\Yaml\Yaml;
+use Db3v4l\API\Interfaces\TimedExecutor;
 use Db3v4l\Service\DatabaseConfigurationManager;
 use Db3v4l\Service\SqlExecutorFactory;
 use Db3v4l\Service\ProcessManager;
+use Db3v4l\Util\Process;
 
 class SqlExecute extends BaseCommand
 {
@@ -83,21 +84,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         /** @var Process[] $processes */
         $processes = [];
-        $timingFiles = [];
+        $executors = [];
         foreach ($dbList as $dbName) {
             $dbConnectionSpec = $this->dbManager->getDatabaseConnectionSpecification($dbName);
-            $process = $this->executorFactory->createForkedExecutor($dbConnectionSpec)->getProcess($sql);
 
-            // wrap in a `time` call
-            $timingFile = tempnam(sys_get_temp_dir(), 'db3val_');
-            $process->setCommandLine(
-                'time ' . escapeshellarg('--output=' . $timingFile) . ' ' . escapeshellarg('--format=%M %e') . ' '
-                . $process->getCommandLine());
+            $executor = $this->executorFactory->createForkedExecutor($dbConnectionSpec);
+            $process = $executor->getProcess($sql);
 
             $process->setTimeout($timeout);
 
+            $executors[$dbName] = $executor;
             $processes[$dbName] = $process;
-            $timingFiles[$dbName] = $timingFile;
         }
 
         if ($format === 'text') {
@@ -116,13 +113,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 'exitcode' => $process->getExitCode()
             );
 
-            $timingData = file_get_contents($timingFiles[$dbName]);
-            if ($timingData != '') {
-                $timingData = explode(' ', $timingData, 2);
-                $results[$dbName]['time'] = $timingData[1];
-                $results[$dbName]['memory'] = $timingData[0];
+            if ($executors[$dbName] instanceof TimedExecutor) {
+                $timingData = $executors[$dbName]->getTimingData();
+                $results[$dbName] = array_merge($results[$dbName], $timingData);
             }
-            unlink($timingFiles[$dbName]);
 
             if ($process->isSuccessful()) {
                 $succeeded++;
@@ -135,7 +129,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $time = microtime(true) - $start;
 
         $this->writeResults($results, $succeeded, $failed, $time, $format);
-
     }
 
     /**
@@ -147,13 +140,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
      */
     protected function writeResults(array $results, $succeeded, $failed, $time, $format = 'text')
     {
-        if ($format === 'text') {
-            $this->writeln($succeeded . ' succeeded, ' . $failed . ' failed');
-
-            // since we use subprocesses, we can not measure max memory used
-            $this->writeln("<info>Time taken: ".sprintf('%.2f', $time)." secs</info>");
-        }
-
         switch ($format) {
             case 'json':
                 $results = json_encode($results, JSON_PRETTY_PRINT);
@@ -170,8 +156,14 @@ protected function writeResults(array $results, $succeeded, $failed, $time, $for
                 throw new \Exception("Unsupported output format: '$format'");
                 break;
         }
-
         $this->writeln($results, OutputInterface::VERBOSITY_QUIET,  OutputInterface::OUTPUT_RAW);
+
+        if ($format === 'text') {
+            $this->writeln($succeeded . ' succeeded, ' . $failed . ' failed');
+
+            // since we use subprocesses, we can not measure max memory used
+            $this->writeln("<info>Time taken: ".sprintf('%.2f', $time)." secs</info>");
+        }
     }
 
     /**

app/src/Service/SqlExecutor/Forked/NativeClient.php

@@ -24,6 +24,7 @@ public function getProcess($sql)
                     '--port=' . $this->databaseConfiguration['port'] ?? '3306',
                     '--user=' . $this->databaseConfiguration['user'],
                     '-p' . $this->databaseConfiguration['password'],
+                    '--binary-mode', // 'It also disables all mysql commands except charset and delimiter in non-interactive mode (for input piped to mysql or loaded using the source command)'
                     '--execute=' . $sql,
                     // $dbname
                 ];

app/src/Service/SqlExecutor/Forked/TimedExecutor.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Db3v4l\Service\SqlExecutor\Forked;
+
+use Db3v4l\API\Interfaces\ForkedSqlExecutor;
+use Db3v4l\API\Interfaces\TimedExecutor as TimedExecutorInterface;
+
+class TimedExecutor implements ForkedSqlExecutor, TimedExecutorInterface
+{
+    /** @var ForkedSqlExecutor */
+    protected $wrappedExecutor;
+    protected $timingFile;
+
+    public function __construct(ForkedSqlExecutor $wrappedExecutor)
+    {
+        $this->wrappedExecutor = $wrappedExecutor;
+    }
+
+    public function getProcess($sql)
+    {
+        $process = $this->wrappedExecutor->getProcess($sql);
+
+        // wrap in a `time` call
+        $this->timingFile = tempnam(sys_get_temp_dir(), 'db3val_');
+        $process->setCommandLine(
+            'time ' . escapeshellarg('--output=' . $this->timingFile) . ' ' . escapeshellarg('--format=%M %e') . ' '
+            . $process->getCommandLine());
+
+        return $process;
+    }
+
+    public function getTimingData($onceIsEnough = true)
+    {
+        if (!is_file($this->timingFile)) {
+            throw new \Exception("File with timing data gone missing: '{$this->timingFile}'");
+        }
+
+        $timingData = file_get_contents($this->timingFile);
+        if ($timingData != '') {
+            $timingData = explode(' ', $timingData, 2);
+            $results['time'] = $timingData[1];
+            $results['memory'] = $timingData[0];
+        }
+
+        if ($onceIsEnough) {
+            unlink ($this->timingFile);
+        }
+
+        return $results;
+    }
+}

app/src/Service/SqlExecutorFactory.php

@@ -5,24 +5,34 @@
 use Db3v4l\API\Interfaces\ForkedSqlExecutor;
 use Db3v4l\Service\SqlExecutor\Forked\NativeClient;
 use Db3v4l\Service\SqlExecutor\Forked\Doctrine;
+use Db3v4l\Service\SqlExecutor\Forked\TimedExecutor;
 
 class SqlExecutorFactory
 {
     /**
      * @param array $databaseConnectionConfiguration
      * @param string $executionStrategy
+     * @bool $timed
      * @return ForkedSqlExecutor
      * @throws \OutOfBoundsException
      */
-    public function createForkedExecutor($databaseConnectionConfiguration, $executionStrategy = 'NativeClient')
+    public function createForkedExecutor($databaseConnectionConfiguration, $executionStrategy = 'NativeClient', $timed = true)
     {
         switch ($executionStrategy) {
             case 'Doctrine':
-                return new Doctrine($databaseConnectionConfiguration);
+                $executor = new Doctrine($databaseConnectionConfiguration);
+                break;
             case 'NativeClient':
-                return new NativeClient($databaseConnectionConfiguration);
+                $executor = new NativeClient($databaseConnectionConfiguration);
+                break;
             default:
                 throw new \OutOfBoundsException("Unsupported executor strategy '$executionStrategy'");
         }
+
+        if ($timed) {
+            $executor = new TimedExecutor($executor);
+        }
+
+        return $executor;
     }
-}
+}