Merge branch 'redis-events-simpler' of https://github.com/tillkruss/framework into tillkruss-redis-events-simpler

Author: taylorotwell

src/Illuminate/Foundation/Testing/Concerns/InteractsWithRedis.php

@@ -3,6 +3,7 @@
 namespace Illuminate\Foundation\Testing\Concerns;
 
 use Illuminate\Redis\RedisManager;
+use Illuminate\Foundation\Application;
 
 trait InteractsWithRedis
 {
@@ -27,6 +28,7 @@ trait InteractsWithRedis
      */
     public function setUpRedis()
     {
+        $app = $this->app ?? new Application;
         $host = getenv('REDIS_HOST') ?: '127.0.0.1';
         $port = getenv('REDIS_PORT') ?: 6379;
 
@@ -37,7 +39,7 @@ public function setUpRedis()
         }
 
         foreach ($this->redisDriverProvider() as $driver) {
-            $this->redis[$driver[0]] = new RedisManager($driver[0], [
+            $this->redis[$driver[0]] = new RedisManager($app, $driver[0], [
                 'cluster' => false,
                 'default' => [
                     'host' => $host,

src/Illuminate/Redis/Connections/Connection.php

@@ -3,6 +3,8 @@
 namespace Illuminate\Redis\Connections;
 
 use Closure;
+use Illuminate\Redis\Events\QueryExecuted;
+use Illuminate\Contracts\Events\Dispatcher;
 use Illuminate\Redis\Limiters\DurationLimiterBuilder;
 use Illuminate\Redis\Limiters\ConcurrencyLimiterBuilder;
 
@@ -18,6 +20,13 @@ abstract class Connection
      */
     protected $client;
 
+    /**
+     * The event dispatcher instance.
+     *
+     * @var \Illuminate\Contracts\Events\Dispatcher
+     */
+    protected $events;
+
     /**
      * The Redis connection name.
      *
@@ -100,7 +109,41 @@ public function psubscribe($channels, Closure $callback)
      */
     public function command($method, array $parameters = [])
     {
-        return $this->client->{$method}(...$parameters);
+        $start = microtime(true);
+        $result = $this->client->{$method}(...$parameters);
+        $time = round((microtime(true) - $start) * 1000, 2);
+
+        if (isset($this->events)) {
+            $this->event(new QueryExecuted($method, $parameters, $time, $this));
+        }
+
+        return $result;
+    }
+
+    /**
+     * Fire the given event if possible.
+     *
+     * @param  mixed  $event
+     * @return void
+     */
+    protected function event($event)
+    {
+        if (isset($this->events)) {
+            $this->events->dispatch($event);
+        }
+    }
+
+    /**
+     * Register a Redis query listener with the connection.
+     *
+     * @param  \Closure  $callback
+     * @return void
+     */
+    public function listen(Closure $callback)
+    {
+        if (isset($this->events)) {
+            $this->events->listen(QueryExecuted::class, $callback);
+        }
     }
 
     /**
@@ -126,6 +169,37 @@ public function setName($name)
         return $this;
     }
 
+    /**
+     * Get the event dispatcher used by the connection.
+     *
+     * @return \Illuminate\Contracts\Events\Dispatcher
+     */
+    public function getEventDispatcher()
+    {
+        return $this->events;
+    }
+
+    /**
+     * Set the event dispatcher instance on the connection.
+     *
+     * @param  \Illuminate\Contracts\Events\Dispatcher  $events
+     * @return void
+     */
+    public function setEventDispatcher(Dispatcher $events)
+    {
+        $this->events = $events;
+    }
+
+    /**
+     * Unset the event dispatcher instance on the connection.
+     *
+     * @return void
+     */
+    public function unsetEventDispatcher()
+    {
+        $this->events = null;
+    }
+
     /**
      * Pass other method calls down to the underlying client.
      *

src/Illuminate/Redis/Events/QueryExecuted.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Illuminate\Redis\Events;
+
+class QueryExecuted
+{
+    /**
+     * The Redis command that was executed.
+     *
+     * @var string
+     */
+    public $command;
+
+    /**
+     * The array of query parameters.
+     *
+     * @var array
+     */
+    public $parameters;
+
+    /**
+     * The number of milliseconds it took to execute the query.
+     *
+     * @var float
+     */
+    public $time;
+
+    /**
+     * The Redis connection instance.
+     *
+     * @var \Illuminate\Redis\Connections\Connection
+     */
+    public $connection;
+
+    /**
+     * The Redis connection name.
+     *
+     * @var string
+     */
+    public $connectionName;
+
+    /**
+     * Create a new event instance.
+     *
+     * @param  string  $command
+     * @param  array  $parameters
+     * @param  float|null  $time
+     * @param  \Illuminate\Redis\Connections\Connection  $connection
+     * @return void
+     */
+    public function __construct($command, $parameters, $time, $connection)
+    {
+        $this->time = $time;
+        $this->command = $command;
+        $this->parameters = $parameters;
+        $this->connection = $connection;
+        $this->connectionName = $connection->getName();
+    }
+}

src/Illuminate/Redis/RedisManager.php

@@ -4,12 +4,20 @@
 
 use InvalidArgumentException;
 use Illuminate\Contracts\Redis\Factory;
+use Illuminate\Redis\Connections\Connection;
 
 /**
  * @mixin \Illuminate\Redis\Connections\Connection
  */
 class RedisManager implements Factory
 {
+    /**
+     * The application instance.
+     *
+     * @var \Illuminate\Foundation\Application
+     */
+    protected $app;
+
     /**
      * The name of the default driver.
      *
@@ -31,15 +39,24 @@ class RedisManager implements Factory
      */
     protected $connections;
 
+    /**
+     * Indicates whether event dispatcher is set on connections.
+     *
+     * @var bool
+     */
+    protected $events = true;
+
     /**
      * Create a new Redis manager instance.
      *
+     * @param  \Illuminate\Foundation\Application  $app
      * @param  string  $driver
      * @param  array  $config
      * @return void
      */
-    public function __construct($driver, array $config)
+    public function __construct($app, $driver, array $config)
     {
+        $this->app = $app;
         $this->driver = $driver;
         $this->config = $config;
     }
@@ -58,7 +75,9 @@ public function connection($name = null)
             return $this->connections[$name];
         }
 
-        return $this->connections[$name] = $this->resolve($name)->setName($name);
+        return $this->connections[$name] = $this->configure(
+            $this->resolve($name), $name
+        );
     }
 
     /**
@@ -101,6 +120,24 @@ protected function resolveCluster($name)
         );
     }
 
+    /**
+     * Get the connector instance for the current driver.
+     *
+     * @param  \Illuminate\Redis\Connections\Connection  $connection
+     * @param  string  $name
+     * @return \Illuminate\Redis\Connections\Connection
+     */
+    protected function configure(Connection $connection, $name)
+    {
+        $connection->setName($name);
+
+        if ($this->events && $this->app->bound('events')) {
+            $connection->setEventDispatcher($this->app['events']);
+        }
+
+        return $connection;
+    }
+
     /**
      * Get the connector instance for the current driver.
      *
@@ -126,6 +163,26 @@ public function connections()
         return $this->connections;
     }
 
+    /**
+     * Enable setting event dispatcher on connections.
+     *
+     * @return array
+     */
+    public function enableEvents()
+    {
+        return $this->events = true;
+    }
+
+    /**
+     * Disable setting event dispatcher on connections.
+     *
+     * @return array
+     */
+    public function disableEvents()
+    {
+        return $this->events = false;
+    }
+
     /**
      * Pass methods onto the default Redis connection.
      *

src/Illuminate/Redis/RedisServiceProvider.php

@@ -24,7 +24,7 @@ public function register()
         $this->app->singleton('redis', function ($app) {
             $config = $app->make('config')->get('database.redis');
 
-            return new RedisManager(Arr::pull($config, 'client', 'predis'), $config);
+            return new RedisManager($app, Arr::pull($config, 'client', 'predis'), $config);
         });
 
         $this->app->bind('redis.connection', function ($app) {

tests/Redis/RedisConnectionTest.php

@@ -2,8 +2,10 @@
 
 namespace Illuminate\Tests\Redis;
 
+use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Illuminate\Redis\RedisManager;
+use Illuminate\Foundation\Application;
 use Illuminate\Foundation\Testing\Concerns\InteractsWithRedis;
 
 class RedisConnectionTest extends TestCase
@@ -573,6 +575,29 @@ public function it_runs_raw_command()
         }
     }
 
+    /**
+     * @test
+     */
+    public function it_dispatches_query_event()
+    {
+        foreach ($this->connections() as $redis) {
+            $redis->setEventDispatcher($events = m::mock('Illuminate\Contracts\Events\Dispatcher'));
+
+            $events->shouldReceive('dispatch')->once()->with(m::on(function ($event) {
+                $this->assertEquals('get', $event->command);
+                $this->assertEquals(['foobar'], $event->parameters);
+                $this->assertEquals('default', $event->connectionName);
+                $this->assertInstanceOf('\Illuminate\Redis\Connections\Connection', $event->connection);
+
+                return true;
+            }));
+
+            $redis->get('foobar');
+
+            $redis->unsetEventDispatcher();
+        }
+    }
+
     public function connections()
     {
         $connections = [
@@ -584,7 +609,7 @@ public function connections()
             $host = getenv('REDIS_HOST') ?: '127.0.0.1';
             $port = getenv('REDIS_PORT') ?: 6379;
 
-            $prefixedPhpredis = new RedisManager('phpredis', [
+            $prefixedPhpredis = new RedisManager(new Application, 'phpredis', [
                 'cluster' => false,
                 'default' => [
                     'host' => $host,