Fix bug with doubled up free results. Improved readme, updated example.

Author: dustingraham

README.md

@@ -3,38 +3,59 @@
 Non-blocking MySQLi database access with PHP.
 Designed to work with [reactphp/react](https://github.com/reactphp/react).
 
+[![Build Status](https://travis-ci.org/dustingraham/react-mysql.svg?branch=master)](https://travis-ci.org/dustingraham/react-mysql)
+
+## Quickstart
+
+    $db = new \DustinGraham\ReactMysql\Database(
+        ['localhost', 'apache', 'apache', 'react_mysql_test']
+    );
+    
+    $db->statement('SELECT * FROM simple_table WHERE id = :test', [':test' => 2])
+        ->then(function(\mysqli_result $result)
+        {
+            $rows = $result->fetch_all(MYSQLI_ASSOC);
+        });
+    
+    $db->shuttingDown = true;
+    $db->loop->run();
+
+Setting `shuttingDown` to true will allow the loop to exit once the query has resolved.
 
 ## Working
 
-This __is__ working. But it is nowhere near complete. 
+This __is__ working. But it is nowhere near complete. Check out the example file
+as well as the unit tests for more examples.
 
-    $ ./run
-    Starting loop...
-    DB Created.
+    $ ./example 
+    Creating database....done!
     Run Query: 0
     Found rows: 0
     Run Query: 1
     Found rows: 1
-    Current memory usage: 735.117K
+    Current memory usage: 868.164K
     Run Query: 2
-    Found rows: 0
+    Found rows: 1
     Run Query: 3
     Found rows: 1
     Run Query: 4
-    Found rows: 1
-    Current memory usage: 735.117K
+    Found rows: 0
+    Current memory usage: 868.164K
     Run Query: 5
     Found rows: 0
-    Current memory usage: 733.602K
-    Current memory usage: 733.602K
-    Current memory usage: 733.602K
+    Current memory usage: 865.719K
+    Current memory usage: 865.719K
+    Current memory usage: 865.719K
     Loop finished, all timers halted.
 
 This won't work out of the box without the database configured.
-As of this point, database configuration is hard coded.
-Still need to pull out the configs. You will also need to
-set up a database with some data to query. Check back later
-for more!
+You will also need to set up a database with some data to query.
+
+## Unit Tests
+
+The example and unit tests expect a database called `react_mysql_test` which it
+will populate with the proper tables each time it runs. It also expects `localhost`
+and a user `apache` with password `apache`.
 
 ## TODO
 
@@ -52,23 +73,20 @@ These are just plans for now. It may change wildly as we develop.
 
 Here is an example of what is currently working for the most part.
 
-    $loop = React\EventLoop\Factory::create();
-    
-    ConnectionFactory::init($loop, ['db_host', 'db_user', 'db_pass', 'db_name']);
-    
-    $db = new \DustinGraham\ReactMysql\Database();  
+    $db = new \DustinGraham\ReactMysql\Database(
+        ['localhost', 'apache', 'apache', 'react_mysql_test']
+    );
 
-    $db->createCommand("SELECT * FROM `table` WHERE id = :id;", [':id' => $id])
-      ->execute()->then(
-        function($result)
+    $db->statement('SELECT * FROM simple_table WHERE id = :test', [':test' => 2])
+        ->then(function(\mysqli_result $result)
         {
             $rows = $result->fetch_all(MYSQLI_ASSOC);
-            $result->close();
             
             // Do something with $rows.
-        }
-    );
+        });
 
+    $db->shuttingDown = true;
+    $db->loop->run();
 
 ### Original Big Picture Plans
 

example

@@ -0,0 +1,50 @@
+#!/usr/bin/env php
+<?php
+error_reporting(-1);
+ini_set("display_errors", 1);
+
+require __DIR__.'/vendor/autoload.php';
+
+echo 'Creating database..';
+
+$db = new \DustinGraham\ReactMysql\Database(
+    ['localhost', 'apache', 'apache', 'react_mysql_test']
+);
+
+echo '..done!'.PHP_EOL;
+
+$j = 0;
+$db->loop->addPeriodicTimer(0.3, function (\React\EventLoop\Timer\TimerInterface $timer) use (&$j)
+{
+    $memory = memory_get_usage() / 1024;
+    $formatted = number_format($memory, 3).'K';
+    echo "Current memory usage: {$formatted}\n";
+    
+    if ($j++ > 3) $timer->cancel();
+});
+
+$i = 0;
+$db->loop->addPeriodicTimer(0.1, function (\React\EventLoop\Timer\TimerInterface $timer) use (&$i, $db)
+{
+    echo "Run Query: $i\n";
+    
+    $db->statement(
+        'SELECT * FROM `simple_table` WHERE id = :test',
+        [':test' => $i]
+    )->then(function(\mysqli_result $result)
+    {
+        $rows = $result->fetch_all(MYSQLI_ASSOC);
+        echo 'Found rows: '.count($rows).PHP_EOL;
+    })->done();
+    
+    if ($i++ >= 5)
+    {
+        // All queries added.
+        $db->shuttingDown = true;
+        $timer->cancel();
+    }
+});
+
+$db->loop->run();
+
+echo 'Loop finished, all timers halted.'.PHP_EOL;

run

@@ -24,10 +24,10 @@ class Command
         'NOW()',
     ];
 
-    public function __construct(Database $database, $sql = null)
+    public function __construct($sql = null, $params = null)
     {
-        $this->db = $database;
         $this->sql = $sql;
+        $this->bind($params);
     }
 
     /**
@@ -39,10 +39,12 @@ public function bind($key, $value = null)
     {
         if (is_array($key))
         {
-            // TODO: Is this cludgy?
-            $this->bindValues($key);
+            foreach ($key as $k => $v)
+            {
+                $this->params[$k] = $v;
+            }
         }
-        else
+        else if (!is_null($key))
         {
             $this->params[$key] = $value;
         }
@@ -51,17 +53,14 @@ public function bind($key, $value = null)
     }
 
     /**
+     * @deprecated 
+     * 
      * @param $params
      * @return $this
      */
     public function bindValues($params)
     {
-        foreach ($params as $k => $v)
-        {
-            $this->params[$k] = $v;
-        }
-        
-        return $this;
+        return $this->bind($params);
     }
 
     /**
@@ -113,6 +112,8 @@ protected function quoteIntoSql(Connection $connection)
     }
 
     /**
+     * @deprecated 
+     * 
      * @return \React\Promise\Promise
      */
     public function execute()

src/Command.php

@@ -36,10 +36,12 @@ public function __construct($host = null, $username = null, $passwd = null, $dbn
      */
     public function escape($string)
     {
-        return $this->mysqli->real_escape_string($string);
+        return $this->real_escape_string($string);
     }
 
     /**
+     * @deprecated 
+     * 
      * Close the mysqli connection.
      */
     public function close()

src/Connection.php

@@ -4,24 +4,23 @@
 
 class ConnectionFactory
 {
-    /**
-     * @var LoopInterface
-     */
-    //public static $loop;
-    
     /**
      * @var array
      */
     protected static $credentials;
 
-    public static function init(LoopInterface $loop, $credentials)
+    public static function init($credentials)
     {
-        //self::$loop = $loop;
         self::$credentials = $credentials;
     }
 
     public static function createConnection()
     {
+        if (is_null(self::$credentials))
+        {
+            throw new \Exception('Database credentials not set.');
+        }
+        
         $connection = new Connection(
             self::$credentials[0],
             self::$credentials[1],

src/ConnectionFactory.php

@@ -22,9 +22,13 @@ class Database
      */
     protected $pollInterval = 0.01;
 
-    
-    public function __construct()
+    public function __construct($credentials = null)
     {
+        if (!is_null($credentials))
+        {
+            ConnectionFactory::init($credentials);
+        }
+        
         $this->loop = Factory::create();
         $this->initLoop();
 
@@ -90,12 +94,16 @@ public function getPool()
         return $this->pool;
     }
 
-    public function statement($sql)
+    public function statement($sql, $params = null)
     {
+        $command = new Command($sql, $params);
+        
         $deferred = new Deferred();
 
-        $this->pool->withConnection(function($connection) use ($sql, $deferred)
+        $this->pool->withConnection(function(Connection $connection) use ($command, $deferred)
         {
+            $sql = $command->getPreparedQuery($connection);
+            
             $connection->query($sql, MYSQLI_ASYNC);
 
             $this->conns[$connection->id] = [
@@ -126,6 +134,8 @@ public function loopTick(TimerInterface $timer)
             // If we are shutting down, and have nothing to check, kill the timer.
             if ($this->shuttingDown)
             {
+                // TODO: Possible race condition if shutdown also queues queries, such as a final save.
+                // This could be prematurely cancelled.
                 $timer->cancel();
             }
 
@@ -151,7 +161,11 @@ public function loopTick(TimerInterface $timer)
             if ($result !== false)
             {
                 $deferred->resolve($result);
-                $result->free();
+                
+                // If userland code has already freed the result, this will throw a warning.
+                // No need to throw a warning here...
+                // If you know how to check if the result has already been freed, please PR!
+                @$result->free();
             }
             else
             {