[9.x] Normalise predis command argument where it maybe an object. (#47902)

* [9.x] Normalise predis command argument where it maybe an object.

Starting from predis 2.1.1 it is possible to apply an implementation of
`Predis\Command\Argument\ArrayableArgument`

fixes laravel/telescope#1366

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* Apply fixes from StyleCI

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* wip

Signed-off-by: Mior Muhammad Zaki <[email protected]>

* formatting

---------

Signed-off-by: Mior Muhammad Zaki <[email protected]>
Co-authored-by: StyleCI Bot <[email protected]>
Co-authored-by: Taylor Otwell <[email protected]>

Author: 3 people

src/Illuminate/Redis/Connections/Connection.php

@@ -118,12 +118,25 @@ public function command($method, array $parameters = [])
         $time = round((microtime(true) - $start) * 1000, 2);
 
         if (isset($this->events)) {
-            $this->event(new CommandExecuted($method, $parameters, $time, $this));
+            $this->event(new CommandExecuted(
+                $method, $this->parseParametersForEvent($parameters), $time, $this
+            ));
         }
 
         return $result;
     }
 
+    /**
+     * Parse the command's parameters for event dispatching.
+     *
+     * @param  array  $parameters
+     * @return array
+     */
+    protected function parseParametersForEvent(array $parameters)
+    {
+        return $parameters;
+    }
+
     /**
      * Fire the given event if possible.
      *

src/Illuminate/Redis/Connections/PredisConnection.php

@@ -4,6 +4,7 @@
 
 use Closure;
 use Illuminate\Contracts\Redis\Connection as ConnectionContract;
+use Predis\Command\Argument\ArrayableArgument;
 
 /**
  * @mixin \Predis\Client
@@ -50,4 +51,20 @@ public function createSubscription($channels, Closure $callback, $method = 'subs
 
         unset($loop);
     }
+
+    /**
+     * Parse the command's parameters for event dispatching.
+     *
+     * @param  array  $parameters
+     * @return array
+     */
+    protected function parseParametersForEvent(array $parameters)
+    {
+        return collect($parameters)
+            ->transform(function ($parameter) {
+                return $parameter instanceof ArrayableArgument
+                    ? $parameter->toArray()
+                    : $parameter;
+            })->all();
+    }
 }

tests/Integration/Redis/PredisConnectionTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Illuminate\Tests\Integration\Redis;
+
+use Illuminate\Redis\Connections\PredisConnection;
+use Illuminate\Redis\Events\CommandExecuted;
+use Illuminate\Support\Facades\Event;
+use Mockery as m;
+use Orchestra\Testbench\TestCase;
+use Predis\Client;
+use Predis\Command\Argument\Search\SearchArguments;
+
+class PredisConnectionTest extends TestCase
+{
+    protected function defineEnvironment($app)
+    {
+        $app->get('config')->set('database.redis.client', 'predis');
+    }
+
+    public function testPredisCanEmitEventWithArrayableArgumentObject()
+    {
+        if (! class_exists(SearchArguments::class)) {
+            return $this->markTestSkipped('Skipped tests on predis/predis dependency without '.SearchArguments::class);
+        }
+
+        $event = Event::fake();
+
+        $command = 'ftSearch';
+        $parameters = ['test', '*', (new SearchArguments())->dialect('3')->withScores()];
+
+        $predis = new PredisConnection($client = m::mock(Client::class));
+        $predis->setEventDispatcher($event);
+
+        $client->shouldReceive($command)->with(...$parameters)->andReturnTrue();
+
+        $this->assertTrue($predis->command($command, $parameters));
+
+        $event->assertDispatched(function (CommandExecuted $event) use ($command) {
+            return $event->connection instanceof PredisConnection
+                && $event->command === $command
+                && $event->parameters === ['test', '*', ['DIALECT', '3', 'WITHSCORES']];
+        });
+    }
+}