Improve error reporting, include MySQL URI in all connection errors

Author: clue

README.md

@@ -33,9 +33,7 @@ This example runs a simple `SELECT` query and dumps all the records from a `book
 
 ```php
 $factory = new React\MySQL\Factory();
-
-$uri = 'test:test@localhost/test';
-$connection = $factory->createLazyConnection($uri);
+$connection = $factory->createLazyConnection('user:pass@localhost/bookstore');
 
 $connection->query('SELECT * FROM book')->then(
     function (QueryResult $command) {

examples/01-query.php

@@ -1,18 +1,17 @@
 <?php
 
+// $ php examples/01-query.php
+// $ MYSQL_URI=test:test@localhost/test php examples/01-query.php "SELECT * FROM book"
+
 use React\MySQL\Factory;
 use React\MySQL\QueryResult;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 $factory = new Factory();
+$connection = $factory->createLazyConnection(getenv('MYSQL_URI') ?: 'test:test@localhost/test');
 
-$uri = 'test:test@localhost/test';
 $query = isset($argv[1]) ? $argv[1] : 'select * from book';
-
-//create a lazy mysql connection for executing query
-$connection = $factory->createLazyConnection($uri);
-
 $connection->query($query)->then(function (QueryResult $command) {
     if (isset($command->resultRows)) {
         // this is a response to a SELECT etc. with some rows (0+)

examples/02-query-stream.php

@@ -1,19 +1,16 @@
 <?php
 
 // $ php examples/02-query-stream.php "SHOW VARIABLES"
+// $ MYSQL_URI=test:test@localhost/test php examples/02-query-stream.php "SELECT * FROM book"
 
 use React\MySQL\Factory;
 
 require __DIR__ . '/../vendor/autoload.php';
 
 $factory = new Factory();
+$connection = $factory->createLazyConnection(getenv('MYSQL_URI') ?: 'test:test@localhost/test');
 
-$uri = 'test:test@localhost/test';
 $query = isset($argv[1]) ? $argv[1] : 'select * from book';
-
-//create a lazy mysql connection for executing query
-$connection = $factory->createLazyConnection($uri);
-
 $stream = $connection->queryStream($query);
 
 $stream->on('data', function ($row) {

examples/11-interactive.php

@@ -1,5 +1,8 @@
 <?php
 
+// $ php examples/11-interactive.php
+// $ MYSQL_URI=test:test@localhost/test php examples/11-interactive.php
+
 use React\MySQL\ConnectionInterface;
 use React\MySQL\QueryResult;
 use React\MySQL\Factory;
@@ -8,8 +11,7 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 $factory = new Factory();
-
-$uri = 'test:test@localhost/test';
+$uri = getenv('MYSQL_URI') ?: 'test:test@localhost/test';
 
 // open a STDIN stream to read keyboard input (not supported on Windows)
 $stdin = new ReadableResourceStream(STDIN);

examples/12-slow-stream.php

@@ -1,6 +1,7 @@
 <?php
 
 // $ php examples/12-slow-stream.php "SHOW VARIABLES"
+// $ MYSQL_URI=test:test@localhost/test php examples/12-slow-stream.php "SELECT * FROM book"
 
 use React\EventLoop\Loop;
 use React\MySQL\ConnectionInterface;
@@ -9,8 +10,8 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 $factory = new Factory();
+$uri = getenv('MYSQL_URI') ?: 'test:test@localhost/test';
 
-$uri = 'test:test@localhost/test';
 $query = isset($argv[1]) ? $argv[1] : 'select * from book';
 
 //create a mysql connection for executing query

src/Factory.php

@@ -163,8 +163,9 @@ public function createConnection($uri)
         }
 
         $parts = parse_url($uri);
+        $uri = preg_replace('#:[^:/]*@#', ':***@', $uri);
         if (!isset($parts['scheme'], $parts['host']) || $parts['scheme'] !== 'mysql') {
-            return \React\Promise\reject(new \InvalidArgumentException('Invalid connect uri given'));
+            return \React\Promise\reject(new \InvalidArgumentException('Invalid MySQL URI given'));
         }
 
         $args = [];
@@ -187,9 +188,11 @@ public function createConnection($uri)
             $parts['host'] . ':' . (isset($parts['port']) ? $parts['port'] : 3306)
         );
 
-        $deferred = new Deferred(function ($_, $reject) use ($connecting) {
+        $deferred = new Deferred(function ($_, $reject) use ($connecting, $uri) {
             // connection cancelled, start with rejecting attempt, then clean up
-            $reject(new \RuntimeException('Connection to database server cancelled'));
+            $reject(new \RuntimeException(
+                'Connection to ' . $uri . ' cancelled'
+            ));
 
             // either close successful connection or cancel pending connection attempt
             $connecting->then(function (SocketConnectionInterface $connection) {
@@ -198,7 +201,7 @@ public function createConnection($uri)
             $connecting->cancel();
         });
 
-        $connecting->then(function (SocketConnectionInterface $stream) use ($authCommand, $deferred) {
+        $connecting->then(function (SocketConnectionInterface $stream) use ($authCommand, $deferred, $uri) {
             $executor = new Executor();
             $parser = new Parser($stream, $executor);
 
@@ -209,12 +212,20 @@ public function createConnection($uri)
             $command->on('success', function () use ($deferred, $connection) {
                 $deferred->resolve($connection);
             });
-            $command->on('error', function ($error) use ($deferred, $stream) {
-                $deferred->reject($error);
+            $command->on('error', function (\Exception $error) use ($deferred, $stream, $uri) {
+                $deferred->reject(new \RuntimeException(
+                    'Connection to ' . $uri . ' failed during authentication: ' . $error->getMessage(),
+                    $error->getCode(),
+                    $error
+                ));
                 $stream->close();
             });
-        }, function ($error) use ($deferred) {
-            $deferred->reject(new \RuntimeException('Unable to connect to database server', 0, $error));
+        }, function (\Exception $error) use ($deferred, $uri) {
+            $deferred->reject(new \RuntimeException(
+                'Connection to ' . $uri . ' failed: ' . $error->getMessage(),
+                $error->getCode(),
+                $error
+            ));
         });
 
         // use timeout from explicit ?timeout=x parameter or default to PHP's default_socket_timeout (60)
@@ -223,10 +234,10 @@ public function createConnection($uri)
             return $deferred->promise();
         }
 
-        return \React\Promise\Timer\timeout($deferred->promise(), $timeout, $this->loop)->then(null, function ($e) {
+        return \React\Promise\Timer\timeout($deferred->promise(), $timeout, $this->loop)->then(null, function ($e) use ($uri) {
             if ($e instanceof TimeoutException) {
                 throw new \RuntimeException(
-                    'Connection to database server timed out after ' . $e->getTimeout() . ' seconds'
+                    'Connection to ' . $uri . ' timed out after ' . $e->getTimeout() . ' seconds'
                 );
             }
             throw $e;

tests/FactoryTest.php

@@ -109,8 +109,14 @@ public function testConnectWithInvalidUriWillRejectWithoutConnecting()
         $factory = new Factory($loop, $connector);
         $promise = $factory->createConnection('///');
 
-        $this->assertInstanceof('React\Promise\PromiseInterface', $promise);
-        $promise->then(null, $this->expectCallableOnce());
+        $promise->then(null, $this->expectCallableOnceWith(
+            $this->logicalAnd(
+                $this->isInstanceOf('InvalidArgumentException'),
+                $this->callback(function (\InvalidArgumentException $e) {
+                    return $e->getMessage() === 'Invalid MySQL URI given';
+                })
+            )
+        ));
     }
 
     public function testConnectWithInvalidCharsetWillRejectWithoutConnecting()
@@ -149,7 +155,7 @@ public function testConnectWithInvalidPassRejectsWithAuthenticationError()
             $this->logicalAnd(
                 $this->isInstanceOf('Exception'),
                 $this->callback(function (\Exception $e) {
-                    return !!preg_match("/^Access denied for user '.*?'@'.*?' \(using password: YES\)$/", $e->getMessage());
+                    return !!preg_match("/^Connection to mysql:\/\/[^ ]* failed during authentication: Access denied for user '.*?'@'.*?' \(using password: YES\)$/", $e->getMessage());
                 })
             )
         ));
@@ -180,15 +186,17 @@ public function testConnectWillRejectOnExplicitTimeoutDespiteValidAuth()
     {
         $factory = new Factory();
 
-        $uri = $this->getConnectionString() . '?timeout=0';
+        $uri = 'mysql://' . $this->getConnectionString() . '?timeout=0';
 
         $promise = $factory->createConnection($uri);
 
+        $uri = preg_replace('/:[^:]*@/', ':***@', $uri);
+
         $promise->then(null, $this->expectCallableOnceWith(
             $this->logicalAnd(
                 $this->isInstanceOf('Exception'),
-                $this->callback(function (\Exception $e) {
-                    return $e->getMessage() === 'Connection to database server timed out after 0 seconds';
+                $this->callback(function (\Exception $e) use ($uri) {
+                    return $e->getMessage() === 'Connection to ' . $uri . ' timed out after 0 seconds';
                 })
             )
         ));
@@ -200,18 +208,20 @@ public function testConnectWillRejectOnDefaultTimeoutFromIniDespiteValidAuth()
     {
         $factory = new Factory();
 
-        $uri = $this->getConnectionString();
+        $uri = 'mysql://' . $this->getConnectionString();
 
         $old = ini_get('default_socket_timeout');
         ini_set('default_socket_timeout', '0');
         $promise = $factory->createConnection($uri);
         ini_set('default_socket_timeout', $old);
 
+        $uri = preg_replace('/:[^:]*@/', ':***@', $uri);
+
         $promise->then(null, $this->expectCallableOnceWith(
             $this->logicalAnd(
                 $this->isInstanceOf('Exception'),
-                $this->callback(function (\Exception $e) {
-                    return $e->getMessage() === 'Connection to database server timed out after 0 seconds';
+                $this->callback(function (\Exception $e) use ($uri) {
+                    return $e->getMessage() === 'Connection to ' . $uri . ' timed out after 0 seconds';
                 })
             )
         ));
@@ -382,22 +392,75 @@ public function testConnectWithValidAuthCanCloseAndAbortPing()
         Loop::run();
     }
 
-    public function testCancelConnectWillCancelPendingConnection()
+    public function testlConnectWillRejectWhenUnderlyingConnectorRejects()
+    {
+        $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
+        $connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
+        $connector->expects($this->once())->method('connect')->willReturn(\React\Promise\reject(new \RuntimeException('Failed', 123)));
+
+        $factory = new Factory($loop, $connector);
+        $promise = $factory->createConnection('user:[email protected]');
+
+        $promise->then(null, $this->expectCallableOnceWith($this->isInstanceOf('RuntimeException')));
+        $promise->then(null, $this->expectCallableOnceWith($this->callback(function ($e) {
+            return ($e->getMessage() === 'Connection to mysql://user:***@127.0.0.1 failed: Failed');
+        })));
+        $promise->then(null, $this->expectCallableOnceWith($this->callback(function ($e) {
+            return ($e->getCode() === 123);
+        })));
+    }
+
+    public function provideUris()
+    {
+        return [
+            [
+                'localhost',
+                'mysql://localhost'
+            ],
+            [
+                'mysql://localhost',
+                'mysql://localhost'
+            ],
+            [
+                'mysql://user:pass@localhost',
+                'mysql://user:***@localhost'
+            ],
+            [
+                'mysql://user:@localhost',
+                'mysql://user:***@localhost'
+            ],
+            [
+                'mysql://user@localhost',
+                'mysql://user@localhost'
+            ]
+        ];
+    }
+
+    /**
+     * @dataProvider provideUris
+     * @param string $uri
+     * @param string $safe
+     */
+    public function testCancelConnectWillCancelPendingConnection($uri, $safe)
     {
         $pending = new Promise(function () { }, $this->expectCallableOnce());
         $loop = $this->getMockBuilder('React\EventLoop\LoopInterface')->getMock();
         $connector = $this->getMockBuilder('React\Socket\ConnectorInterface')->getMock();
         $connector->expects($this->once())->method('connect')->willReturn($pending);
 
         $factory = new Factory($loop, $connector);
-        $promise = $factory->createConnection('127.0.0.1');
+        $promise = $factory->createConnection($uri);
 
         $promise->cancel();
 
-        $promise->then(null, $this->expectCallableOnceWith($this->isInstanceOf('RuntimeException')));
-        $promise->then(null, $this->expectCallableOnceWith($this->callback(function ($e) {
-            return ($e->getMessage() === 'Connection to database server cancelled');
-        })));
+        $promise->then(null, $this->expectCallableOnceWith(
+            $this->logicalAnd(
+                $this->isInstanceOf('RuntimeException'),
+                $this->callback(function (\RuntimeException $e) use ($safe) {
+                    return $e->getMessage() === 'Connection to ' . $safe . ' cancelled';
+                })
+            )
+        ));
     }
 
     public function testCancelConnectWillCancelPendingConnectionWithRuntimeException()
@@ -416,7 +479,7 @@ public function testCancelConnectWillCancelPendingConnectionWithRuntimeException
 
         $promise->then(null, $this->expectCallableOnceWith($this->isInstanceOf('RuntimeException')));
         $promise->then(null, $this->expectCallableOnceWith($this->callback(function ($e) {
-            return ($e->getMessage() === 'Connection to database server cancelled');
+            return ($e->getMessage() === 'Connection to mysql://127.0.0.1 cancelled');
         })));
     }
 
@@ -436,7 +499,7 @@ public function testCancelConnectDuringAuthenticationWillCloseConnection()
 
         $promise->then(null, $this->expectCallableOnceWith($this->isInstanceOf('RuntimeException')));
         $promise->then(null, $this->expectCallableOnceWith($this->callback(function ($e) {
-            return ($e->getMessage() === 'Connection to database server cancelled');
+            return ($e->getMessage() === 'Connection to mysql://127.0.0.1 cancelled');
         })));
     }