Added support for bidirectional audio websockets

Author: dragonmantank

src/OpenTok/OpenTok.php

@@ -1329,6 +1329,7 @@ public function signal($sessionId, $payload, $connectionId = null)
      *    <li><code>'uri'</code> (string) &mdash; A publically reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)</li>
      *    <li><code>'streams'</code> (array) &mdash; (Optional) The stream IDs of the participants' whose audio is going to be connected. If not provided, all streams in session will be selected.</li>
      *    <li><code>'headers'</code> (array) &mdash; (Optional) An object of key/val pairs with additional properties to send to your Websocket server, with a maximum length of 512 bytes.</li>
+     *    <li><code>'bidirectional'</code> (boolean) &mdash; (Optional) Whether the WebSocket connection should be bidirectional. Default is false if not provided.</li>
      * </ul>
      *
      * @return array $response Response from the API, structured as follows:

src/OpenTok/Util/Validators.php

@@ -435,6 +435,9 @@ public static function validateWebsocketOptions(array $websocketOptions)
         if (!array_key_exists('uri', $websocketOptions)) {
             throw new InvalidArgumentException('Websocket configuration must have a uri');
         }
+        if (array_key_exists('bidirectional', $websocketOptions) && !is_bool($websocketOptions['bidirectional'])) {
+            throw new InvalidArgumentException('Websocket configuration bidirectional option must be a boolean');
+        }
     }
 
     public static function validateAutoArchiveResolution($archiveResolution)

tests/OpenTokTest/OpenTokTest.php

@@ -3093,4 +3093,78 @@ public function testCanStopCaptions(): void
         $result = $this->opentok->stopCaptions('7c0680fc-6274-4de5-a66f-d0648e8d3ac2');
         $this->assertTrue($result);
     }
+
+    public function testCanConnectAudioStreamWithBidirectionalWebsocketTrue()
+    {
+        $this->setupOTWithMocks([[
+            'code' => 200,
+            'headers' => [
+                'Content-Type' => 'application/json'
+            ],
+            'path' => '/v2/project/APIKEY/connect'
+        ]]);
+
+        $sessionId = '1_MX4xMjM0NTY3OH4-VGh1IEZlYiAyNyAwNDozODozMSBQU1QgMjAxNH4wLjI0NDgyMjI';
+        $token = '063e72a4-64b4-43c8-9da5-eca071daab89';
+        $websocketConfig = [
+            'uri' => 'ws://service.com/wsendpoint',
+            'streams' => [
+                'we9r885',
+                '9238fujs'
+            ],
+            'headers' => [
+                'key1' => 'value'
+            ],
+            'bidirectional' => true
+        ];
+
+        $response = $this->opentok->connectAudio($sessionId, $token, $websocketConfig);
+        $this->assertEquals('063e72a4-64b4-43c8-9da5-eca071daab89', $response['id']);
+        $this->assertEquals('7aebb3a4-3d86-4962-b317-afb73e05439d', $response['connectionId']);
+    }
+
+    public function testCanConnectAudioStreamWithBidirectionalWebsocketFalse()
+    {
+        $this->setupOTWithMocks([[
+            'code' => 200,
+            'headers' => [
+                'Content-Type' => 'application/json'
+            ],
+            'path' => '/v2/project/APIKEY/connect'
+        ]]);
+
+        $sessionId = '1_MX4xMjM0NTY3OH4-VGh1IEZlYiAyNyAwNDozODozMSBQU1QgMjAxNH4wLjI0NDgyMjI';
+        $token = '063e72a4-64b4-43c8-9da5-eca071daab89';
+        $websocketConfig = [
+            'uri' => 'ws://service.com/wsendpoint',
+            'streams' => [
+                'we9r885',
+                '9238fujs'
+            ],
+            'headers' => [
+                'key1' => 'value'
+            ],
+            'bidirectional' => false
+        ];
+
+        $response = $this->opentok->connectAudio($sessionId, $token, $websocketConfig);
+        $this->assertEquals('063e72a4-64b4-43c8-9da5-eca071daab89', $response['id']);
+        $this->assertEquals('7aebb3a4-3d86-4962-b317-afb73e05439d', $response['connectionId']);
+    }
+
+    public function testConnectAudioStreamWithInvalidBidirectionalThrows()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectErrorMessage('Websocket configuration bidirectional option must be a boolean');
+        $this->setupOTWithMocks([[
+            'code' => 200
+        ]]);
+
+        $badPayload = [
+            'uri' => 'ws://service.com/wsendpoint',
+            'bidirectional' => 'notaboolean'
+        ];
+
+        $this->opentok->connectAudio('9999', 'wrwetg', $badPayload);
+    }
 }