Merge branch 'async'
authorMichael Wallner <mike@php.net>
Wed, 20 May 2015 15:42:36 +0000 (17:42 +0200)
committerMichael Wallner <mike@php.net>
Wed, 20 May 2015 15:42:36 +0000 (17:42 +0200)
composer.json
lib/pq/Query/AsyncExecutor.php
tests/lib/pq/Query/AsyncExecutorTest.php [new file with mode: 0644]
tests/setup.inc

index 07c3d537bb6ae87eeb93df83aa37da44ff103e3f..2fd2af6f4e95bb0ecaf9999d696ec05ff5b95f59 100644 (file)
@@ -17,7 +17,8 @@
                        "pq\\Query": "lib"
                }
        },
-       "suggest": {
-               "react/promise": "1.0.*"
+       "require-dev": {
+               "react/promise": "~2.2",
+               "amphp/amp": "^1.0-beta"
        }
 }
index 737c0ebf5492429f36d58183222682dda11d4c28..a61f87a868cca08df0729562ba35cd43a29ad6b3 100644 (file)
 <?php
 
-namespace pq\Query\Executor;
+namespace pq\Query;
 
 use \pq\Query\Executor;
 use \pq\Query\WriterInterface;
 
-/**
- * @requires \React\Promise
- */
-use \React\Promise\Deferred;
-
 /**
  * An asynchronous query executor
  */
-class Async extends Executor
+class AsyncExecutor extends Executor
 {
+       /**
+        * Context initializer
+        * @var callable
+        */
+       protected $init;
+       
+       /**
+        * Result resolver
+        * @var callable
+        */
+       protected $done;
+       
+       /**
+        * Callback queue
+        * @var callable
+        */
+       protected $then;
+       
+       /**
+        * Set (promise) callbacks
+        * 
+        * Example with reactphp:
+        * <code>
+        * use React\Promise\Deferred;
+        * 
+        * $exec = new pq\Query\AsyncExecutor(new pq\Connection);
+        * $exec->setCallbacks(
+        * # init context
+        * function() {
+        *              return new Deferred;
+        * },
+        * # done
+        * function(Deferred $context, $result) {
+        *              $context->resolve($result);
+        * },
+        * # then
+        * function(Deferred $context, callable $cb) {
+        *              return $context->promise()->then($cb);
+        * });
+        * $exec->execute($queryWriter, function($result){});
+        * </code>
+        * 
+        * Example with amphp:
+        * <code>
+        * use Amp\Deferred;
+        * 
+        * $exec = new pq\Query\AsyncExecutor(new pq\Connection);
+        * $exec->setCallbacks(
+        * # init context
+        * function() {
+        *              return new Deferred;
+        * },
+        * # done
+        * function(Deferred $context, $result) {
+        *              $context->succeed($result);
+        * },
+        * # then
+        * function(Deferred $context, callable $cb) {
+        *              return $context->promise()->when(function($error, $result) use ($cb) {
+        *                      $cb($result);
+        *              });
+        * });
+        * $exec->execute($queryWriter, function($result){});
+        * </code>
+        * 
+        * @param callable $init context initializer as function()
+        * @param callable $done result receiver as function($context, $result)
+        * @param callable $then callback queue as function($context, $callback)
+        */
+       function setCallbacks(callable $init, callable $done, callable $then) {
+               $this->init = $init;
+               $this->done = $done;
+               $this->then = $then;
+       }
+       
+       /**
+        * Get (promise) callbacks previously set
+        * @return array(callable)
+        */
+       function getCallbacks() {
+               return array($this->init, $this->done, $this->then);
+       }
+       
+       /**
+        * Prepare (promise) callbacks
+        * @param callable $callback
+        * @return array($context, $resolver)
+        */
+       protected function prepareCallbacks(callable $callback/*, ... */) {
+               list($init, $done, $then) = $this->getCallbacks();
+               
+               $context = $init();
+               foreach (func_get_args() as $cb) {
+                       $then($context, $cb);
+               }
+               
+               return array($context, function($result) use ($context, $done) {
+                       $done($context, $result);
+               });
+       }
+       
        /**
         * Execute the query asynchronously through \pq\Connection::execParamsAsync()
         * @param \pq\Query\WriterInterface $query
-        * @param callable $callback
-        * @return \React\Promise\DeferredPromise
+        * @param callable $callback result callback
+        * @return mixed context created by the init callback
         */
        function execute(WriterInterface $query, callable $callback) {
                $this->result = null;
                $this->query = $query;
                $this->notify();
                
-               $deferred = new Deferred;
-               $this->getConnection()->execParamsAsync($query, $query->getParams(), $query->getTypes(), 
-                       array($deferred->resolver(), "resolve"));
-               
-               return $deferred->then(function($result) {
-                       $this->result = $result;
-                       $this->notify();
-               })->then($callback);
+               list($context, $resolver) = $this->prepareCallbacks(
+                       function(\pq\Result $result) {
+                               $this->result = $result;
+                               $this->notify();
+                               return $result;
+                       }, $callback);
+               $this->getConnection()->execParamsAsync($query, $query->getParams(), 
+                       $query->getTypes(), $resolver);
+               return $context;
        }
 }
diff --git a/tests/lib/pq/Query/AsyncExecutorTest.php b/tests/lib/pq/Query/AsyncExecutorTest.php
new file mode 100644 (file)
index 0000000..ad68a91
--- /dev/null
@@ -0,0 +1,72 @@
+<?php
+
+namespace pq\Query;
+
+include_once __DIR__."/../../../setup.inc";
+
+use pq\Connection;
+use React\Promise\Deferred as Reacted;
+use Amp\Deferred as Amped;
+
+class AsyncExecutorTest extends \PHPUnit_Framework_TestCase {
+       private $conn;
+       private $query;
+       
+       protected function setUp() {
+               $this->conn = new Connection(PQ_TEST_DSN);
+               $this->query = new Writer("SELECT \$1::int,\$2::int", [1,2]);
+       }
+
+       function testReact() {
+               $exec = new AsyncExecutor($this->conn);
+               $exec->setCallbacks(
+               # init context
+               function() {
+                       return new Reacted;
+               },
+               # done
+               function(Reacted $context, $result) {
+                       $context->resolve($result);
+               },
+               # then
+               function(Reacted $context, callable $cb) {
+                       return $context->promise()->then($cb);
+               });
+
+               $guard = new \stdClass;
+               $exec->execute($this->query, function($result) use($guard) {
+                       $guard->result = $result;
+               });
+               $this->conn->getResult();
+               $this->assertTrue(!empty($guard->result), "guard is empty");
+               $this->assertInstanceOf("pq\\Result", $guard->result);
+               $this->assertSame([[1,2]], $guard->result->fetchAll());
+       }
+
+       function testAmp() {
+               $exec = new AsyncExecutor($this->conn);
+               $exec->setCallbacks(
+               # init context
+               function() {
+                       return new Amped;
+               },
+               # done
+               function(Amped $context, $result) {
+                       $context->succeed($result);
+               },
+               # then
+               function(Amped $context, callable $cb) {
+                       return $context->promise()->when(function($error, $result) use ($cb) {
+                               $cb($result);
+                       });
+               });
+               $guard = new \stdClass;
+               $exec->execute($this->query, function($result) use($guard) {
+                       $guard->result = $result;
+               });
+               $this->conn->getResult();
+               $this->assertTrue(!empty($guard->result), "guard is empty");
+               $this->assertInstanceOf("pq\\Result", $guard->result);
+               $this->assertSame([[1,2]], $guard->result->fetchAll());
+       }
+}
index 9c7a93237a20cbf62f6b89fd9a716412f6ee63a9..bdee9d3ac2da135ab436f61e7644b14ac4df6296 100644 (file)
@@ -39,7 +39,7 @@ const PQ_TEST_TEARDOWN_SQL = <<<SQL
        drop table if exists reftest cascade;
 SQL;
 
-include_once __DIR__ . "/../lib/autoload.php";
+require_once __DIR__ . "/../vendor/autoload.php";
 
 function executeInConcurrentTransaction(\pq\Query\ExecutorInterface $exec, $sql, array $params = null) {
        $conn = $exec->getConnection();