Added unit tests to check for decoding invalid socket id

Author: sacOO7

src/AblyBroadcaster.php

@@ -320,7 +320,7 @@ public function formatChannels($channels)
      */
     protected function buildAblyMessage($event, $payload = [], $socketIdObject = null)
     {
-        $message = tap(new AblyMessage, function ($message) use ($event, $payload, $socketIdObject) {
+        $message = tap(new AblyMessage, function ($message) use ($event, $payload) {
             $message->name = $event;
             $message->data = $payload;
         });

src/Utils.php

@@ -3,7 +3,6 @@
 namespace Ably\LaravelBroadcaster;
 
 use Ably\Exceptions\AblyException;
-use Illuminate\Broadcasting\BroadcastException;
 
 class Utils
 {
@@ -73,7 +72,7 @@ public static function base64url_decode($data) {
         return base64_decode(strtr($data, '-_', '+/'), true);
     }
 
-    const SOCKET_ID_ERROR = "please make sure to send base64 encoded json with "
+    const SOCKET_ID_ERROR = "please make sure to send base64 url encoded json with "
     ."'connectionKey' and 'clientId' as keys. 'clientId' is null if connection is not identified";
 
     /**
@@ -87,9 +86,9 @@ public static function decodeSocketId($socketId) {
                 throw new AblyException("SocketId decoding failed, ".self::SOCKET_ID_ERROR);
             }
             if (!isset($socketIdObject->connectionKey)) {
-                throw new AblyException("ConnectionKey is missing, ".self::SOCKET_ID_ERROR);
+                throw new AblyException("ConnectionKey is not set, ".self::SOCKET_ID_ERROR);
             }
-            if (!isset($socketIdObject->clientId)) {
+            if (!property_exists($socketIdObject, 'clientId')) {
                 throw new AblyException("ClientId is missing, ".self::SOCKET_ID_ERROR);
             }
         }

tests/UtilsTest.php

@@ -2,6 +2,7 @@
 
 namespace Ably\LaravelBroadcaster\Tests;
 
+use Ably\Exceptions\AblyException;
 use Ably\LaravelBroadcaster\Utils;
 
 class UtilsTest extends TestCase
@@ -27,12 +28,49 @@ public function testGenerateAndValidateToken()
         self::assertTrue($jwtIsValid);
     }
 
-    public function testValidateDecodingSocketId() {
+    /**
+     * @throws AblyException
+     */
+    public function testDecodingSocketId() {
         $socketId = new \stdClass();
         $socketId->connectionKey = 'key';
-        $socketId->clientId = 'clientId';
+        $socketId->clientId = null;
         $socketIdObject = Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketId)));
         self::assertEquals('key', $socketIdObject->connectionKey);
-        self::assertEquals('clientId', $socketIdObject->clientId);
+        self::assertNull($socketIdObject->clientId);
+
+        $socketId = new \stdClass();
+        $socketId->connectionKey = 'key';
+        $socketId->clientId = 'id';
+        $socketIdObject = Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketId)));
+        self::assertEquals('key', $socketIdObject->connectionKey);
+        self::assertEquals('id', $socketIdObject->clientId);
+    }
+
+    public function testExceptionOnDecodingInvalidSocketId()
+    {
+        self::expectException(AblyException::class);
+        self::expectExceptionMessage("SocketId decoding failed, ".Utils::SOCKET_ID_ERROR);
+        Utils::decodeSocketId("invalid_socket_id");
+    }
+
+    public function testExceptionOnMissingClientIdInSocketId()
+    {
+        $socketId = new \stdClass();
+        $socketId->connectionKey = 'key';
+
+        self::expectException(AblyException::class);
+        self::expectExceptionMessage("ClientId is missing, ".Utils::SOCKET_ID_ERROR);
+        Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketId)));
+    }
+
+    public function testExceptionOnMissingConnectionKeyInSocketId()
+    {
+        $socketId = new \stdClass();
+        $socketId->clientId = 'id';
+
+        self::expectException(AblyException::class);
+        self::expectExceptionMessage("ConnectionKey is not set, ".Utils::SOCKET_ID_ERROR);
+        Utils::decodeSocketId(Utils::base64url_encode(json_encode($socketId)));
     }
 }