Merge pull request #5 from krakphp/support-tls

Support TLS

Author: ragboyjr

README.md

@@ -74,6 +74,10 @@ Here are the available options that can be provided to the transport options arr
   - *default:* N/A
   - *description:* The redis database to select when performing redis operations. This value can also be set from the dsn via a query parameter or by setting the path in the dsn (`redis//redis:6379?db=1` or `redis://redis:6379/1`).
 
+### TLS Support
+
+To enable TLS support, make the DSN schema `rediss://` instead of `redis://` to note that the redis client should connect with TLS.
+
 ### Processed Queue
 
 This library uses the [rpoplpush reliable queue pattern](https://redis.io/commands/rpoplpush#pattern-reliable-queue). It's important to note however that this library does not make any attempt to clean up that processed queue.

src/Transport/RedisTransport.php

@@ -48,11 +48,16 @@ public static function fromDsn(SerializerInterface $serializer, string $dsn, arr
             throw new InvalidArgumentException('The queue option must be included in the query parameters or configuration options.');
         }
 
+        $host = $parsedUrl['host'] ?? '127.0.0.1';
+        if ($parsedUrl['scheme'] === 'rediss') {
+            $host = 'tls://'.$host;
+        }
+
         return new self(
             $serializer,
             new Redis(),
             $options['queue'] ?? $query['queue'],
-            [$parsedUrl['host'] ?? '127.0.0.1', intval($parsedUrl['port'] ?? 6379)],
+            [$host, intval($parsedUrl['port'] ?? 6379)],
             function(Redis $conn) use ($query, $parsedUrl, $options) {
                 $auth = $options['password'] ?? $parsedUrl['pass'] ?? null;
                 if ($auth) {

src/Transport/RedisTransportFactory.php

@@ -20,6 +20,6 @@ public function createTransport(string $dsn, array $options, SerializerInterface
      * of this implementation.
      */
     public function supports(string $dsn, array $options): bool {
-        return strpos($dsn, 'redis://') === 0 && boolval($options['use_krak_redis'] ?? true);
+        return (strpos($dsn, 'redis://') === 0 || strpos($dsn, 'rediss://') === 0) && boolval($options['use_krak_redis'] ?? true);
     }
 }

tests/Feature/TransportTest.php

@@ -48,6 +48,12 @@ public function provide_custom_redis_urls_with_db() {
         yield 'db in options' => ['options'];
     }
 
+    /** @test */
+    public function supports_tls() {
+        $this->given_the_redis_transport_is_setup_from_dsn_and_options('rediss://redis?queue=messenger');
+        $this->then_the_redis_transport_connect_params_use_tls();
+    }
+
     /** @test */
     public function can_send_a_message() {
         $this->given_there_is_a_wrapped_message();
@@ -220,18 +226,26 @@ private function then_the_queue_contains_the_message() {
         );
     }
 
-    public function then_the_queue_has_size(int $size): void {
+    private function then_the_queue_has_size(int $size): void {
         $this->assertEquals($size, $this->redis->lLen('messenger') + $this->redis->zCard('messenger:delayed'));
     }
 
-    public function then_the_message_is_not_available_immediately() {
+    private function then_the_message_is_not_available_immediately() {
         $res = $this->transport->get();
         $this->assertCount(0, $res);
     }
 
-    public function then_the_message_is_available_after(int $delayMs) {
+    private function then_the_message_is_available_after(int $delayMs) {
         usleep($delayMs * 1000);
         $res = $this->transport->get();
         $this->assertCount(1, $res);
     }
+
+    private function then_the_redis_transport_connect_params_use_tls() {
+        // this is NOT a great test, but setting up a redis TLS server is quite a pain, so this is just hack to give
+        // some piece of mind regarding the code, but isn't a good test because it's asserting private functionality.
+        \Closure::bind(function() {
+            TransportTest::assertEquals(['tls://redis', 6379], $this->connectParams);
+        }, $this->transport, RedisTransport::class)();
+    }
 }